Recovery

Create a point of a volume

Changed on

Admits a root capture of one named volume. Eligibility, readiness, dependent stacks, the access check, a generation probe, the operation record, and the locks all happen before the answer, so a held or stale lock is a real 409 rather than a background failure. A refused request is not recorded, so the same idempotency key can be sent again once the lock is gone. One repository lock covers the node: only one capture, verification, restore, or repository replacement runs at a time on it. A node with no repository answers 503 capability_unavailable with reason repository_not_initialized. The capture runs in the background and is followed by a repository-wide metadata check before the operation ends. Only a Full Admin API token may call it; any other scope is refused with 403 SCOPE_DENIED.

post/api/recovery/storage/points

Request

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

volumeNamestring required

A name Docker accepts for a volume. Anything else answers 400.

idempotencyKeystring required

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