Archiving entities

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 Auto archiving entities.

It's also possible to manually archive entities in the Cortex UI or via the Cortex API, as described below.

How to archive and unarchive entities

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.

Cortex UI

1. Navigate to an entity's details page in Cortex.

2. Click the 3 dots menu at the top of the page, then click Archive entity.

3. In the confirmation window, click Archive.

To un-archive an entity:

1. Navigate to the archived entity's details page in Cortex.

2. Click the 3 dots menu at the top of the page, then click Unarchive entity.

3. In the confirmation window, click Restore.

API

See the API documentation on archiving an entity and unarchiving an entity.

How archived entities are handled in Cortex

Archived entities are not included in the following Cortex features:

• Scorecards and Initiatives

• Reports

• Eng Intelligence

• Cortex Query Language (CQL) features, including CQL reports and query builder

• Relationship graphs

• Workflows

The "All entities" and Catalogs pages

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:

1. Click Display at the top of the list.

2. Toggle on the setting for Show archived.

Note that this setting is not persistent when you navigate away from the page.

An entity details page

On an entity's details page, if a related dependency, child entity, or parent entity has been archived, it will not be displayed under Relationships in the entity's sidebar.

If the entity itself has been archived, you will see an "Archived" flag appear next to its name:

Entity configuration

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.

The discovered entities list

Cortex will tag detected changes to signify whether an entity or repository has been archived. Learn more in Viewing discovered entities.