GET

/api/v1/vault

Zustand des Tresors

Anfrage#

POSIX-Shell · curl

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

Verwende lokale Adresse und Token aus API & MCP. Ersetze Pfadplatzhalter wie {id} durch tatsächliche IDs.

Authentifizierung und Rechte#

Authentifizierung: Bearer-Token

Scopes: admin

Alle aufgeführten Scopes sind erforderlich; admin erfüllt Scope-Prüfungen. Kontorechte, Anfrageinhalt, Tresorzustand und Ressourcenrechte können weitere Voraussetzungen setzen.

Parameter#

Keine Pfad- oder Query-Parameter deklariert.

Anfragekörper#

Kein Anfragekörper deklariert.

Antworten#

200 · Standardantwort

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-Fehlerhülle. Status und error.code bezeichnen den Fehler.

OpenAPI JSON

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

Allgemeine Authentifizierungs- und Transportfehler können zusätzlich zu den dokumentierten Antworten auftreten.

OpenAPI-Definition#

Vollständige Operationsdefinition

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"
          }
        }
      }
    }
  }
}