Retrieve entity descriptor
Retrieve entity descriptor
The descriptor does not include objects (e.g. custom data, dependencies, etc) defined via the API
Authorizations
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
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
Query Parameters
When true, returns the YAML representation of the descriptor
Response
Successfully found entity descriptor