Retention Rules

Get retention rule by id

Get a specific retention rule by id

get/v1/private/retention/rules/{ruleId}

Request

  • Base URL
    http://localhost:5173/api
  • URL
    http://localhost:5173/api/v1/private/retention/rules/{ruleId}
  • Auth
    none declared

Path parameters

ruleIdstring uuid required

Response

Retention rule

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 operation across all 82 revisions of this API.