Skip to content

Get data retention cleanup status.

GET
/api/admin/data-retention/cleanup/{runId}
Code sample: Shell / cURL
curl --request GET \
--url https://auth.example.com/api/admin/data-retention/cleanup/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
--header 'Authorization: Bearer <token>'

Validates a cleanup run UUID and returns the current synchronous-cleanup status. In the current implementation cleanup runs complete immediately and are not persisted as asynchronous jobs.

runId
required
string format: uuid

Cleanup run UUID.

Data retention cleanup status response.

Media type application/json
object
id
required
string
status
required
string
message
required
string
key
additional properties
Example generated
{
"id": "example",
"status": "example",
"message": "example"
}

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
"error": "example",
"message": "example",
"error_description": "example"
}

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
"error": "example",
"message": "example",
"error_description": "example"
}

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
"error": "example",
"message": "example",
"error_description": "example"
}

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
"error": "example",
"message": "example",
"error_description": "example"
}