integrationInstanceIdstringrequired
The id of the integration instance.
Example:3f51fa25-310a-421d-bd1a-007f859021a3
resourceIdstringrequired
The id of the resource.
Example:AflTNLY0tTQhv2my
Update Resource
Updates a resource.
patch
Path Parameters
Body
application/json
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
200 application/json
Response
200 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.
attributesobject | nullrequiredread-only
JSON object containing schemaless attributes 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
patch/integration-instances/{integrationInstanceId}/resources/{resourceId}
Path Parameters
Body
{}
200 application/json
Resource Mappings
Create Resource Mapping
Creates a mapping between a catalog resource and service.
post
Body
application/json
Body
application/json
CreateCatalogResourceMapping
* Additional properties are NOT allowed.
servicestringrequired
The id or name of the service to map the resource to.
Example:user-svc
resource
One Ofrequired
CatalogResourceIdstring(base64url)
The resource ID.
>= 16 characters<= 16 characters
Example:4UdXnoaDYYJsH_Ir
Response
201 application/json
Response
201 application/json
A response containing a single catalog resource mapping.
CatalogResourceMapping
Describes a mapping between a catalog resource and a service.
idstring(uuid)required
The resource mapping ID.
Example:d277faad-ed4e-4c56-a0fb-acce065dee34
resourceobjectrequired
Short-hand descriptor of a catalog resource.
Show Child Parameters
serviceobjectrequired
Short-hand descriptor of a catalog service.
Show Child Parameters
post/resource-mappings
Body
{
"service": "user-svc",
"resource": "4UdXnoaDYYJsH_Ir"
}
201 application/json
List Resource Mappings
Returns a paginated collection of catalog resource mappings.
get
Query Parameters
filterobject
Filters a collection of resource mappings.
sort
Sorts a collection of resource mappings. Supported sort attributes are:
created_at
Default sort is created_at in descending order.
Response
200 application/json
Response
200 application/json
A paginated list response for a collection of catalog resource mappings.
* Additional properties are NOT allowed.
metarequired
dataarray[object]required
Describes a mapping between a catalog resource and a service.
Show Child Parameters
get/resource-mappings
Query Parameters
200 application/json
Fetch Resource Mapping
Fetches a resource mapping by ID.
get
Path Parameters
idstring(uuid)required
The id of the resource mapping.
Example:d277faad-ed4e-4c56-a0fb-acce065dee34
Response
200 application/json
Response
200 application/json
A response containing a single catalog resource mapping.
CatalogResourceMapping
Describes a mapping between a catalog resource and a service.
idstring(uuid)required
The resource mapping ID.
Example:d277faad-ed4e-4c56-a0fb-acce065dee34
resourceobjectrequired
Short-hand descriptor of a catalog resource.
Show Child Parameters
serviceobjectrequired
Short-hand descriptor of a catalog service.
Show Child Parameters
get/resource-mappings/{id}
Path Parameters
200 application/json