Skip to main content

Retrieve entity details

GET 
/api/v1/catalog/:tagOrId

Retrieve entity details

Request​

Path Parameters

    tagOrId stringrequired

    The tag (x-cortex-tag) or unique, auto-generated identifier for the entity.

Query Parameters

    hierarchyDepth string

    Default value: full

    Depth of the parent / children hierarchy nodes. Can be 'full' or a valid integer

    includeHierarchyFields string[]

    List of sub fields to include for hierarchies. Only supports 'groups'

    Example: groups

Responses​

Successfully found entity

Schema

    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

    alias string

    Custom defined alias (this is only relevant if you have opted into multi account support)

    basepath string

    If the entity is in a monorepo (e.g. in a subdirectory), this field defines the subdirectory

    provider stringrequired

    Name of the Git provider

    repository stringrequired

    Repository name as defined in your Git provider

    repositoryUrl stringrequired

    URL of the Git repository

    groups string[]required

    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.

    children

    object[]

    required

    Nested children chain for the specific entity.

  • Array [

    • children

    object

    required

    Child at the current depth, and its children.

    definition object
    description string
    groups string[]

    List of groups for this node. Only included if includeHierarchyFields contains groups

    id stringrequired
    name stringrequired
    tag stringrequired
    type stringrequired
    definition object
    description string
    groups string[]

    List of groups for this node. Only included if includeHierarchyFields contains groups

    id stringrequired
    name stringrequired
    tag stringrequired
    type stringrequired

  • ]

    • parents

    object[]

    required

    Nested parent chain for the specific entity.

  • Array [

    • definition object
    description string
    groups string[]

    List of groups for this node. Only included if includeHierarchyFields contains groups

    id stringrequired
    name stringrequired

    parents

    object

    required

    Parent at the current depth, and its parents.

    definition object
    description string
    groups string[]

    List of groups for this node. Only included if includeHierarchyFields contains groups

    id stringrequired
    name stringrequired
    tag stringrequired
    type stringrequired
    tag stringrequired
    type stringrequired

  • ]

    • id stringrequired

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

    isArchived booleanrequired
    lastUpdated date-timerequired

    Last updated ISO timestamp

    links

    object[]

    required

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

  • Array [

    • description string

    An optional description of the link

    name stringrequired

    Human-readable name for the link visible in the Catalog

    type stringrequired

    Corresponds to the type field in a link definition provided in the Catalog Descriptor

    url stringrequired

  • ]

    • metadata

    object[]

    required

    Custom data key/values associated with the entity

  • Array [

    • key stringrequired

    The custom data key, referred to in CQL as custom("key")

    value objectrequired

  • ]

    • name stringrequired

    Human-readable name for the entity

    ownersV2

    object

    Entity owners information

    individuals

    object[]

    required

  • Array [

    • description string

    Description of the email owner

    email stringrequired

  • ]

    • teams

    object[]

    required

  • Array [

    • description string

    Description of the team entity

    id stringrequired

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

    inheritance string

    Possible values: [APPEND, FALLBACK, NONE]

    Inheritance type, only defined for domain entities

    isArchived booleanrequired
    name stringrequired

    Human-readable name for the team entity

    provider string

    Possible values: [ACTIVE_DIRECTORY, BAMBOO_HR, CORTEX, GITHUB, GITLAB, GOOGLE, OKTA, OPSGENIE, WORKDAY, SERVICE_NOW]

    If defined, indicates the ownership provider the team slug references

    tag stringrequired

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

  • ]

    • ownership

    object

    required

    emails

    object[]

    required

  • Array [

    • description string

    Description of this owner defined in the Catalog Descriptor, not to be confused with the description of the team in the Team pages

    email stringrequired
    inheritance string

    Possible values: [APPEND, FALLBACK, NONE]

    Inheritance type, only defined for domain entities

  • ]

    • groups

    object[]

    required

    List of IdP or Cortex Teams (not to be confused with the x-cortex-groups).

  • Array [

    • description string

    Description of this owner defined in the Catalog Descriptor. Not to be confused with the description of the team in the Team pages.

    groupName stringrequired

    The slug for the group as defined in the ownership provider. For example, the org/team for GitHub teams or the team tag for Cortex Teams

    inheritance string

    Possible values: [APPEND, FALLBACK, NONE]

    Inheritance type, only defined for domain entities

    provider string

    Possible values: [ACTIVE_DIRECTORY, BAMBOO_HR, CORTEX, GITHUB, GITLAB, GOOGLE, OKTA, OPSGENIE, WORKDAY, SERVICE_NOW]

    If defined, indicates the ownership provider the team slug references

  • ]

    • slackChannels

    object[]

    required

    deprecated

    Use the top-level slackChannels field instead of the one nested inside ownership

  • Array [

    • channel stringrequired

    The Slack channel identifier without the preceding #

    description string

    Description of this owner defined in the Catalog Descriptor. Not to be confused with the description of the team in the Team pages.

    inheritance string

    Possible values: [APPEND, FALLBACK, NONE]

    Inheritance type, only defined for domain entities

    notificationsEnabled boolean

    Refers to the corresponding field in the Catalog Descriptor. This is meant to be used for your automation purposes and does not actually impact the notification behavior in Cortex.

  • ]

    • slackChannels

    object[]

    required

  • Array [

    • description string

    Description of the Slack channel

    name stringrequired

    Name of the Slack channel

    notificationsEnabled booleanrequired

    Whether notifications are enabled for this channel

  • ]

    • tag stringrequired

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

    type stringrequired

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

Loading...