STstudio-saelix
Recovery

Read this node's recovery status

Changed on

Returns this node's recovery contract version and whether it can create and restore volume recovery points, with the reason when it cannot. The operationId echoes the dispatch id a control instance sent, so a caller can match the answer to its request. A node that predates this route answers 404, which a control instance reads as an update being required.

get/api/recovery/node

Request

  • Base URL
    https://localhost:1852
  • URL
    https://localhost:1852/api/recovery/node
  • Auth
    HTTP bearer

Headers

x-node-idinteger
Example:1

Target a specific node by ID. If omitted, the default node is used. Can also be passed as ?nodeId= query parameter.

Response

This node's recovery descriptor.

contractVersioninteger required
operationIdstring nullable required

The dispatch id a control instance sent, echoed back, or null for a direct call.

Example response

{
  "contractVersion": 1,
  "volumeProtection": {
    "capability": "volume-protection-v1",
    "version": 1,
    "reason": "engine_registered"
  }
}

Changes