STstudio-saelix
Recovery

Read this node's recovery repository

Changed on

Returns the repository's health, the reason it is not healthy, the failure domain, and the warning that points share this node's failure domain. The repository object names the volume, fingerprint, secret state, creation time, and the last check; it is returned only to a caller who may change these settings. The repository password is never returned by any shape.

get/api/recovery/repository

Request

  • Base URL
    https://localhost:1852
  • URL
    https://localhost:1852/api/recovery/repository
  • 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

Repository health, and configuration facts for a caller who may change settings.

health'available' | 'unavailable' | 'update_required' | 'unknown' required
reasonstring required

The capability reason, for example engine_registered, helper_unavailable, or repository_not_initialized.

failureDomain'same_failure_domain' | 'separate' | 'unknown' required
warningstring required
initializedboolean required

Example response

{
  "repository": {
    "locator": "sencho-recovery-4f2a1c9d8e70-7b3d5a1e9c42-g1"
  }
}

Changes