2.0.0OAS 3.0

The API for Kong 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
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.
The PAT token must be passed in the header of a request, for example:
curl -X GET 'https://global.api.konghq.com/v2/users/' --header 'Authorization: Bearer kpat_xgfT...'

systemAccountAccessToken (http)

The system account access token is meant for automations and integrations that are not directly associated with a human identity.
You can generate a system account Access Token by creating a system account and then obtaining a system account access token for that account.
The access token must be passed in the header of a request, for example:
curl -X GET 'https://global.api.konghq.com/v2/users/' --header 'Authorization: Bearer spat_i2Ej...'

Additional Information
Contact Kong

Runtime Groups

List Runtime Groups

Returns an array of runtime groups objects containing information about the Konnect Runtime Groups.

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

filter[name][eq]string

Filter by direct equality comparison of the name property with a supplied value.

Example:test

filter[name]string

Filter by direct equality comparison (short-hand) of the name property with a supplied value.

Example:test

filter[name][contains]string

Filter by contains comparison of the name property with a supplied substring.

Example:test

filter[name][neq]string

Filter by non-equality comparison of the name property with a supplied value.

Example:test

filter[id][eq]string

Filter by direct equality comparison of the id property with a supplied value.

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

filter[id]string

Filter by direct equality comparison (short-hand) of the id property with a supplied value.

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

filter[id][oeq]string

Filter by direct equality comparison of id property with multiple supplied values.

Example:some-value,some-other-value

filter[cluster_type][eq]string

Filter by direct equality comparison of the cluster_type property with a supplied value.

Example:CLUSTER_TYPE_HYBRID

filter[cluster_type]string

Filter by direct equality comparison (short-hand) of the cluster_type property with a supplied value.

Example:CLUSTER_TYPE_HYBRID

filter[cluster_type][neq]string

Filter by non-equality comparison of the cluster_type property with a supplied value.

Example:test

labelsstring

Filter runtime groups in the response by associated labels.

Example:key:value,existCheck

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 runtime groups.

ListRuntimeGroupsResponse

* Additional properties are NOT allowed.
metaobjectrequired

returns the pagination information

Show Child Parameters
dataarrayrequired

The runtime group object contains information about a Kong control plane.

* Additional properties are NOT allowed.
Show Child Parameters
get/runtime-groups
 
application/json

Create Runtime Group

Create a runtime group in the Konnect Organization.

post

Body

application/json

CreateRuntimeGroupRequest

The request schema for the create runtime group request.

* Additional properties are NOT allowed.
namestringrequired

The name of the runtime group.

Example:Test Runtime Group

descriptionstring

The description of the runtime group in Konnect.

Example:A test runtime group for exploration.

cluster_typestring

The ClusterType value of the cluster associated with the Runtime Group.

Allowed values:CLUSTER_TYPE_HYBRIDCLUSTER_TYPE_K8S_INGRESS_CONTROLLERCLUSTER_TYPE_COMPOSITECLUSTER_TYPE_SERVERLESSCLUSTER_TYPE_KAFKA_NATIVE_EVENT_PROXYCLUSTER_TYPE_SERVERLESS_V1

Example:CLUSTER_TYPE_HYBRID

auth_typestring

The auth type value of the cluster associated with the Runtime Group.

Allowed values:pinned_client_certspki_client_certs

Example:pinned_client_certs

cloud_gatewayboolean

Whether this runtime group can be used for cloud-gateways.

Example:false

proxy_urlsarray[object]

Proxy URL associated with reaching the data-planes connected to a runtime group.

Example:{"host":"example.com","port":443,"protocol":"https"}

* Additional properties are NOT allowed.
Show Child Parameters
labelsobject

Labels to facilitate tagged search on runtime groups. Keys must be of length 1-63 characters, and cannot start with ‘kong’, ‘konnect’, ‘mesh’, ‘kic’, or ‘_’.

Example:{"test":"true"}

Response

application/json

A response to creating a runtime group.

RuntimeGroup

The runtime group object contains information about a Kong control plane.

* Additional properties are NOT allowed.
idstring(uuid)read-only

The runtime group ID.

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

namestring

The name of the runtime group.

Example:Test Runtime Group

descriptionstring

The description of the runtime group in Konnect.

Example:A test runtime group for exploration.

labelsobject

Labels to facilitate tagged search on runtime groups. Keys must be of length 1-63 characters, and cannot start with ‘kong’, ‘konnect’, ‘mesh’, ‘kic’, or ‘_’.

Example:{"test":"true"}{"test":"true"}

configobject

CP configuration object for related access endpoints.

* Additional properties are NOT allowed.
Show Child Parameters
created_atstring(date-time)read-only

An ISO-8604 timestamp representation of runtime group creation date.

Example:2022-11-04T20:10:06.927Z

updated_atstring(date-time)read-only

An ISO-8604 timestamp representation of runtime group update date.

Example:2022-11-04T20:10:06.927Z

post/runtime-groups

Body

{ "name": "Test Runtime Group", "description": "A test runtime group for exploration.", "cluster_type": "CLUSTER_TYPE_K8S_INGRESS_CONTROLLER", "cloud_gateway": false, "proxy_urls": [ { "host": "example.com", "port": 443, "protocol": "https" } ], "labels": { "test": "true" } }
 
application/json

Get a Runtime Group

Returns information about a team from a given team ID.

get

Path Parameters

idstring(uuid)required

The runtime group ID

Example:d32d905a-ed33-46a3-a093-d8f536af9a8a

Response

application/json

A response to retrieving a single runtime group.

RuntimeGroup

The runtime group object contains information about a Kong control plane.

* Additional properties are NOT allowed.
idstring(uuid)read-only

The runtime group ID.

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

namestring

The name of the runtime group.

Example:Test Runtime Group

descriptionstring

The description of the runtime group in Konnect.

Example:A test runtime group for exploration.

labelsobject

Labels to facilitate tagged search on runtime groups. Keys must be of length 1-63 characters, and cannot start with ‘kong’, ‘konnect’, ‘mesh’, ‘kic’, or ‘_’.

Example:{"test":"true"}{"test":"true"}

configobject

CP configuration object for related access endpoints.

* Additional properties are NOT allowed.
Show Child Parameters
created_atstring(date-time)read-only

An ISO-8604 timestamp representation of runtime group creation date.

Example:2022-11-04T20:10:06.927Z

updated_atstring(date-time)read-only

An ISO-8604 timestamp representation of runtime group update date.

Example:2022-11-04T20:10:06.927Z

get/runtime-groups/{id}
 
application/json