Find retention rules

GET

/v1/private/retention/rules

GET

/api/v1/private/retention/rules

1 import requests
2 
3 url = "http://localhost:5173/api/v1/private/retention/rules"
4 
5 payload = {}
6 headers = {"Content-Type": "application/json"}
7 
8 response = requests.get(url, json=payload, headers=headers)
9 
10 print(response.json())

200Retrieved

1 {
2   "content": [
3     {
4       "retention": "short_14d",
5       "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
6       "workspace_id": "workspace_12345",
7       "project_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
8       "level": "organization",
9       "apply_to_past": true,
10       "enabled": true,
11       "created_by": "alice@example.com",
12       "created_at": "2024-01-15T09:30:00Z",
13       "last_updated_by": "bob@example.com",
14       "last_updated_at": "2024-01-15T09:30:00Z"
15     }
16   ],
17   "page": 1,
18   "size": 1,
19   "total": 1
20 }

List retention rules for the caller's workspace. Defaults to active only.

Query parameters

pageintegerOptional>=1Defaults to 1

sizeintegerOptional>=1Defaults to 10

include_inactivebooleanOptionalDefaults to false

Response

Retention rules page

contentlist of objects

pageinteger

sizeinteger

totallong