Returns a paginated collection of resources.
Determines which page of the collection to retrieve.
Filters a collection of resources.
The asc suffix is optional as the default sort order is ascending.
The desc suffix is used to specify a descending order.
Multiple sort attributes may be provided via a comma separated list.
JSONPath notation may be used to specify a sub-attribute (eg: ‘foo.bar desc’).
Example:created_at desc
A paginated list response for a collection of resources.
Pagination metadata.
Information about a catalog resource.
Fetches a resource by ID.
The id of the resource.
Example:AflTNLY0tTQhv2my
A response containing a single resource object.
Information about a catalog resource.
The resource ID.
>= 16 characters<= 16 characters
Example:4UdXnoaDYYJsH_Ir
The name of the resource.
Will be null when the resource has not yet been hydrated by the integration.
>= 1 characters<= 255 characters
Short-hand descriptor of an integration installed within the catalog.
The resource type. Available resource types are compiled from the integrations installed within the catalog.
>= 1 characters<= 120 characters
Example:gateway_svc
JSON object representing the properties used to identify the resource in the third-party system.
The schema depends on the resource type and is dynamically registered at runtime.
Example:{"control_plane_id":"ccadfb0a-56cd-4f74-955d-aec1d87157c8","gateway_service_id":"94896d05-0c4d-45eb-aae3-de754885dd58"}
JSON object containing schemaless integration data of the resource.
This field is always populated by the system backing the integration.
When null, the resource has been manually initialized via API but has
yet to be hydrated by the integration.
Whether or not the resource has been archived.
Example:false
The number of catalog services this resource is mapped to.
>= 0
Example:2
An ISO-8601 timestamp representation of entity creation date.
Example:2022-11-04T20:10:06.927Z
An ISO-8601 timestamp representation of entity update date.
Example:2022-11-04T20:10:06.927Z
Initializes a placeholder resource. This operation is typically used in GitOps workflows or other infrastructure-as-code setups where a resource is declared before it is fully discovered.
The initialized resource acts as a stub — it contains minimal identifying metadata and does not yet include the full set of attributes typically populated by integration-based discovery.
After initialization, the resource will be automatically hydrated with additional data by catalog integrations responsible for discovering and maintaining its up-to-date state.
This API is not intended for direct resource management, but rather for signaling the intent to track a given resource, allowing integrations to take over and populate it asynchronously.
The id of the integration instance.
Example:3f51fa25-310a-421d-bd1a-007f859021a3
The resource type. Available resource types are compiled from the integrations installed within the catalog.
>= 1 characters<= 120 characters
Example:gateway_svc
JSON object representing the properties used to identify the resource in the third-party system.
The schema depends on the resource type and is dynamically registered at runtime.
Example:{"control_plane_id":"ccadfb0a-56cd-4f74-955d-aec1d87157c8","gateway_service_id":"94896d05-0c4d-45eb-aae3-de754885dd58"}
A response containing a single resource object.
Information about a catalog resource.
The resource ID.
>= 16 characters<= 16 characters
Example:4UdXnoaDYYJsH_Ir
The name of the resource.
Will be null when the resource has not yet been hydrated by the integration.
>= 1 characters<= 255 characters
Short-hand descriptor of an integration installed within the catalog.
The resource type. Available resource types are compiled from the integrations installed within the catalog.
>= 1 characters<= 120 characters
Example:gateway_svc
JSON object representing the properties used to identify the resource in the third-party system.
The schema depends on the resource type and is dynamically registered at runtime.
Example:{"control_plane_id":"ccadfb0a-56cd-4f74-955d-aec1d87157c8","gateway_service_id":"94896d05-0c4d-45eb-aae3-de754885dd58"}
JSON object containing schemaless integration data of the resource.
This field is always populated by the system backing the integration.
When null, the resource has been manually initialized via API but has
yet to be hydrated by the integration.
Whether or not the resource has been archived.
Example:false
The number of catalog services this resource is mapped to.
>= 0
Example:2
An ISO-8601 timestamp representation of entity creation date.
Example:2022-11-04T20:10:06.927Z
An ISO-8601 timestamp representation of entity update date.
Example:2022-11-04T20:10:06.927Z
Upserts resources. If a resource with the same externalId already exists for the given integration instance, it will be updated; otherwise, a new resource will be created.
When a resource’s backing definition in the integration has integration_data_schema populated, the integration_data value provided for that resource will be validated against integration_data_schema during upsert operations.
When a resource’s backing definition in the integration has no integration_data_schema populated (i.e. null), no validation will be performed on the integration_data value provided for that resource.
This API is typically used by service catalog integration applications to report discovered resources back to the catalog.
The id of the integration instance.
Example:3f51fa25-310a-421d-bd1a-007f859021a3
>= 1 items<= 100 items
All resources delivered in the payload were ingested successfully.
Delete up to 100 resources which belong to the related integration instance.
This API is intended only for service catalog integration applications.
The id of the integration instance.
Example:3f51fa25-310a-421d-bd1a-007f859021a3
>= 1 items<= 100 items
Resources deleted successfully.