PATCH

/api/v1/trash/{id}

Suspend or resume permanent deletion

Request#

POSIX shell · curl

curl --fail-with-body --request PATCH \
  "$ADBR_API_URL/api/v1/trash/{id}" \
  -H "Authorization: Bearer $ADBR_API_TOKEN" \
  -H "Content-Type: application/json" \
  --data @request.json

Use the local address and token from API & MCP. Replace path placeholders such as {id} with actual IDs. Create request.json according to the body schema below before running this command.

Authentication and permissions#

Authentication: Bearer token

Scopes: trash:manage

All listed scopes are required; admin satisfies scope checks. Account permissions, request content, vault state and resource permissions can impose additional requirements.

Parameters#

Parameter	Location	Required	Description
`id`	path	Yes

Complete parameter schemas

OpenAPI JSON

[
  {
    "schema": {
      "type": "string",
      "minLength": 1,
      "maxLength": 64
    },
    "in": "path",
    "name": "id",
    "required": true
  }
]

Request body#

Required.

Field	Type	Required	Description
`purge_hold`	`boolean`	Yes

Complete body schema

OpenAPI JSON

{
  "required": true,
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "purge_hold"
        ],
        "properties": {
          "purge_hold": {
            "type": "boolean"
          }
        },
        "additionalProperties": false
      }
    }
  }
}

Responses#

200 · Default response

OpenAPI JSON

{
  "description": "Default Response",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "id",
          "no",
          "name",
          "folder_key",
          "engine",
          "origin_group",
          "tags",
          "deleted_at",
          "deleted_by",
          "delete_source",
          "purge_after",
          "purge_hold",
          "size_bytes",
          "state",
          "remaining_ms",
          "proxy_in_trash",
          "purge_error"
        ],
        "properties": {
          "id": {
            "type": "string"
          },
          "no": {
            "type": "integer"
          },
          "name": {
            "type": "string"
          },
          "folder_key": {
            "type": "string"
          },
          "engine": {
            "type": "string"
          },
          "origin_group": {
            "type": "object",
            "required": [
              "id",
              "name"
            ],
            "properties": {
              "id": {
                "type": [
                  "null",
                  "string"
                ]
              },
              "name": {
                "type": [
                  "null",
                  "string"
                ]
              }
            }
          },
          "tags": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "deleted_at": {
            "type": "integer"
          },
          "deleted_by": {
            "type": [
              "null",
              "string"
            ]
          },
          "delete_source": {
            "type": [
              "null",
              "string"
            ]
          },
          "purge_after": {
            "type": [
              "null",
              "integer"
            ]
          },
          "purge_hold": {
            "type": "boolean"
          },
          "size_bytes": {
            "type": [
              "null",
              "integer"
            ]
          },
          "state": {
            "type": "string"
          },
          "remaining_ms": {
            "type": [
              "null",
              "integer"
            ]
          },
          "proxy_in_trash": {
            "type": "boolean"
          },
          "purge_error": {
            "type": [
              "null",
              "string"
            ]
          }
        }
      }
    }
  }
}

default · HTTP error envelope. The status and error.code identify the failure.

OpenAPI JSON

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

General authentication and transport errors may occur in addition to the documented responses.

OpenAPI definition#

Complete operation definition

OpenAPI JSON

{
  "summary": "Endlöschung aussetzen oder fortsetzen",
  "tags": [
    "Papierkorb"
  ],
  "requestBody": {
    "required": true,
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "required": [
            "purge_hold"
          ],
          "properties": {
            "purge_hold": {
              "type": "boolean"
            }
          },
          "additionalProperties": false
        }
      }
    }
  },
  "parameters": [
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 64
      },
      "in": "path",
      "name": "id",
      "required": true
    }
  ],
  "x-required-scopes": [
    "trash:manage"
  ],
  "responses": {
    "200": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "id",
              "no",
              "name",
              "folder_key",
              "engine",
              "origin_group",
              "tags",
              "deleted_at",
              "deleted_by",
              "delete_source",
              "purge_after",
              "purge_hold",
              "size_bytes",
              "state",
              "remaining_ms",
              "proxy_in_trash",
              "purge_error"
            ],
            "properties": {
              "id": {
                "type": "string"
              },
              "no": {
                "type": "integer"
              },
              "name": {
                "type": "string"
              },
              "folder_key": {
                "type": "string"
              },
              "engine": {
                "type": "string"
              },
              "origin_group": {
                "type": "object",
                "required": [
                  "id",
                  "name"
                ],
                "properties": {
                  "id": {
                    "type": [
                      "null",
                      "string"
                    ]
                  },
                  "name": {
                    "type": [
                      "null",
                      "string"
                    ]
                  }
                }
              },
              "tags": {
                "type": "array",
                "items": {
                  "type": "string"
                }
              },
              "deleted_at": {
                "type": "integer"
              },
              "deleted_by": {
                "type": [
                  "null",
                  "string"
                ]
              },
              "delete_source": {
                "type": [
                  "null",
                  "string"
                ]
              },
              "purge_after": {
                "type": [
                  "null",
                  "integer"
                ]
              },
              "purge_hold": {
                "type": "boolean"
              },
              "size_bytes": {
                "type": [
                  "null",
                  "integer"
                ]
              },
              "state": {
                "type": "string"
              },
              "remaining_ms": {
                "type": [
                  "null",
                  "integer"
                ]
              },
              "proxy_in_trash": {
                "type": "boolean"
              },
              "purge_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"
          }
        }
      }
    }
  }
}