GET

/api/v1/system/status

Zustand des Core

Anfrage#

POSIX-Shell · curl

curl --fail-with-body --request GET \
  "$ADBR_API_URL/api/v1/system/status" \
  -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: keine deklariert

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": [
          "mode",
          "reason",
          "warnings",
          "data_root",
          "store_id",
          "disk",
          "disk_free_bytes",
          "db_version",
          "vault",
          "api"
        ],
        "properties": {
          "mode": {
            "type": "string"
          },
          "reason": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "warnings": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "data_root": {
            "type": "string"
          },
          "store_id": {
            "type": "string"
          },
          "disk": {
            "type": "string"
          },
          "disk_free_bytes": {
            "anyOf": [
              {
                "type": "integer"
              },
              {
                "type": "null"
              }
            ]
          },
          "db_version": {
            "type": "integer"
          },
          "vault": {
            "type": "object",
            "required": [
              "state",
              "reason"
            ],
            "properties": {
              "state": {
                "type": "string"
              },
              "reason": {
                "anyOf": [
                  {
                    "type": "string"
                  },
                  {
                    "type": "null"
                  }
                ]
              }
            }
          },
          "api": {
            "type": "object",
            "required": [
              "url",
              "port"
            ],
            "properties": {
              "url": {
                "type": "string"
              },
              "port": {
                "type": "integer"
              }
            }
          }
        }
      }
    }
  }
}

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 Core",
  "tags": [
    "System"
  ],
  "x-required-scopes": [],
  "responses": {
    "200": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "mode",
              "reason",
              "warnings",
              "data_root",
              "store_id",
              "disk",
              "disk_free_bytes",
              "db_version",
              "vault",
              "api"
            ],
            "properties": {
              "mode": {
                "type": "string"
              },
              "reason": {
                "anyOf": [
                  {
                    "type": "string"
                  },
                  {
                    "type": "null"
                  }
                ]
              },
              "warnings": {
                "type": "array",
                "items": {
                  "type": "string"
                }
              },
              "data_root": {
                "type": "string"
              },
              "store_id": {
                "type": "string"
              },
              "disk": {
                "type": "string"
              },
              "disk_free_bytes": {
                "anyOf": [
                  {
                    "type": "integer"
                  },
                  {
                    "type": "null"
                  }
                ]
              },
              "db_version": {
                "type": "integer"
              },
              "vault": {
                "type": "object",
                "required": [
                  "state",
                  "reason"
                ],
                "properties": {
                  "state": {
                    "type": "string"
                  },
                  "reason": {
                    "anyOf": [
                      {
                        "type": "string"
                      },
                      {
                        "type": "null"
                      }
                    ]
                  }
                }
              },
              "api": {
                "type": "object",
                "required": [
                  "url",
                  "port"
                ],
                "properties": {
                  "url": {
                    "type": "string"
                  },
                  "port": {
                    "type": "integer"
                  }
                }
              }
            }
          }
        }
      }
    },
    "default": {
      "description": "HTTP error envelope. The status and error.code identify the failure.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Error"
          }
        }
      }
    }
  }
}