Skip to main content

List entity descriptors

GET 
/api/v1/catalog/descriptors

List entity descriptors

Request​

Query Parameters

    yaml boolean

    When true, returns the YAML representation of the descriptors

    types string[]

    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
    pageSize int32

    Number of entities to return per page

    page int32

    Page number to return, 0 indexed

Responses​

Successfully retrieved entity descriptors

Schema

    oneOf

    descriptors string[]required
    page int32required

    Current page number, 0-indexed

    total int32required

    Total number of results

    totalPages int32required

    Total number of pages

Loading...