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

project_idstringOptionalformat: "uuid"

organization_levelbooleanOptional

Set to true to create an organization-level rule

apply_to_pastbooleanOptional

LocationstringOptional

Created

retentionenum

idstringOptionalRead-onlyformat: "uuid"

workspace_idstringOptionalRead-only

project_idstringOptionalformat: "uuid"

levelenumOptionalRead-only

Computed from projectId and organizationLevel

apply_to_pastbooleanOptional

enabledbooleanOptionalRead-only

created_bystringOptionalRead-only

created_atdatetimeOptionalRead-only

last_updated_bystringOptionalRead-only

last_updated_atdatetimeOptionalRead-only

catch_up_cursorstringOptionalRead-onlyformat: "uuid"

Current position of historical data cleanup

catch_up_donebooleanOptionalRead-only

Whether historical catch-up is complete

$	curl -X POST http://localhost:5173/api/v1/private/retention/rules \
>	-H "Content-Type: application/json" \
>	-d '{
>	"retention": "short_14d"
>	}'