PUT

/api/v1/settings/trash

Change retention (0–365 days); applies retroactively to all entries

Request#

POSIX shell · curl

curl --fail-with-body --request PUT \
  "$ADBR_API_URL/api/v1/settings/trash" \
  -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: settings:write

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

Parameters#

No path or query parameters declared.

Request body#

Required.

Field	Type	Required
`retention_days`	`integer`	Yes
`confirm_shorten`	`boolean`	No
`confirm_immediate`	`boolean`	No

Complete body schema

OpenAPI JSON

{
  "required": true,
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "retention_days"
        ],
        "properties": {
          "retention_days": {
            "type": "integer",
            "minimum": 0,
            "maximum": 365
          },
          "confirm_shorten": {
            "type": "boolean"
          },
          "confirm_immediate": {
            "type": "boolean"
          }
        },
        "additionalProperties": false
      }
    }
  }
}

Responses#

200 · Default response

OpenAPI JSON

{
  "description": "Default Response",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "retention_days",
          "affected",
          "purge_not_before"
        ],
        "properties": {
          "retention_days": {
            "type": "integer"
          },
          "affected": {
            "type": "integer"
          },
          "purge_not_before": {
            "type": [
              "null",
              "integer"
            ]
          }
        }
      }
    }
  }
}

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": "Aufbewahrungsfrist ändern (0–365 Tage); wirkt rückwirkend auf alle Einträge",
  "tags": [
    "Papierkorb"
  ],
  "requestBody": {
    "required": true,
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "required": [
            "retention_days"
          ],
          "properties": {
            "retention_days": {
              "type": "integer",
              "minimum": 0,
              "maximum": 365
            },
            "confirm_shorten": {
              "type": "boolean"
            },
            "confirm_immediate": {
              "type": "boolean"
            }
          },
          "additionalProperties": false
        }
      }
    }
  },
  "x-required-scopes": [
    "settings:write"
  ],
  "responses": {
    "200": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "retention_days",
              "affected",
              "purge_not_before"
            ],
            "properties": {
              "retention_days": {
                "type": "integer"
              },
              "affected": {
                "type": "integer"
              },
              "purge_not_before": {
                "type": [
                  "null",
                  "integer"
                ]
              }
            }
          }
        }
      }
    },
    "default": {
      "description": "HTTP error envelope. The status and error.code identify the failure.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Error"
          }
        }
      }
    }
  }
}