Catalog Resources
Resources are entities discovered from integration instances and are intended to be mapped to the relevant services in the catalog.
Once a resource has been mapped to a service, a rich view of this resource will be displayed when viewing your service.
Any resources which you would like to ignore and hide can be archived.
Note that archiving a resource will remove any mappings it has to services in the catalog.
You can create Resources using only the properties required to identify the resource in the third-party system.
Additional data will be hydrated if the integration that the Resource is linked to has been provided with authentication credentials.
Resources which have not yet been hydrated may still be mapped to a Catalog Service.
List Resources
Returns a paginated collection of resources.
Query Parameters
Determines which page of the collection to retrieve.
Show Child Parameters
Filters a collection of resources.
Show Child Parameters
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
Response
application/json
Response
A paginated list response for a collection of resources.
Pagination metadata.
Show Child Parameters
Information about a catalog resource.
Show Child Parameters
Authentication
Query Parameters
Get a Resource
Fetches a resource by ID.
Path Parameters
The id of the resource.
Example:AflTNLY0tTQhv2my
Response
application/json
Response
A response containing a single resource object.
CatalogResource
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.
Show Child Parameters
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
Authentication
Path Parameters
Update Resource
Updates a resource.
Path Parameters
The id of the integration instance.
Example:3f51fa25-310a-421d-bd1a-007f859021a3
The id of the resource.
Example:AflTNLY0tTQhv2my
Body
application/json
Body
UpdateCatalogResource
Whether or not to archive the resource.
When a resource is archived, all catalog service mappings will be removed.
Example:false
Response
application/json
Response
A response containing a single resource object.
CatalogResource
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.
Show Child Parameters
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
Authentication
Path Parameters
Body
Catalog Resource Mappings
Resource mappings represent the link between a resource and a service.
Once a resource is mapped to a service, a rich view of the resource will be presented on the service page.
A resource may be mapped to multiple services, but it cannot be mapped to the same service twice.
If a resource mapped to a service is later archived, the resource mapping will be deleted.