Search
K
Konnect Service Catalog

Konnect Service Catalog

1.2.0OAS 3.0

The platform API for Konnect Service Catalog.

API Base URL
  • Server 1:https://us.api.konghq.com/v1

    US Region Base URL

  • Server 2:https://eu.api.konghq.com/v1

    EU Region Base URL

  • Server 3:https://au.api.konghq.com/v1

    AU Region Base URL

  • Server 4:https://me.api.konghq.com/v1

    ME Region Base URL

  • Server 5:https://in.api.konghq.com/v1

    IN Region Base URL

Additional Information
Contact Kong

Services

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

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

201 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
post/services

Body

{ "name": "user-svc", "display_name": "User Service" }
 
201 application/json

List Services

Returns a paginated collection of services.

get

Query Parameters

filterobject

Filters a collection of services.

Show Child Parameters
sort

Sorts a collection of services. Supported sort attributes are:

  • display_name
  • name
  • created_at
  • updated_at

Default sort is display_name in ascending order.

Response

200 application/json

A paginated list response for a collection of services.

* Additional properties are NOT allowed.
metarequired
dataarray[object]required

The service object contains information about a Service Catalog service.

Show Child Parameters
get/services
 
200 application/json

Fetch Service

Fetches a service.

get

Path Parameters

idstringrequired

The id of the service.

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

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}
 
200 application/json