Get Integration
Gets a catalog integration.
Path Parameters
The name of the integration.
Example:jira
Response
application/json
Response
A response containing a single integration object.
CatalogIntegration
The machine name of the integration that uniquely identifies it within the catalog.
Example:gateway-manager
The display name of the integration.
Example:Gateway Manager
The description of the integration.
Denotes whether the integration is built-in to the catalog.
Built-in integrations are always connected and available by default.
Example:true
The integration version.
Example:v1
The visibility of the integration.
Allowed values:publicprivate
Example:public
Any OfDefines the authorization strategy for an integration.
Defines the configuration schema for the integration.
Example:{"base_url":{"type":"string","display_name":"Base URL","description":"The customer-specific API URL","required":true}}
Defines the resource types that the integration manages within the catalog.
This schema is a key-value object where:
- Keys are globally unique, machine-readable identifiers for each resource type.
- Values are objects describing metadata about the resource type.
This declaration enables the platform to understand the structure, identity, and behavior of resources discovered by the integration.
By registering resource types, integrations communicate the kinds of entities they will ingest and maintain,
allowing the catalog to enforce consistency, validation, and visibility across all integrations.
Example:{"gateway_svc":{"display_name":"Gateway Service","schema":{"type":"simple","definition":{"control_plane_id":"string","gatway_service_id":"string"}},"resource_id_template":"{{control_plane_id}}:{{gateway_service_id}}","integration_data_schema":null},"analytics_dashboard":{"display_name":"Dashboard","schema":{"type":"simple","definition":{"dashboard_id":"string"}},"resource_id_template":"{{dashboard_id}}","integration_data_schema":null}}
Defines how the integration participates in Discovery.
Discovery enables integrations to automatically ingest and update resources in the catalog.
Show Child Parameters
Defines how an integration behaves as a source provider of Catalog Service API specs.
API specs are entities that can be attached to Catalog Services.
When an integration implements this capability, it can act as a source type for API spec contents.
In this role, the integration becomes the source of truth for the spec.
When a spec is attached to a Catalog Service using this source type, the platform relies on the external system to provide and update the spec data.
A null value indicates the given integration does not act as a source provider of API specs.
Show Child Parameters
Defines the event types across all resource types belonging to the integration that will be ingested into the catalog.
- Keys are the machine-readable, globally unique names of resource types registered by this integration.
- Values are a map of event type definitions.
Example:{"gateway_svc":{"plugin_added":{"display_name":"Plugin Added","description":"Event triggered when a new plugin is added to a gateway service.","events_feed":{"enabled":true}}}}
Defines how an integration behaves as a source provider of Catalog Service Incidents.
Incidents are entities that can be attached to Catalog Services via an integration’s Resource mapping.
When an integration implements this capability, it can act as a source type for Incident data.
In this role, the integration becomes the source of truth for the incident data.
When an incident is attached to a Catalog Service using this source type, the platform relies on the external system to provide and update the incident data.
A null value indicates the given integration does not act as a source provider of incidents.
Defines how an integration behaves as a source provider of Catalog Service On-Call schedules.
On-Call schedules are entities that can be attached to Catalog Services via an integration’s Resource mapping.
When an integration implements this capability, it can act as a source type for On-Call data.
In this role, the integration becomes the source of truth for the on-call schedule data.
When an on-call schedule is attached to a Catalog Service using this source type, the platform relies on the external system to provide and update the on-call schedule data.
A null value indicates the given integration does not act as a source provider of on-call schedules.
Defines how an integration behaves as a source provider of Catalog Service Pull Requests.
Pull Requests are entities that can be attached to Catalog Services via an integration’s Resource mapping.
When an integration implements this capability, it can act as a source type for Pull Request data.
In this role, the integration becomes the source of truth for the pull request data.
When a pull request is attached to a Catalog Service using this source type, the platform relies on the external system to provide and update the pull request data.
A null value indicates the given integration does not act as a source provider of pull requests.
Defines how an integration behaves as a source provider of Catalog Service Workflows.
Workflows are entities that can be attached to Catalog Services via an integration’s Resource mapping.
When an integration implements this capability, it can act as a source type for Workflow data.
In this role, the integration becomes the source of truth for the workflow data.
When a workflow is attached to a Catalog Service using this source type, the platform relies on the external system to provide and update the workflow data.
A null value indicates the given integration does not act as a source provider of workflows.
Authentication
Path Parameters
Update Integration
Updates a catalog integration.
Path Parameters
The name of the integration.
Example:jira
Body
application/json
Body
UpdateCatalogIntegration
Description of the integration.
<= 2048 characters
The display name of the catalog integration.
>= 1 characters<= 120 characters
Example:Updated Catalog Integration
Response
application/json
Response
A response containing a single integration object.
CatalogIntegration
The machine name of the integration that uniquely identifies it within the catalog.
Example:gateway-manager
The display name of the integration.
Example:Gateway Manager
The description of the integration.
Denotes whether the integration is built-in to the catalog.
Built-in integrations are always connected and available by default.
Example:true
The integration version.
Example:v1
The visibility of the integration.
Allowed values:publicprivate
Example:public
Any OfDefines the authorization strategy for an integration.
Defines the configuration schema for the integration.
Example:{"base_url":{"type":"string","display_name":"Base URL","description":"The customer-specific API URL","required":true}}
Defines the resource types that the integration manages within the catalog.
This schema is a key-value object where:
- Keys are globally unique, machine-readable identifiers for each resource type.
- Values are objects describing metadata about the resource type.
This declaration enables the platform to understand the structure, identity, and behavior of resources discovered by the integration.
By registering resource types, integrations communicate the kinds of entities they will ingest and maintain,
allowing the catalog to enforce consistency, validation, and visibility across all integrations.
Example:{"gateway_svc":{"display_name":"Gateway Service","schema":{"type":"simple","definition":{"control_plane_id":"string","gatway_service_id":"string"}},"resource_id_template":"{{control_plane_id}}:{{gateway_service_id}}","integration_data_schema":null},"analytics_dashboard":{"display_name":"Dashboard","schema":{"type":"simple","definition":{"dashboard_id":"string"}},"resource_id_template":"{{dashboard_id}}","integration_data_schema":null}}
Defines how the integration participates in Discovery.
Discovery enables integrations to automatically ingest and update resources in the catalog.
Show Child Parameters
Defines how an integration behaves as a source provider of Catalog Service API specs.
API specs are entities that can be attached to Catalog Services.
When an integration implements this capability, it can act as a source type for API spec contents.
In this role, the integration becomes the source of truth for the spec.
When a spec is attached to a Catalog Service using this source type, the platform relies on the external system to provide and update the spec data.
A null value indicates the given integration does not act as a source provider of API specs.
Show Child Parameters
Defines the event types across all resource types belonging to the integration that will be ingested into the catalog.
- Keys are the machine-readable, globally unique names of resource types registered by this integration.
- Values are a map of event type definitions.
Example:{"gateway_svc":{"plugin_added":{"display_name":"Plugin Added","description":"Event triggered when a new plugin is added to a gateway service.","events_feed":{"enabled":true}}}}
Defines how an integration behaves as a source provider of Catalog Service Incidents.
Incidents are entities that can be attached to Catalog Services via an integration’s Resource mapping.
When an integration implements this capability, it can act as a source type for Incident data.
In this role, the integration becomes the source of truth for the incident data.
When an incident is attached to a Catalog Service using this source type, the platform relies on the external system to provide and update the incident data.
A null value indicates the given integration does not act as a source provider of incidents.
Defines how an integration behaves as a source provider of Catalog Service On-Call schedules.
On-Call schedules are entities that can be attached to Catalog Services via an integration’s Resource mapping.
When an integration implements this capability, it can act as a source type for On-Call data.
In this role, the integration becomes the source of truth for the on-call schedule data.
When an on-call schedule is attached to a Catalog Service using this source type, the platform relies on the external system to provide and update the on-call schedule data.
A null value indicates the given integration does not act as a source provider of on-call schedules.
Defines how an integration behaves as a source provider of Catalog Service Pull Requests.
Pull Requests are entities that can be attached to Catalog Services via an integration’s Resource mapping.
When an integration implements this capability, it can act as a source type for Pull Request data.
In this role, the integration becomes the source of truth for the pull request data.
When a pull request is attached to a Catalog Service using this source type, the platform relies on the external system to provide and update the pull request data.
A null value indicates the given integration does not act as a source provider of pull requests.
Defines how an integration behaves as a source provider of Catalog Service Workflows.
Workflows are entities that can be attached to Catalog Services via an integration’s Resource mapping.
When an integration implements this capability, it can act as a source type for Workflow data.
In this role, the integration becomes the source of truth for the workflow data.
When a workflow is attached to a Catalog Service using this source type, the platform relies on the external system to provide and update the workflow data.
A null value indicates the given integration does not act as a source provider of workflows.
Authentication
Path Parameters
Body
Delete Integration
Deletes a catalog integration.
Path Parameters
The name of the integration.
Example:jira
Response
Response
Catalog Integration was deleted successfully.
Authentication
Path Parameters
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.
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.
Path Parameters
The id of the integration instance.
Example:3f51fa25-310a-421d-bd1a-007f859021a3
Body
application/json
Body
InitializeCatalogResource
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"}
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