Get Retention Defaults — GET /api/v1/settings/retention-defaults
Get Retention Defaults
The instance retention defaults: the stored values (NULL = the code default), the code defaults, the effective values, how many projects inherit each field, and who switched the default on. Reads only.
Endpoint: GET /api/v1/settings/retention-defaults
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”No request body.
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:
get_retention_defaults_api_v1_settings_retention_defaults_get - Source code:
backend/app/routers/app_settings.py, line 1658 - Specification: OpenAPI JSON