> ## Documentation Index > Fetch the complete documentation index at: https://docs.cortex.io/llms.txt > Use this file to discover all available pages before exploring further. # List entity descriptors > List entity descriptors The descriptors do not include objects (e.g. custom data, dependencies, etc) defined via the API ## OpenAPI ````yaml /openapi/cortex_swagger.json get /api/v1/catalog/descriptors openapi: 3.0.1 info: description: >- The Cortex REST API provides programmatic access to the data in the catalog, Scorecards, and more. title: Cortex API version: v1 servers: - url: https://api.getcortexapp.com description: Cortex Cloud API host security: - bearerAuth: [] tags: - name: API Keys - name: Audit Logs - name: Catalog Entities - name: Catalogs - name: Custom Data - name: Custom Data [Advanced] - name: Custom Events - name: Custom Metrics - name: Dependencies - name: Deploys - name: Discovery Audit - name: Docs - name: 'Eng Intel: 1-Registry' - name: 'Eng Intel: 2-Metrics' - name: 'Eng Intel: 3-Trace' - name: 'Eng Intel: User Labels' - name: Entity Relationship Types - name: Entity Relationships - name: Entity Types - name: GitOps Logs - name: Groups - name: IP Allowlist - name: Initiatives - name: My Workspace - name: Notification Logs - name: On-call - name: Packages - name: Plugins - name: Queries - name: SCIM - name: Scaffolder - name: Scorecards - name: Secrets - name: Team Roles - name: Teams - name: Teams Hierarchies - name: Teams [Advanced] - name: Teams [Departments] (legacy) - name: Users - name: Verifications - name: Workflows - name: '[Integrations] AWS' - name: '[Integrations] Anthropic' - name: '[Integrations] Apiiro' - name: '[Integrations] ArgoCD' - name: '[Integrations] Azure Active Directory' - name: '[Integrations] Azure Devops' - name: '[Integrations] Azure Resources' - name: '[Integrations] BambooHR' - name: '[Integrations] Bitbucket' - name: '[Integrations] Bugsnag' - name: '[Integrations] Buildkite' - name: '[Integrations] Checkmarx SAST' - name: '[Integrations] CircleCI' - name: '[Integrations] ClickUp' - name: '[Integrations] Codecov' - name: '[Integrations] Coralogix' - name: '[Integrations] Datadog' - name: '[Integrations] Dynatrace' - name: '[Integrations] Firehydrant' - name: '[Integrations] GitHub' - name: '[Integrations] GitLab' - name: '[Integrations] Harness' - name: '[Integrations] Incident.io' - name: '[Integrations] Instana' - name: '[Integrations] Jenkins' - name: '[Integrations] Jira' - name: '[Integrations] Kubernetes' - name: '[Integrations] LaunchDarkly' - name: '[Integrations] Lightstep' - name: '[Integrations] Mend SAST' - name: '[Integrations] Mend SCA' - name: '[Integrations] New Relic' - name: '[Integrations] Okta' - name: '[Integrations] Opsgenie' - name: '[Integrations] PagerDuty' - name: '[Integrations] Prometheus' - name: '[Integrations] Rollbar' - name: '[Integrations] Rootly' - name: '[Integrations] Semgrep' - name: '[Integrations] Sentry' - name: '[Integrations] ServiceNow' - name: '[Integrations] SignalFx' - name: '[Integrations] Snyk' - name: '[Integrations] SonarQube' - name: '[Integrations] SumoLogic' - name: '[Integrations] Veracode' - name: '[Integrations] VictorOps' - name: '[Integrations] Wiz' - name: '[Integrations] Workday' - name: '[Integrations] xMatters' - name: dev-login-controller - name: public-scim-schema-controller paths: /api/v1/catalog/descriptors: get: tags: - Catalog Entities summary: List entity descriptors description: >- List entity descriptors The descriptors do not include objects (e.g. custom data, dependencies, etc) defined via the API operationId: listEntityDescriptors parameters: - description: When true, returns the YAML representation of the descriptors in: query name: yaml schema: type: boolean - description: >- 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. example: service,rds,s3,domain in: query name: types required: false schema: type: array items: type: string - description: Number of entities to return per page in: query name: pageSize required: true schema: type: integer format: int32 - description: Page number to return, 0 indexed in: query name: page required: true schema: type: integer format: int32 - description: Whether to include archived entities in the response in: query name: includeArchived required: false schema: type: boolean responses: '200': content: application/json: schema: oneOf: - $ref: '#/components/schemas/YamlDescriptorsListResponse' - $ref: '#/components/schemas/JsonDescriptorsListResponse' description: Successfully retrieved entity descriptors '429': $ref: '#/components/responses/TooManyRequests' components: schemas: YamlDescriptorsListResponse: required: - descriptors - page - total - totalPages type: object properties: descriptors: type: array items: type: string page: type: integer description: Current page number, 0-indexed format: int32 total: type: integer description: Total number of results format: int32 totalPages: type: integer description: Total number of pages format: int32 JsonDescriptorsListResponse: required: - descriptors - page - total - totalPages type: object properties: descriptors: type: array items: $ref: '#/components/schemas/JsonNode' page: type: integer description: Current page number, 0-indexed format: int32 total: type: integer description: Total number of results format: int32 totalPages: type: integer description: Total number of pages format: int32 JsonNode: type: object TooManyRequestsProblemDetail: required: - type - title - status type: object properties: detail: type: string instance: type: string format: uri-reference retryAfter: minimum: 0 type: integer description: The number of seconds until the rate limiting resets. format: int32 status: maximum: 599 minimum: 100 type: integer format: int32 enum: - 429 title: type: string type: type: string format: uri-reference responses: TooManyRequests: content: application/problem+json: schema: $ref: '#/components/schemas/TooManyRequestsProblemDetail' description: >- The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay. headers: Retry-After: description: The number of seconds until the rate limiting resets. schema: minimum: 0 type: integer format: int32 securitySchemes: bearerAuth: bearerFormat: JWT description: >- All requests to the Cortex API need to provide an `Authorization: Bearer ` header, where `` is an API key created in the Settings page of your workspace. scheme: bearer type: http ```` ## Related topics - [Using the Cortex MCP](/get-started/cortex-ai-assistant/mcp/using-cortex-mcp.md) - [Catalog Entities](/api/rest/catalog-entities.md) - [Using the integration for Slack](/ingesting-data-into-cortex/integrations/slack/using-the-integration-for-slack-ai-assistant.md)