0.0.1OAS 3.0

The API for configurating Konnect Runtime Groups.

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

    United-States Production region

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

    Europe Production region

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

    Australia Production region

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

    Middle-East Production region

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

    India Production region

  • Server 6:https://sg.api.konghq.com/v2

    Singapore Production region

Security
konnectAccessToken (http)

The Konnect access token is meant to be used by the Konnect dashboard and the decK CLI to
authenticate with.

personalAccessToken (http)

The personal access token is meant to be used as an alternative to basic-auth when accessing Konnect via APIs. You can generate a Personal Access Token (PAT) from the personal access token page in the Konnect dashboard.

Services

Gateway services

List all services

List all services

get

Query Parameters

sizeinteger

Number of resources to be returned.

Default:100

>= 1<= 1000

offsetstring

Offset from which to return the next set of resources. Use the value of the ‘offset’ field from the response of a list operation as input here to paginate through all the resources

tagsstring

A list of tags to filter the list of resources on. Multiple tags can be concatenated using ‘,’ to mean AND or using ‘/’ to mean OR.

Example:tag1,tag2

Path Parameters

runtimeGroupIdstringrequired

The ID of your runtime group. This variable is available in the Konnect manager

Example:9524ec7d-36d9-465d-a8c5-83a3c9390458

Response

200 application/json

The service response object is returned when creating a new service or retreiving an existing service.

connect_timeoutinteger
created_atinteger

Unix epoch when the resource was last created.

enabledboolean

Service enabled boolean

hoststring
idstring
namestring
pathstring
portinteger
protocolstring
read_timeoutinteger
retriesinteger
updated_atinteger
write_timeoutinteger
get/runtime-groups/{runtimeGroupId}/core-entities/services
 
200 application/json