COcortex
Catalog Entities

List entities

Changed on

List all entities across the Service, Resource and Domain Catalogs.

This API returns summary data for each entity, so refer to the retrieve entity method to lookup more details for a single entity.

get/api/v1/catalog

Request

  • Base URL
    https://api.getcortexapp.com
  • URL
    https://api.getcortexapp.com/api/v1/catalog
  • Auth
    HTTP bearer

Query parameters

groupsstring[]

Filter based on groups, which correspond to the x-cortex-groups field in the Catalog Descriptor. Accepts a comma-delimited list of groups

ownersstring[]

Filter based on owner group names. Returns entities owned by the specified groups, as well as entities owned by any child/sub-teams of those groups. Group names correspond to the x-cortex-owners field in the Catalog Descriptor. Accepts a comma-delimited list of owner group names.

hierarchyDepthstring

Depth of the parent / children hierarchy nodes to include for each entity. Defaults to 0, which returns no hierarchy data. Pass 'full' to return the entire hierarchy, or a positive integer to limit the depth.

gitRepositoriesstring[]

Filter by git repositories. Supports GitHub (github:org/repo or org/repo), GitLab (gitlab:namespace/project or gitlab:<project ID>), Bitbucket (bitbucket:workspace/repo), and Azure DevOps (azure-devops:project/repo). Unprefixed values default to GitHub for backward compatibility.

includeHierarchyFieldsstring[]

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

typesstring[]

Filter the response to specific types of entities. By default, this includes services, resources, and domains. Corresponds to the x-cortex-type field in the entity descriptor.

querystring

Filter based on a search query. This will search across entity properties. If provided, results will be sorted by relevance.

includeArchivedboolean

Whether to include archived entities in the response

includeMetadataboolean

Whether to include custom data for each entity in the response

includeLinksboolean

Whether to include links for each entity in the response

includeSlackChannelsboolean

Whether to include Slack channels for each entity in the response

includeOwnersboolean

Whether to include ownership information for each entity in the response

includeNestedFieldsstring[]

List of sub fields to include for different types

pageSizeinteger required

Number of results to return per page, between 1 and 1000. Default 250.

pageinteger required

Page number to return, 0-indexed. Default 0.

Response

Successfully found entities

pageinteger required

Current page number, 0-indexed

totalinteger required

Total number of results

totalPagesinteger required

Total number of pages

Example response

{
  "entities": [
    {
      "git": {
        "provider": "github"
      },
      "id": "en2da8159dbeefb974",
      "members": [
        {
          "description": "Product manager",
          "email": "aditya.bansal@cortex.io",
          "name": "Aditya Bansal",
          "roles": [
            {
              "name": "Team Leader",
              "source": "WORKDAY"
            }
          ]
        }
      ],
      "name": "My Favorite Entity",
      "owners": {
        "individuals": [
          {
            "description": "Product manager"
          }
        ],
        "teams": [
          {
            "description": "This is my team",
            "id": "en2da8159dbeefb974",
            "name": "My Favorite Team",
            "tag": "my-favorite-team-entity"
          }
        ]
      },
      "slackChannels": [
        {
          "description": "This is the engineering channel",
          "name": "engineering"
        }
      ],
      "tag": "my-favorite-entity",
      "type": "service"
    }
  ]
}

Changes

  • a7b058663c95Revision changes
    • breaking

      for the query request parameter hierarchyDepth, default value was changed from full to 0

    • info

      added the optional property to the response with the status