idstringrequired
The id of the service.
Example:7f9fd312-a987-4628-b4c5-bb4f4fddd5f7
Fetch Service
Fetches a service.
get
Path Parameters
Response
200 application/json
Response
200 application/json
A response containing a single service object.
CatalogService
The service object contains information about a Service Catalog service.
idstring(uuid)requiredread-only
The service ID.
Example:7f9fd312-a987-4628-b4c5-bb4f4fddd5f7
namestringrequired
The machine name of the Service that uniquely identifies it within the catalog.
Match pattern:^[0-9a-z.-]+$
>= 1 characters<= 120 characters
Example:user-svc
display_namestringrequired
The display name of the Service.
>= 1 characters<= 120 characters
Example:User Service
descriptionstring | nullrequired
Optionally provide a description of the Service.
<= 2048 characters
custom_fieldsobjectrequired
Map of customizable, catalog-defined fields providing information about a service.
Example:{"owner":"John Appleseed","dashboard":{"name":"On-Call Dashboard","link":"https://my-dashboard-svc.io/dashboards/1"}}
labelsrequired
get/services/{id}
Path Parameters
200 application/json
Update Service
Updates a service.
patch
Path Parameters
idstringrequired
The id of the service.
Example:7f9fd312-a987-4628-b4c5-bb4f4fddd5f7
Body
application/json
Body
application/json
UpdateCatalogService
* Additional properties are NOT allowed.
namestring
The machine name of the Service that uniquely identifies it within the catalog.
Match pattern:^[0-9a-z.-]+$
>= 1 characters<= 120 characters
Example:user-svc
display_namestring
The display name of the Service.
>= 1 characters<= 120 characters
Example:User Service
descriptionstring | null
Optionally provide a description of the Service.
<= 2048 characters
labels
custom_fieldsobject
Map of customizable, catalog-defined fields providing information about a service.
Example:{"owner":"John Appleseed","dashboard":{"name":"On-Call Dashboard","link":"https://my-dashboard-svc.io/dashboards/1"}}
Response
200 application/json
Response
200 application/json
A response containing a single service object.
CatalogService
The service object contains information about a Service Catalog service.
idstring(uuid)requiredread-only
The service ID.
Example:7f9fd312-a987-4628-b4c5-bb4f4fddd5f7
namestringrequired
The machine name of the Service that uniquely identifies it within the catalog.
Match pattern:^[0-9a-z.-]+$
>= 1 characters<= 120 characters
Example:user-svc
display_namestringrequired
The display name of the Service.
>= 1 characters<= 120 characters
Example:User Service
descriptionstring | nullrequired
Optionally provide a description of the Service.
<= 2048 characters
custom_fieldsobjectrequired
Map of customizable, catalog-defined fields providing information about a service.
Example:{"owner":"John Appleseed","dashboard":{"name":"On-Call Dashboard","link":"https://my-dashboard-svc.io/dashboards/1"}}
labelsrequired
patch/services/{id}
Path Parameters
Body
{}
200 application/json
Delete Service
Deletes a service.
delete
Path Parameters
idstringrequired
The id of the service.
Example:7f9fd312-a987-4628-b4c5-bb4f4fddd5f7
Response
204
Response
204
Service was deleted successfully.
delete/services/{id}
Path Parameters
204
Integrations
List Integrations
Returns a paginated collection of all catalog integrations available to connect.
Each integration represents a built-in connector that extends the platform’s capabilities;
enabling discovery, resource management, event ingestion, and more.
Integrations expose metadata that describes how they authenticate, what configuration they
require, and how they interact with catalog entities like Resources and Services.
Currently, integrations are platform-defined and cannot be extend or registered by customers.
get
Query Parameters
filterobject
Filters a collection of integrations.
Show Child Parameters
sort
Sorts a collection of integrations. Supported sort attributes are:
display_namename
Default sort is display_name in ascending order.
Response
200 application/json
Response
200 application/json
A paginated list response for a collection of integrations.
* Additional properties are NOT allowed.
metarequired
dataarray[object]required
Show Child Parameters
get/integrations
Query Parameters
200 application/json