Recovery

Provision or replace this node's recovery repository

Changed on

Provisions the repository, or continues a provisioning attempt a crash left half done. Idempotent: the same key answers the operation it already created. With replace: true, registers a new repository volume generation and moves the active pointer to it; the previous repository and its points are kept. A request that builds or replaces the repository takes the node's repository lock, the lock every capture, verification, and restore holds, so it answers 409 and is not recorded while one of them (or another replacement) runs, or while a stale repository lock awaits a reviewed release. A repeated request on a working repository changes nothing and takes no lock. Requires permission to change system settings. Only a Full Admin API token may call it; any other scope is refused with 403 SCOPE_DENIED.

post/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.

Request body

idempotencyKeystring required
replaceboolean

Provision a new repository and keep the previous one and its points.

Response

Replay of an earlier request with the same idempotency key.

failureDomain'same_failure_domain' required
warningstring required

States that the repository shares this node's failure domain and is not an off-host copy.

Changes