Enable Retention Defaults — POST /api/v1/settings/retention-defaults/enable
Enable Retention Defaults
Switch the instance default ON for every project without its own enabled (D12): the preview’s hash must still match (409 preview_stale) and the confirmation must be the exact phrase (422 confirmation_mismatch). Interactive login only.
Endpoint: POST /api/v1/settings/retention-defaults/enable
Authentication: Send a signed-in user’s access token in Authorization: Bearer <access token>, or an API key in X-API-Key: <API key>.
- Your role must be Admin or higher.
Parameters
Section titled “Parameters”| Name | In | Required | Type | Default | Description |
|---|---|---|---|---|---|
X-API-Key | header | no | string or null | API key, as an alternative to the access token (see Authentication). |
Request body
Section titled “Request body”| Content type | Body | Required |
|---|---|---|
application/json | InstanceEnableRequest | yes |
Responses
Section titled “Responses”| Status | Meaning | Body |
|---|---|---|
200 | Successful Response | InstanceRetentionPolicyRead (application/json) |
422 | Validation Error | HTTPValidationError (application/json) |
It can also return 401 if your credential is missing or expired, 403 if your credential does not allow this request, and 404 if the item does not exist or you cannot see it. Your role, your project membership and the key’s scope decide what a credential allows. See Errors and retries.
More details
Section titled “More details”- Group: Settings
- Operation ID:
enable_retention_defaults_api_v1_settings_retention_defaults_enable_post - Source code:
backend/app/routers/app_settings.py, line 1712 - Specification: OpenAPI JSON