Report ownership transfer progress
PATCH api/edge/uuid/ownership_transfer
Reports the output of one step of an ownership transfer. uuid identifies the step, not the node. When SC//Reliant™ Platform Manager starts a step on a node with ownership_transfer.execute, it passes a notification URI that contains a new UUID for that step, in the form rpms://platform.reliant.io/api/edge/<uuid>/ownership_transfer. RVC on the node sends the step's output to this action while the step runs, and sends a final update with the exit code when the step finishes. The output appears in the step's log on the Ownership Transfer page in Platform Manager.
You generally don't call this action directly. For more information, see rvc ownership-transfer and Transferring ownership.
Request syntax
patch api/edge/<uuid>/ownership_transfer '{"contents":"<string>","timestamp":<integer>,"exit_code":<integer>}'Request parameters
The request accepts the following data in JSON format.
| Parameter | Type | Description | Required | Default value |
|---|---|---|---|---|
contents | String | The output of the ownership transfer step. | No | null |
timestamp | Integer | When the output was produced, as a Unix timestamp. | No | null |
exit_code | Integer | The exit code of the step. Set to null for a partial update while the step is still running. | No | null |
Response
A successful request returns a success response with no data that RVC uses. RVC records each delivered update in the RVC server journal on the node, for example Message successfully published to rpms subscriber rpms://platform.reliant.io/api/edge/<uuid>/ownership_transfer.
Errors
The following are errors returned by this API. For a complete list of common errors, see Common errors.
| Code | Message | Cause |
|---|---|---|
401 | 401 Unauthorized | The request was not made with the credentials of a node. This action only accepts requests from a node, so a user API key is rejected. |
Examples
Example: Report the final result of an ownership transfer step
This example reports that an ownership transfer step finished successfully.
curl -X PATCH -H "Accept: application/vnd.reliantsec-v1+json" -H "Content-Type: application/json" https://platform.reliant.io/api/edge/<uuid>/ownership_transfer -d '{"contents":"Step completed","timestamp":1727712000,"exit_code":0}'