STstudio-saelix
Recovery

List volumes and their coverage

Changed on

With ?stack=, returns the volumes that stack's rendered model declares. Without it, considers every volume on the node. Each root carries its eligibility, its coverage reason, and the covering point when there is one. A root the caller may not read appears as {"access": "inaccessible"} with its name withheld, and it still counts against the verdict. A volume recreated since its last capture reads older_generation at once, from Docker's creation time, without waiting for a new capture.

get/api/recovery/storage

Request

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

Query parameters

stackstring

One stack directory name. Omit to consider every volume on the node. A stack that does not exist lists nothing; a repeated parameter or a name that is not a valid stack name answers 400.

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

Roots, the aggregate verdict, and this node's volume-protection capability.

Example response

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

Changes