POST

/api/v1/trash/backup-coverage

Profilinhalt vorhandener Datenbanksicherungen und entschlüsselbarer Vollbackups im Zielordner prüfen; unprüfbare Dateien separat zählen

Anfrage#

POSIX-Shell · curl

curl --fail-with-body --request POST \
  "$ADBR_API_URL/api/v1/trash/backup-coverage" \
  -H "Authorization: Bearer $ADBR_API_TOKEN" \
  -H "Content-Type: application/json" \
  --data @request.json

Verwende lokale Adresse und Token aus API & MCP. Ersetze Pfadplatzhalter wie {id} durch tatsächliche IDs. Erstelle request.json anhand des folgenden Körperschemas, bevor du den Befehl ausführst.

Authentifizierung und Rechte#

Authentifizierung: Bearer-Token

Scopes: profiles:read

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#

Erforderlich.

Vollständiges Körperschema

OpenAPI JSON

{
  "required": true,
  "content": {
    "application/json": {
      "schema": {
        "anyOf": [
          {
            "type": "object",
            "required": [
              "profile_ids"
            ],
            "properties": {
              "profile_ids": {
                "type": "array",
                "items": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 64
                },
                "minItems": 1,
                "maxItems": 1000
              }
            },
            "additionalProperties": false
          },
          {
            "type": "object",
            "required": [
              "empty_trash",
              "include_held"
            ],
            "properties": {
              "empty_trash": {
                "type": "boolean",
                "enum": [
                  true
                ]
              },
              "include_held": {
                "type": "boolean"
              }
            },
            "additionalProperties": false
          }
        ]
      }
    }
  }
}

Antworten#

200 · Standardantwort

OpenAPI JSON

{
  "description": "Default Response",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "db_backups",
          "full_backups",
          "unchecked",
          "profiles",
          "oldest_at"
        ],
        "properties": {
          "db_backups": {
            "type": "integer"
          },
          "full_backups": {
            "type": "integer"
          },
          "unchecked": {
            "type": "integer"
          },
          "profiles": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "id",
                "db_backups",
                "full_backups"
              ],
              "properties": {
                "id": {
                  "type": "string"
                },
                "db_backups": {
                  "type": "integer"
                },
                "full_backups": {
                  "type": "integer"
                }
              }
            }
          },
          "oldest_at": {
            "type": [
              "null",
              "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": "Profilinhalt vorhandener Datenbanksicherungen und entschlüsselbarer Vollbackups im Zielordner prüfen; unprüfbare Dateien separat zählen",
  "tags": [
    "Papierkorb"
  ],
  "requestBody": {
    "required": true,
    "content": {
      "application/json": {
        "schema": {
          "anyOf": [
            {
              "type": "object",
              "required": [
                "profile_ids"
              ],
              "properties": {
                "profile_ids": {
                  "type": "array",
                  "items": {
                    "type": "string",
                    "minLength": 1,
                    "maxLength": 64
                  },
                  "minItems": 1,
                  "maxItems": 1000
                }
              },
              "additionalProperties": false
            },
            {
              "type": "object",
              "required": [
                "empty_trash",
                "include_held"
              ],
              "properties": {
                "empty_trash": {
                  "type": "boolean",
                  "enum": [
                    true
                  ]
                },
                "include_held": {
                  "type": "boolean"
                }
              },
              "additionalProperties": false
            }
          ]
        }
      }
    }
  },
  "x-required-scopes": [
    "profiles:read"
  ],
  "responses": {
    "200": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "db_backups",
              "full_backups",
              "unchecked",
              "profiles",
              "oldest_at"
            ],
            "properties": {
              "db_backups": {
                "type": "integer"
              },
              "full_backups": {
                "type": "integer"
              },
              "unchecked": {
                "type": "integer"
              },
              "profiles": {
                "type": "array",
                "items": {
                  "type": "object",
                  "required": [
                    "id",
                    "db_backups",
                    "full_backups"
                  ],
                  "properties": {
                    "id": {
                      "type": "string"
                    },
                    "db_backups": {
                      "type": "integer"
                    },
                    "full_backups": {
                      "type": "integer"
                    }
                  }
                }
              },
              "oldest_at": {
                "type": [
                  "null",
                  "integer"
                ]
              }
            }
          }
        }
      }
    },
    "default": {
      "description": "HTTP error envelope. The status and error.code identify the failure.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Error"
          }
        }
      }
    }
  }
}