Search
K
Konnect Service Catalog

Catalog Services

Create and maintain a centralized catalog of all services running in your organization.
Add custom fields and map resources from across your organization to provide a 360-degree overview of your services.

Custom fields allow you to surface key information such as:

  • Owner: The person or team responsible for the service
  • Product Manager: The person assigned to guide the service’s direction for customer success
  • Jira Project: The Jira project which represents past, present and future work for the service

Resources are discovered from the integrations you use within your organization to create, operate and manage your services.
Mapping the resources relevant to your service will provide a rich view of the service’s communication channels, dependencies and more.
Types of resources which you can map to a service include:

  • Code Repositories: The software project(s) that make up the service
  • Monitors and Dashboards: Tools providing visibility into the health and performance of the service
  • Communication Channels: Virtual spaces where questions and concerns can be raised about the service
  • Incident Management Resources: Alerts setup within your incident management platform to notify individuals regarding issues with the service

Create Service

Creates a service.

post

Body

application/json

CreateCatalogService

* Additional properties are NOT allowed.
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 | null

Optionally provide a description of the Service.

<= 2048 characters

labelsobject

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

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

post/catalog-services

Body

{ "name": "sample-service", "display_name": "Sample Service", "description": "This is a sample service", "custom_fields": { "owner": "John Appleseed", "cost_center": "Research and Development", "product_manager": "Jane", "jira_project": { "name": "Sample Jira Project", "link": "https://my-company.atlassian.net/jira/software/c/projects/SAMPLE" }, "dashboard": { "name": "Sample Dashboard", "link": "https://my-company.dashboards.com/sample-dashboard" }, "git_repo": { "name": "Sample Project", "link": "https://github.com/MyCompany/SampleProject" }, "slack_channel": { "name": "My Company Channel", "link": "https://my-company.slack.com/archives/C000AAAAAAA" } }, "labels": { "env": "test" } }
 
application/json

List Services

Returns a paginated collection of services.

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

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

* Additional properties are NOT allowed.
metaobjectrequired

returns the pagination information

Show Child Parameters
dataarray[object]required

The service object contains information about a Service Catalog service.

Show Child Parameters
get/catalog-services
 
application/json

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