Skip to main content
PUT
Unarchive an entity

Authorizations

Authorization
string
header
required

All requests to the Cortex API need to provide an Authorization: Bearer <token> header, where <token> is an API key created in the Settings page of your workspace.

Path Parameters

tagOrId
string
required

The tag (x-cortex-tag) or unique, auto-generated identifier (CID) for the entity. If the tag contains forward slashes, URL-encode each / as %2F. The tag is matched exactly as encoded, including leading, trailing, and consecutive slashes, which are preserved and not collapsed (for example, the tag /services/payments-api is referenced as %2Fservices%2Fpayments-api). Tags containing slashes are supported via the API but not in the Cortex UI; this difference is expected. Entity identifier - can be a tag or CID

Response

Successfully unarchived entity

groups
string[]
required

Corresponds to the x-cortex-groups field in the Catalog Descriptor

Corresponds to the x-cortex-groups field in the Catalog Descriptor

hierarchy
object
required

Hierarchy details for the entity. Includes both the parent & the children chains.

id
string
required

Unique, immutable, 18-character auto-generated identifier for the entity.

Example:

"en2da8159dbeefb974"

isArchived
boolean
required
lastUpdated
string<date-time>
required

Last updated ISO timestamp

Relevant links for the entity. Corresponds to the x-cortex-links field in the entity descriptor

metadata
object[]
required

Custom data key/values associated with the entity

name
string
required

Human-readable name for the entity

Example:

"My Favorite Entity"

owners
object
required
deprecated

Deprecated. Use ownership (same semantics) or ownersV2 (newer, richer shape). Retained in the response for backwards compatibility with older integrations and may be removed in a future release.

ownership
object
required
slackChannels
object[]
required
tag
string
required

Unique identifier for the entity. Corresponds to the x-cortex-tag field in the entity descriptor.

Example:

"my-favorite-entity"

type
string
required

Type of the entity. Corresponds to the x-cortex-type field in the entity descriptor or 'service' for services.

Example:

"service"

definition
object
description
string

Description of the entity visible in the Service, Resource, or Domain Catalog. Markdown is supported.

git
object

Metadata about the entity's git repository

ownersV2
object

Entity owners information

Last modified on September 29, 2026