Pause Change Owner Process
Pauses a node ownership change process that is started or in_progress. No further step is sent until the process is resumed. A step whose transaction was already sent is not recalled: it still settles and is recorded, but the next step waits. See the overview for the lifecycle.
Only the platform owner's API key may call this endpoint; any other key gets 403.
Required permission: node:change-owner
Request
POST /v2/admin/nodes/{node_id}/change-owner-processes/{process_id}/pause
Parameters
| Name | Type | In | Description |
|---|---|---|---|
node_id | string | path | Required. The node that owns the setup |
process_id | string | path | Required. The process id; must belong to node_id |
Headers
| Name | Description |
|---|---|
Authorization | Required. Bearer <access_token> |
Example
curl --request POST \
--url '{{baseUrl}}/v2/admin/nodes/6901350deb7ed8c1c38de4e9/change-owner-processes/6907a4e1b5c83f2d9e6a0b17/pause' \
--header 'Authorization: Bearer <access_token>'
Response
204 No Content, no body. The process status is now paused.
Errors
| Status | Code | Description |
|---|---|---|
| 400 | 10000 | process_id is not a valid id |
| 400 | 20001 | No process with this id on this node |
| 400 | 20005 | The process is not started or in_progress (already paused, or finished) |
| 403 | 10005 | The API key does not belong to the platform owner |
See Errors for the error format and common codes.