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.

get

Query Parameters

pageobject

Determines which page of the collection to retrieve.

Show Child Parameters
filterobject

Filters a collection of resources.

Show Child Parameters
sortstring

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

A paginated list response for a collection of resources.

* Additional properties are NOT allowed.
metaobjectrequired

Pagination metadata.

Show Child Parameters
dataarray[object]required

Information about a catalog resource.

Show Child Parameters
get/resources
 
application/json

Get a Resource

Fetches a resource by ID.

get

Path Parameters

idstringrequired

The id of the resource.

Example:AflTNLY0tTQhv2my

Response

application/json

A response containing a single resource object.

CatalogResource

Information about a catalog resource.

idstring(base64url)required

The resource ID.

>= 16 characters<= 16 characters

Example:4UdXnoaDYYJsH_Ir

namestring | nullrequired

The name of the resource.
Will be null when the resource has not yet been hydrated by the integration.

>= 1 characters<= 255 characters

integrationobjectrequired

Short-hand descriptor of an integration installed within the catalog.

Show Child Parameters
typestringrequired

The resource type. Available resource types are compiled from the integrations installed within the catalog.

>= 1 characters<= 120 characters

Example:gateway_svc

configobjectrequired

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"}

* Additional properties are allowed.
integration_dataobject | nullrequired

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.

* Additional properties are allowed.
archivedbooleanrequired

Whether or not the resource has been archived.

Example:false

service_associationsnumberrequiredread-only

The number of catalog services this resource is mapped to.

>= 0

Example:2

created_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity creation date.

Example:2022-11-04T20:10:06.927Z

updated_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity update date.

Example:2022-11-04T20:10:06.927Z

get/resources/{id}
 
application/json

Update Resource

Updates a resource.

patch

Path Parameters

integrationInstanceIdstringrequired

The id of the integration instance.

Example:3f51fa25-310a-421d-bd1a-007f859021a3

resourceIdstringrequired

The id of the resource.

Example:AflTNLY0tTQhv2my

Body

application/json

UpdateCatalogResource

* Additional properties are NOT allowed.
archivedboolean

Whether or not to archive the resource.
When a resource is archived, all catalog service mappings will be removed.

Example:false

Response

application/json

A response containing a single resource object.

CatalogResource

Information about a catalog resource.

idstring(base64url)required

The resource ID.

>= 16 characters<= 16 characters

Example:4UdXnoaDYYJsH_Ir

namestring | nullrequired

The name of the resource.
Will be null when the resource has not yet been hydrated by the integration.

>= 1 characters<= 255 characters

integrationobjectrequired

Short-hand descriptor of an integration installed within the catalog.

Show Child Parameters
typestringrequired

The resource type. Available resource types are compiled from the integrations installed within the catalog.

>= 1 characters<= 120 characters

Example:gateway_svc

configobjectrequired

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"}

* Additional properties are allowed.
integration_dataobject | nullrequired

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.

* Additional properties are allowed.
archivedbooleanrequired

Whether or not the resource has been archived.

Example:false

service_associationsnumberrequiredread-only

The number of catalog services this resource is mapped to.

>= 0

Example:2

created_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity creation date.

Example:2022-11-04T20:10:06.927Z

updated_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity update date.

Example:2022-11-04T20:10:06.927Z

patch/integration-instances/{integrationInstanceId}/resources/{resourceId}

Body

{ "archived": true }
 
application/json

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.