v1
latestOpenAPI 3.0.12026-07-2376273191.5 KBList entities
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.
Query parameters
Filter based on groups, which correspond to the x-cortex-groups field in the Catalog Descriptor. Accepts a comma-delimited list of groups
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.
Depth of the parent / children hierarchy nodes. Can be 'full' or a valid integer
Filter by git repositories. Supports GitHub (github:org/repo or org/repo), GitLab (gitlab:namespace/project), Bitbucket (bitbucket:workspace/repo), and Azure DevOps (azure-devops:project/repo). Unprefixed values default to GitHub for backward compatibility.
List of sub fields to include for hierarchies. Only supports 'groups'
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.
Filter based on a search query. This will search across entity properties. If provided, results will be sorted by relevance.
Whether to include archived entities in the response
Whether to include custom data for each entity in the response
Whether to include links for each entity in the response
Whether to include Slack channels for each entity in the response
Whether to include ownership information for each entity in the response
List of sub fields to include for different types
Number of results to return per page, between 1 and 1000. Default 250.
Page number to return, 0-indexed. Default 0.
Response
Successfully found entities