GET

/api/v1/vault

Vault status

Request#

POSIX shell · curl

curl --fail-with-body --request GET \
  "$ADBR_API_URL/api/v1/vault" \
  -H "Authorization: Bearer $ADBR_API_TOKEN"

Use the local address and token from API & MCP. Replace path placeholders such as {id} with actual IDs.

Authentication and permissions#

Authentication: Bearer token

Scopes: admin

All listed scopes are required; admin satisfies scope checks. Account permissions, request content, vault state and resource permissions can impose additional requirements.

Parameters#

No path or query parameters declared.

Request body#

No request body declared.

Responses#

200 · Default response

OpenAPI JSON

{
  "description": "Default Response",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "state",
          "mode",
          "auto_lock_minutes",
          "reason",
          "method",
          "active_key_id",
          "rotation_due",
          "recovery_key_set"
        ],
        "properties": {
          "state": {
            "type": "string"
          },
          "mode": {
            "type": "string"
          },
          "auto_lock_minutes": {
            "type": "integer"
          },
          "reason": {
            "type": [
              "null",
              "string"
            ]
          },
          "method": {
            "type": "string"
          },
          "active_key_id": {
            "type": "string"
          },
          "rotation_due": {
            "type": "boolean"
          },
          "recovery_key_set": {
            "type": "boolean"
          }
        }
      }
    }
  }
}

default · HTTP error envelope. The status and error.code identify the failure.

OpenAPI JSON

{
  "description": "HTTP error envelope. The status and error.code identify the failure.",
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/Error"
      }
    }
  }
}

General authentication and transport errors may occur in addition to the documented responses.

OpenAPI definition#

Complete operation definition

OpenAPI JSON

{
  "summary": "Zustand des Tresors",
  "tags": [
    "Tresor"
  ],
  "x-required-scopes": [
    "admin"
  ],
  "responses": {
    "200": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "state",
              "mode",
              "auto_lock_minutes",
              "reason",
              "method",
              "active_key_id",
              "rotation_due",
              "recovery_key_set"
            ],
            "properties": {
              "state": {
                "type": "string"
              },
              "mode": {
                "type": "string"
              },
              "auto_lock_minutes": {
                "type": "integer"
              },
              "reason": {
                "type": [
                  "null",
                  "string"
                ]
              },
              "method": {
                "type": "string"
              },
              "active_key_id": {
                "type": "string"
              },
              "rotation_due": {
                "type": "boolean"
              },
              "recovery_key_set": {
                "type": "boolean"
              }
            }
          }
        }
      }
    },
    "default": {
      "description": "HTTP error envelope. The status and error.code identify the failure.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Error"
          }
        }
      }
    }
  }
}