Skip to content
Tilecast Docs

updateActivityRetention

PATCH
/api/v1/activity/retention
curl --request PATCH \
  --url https://example.com/api/v1/activity/retention \
  --header 'Content-Type: application/json' \
  --cookie tilecast_session=<tilecast_session> \
  --data '{ "rawEventDays": 1, "playbackSessionDays": 1, "screenStateDays": 1, "auditLogDays": 1, "diagnosticMetadataDays": 1, "telemetryRollupDays": 1 }'

Update the activity retention policy within deployment hard limits. Requires an Owner or Administrator with the write scope. Cookie-authenticated unsafe requests require X-CSRF-Token.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “ Parameters ”

Header Parameters

Section titled “Header Parameters”
X-CSRF-Token
string

Cookie-backed browser requests only, and only on unsafe methods. Bearer grants never send it.

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
rawEventDays
integer
>= 7 <= 365
playbackSessionDays
integer
>= 30 <= 2555
screenStateDays
integer
>= 30 <= 2555
auditLogDays
integer
>= 90 <= 3650
diagnosticMetadataDays
integer
>= 7 <= 180
telemetryRollupDays
integer
>= 7 <= 400
Examplegenerated
{
  "rawEventDays": 1,
  "playbackSessionDays": 1,
  "screenStateDays": 1,
  "auditLogDays": 1,
  "diagnosticMetadataDays": 1,
  "telemetryRollupDays": 1
}

Responses

Section titled “ Responses ”

200

Section titled “200”

Activity retention policy updated

Media typeapplication/json
object
data
required
object
rawEventDays
required
integer
>= 7 <= 365
playbackSessionDays
required
integer
>= 30 <= 2555
screenStateDays
required
integer
>= 30 <= 2555
auditLogDays
required
integer
>= 90 <= 3650
diagnosticMetadataDays
required
integer
>= 7 <= 180
telemetryRollupDays
required
integer
>= 7 <= 400
updatedAt
required
string format: date-time
Examplegenerated
{
  "data": {
    "rawEventDays": 1,
    "playbackSessionDays": 1,
    "screenStateDays": 1,
    "auditLogDays": 1,
    "diagnosticMetadataDays": 1,
    "telemetryRollupDays": 1,
    "updatedAt": "2026-04-15T12:00:00Z"
  }
}

400

Section titled “400”

Retention values invalid

401

Section titled “401”

Dashboard authentication required

403

Section titled “403”

Insufficient role

422

Section titled “422”

Retention values exceed hard limits