Create retention rule | Opik Documentation

Create a new retention rule. Auto-deactivates any existing active rule for the same scope.

This endpoint expects an object.

retentionenumRequired

Allowed values:

project_idstringOptionalformat: "uuid"

organization_levelbooleanOptional

Set to true to create an organization-level rule

apply_to_pastbooleanOptional

Locationstring

Created

retentionenum

Allowed values:

idstringRead-onlyformat: "uuid"

workspace_idstringRead-only

project_idstringformat: "uuid"

levelenumRead-only

Computed from projectId and organizationLevel

Allowed values:

apply_to_pastboolean

enabledbooleanRead-only

created_bystringRead-only

created_atdatetimeRead-only

last_updated_bystringRead-only

last_updated_atdatetimeRead-only

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