Get a Service

Fetches a service.

get

Path Parameters

idstringrequired

The id of the service.

Example:7f9fd312-a987-4628-b4c5-bb4f4fddd5f7

Response

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

labelsobjectrequired

Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.

Keys must be of length 1-63 characters, and cannot start with “kong”, “konnect”, “mesh”, “kic”, or “_”.

Example:{"env":"test"}

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/catalog-services/{id}
 
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

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

labelsobject | null

Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.

Labels are intended to store INTERNAL metadata.

Keys must be of length 1-63 characters, and cannot start with “kong”, “konnect”, “mesh”, “kic”, or “_”.

Example:{"env":"test"}

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

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

labelsobjectrequired

Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.

Keys must be of length 1-63 characters, and cannot start with “kong”, “konnect”, “mesh”, “kic”, or “_”.

Example:{"env":"test"}

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/catalog-services/{id}

Body

{ "description": "This is a sample service" }
 
application/json

Delete Service

Deletes a service.

delete

Path Parameters

idstringrequired

The id of the service.

Example:7f9fd312-a987-4628-b4c5-bb4f4fddd5f7

Response

Service was deleted successfully.

delete/catalog-services/{id}
 

Catalog Integrations

Integrations are applications, either Konnect-internal or external, which extend the functionality of the Service Catalog.
Install and authorize an integration to discover the resources across your organization which support your services.
Map relevant resources to your services to provide a rich view of cataloged services.
To set up and view a list of all the integrations we support please view our documentation.

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

page[size]integer

The maximum number of items to include per page. The last page of a collection may include fewer items.

Example:10

page[number]integer

Determines which page of the entities to retrieve.

Example:1

filterobject

Filters a collection of integrations.

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 integrations.

* Additional properties are NOT allowed.
metaobjectrequired

returns the pagination information

Show Child Parameters
dataarray[object]required
Show Child Parameters
get/integrations
 
application/json