---
title: "Set retention window"
method: PATCH
path: "/v1/account/retention"
tags: ["account"]
---

# Set retention window

`PATCH /v1/account/retention`

## Request

- Base URL: `https://api.brixsignage.com`
- URL: `https://api.brixsignage.com/v1/account/retention`
- Auth: HTTP bearer

Sets the retention window, in days, for one or more data streams. Sending `null` for a stream resets it to the platform default. Values are clamped to the allowed range for each stream.

## Request body

- object: Days per stream; a value outside the stream's bounds is clamped; null returns the stream to the platform window.
  - `offline` number, nullable
  - `screenshots` number, nullable
  - `playback` number, nullable
  - `deviceLogs` number, nullable
  - `vitals` number, nullable
  - `replays` number, nullable
  - `aiEvents` number, nullable

## Response `200`

Success.

- object
  - `data` RetentionSchedule, required
    - `policy` object, required: Days kept per stream, only for the streams the workspace has set. An absent stream uses the platform window.
      - `offline` number
      - `screenshots` number
      - `playback` number
      - `deviceLogs` number
      - `vitals` number
      - `replays` number
      - `aiEvents` number
    - `effective` object, required: Days kept per stream now.
      - `offline` integer, required
      - `screenshots` integer, required
      - `playback` integer, required
      - `deviceLogs` integer, required
      - `vitals` integer, required
      - `replays` integer, required
      - `aiEvents` integer, required
    - `bounds` object, required
      - `offline` object, required
        - `min` integer, required
        - `max` integer, required
        - `platformDefault` integer, required
        - `label` string, required
        - `what` string, required
      - `screenshots` object, required
        - `min` integer, required
        - `max` integer, required
        - `platformDefault` integer, required
        - `label` string, required
        - `what` string, required
      - `playback` object, required
        - `min` integer, required
        - `max` integer, required
        - `platformDefault` integer, required
        - `label` string, required
        - `what` string, required
      - `deviceLogs` object, required
        - `min` integer, required
        - `max` integer, required
        - `platformDefault` integer, required
        - `label` string, required
        - `what` string, required
      - `vitals` object, required
        - `min` integer, required
        - `max` integer, required
        - `platformDefault` integer, required
        - `label` string, required
        - `what` string, required
      - `replays` object, required
        - `min` integer, required
        - `max` integer, required
        - `platformDefault` integer, required
        - `label` string, required
        - `what` string, required
      - `aiEvents` object, required
        - `min` integer, required
        - `max` integer, required
        - `platformDefault` integer, required
        - `label` string, required
        - `what` string, required

## Other responses

- `401`: Missing, expired or revoked bearer token.
- `403`: You do not hold the permission for the whole workspace (a grant at one location is not enough).
- `5XX`: Server error. The body carries a `requestId` to quote to support.

---

[API](https://skmtc.dev/brixsignage/apis/brix-api.md) · [All operations](https://skmtc.dev/brixsignage/apis/brix-api/llms.txt) · [OpenAPI document](https://skmtc.dev/brixsignage/apis/brix-api/revisions/02fd3665dc7d?raw)