Sign in
Retention Rules

Create retention rule

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

post/v1/private/retention/rules

Request body

project_idstring uuid
organization_levelboolean

Set to true to create an organization-level rule

retention'short_14d' | 'base_60d' | 'extended_400d' | 'unlimited' required
apply_to_pastboolean

Response

Created

idstring uuid
workspace_idstring
project_idstring uuid
level'organization' | 'workspace' | 'project'

Computed from projectId and organizationLevel

retention'short_14d' | 'base_60d' | 'extended_400d' | 'unlimited' required
apply_to_pastboolean
enabledboolean
created_bystring
created_atstring date-time
last_updated_bystring
last_updated_atstring date-time
catch_up_cursorstring uuid

Current position of historical data cleanup

catch_up_doneboolean

Whether historical catch-up is complete

Changes

No recorded changes to this endpoint across all 57 revisions of this API.