integrationInstanceIdstringrequired
The id of the integration instance.
Example:3f51fa25-310a-421d-bd1a-007f859021a3
Initialize Resource
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.
post
Path Parameters
Body
application/json
Body
application/json
InitializeCatalogResource
* Additional properties are NOT allowed.
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.
Response
application/json
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
post/integration-instances/{integrationInstanceId}/resources
Authentication
Path Parameters
Body
{
"type": "gateway_svc",
"config": {
"control_plane_id": "ccadfb0a-56cd-4f74-955d-aec1d87157c8",
"gateway_service_id": "94896d05-0c4d-45eb-aae3-de754885dd58"
}
}
application/json
Upsert Resources
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.
put
Path Parameters
integrationInstanceIdstringrequired
The id of the integration instance.
Example:3f51fa25-310a-421d-bd1a-007f859021a3
Body
application/json
Body
application/json
* Additional properties are NOT allowed.
dataarray[object]required
>= 1 items<= 100 items
* Additional properties are NOT allowed.
Show Child Parameters
Response
Response
All resources delivered in the payload were ingested successfully.
put/integration-instances/{integrationInstanceId}/resources
Authentication
Path Parameters
Body
{
"data": [
{
"name": "name",
"type": "gateway_svc",
"config": {
"control_plane_id": "ccadfb0a-56cd-4f74-955d-aec1d87157c8",
"gateway_service_id": "94896d05-0c4d-45eb-aae3-de754885dd58"
},
"integration_data": {}
}
]
}
Delete Resources
Delete up to 100 resources which belong to the related integration instance.
This API is intended only for service catalog integration applications.
post
Path Parameters
idstringrequired
The id of the integration instance.
Example:3f51fa25-310a-421d-bd1a-007f859021a3
Body
application/json
Body
application/json
DeleteCatalogResources
* Additional properties are NOT allowed.
dataarray[object]required
>= 1 items<= 100 items
* Additional properties are NOT allowed.
Show Child Parameters
Response
Response
Resources deleted successfully.
post/integration-instances/{id}/resources/bulk-delete
Authentication
Path Parameters
Body
{
"data": [
{
"id": "id"
}
]
}
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
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
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}
Authentication
Path Parameters
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.