POST

/api/v1/profiles/{id}/snapshots

Snapshot jetzt anlegen (Profil muss geschlossen sein)

Anfrage#

POSIX-Shell · curl

curl --fail-with-body --request POST \
  "$ADBR_API_URL/api/v1/profiles/{id}/snapshots" \
  -H "Authorization: Bearer $ADBR_API_TOKEN" \
  -H "Content-Type: application/json" \
  --data '{}'

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

Authentifizierung und Rechte#

Authentifizierung: Bearer-Token

Scopes: profiles:write

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

Parameter#

Parameter	Ort	Pflicht	Beschreibung
`operation_id`	query	Nein
`id`	path	Ja

Vollständige Parameterschemas

OpenAPI JSON

[
  {
    "schema": {
      "type": "string",
      "pattern": "^[a-zA-Z0-9-]{16,64}$"
    },
    "in": "query",
    "name": "operation_id",
    "required": false
  },
  {
    "schema": {
      "type": "string",
      "minLength": 1,
      "maxLength": 64
    },
    "in": "path",
    "name": "id",
    "required": true
  }
]

Anfragekörper#

Kein Anfragekörper deklariert.

Antworten#

200 · Standardantwort

OpenAPI JSON

{
  "description": "Default Response",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "id",
          "profile_id",
          "reason",
          "file_name",
          "size_bytes",
          "engine_build",
          "created_at",
          "exists"
        ],
        "properties": {
          "id": {
            "type": "string"
          },
          "profile_id": {
            "type": "string"
          },
          "reason": {
            "type": "string"
          },
          "file_name": {
            "type": "string"
          },
          "size_bytes": {
            "type": "integer"
          },
          "engine_build": {
            "type": "string"
          },
          "created_at": {
            "type": "integer"
          },
          "exists": {
            "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": "Snapshot jetzt anlegen (Profil muss geschlossen sein)",
  "tags": [
    "Snapshots"
  ],
  "parameters": [
    {
      "schema": {
        "type": "string",
        "pattern": "^[a-zA-Z0-9-]{16,64}$"
      },
      "in": "query",
      "name": "operation_id",
      "required": false
    },
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 64
      },
      "in": "path",
      "name": "id",
      "required": true
    }
  ],
  "x-required-scopes": [
    "profiles:write"
  ],
  "responses": {
    "200": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "id",
              "profile_id",
              "reason",
              "file_name",
              "size_bytes",
              "engine_build",
              "created_at",
              "exists"
            ],
            "properties": {
              "id": {
                "type": "string"
              },
              "profile_id": {
                "type": "string"
              },
              "reason": {
                "type": "string"
              },
              "file_name": {
                "type": "string"
              },
              "size_bytes": {
                "type": "integer"
              },
              "engine_build": {
                "type": "string"
              },
              "created_at": {
                "type": "integer"
              },
              "exists": {
                "type": "boolean"
              }
            }
          }
        }
      }
    },
    "default": {
      "description": "HTTP error envelope. The status and error.code identify the failure.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Error"
          }
        }
      }
    }
  }
}