List entity descriptors
GET/api/v1/catalog/descriptors
List entity descriptors
The descriptors do not include objects (e.g. custom data, dependencies, etc) defined via the API
Request
Query Parameters
When true, returns the YAML representation of the descriptors
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.
Number of entities to return per page
Page number to return, 0 indexed
Responses
- 200
- 429
Successfully retrieved entity descriptors
- application/json
- Schema
- Example (from schema)
Schema
- YamlDescriptorsListResponse
- JsonDescriptorsListResponse
oneOf
Current page number, 0-indexed
Total number of results
Total number of pages
Current page number, 0-indexed
Total number of results
Total number of pages
{}
The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.
Response Headers
Retry-After
integer
The number of seconds until the rate limiting resets.
- application/problem+json
- Schema
- Example (from schema)
Schema
The number of seconds until the rate limiting resets.
Possible values: >= 100 and <= 599, [429]
{
"detail": "string",
"instance": "string",
"retryAfter": 0,
"status": 429,
"title": "string",
"type": "string"
}