Dokumentation / Wartung / Endpunkt
POST

/api/v1/maintenance/orphans/delete

Unbekannte Profilordner endgültig löschen (confirm_count muss der Anzahl entsprechen)

Anfrage#

POSIX-Shell · curl
curl --fail-with-body --request POST \
  "$ADBR_API_URL/api/v1/maintenance/orphans/delete" \
  -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: trash:manage

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.

FeldTypPflichtBeschreibung
folder_keysarrayJa
confirm_countintegerJa
Vollständiges Körperschema
OpenAPI JSON
{
  "required": true,
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "folder_keys",
          "confirm_count"
        ],
        "properties": {
          "folder_keys": {
            "type": "array",
            "items": {
              "type": "string",
              "pattern": "^[0-9A-Z]{12}$"
            },
            "minItems": 1,
            "maxItems": 500
          },
          "confirm_count": {
            "type": "integer",
            "minimum": 1
          }
        },
        "additionalProperties": false
      }
    }
  }
}

Antworten#

200 · Standardantwort
OpenAPI JSON
{
  "description": "Default Response",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "results"
        ],
        "properties": {
          "results": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "folder_key",
                "ok",
                "id",
                "no",
                "warnings",
                "error"
              ],
              "properties": {
                "folder_key": {
                  "type": "string"
                },
                "ok": {
                  "type": "boolean"
                },
                "id": {
                  "type": [
                    "null",
                    "string"
                  ]
                },
                "no": {
                  "type": [
                    "null",
                    "integer"
                  ]
                },
                "warnings": {
                  "type": "array",
                  "items": {
                    "type": "string"
                  }
                },
                "error": {
                  "type": [
                    "null",
                    "string"
                  ]
                }
              }
            }
          }
        }
      }
    }
  }
}
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": "Unbekannte Profilordner endgültig löschen (confirm_count muss der Anzahl entsprechen)",
  "tags": [
    "Wartung"
  ],
  "requestBody": {
    "required": true,
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "required": [
            "folder_keys",
            "confirm_count"
          ],
          "properties": {
            "folder_keys": {
              "type": "array",
              "items": {
                "type": "string",
                "pattern": "^[0-9A-Z]{12}$"
              },
              "minItems": 1,
              "maxItems": 500
            },
            "confirm_count": {
              "type": "integer",
              "minimum": 1
            }
          },
          "additionalProperties": false
        }
      }
    }
  },
  "x-required-scopes": [
    "trash:manage"
  ],
  "responses": {
    "200": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "results"
            ],
            "properties": {
              "results": {
                "type": "array",
                "items": {
                  "type": "object",
                  "required": [
                    "folder_key",
                    "ok",
                    "id",
                    "no",
                    "warnings",
                    "error"
                  ],
                  "properties": {
                    "folder_key": {
                      "type": "string"
                    },
                    "ok": {
                      "type": "boolean"
                    },
                    "id": {
                      "type": [
                        "null",
                        "string"
                      ]
                    },
                    "no": {
                      "type": [
                        "null",
                        "integer"
                      ]
                    },
                    "warnings": {
                      "type": "array",
                      "items": {
                        "type": "string"
                      }
                    },
                    "error": {
                      "type": [
                        "null",
                        "string"
                      ]
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "default": {
      "description": "HTTP error envelope. The status and error.code identify the failure.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Error"
          }
        }
      }
    }
  }
}

Suche nach Headless, MCP, Cookies oder einem API-Endpunkt.

↑ ↓ NavigierenEnter ÖffnenEsc Schließen