Archiving entities
Last updated
Last updated
Archiving an entity allows you to remove it from active use while preserving its history and context.
You can configure Cortex to automatically archive entities when they are no longer detected in your integrations or when their corresponding YAML files are deleted. We recommend enabling this feature to keep your data up-to-date without manual effort. Learn more in .
It's also possible to manually archive entities in the Cortex UI or via the Cortex API, as described below.
To archive entities, your user or API key must have the Archive entities permission. To unarchive entities, your user or API key must have the Configure entities permission.
Navigate to an in Cortex.
Click the 3 dots menu at the top of the page, then click Archive entity.
In the confirmation window, click Archive.
To un-archive an entity:
Navigate to the archived in Cortex.
Click the 3 dots menu at the top of the page, then click Unarchive entity.
In the confirmation window, click Restore.
Archived entities are not included in the following Cortex features:
By default, archived entities do not appear in the lists on "All entities" or in catalogs, but you can choose to include archived entities in your view.
To include archived entities:
Toggle on the setting for Show archived.
Note that this setting is not persistent when you navigate away from the page.
If the entity itself has been archived, you will see an "Archived" flag appear next to its name:
While configuring an entity, you cannot add an archived team as an owner. You cannot add archived entities as dependencies or as parent or child entities.
and
, including
features, including CQL reports and query builder
Click Display at the top of the list.
On an , if a related dependency, child entity, or parent entity has been archived, it will not be displayed under Relationships in the entity's sidebar.
Cortex will tag detected changes to signify whether an entity or repository has been archived. Learn more in .
