COcortex
Entity Archival

Update entity archival configuration

Changed on

Change the workspace's archival settings. Only the fields in the request change. Setting retentionDays requires automatic deletion to be enabled for the workspace. Requires the Edit Settings permission.

patch/api/v1/entity-archival-config

Request

  • Base URL
    https://api.getcortexapp.com
  • URL
    https://api.getcortexapp.com/api/v1/entity-archival-config
  • Auth
    HTTP bearer

Request body

entityTypesobject required

Settings to change per entity type, keyed by type. Types you leave out keep their settings.

monorepoAutoArchivalboolean

Leave out to keep the current value.

Response

The workspace's archival settings after the change

entityTypesobject required

Settings per entity type, keyed by type. Lists the built-in types and every type with a setting of its own.

monorepoAutoArchivalboolean required

Auto-archive and auto-unarchive entities that have a basepath (monorepo entities).

Changes