API docs by Redocly

Konnect Control Planes Configuration (0.0.1)

Download OpenAPI specification:Download

Kong Inc: support@konghq.com URL: https://konghq.com License: Apache 2.0

OpenAPI 3.0 spec for Kong Gateway's Admin API.

You can lean more about Kong Gateway at docs.konghq.com .Give Kong a star at Kong/kong repository.

Documentation for Kong Gateway and its APIs

DP Nodes

DP Nodes

Fetch Expected Config Hash

Retrieve the expected config hash for this control plane. The expected config hash can be used to verify if the config hash of a data plane node is up to date with the control plane. The config hash will be the same if they are in sync.

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

Responses

Response samples

Content type
application/json
{
  • "expected_hash": "string",
  • "created_at": 0,
  • "updated_at": 0
}

Fetch Expected Config Version

Retrieve the expected config version for this control plane. The expected config version can be used to verify if the config version of a data plane node is up to date with the control plane. The config version will be the same if they are in sync.

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

Responses

Response samples

Content type
application/json
{
  • "expected_config_version": "string",
  • "created_at": 0
}

List Data Plane Node Records

Returns a list of data plane node records that are associated to this control plane. A data plane node record contains metadata information for the data plane running Kong Gateway.

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

query Parameters
page[size]
integer
Example: page[size]=10

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

page[after]
string
Example: page[after]=ewogICJpZCI6ICJoZWxsbyB3b3JsZCIKfQ

Request the next page of data, starting with the item after this parameter.

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "page": {
    }
}

List End-of-Life Data Plane Node Records

Returns a list of records of data plane nodes, whose versions are approaching End of Full Support/End of Life, that are associated with this control plane. Each record contains a data plane node's id, version, and corresponding resolution message to upgrade to the closest Long Term Support version.

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

query Parameters
page[size]
integer
Example: page[size]=10

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

page[after]
string
Example: page[after]=ewogICJpZCI6ICJoZWxsbyB3b3JsZCIKfQ

Request the next page of data, starting with the item after this parameter.

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "page": {
    }
}

Fetch Data Plane Node Record

Retrieve a specific data plane node record associated to this control plane. A data plane node record contains all the metadata information of the Kong Gateway dataplane.

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

nodeId
required
string <uuid>
Example: d32d905a-ed33-46a3-a093-d8f536af9a8a

Node identifier

query Parameters
size
integer [ 1 .. 1000 ]
Default: 100

Number of resources to be returned.

tags
string
Example: tags=tag1,tag2

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.

Responses

Response samples

Content type
application/json
{
  • "item": {
    }
}

Delete Data Plane Node Record

Remove a specific data plane node record associated to this control plane. Deleting this record does not prevent the data plane node from re-connecting to the control plane.

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

nodeId
required
string <uuid>
Example: d32d905a-ed33-46a3-a093-d8f536af9a8a

Node identifier

Responses

DP Certificates

DP Certificates

List DP Client Certificates

Returns a list of pinned dataplane client certificates that are associated to this control plane. A pinned dataplane certificate allows dataplanes configured with the certificate and corresponding private key to establish connection with this control plane.

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "page": {
    }
}

Pin New DP Client Certificate

Pin a new DP Client Certificate to this control plane. A pinned dataplane certificate allows dataplanes configured with the certificate and corresponding private key to establish connection with this control plane.

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

Request Body schema: application/json

Request body for creating a dp-client-certificate.

cert
required
string

JSON escaped string of the certificate.

Responses

Request samples

Content type
application/json
{
  • "cert": "-----BEGIN CERTIFICATE-----\r\n*****\r\n-----END CERTIFICATE-----\r\n"
}

Response samples

Content type
application/json
{
  • "item": {
    }
}

Fetch DP Client Certificate

Retrieve a pinned dataplane client certificate associated to this control plane. A pinned dataplane certificate allows dataplanes configured with the certificate and corresponding private key to establish connection with this control plane.

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

certificateId
required
string

Responses

Response samples

Content type
application/json
{
  • "item": {
    }
}

Delete DP Client Certificate

Remove a pinned dataplane client certificate associated to this control plane. Removing a pinned dataplane certificate would invalidate any dataplanes currently connected to this control plane using this certificate.

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

certificateId
required
string

Responses

Custom Plugin Schemas

Custom Plugin Schemas

List custom plugin schemas associated with a control plane

Returns an array of custom plugins schemas associated with a control plane.

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

query Parameters
page[size]
integer
Example: page[size]=10

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

page[after]
string
Example: page[after]=ewogICJpZCI6ICJoZWxsbyB3b3JsZCIKfQ

Request the next page of data, starting with the item after this parameter.

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "page": {
    }
}

Upload custom plugin schema

Upload a custom plugin schema associated with a control plane.

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

Request Body schema: application/json
lua_schema
required
string

The custom plugin schema; jq -Rs '.' schema.lua.

Responses

Request samples

Content type
application/json
{
  • "lua_schema": "return { name = \\\"myplugin\\\", fields = { { config = { type = \\\"record\\\", fields = { } } } } }"
}

Response samples

Content type
application/json
{
  • "item": {
    }
}

Fetch custom plugin schema

Returns information about a custom plugin from a given name.

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

name
required
string
Example: myplugin

The custom plugin name

Responses

Response samples

Content type
application/json
{
  • "item": {
    }
}

Delete custom plugin schema

Delete an individual custom plugin schema.

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

name
required
string
Example: myplugin

The custom plugin name

Responses

Response samples

Content type
application/problem+json
{
  • "status": 401,
  • "title": "Unauthorized",
  • "instance": "kong:trace:8347343766220159418",
  • "detail": "Unauthorized"
}

Create or update a custom plugin schema

Create or update an individual custom plugin schema.

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

name
required
string
Example: myplugin

The custom plugin name

Request Body schema: application/json
lua_schema
required
string

The custom plugin schema; jq -Rs '.' schema.lua.

Responses

Request samples

Content type
application/json
{
  • "lua_schema": "return { name = \\\"myplugin\\\", fields = { { config = { type = \\\"record\\\", fields = { } } } } }"
}

Response samples

Content type
application/json
{
  • "item": {
    }
}

Config Stores

Config Stores

List all config stores for a control plane

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

query Parameters
page[size]
integer
Example: page[size]=10

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

page[after]
string
Example: page[after]=ewogICJpZCI6ICJoZWxsbyB3b3JsZCIKfQ

Request the next page of data, starting with the item after this parameter.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Create Config Store

Create a Config Store

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

Request Body schema: application/json
name
string [ 1 .. 100 ] characters

Responses

Request samples

Content type
application/json
{
  • "name": "Config Store"
}

Response samples

Content type
application/json
{
  • "id": "e7a4f6c0-5777-4a37-bcb9-2d37d3b362ee",
  • "name": "Config Store",
  • "created_at": "2024-01-01T00:00:00.000Z",
  • "updated_at": "2024-01-01T00:00:00.000Z"
}

Fetch Config Store

Returns a Config Store

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

configStoreId
required
string <uuid>
Example: d32d905a-ed33-46a3-a093-d8f536af9a8a

Config Store identifier

Responses

Response samples

Content type
application/json
{
  • "id": "e7a4f6c0-5777-4a37-bcb9-2d37d3b362ee",
  • "name": "Config Store",
  • "created_at": "2024-01-01T00:00:00.000Z",
  • "updated_at": "2024-01-01T00:00:00.000Z"
}

Update an individual Config Store

Updates a Config Store

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

configStoreId
required
string <uuid>
Example: d32d905a-ed33-46a3-a093-d8f536af9a8a

Config Store identifier

Request Body schema: application/json
name
string [ 1 .. 100 ] characters

Responses

Request samples

Content type
application/json
{
  • "name": "Config Store with Updated Name"
}

Response samples

Content type
application/json
{
  • "id": "e7a4f6c0-5777-4a37-bcb9-2d37d3b362ee",
  • "name": "Config Store",
  • "created_at": "2024-01-01T00:00:00.000Z",
  • "updated_at": "2024-01-01T00:00:00.000Z"
}

Delete Config Store

Removes a config store

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

configStoreId
required
string <uuid>
Example: d32d905a-ed33-46a3-a093-d8f536af9a8a

Config Store identifier

query Parameters
force
string
Default: "false"
Enum: "true" "false"

If true, delete specified config store and all secrets, even if there are secrets linked to the config store If false, do not allow deletion if there are secrets linked to the config store

Responses

Response samples

Content type
application/problem+json
{
  • "status": 400,
  • "title": "Invalid Request",
  • "instance": "kong:trace:1433447772874964729",
  • "detail": "Invalid Parameters",
  • "invalid_parameters": [
    ]
}

Config Store Secrets

Config Store Secrets

Create Config Store Secret

Creates a secret for a Config Store.

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

configStoreId
required
string <uuid>
Example: d32d905a-ed33-46a3-a093-d8f536af9a8a

Config Store identifier

Request Body schema: application/json
key
required
string [ 1 .. 512 ] characters
value
required
string [ 1 .. 5120 ] characters

Responses

Request samples

Content type
application/json
{
  • "key": "ConfigStoreSecretKey",
  • "value": "ConfigStoreSecretValue"
}

Response samples

Content type
application/json
{
  • "key": "ConfigStoreSecretKey",
  • "value": "ConfigStoreSecretValue",
  • "created_at": "2024-01-01T00:00:00.000Z",
  • "updated_at": "2024-01-01T00:00:00.000Z"
}

List Config Store Secrets

Returns a collection of all secrets for a Config Store.

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

configStoreId
required
string <uuid>
Example: d32d905a-ed33-46a3-a093-d8f536af9a8a

Config Store identifier

query Parameters
page[size]
integer
Example: page[size]=10

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

page[after]
string
Example: page[after]=ewogICJpZCI6ICJoZWxsbyB3b3JsZCIKfQ

Request the next page of data, starting with the item after this parameter.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Fetch Config Store Secret

Returns a secret for the Config Store.

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

configStoreId
required
string <uuid>
Example: d32d905a-ed33-46a3-a093-d8f536af9a8a

Config Store identifier

key
required
string
Example: ConfigStoreSecretKey

Config Store Secret key

Responses

Response samples

Content type
application/json
{
  • "key": "ConfigStoreSecretKey",
  • "value": "ConfigStoreSecretValue",
  • "created_at": "2024-01-01T00:00:00.000Z",
  • "updated_at": "2024-01-01T00:00:00.000Z"
}

Update Config Store Secret

Updates a secret for a Config Store.

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

configStoreId
required
string <uuid>
Example: d32d905a-ed33-46a3-a093-d8f536af9a8a

Config Store identifier

key
required
string
Example: ConfigStoreSecretKey

Config Store Secret key

Request Body schema: application/json
value
required
string [ 1 .. 5120 ] characters

Responses

Request samples

Content type
application/json
{
  • "value": "ConfigStoreSecretValue"
}

Response samples

Content type
application/json
{
  • "key": "ConfigStoreSecretKey",
  • "value": "ConfigStoreSecretValue",
  • "created_at": "2024-01-01T00:00:00.000Z",
  • "updated_at": "2024-01-01T00:00:00.000Z"
}

Delete Config Store Secret

Removes a secret from a Config Store.

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

configStoreId
required
string <uuid>
Example: d32d905a-ed33-46a3-a093-d8f536af9a8a

Config Store identifier

key
required
string
Example: ConfigStoreSecretKey

Config Store Secret key

Responses

Response samples

Content type
application/problem+json
{
  • "status": 401,
  • "title": "Unauthorized",
  • "instance": "kong:trace:8347343766220159418",
  • "detail": "Unauthorized"
}

Debug Sessions

Debug Sessions

List all debug sessions for a control plane

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

query Parameters
page[size]
integer
Example: page[size]=10

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

page[after]
string
Example: page[after]=ewogICJpZCI6ICJoZWxsbyB3b3JsZCIKfQ

Request the next page of data, starting with the item after this parameter.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Create Debug Session

Create Debug Session

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

Request Body schema: application/json
name
string

The optional session name.

max_samples
integer

The maximum amount of samples to collect per data plane.

sampling_rule
string or null

An expression used to filter the requests to sample.

duration_secs
integer

The duration of the debug session in seconds.

capture_content
Array of strings
Items Enum: "headers" "body"
targets
Array of strings <uuid>

The data plane nodes to collect samples from.

Responses

Request samples

Content type
application/json
{
  • "id": "e7a4f6c0-5777-4a37-bcb9-2d37d3b362ee",
  • "max_samples": 10,
  • "targets": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "e7a4f6c0-5777-4a37-bcb9-2d37d3b362ee",
  • "max_samples": 10,
  • "duration_secs": 300,
  • "created_at": "2024-10-01T20:10:00.000Z",
  • "updated_at": "2024-10-01T20:10:00.000Z"
}

Fetch a Debug Session

Returns a Debug Session

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

debugSessionId
required
string <uuid>
Example: d32d905a-ed33-46a3-a093-d8f536af9a8a

Debug Session identifier

Responses

Response samples

Content type
application/json
{
  • "id": "e7a4f6c0-5777-4a37-bcb9-2d37d3b362ee",
  • "max_samples": 10,
  • "duration_secs": 300,
  • "created_at": "2024-10-01T20:10:00.000Z",
  • "updated_at": "2024-10-01T20:10:00.000Z"
}

Delete a Debug Session

Deletes a Debug Session

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

debugSessionId
required
string <uuid>
Example: d32d905a-ed33-46a3-a093-d8f536af9a8a

Debug Session identifier

Responses

Response samples

Content type
application/problem+json
{
  • "status": 401,
  • "title": "Unauthorized",
  • "instance": "kong:trace:8347343766220159418",
  • "detail": "Unauthorized"
}

Stops an active Debug Session

Stops an active Debug Session

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

debugSessionId
required
string <uuid>
Example: d32d905a-ed33-46a3-a093-d8f536af9a8a

Debug Session identifier

Responses

Response samples

Content type
application/json
{ }

Gets data for a debug session (internal only)

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

Responses

Response samples

Content type
application/json
{ }

CustomPlugins

List all CustomPlugins

Pre-release Endpoint This endpoint is currently in beta and is subject to change.

List all CustomPlugins

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

query Parameters
size
integer [ 1 .. 1000 ]
Default: 100

Number of resources to be returned.

offset
string

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

tags
string
Example: tags=tag1,tag2

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.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "next": "string",
  • "offset": "string"
}

Create a new CustomPlugin

Pre-release Endpoint This endpoint is currently in beta and is subject to change.

Create a new CustomPlugin

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

Request Body schema: application/json

Description of the new CustomPlugin for creation

created_at
integer or null

Unix epoch when the resource was created.

handler
required
string
id
string or null
name
required
string
schema
required
string
tags
Array of strings
updated_at
integer or null

Unix epoch when the resource was last updated.

Responses

Request samples

Content type
application/json
{
  • "handler": "return { VERSION = '1.0,0', PRIORITY = 500, access = function(self, config) kong.service.request.set_header(config.name, config.value) end }",
  • "id": "868346aa-1105-4b77-8346-aa1105fb77c4",
  • "name": "set-header",
  • "schema": "return { name = 'set-header', fields = { { protocols = require('kong.db.schema.typedefs').protocols_http }, { config = { type = 'record', fields = { { name = { description = 'The name of the header to set.', type = 'string', required = true } }, { value = { description = 'The value for the header.', type = 'string', required = true } } } } } } }"
}

Response samples

Content type
application/json
{
  • "handler": "return { VERSION = '1.0,0', PRIORITY = 500, access = function(self, config) kong.service.request.set_header(config.name, config.value) end }",
  • "id": "868346aa-1105-4b77-8346-aa1105fb77c4",
  • "name": "set-header",
  • "schema": "return { name = 'set-header', fields = { { protocols = require('kong.db.schema.typedefs').protocols_http }, { config = { type = 'record', fields = { { name = { description = 'The name of the header to set.', type = 'string', required = true } }, { value = { description = 'The value for the header.', type = 'string', required = true } } } } } } }"
}

Delete a CustomPlugin

Pre-release Endpoint This endpoint is currently in beta and is subject to change.

Delete a CustomPlugin

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

CustomPluginId
required
string

ID of the CustomPlugin to lookup

Responses

Response samples

Content type
application/json
Example
{
  • "message": "Duplicate API key found",
  • "status": 401
}

Fetch a CustomPlugin

Pre-release Endpoint This endpoint is currently in beta and is subject to change.

Get a CustomPlugin using ID or name.

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
CustomPluginId
required
string

ID of the CustomPlugin to lookup

controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

Responses

Response samples

Content type
application/json
{
  • "handler": "return { VERSION = '1.0,0', PRIORITY = 500, access = function(self, config) kong.service.request.set_header(config.name, config.value) end }",
  • "id": "868346aa-1105-4b77-8346-aa1105fb77c4",
  • "name": "set-header",
  • "schema": "return { name = 'set-header', fields = { { protocols = require('kong.db.schema.typedefs').protocols_http }, { config = { type = 'record', fields = { { name = { description = 'The name of the header to set.', type = 'string', required = true } }, { value = { description = 'The value for the header.', type = 'string', required = true } } } } } } }"
}

Upsert a CustomPlugin

Pre-release Endpoint This endpoint is currently in beta and is subject to change.

Create or Update CustomPlugin using ID or name.

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
CustomPluginId
required
string

ID of the CustomPlugin to lookup

controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

Request Body schema: application/json

Description of the CustomPlugin

created_at
integer or null

Unix epoch when the resource was created.

handler
required
string
id
string or null
name
required
string
schema
required
string
tags
Array of strings
updated_at
integer or null

Unix epoch when the resource was last updated.

Responses

Request samples

Content type
application/json
{
  • "handler": "return { VERSION = '1.0,0', PRIORITY = 500, access = function(self, config) kong.service.request.set_header(config.name, config.value) end }",
  • "id": "868346aa-1105-4b77-8346-aa1105fb77c4",
  • "name": "set-header",
  • "schema": "return { name = 'set-header', fields = { { protocols = require('kong.db.schema.typedefs').protocols_http }, { config = { type = 'record', fields = { { name = { description = 'The name of the header to set.', type = 'string', required = true } }, { value = { description = 'The value for the header.', type = 'string', required = true } } } } } } }"
}

Response samples

Content type
application/json
{
  • "handler": "return { VERSION = '1.0,0', PRIORITY = 500, access = function(self, config) kong.service.request.set_header(config.name, config.value) end }",
  • "id": "868346aa-1105-4b77-8346-aa1105fb77c4",
  • "name": "set-header",
  • "schema": "return { name = 'set-header', fields = { { protocols = require('kong.db.schema.typedefs').protocols_http }, { config = { type = 'record', fields = { { name = { description = 'The name of the header to set.', type = 'string', required = true } }, { value = { description = 'The value for the header.', type = 'string', required = true } } } } } } }"
}

Services

Service entities are abstractions of your microservice interfaces or formal APIs. For example, a service could be a data transformation microservice or a billing API.

The main attribute of a service is the destination URL for proxying traffic. This URL can be set as a single string or by specifying its protocol, host, port and path individually.

Services are associated to routes, and a single service can have many routes associated with it. Routes are entrypoints in Kong Gateway which define rules to match client requests. Once a route is matched, Kong Gateway proxies the request to its associated service. See the Proxy Reference for a detailed explanation of how Kong proxies traffic.

Services can be both tagged and filtered by tags.

List all Services

List all Services

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

query Parameters
size
integer [ 1 .. 1000 ]
Default: 100

Number of resources to be returned.

offset
string

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

tags
string
Example: tags=tag1,tag2

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.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "next": "string",
  • "offset": "string"
}

Create a new Service

Create a new Service

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

Request Body schema: application/json

Description of the new Service for creation

ca_certificates
Array of strings or null

Array of CA Certificate object UUIDs that are used to build the trust store while verifying upstream server's TLS certificate. If set to null when Nginx default is respected. If default CA list in Nginx are not specified and TLS verification is enabled, then handshake with upstream server will always fail (because no CA are trusted).

object or null

Certificate to be used as client certificate while TLS handshaking to the upstream server.

connect_timeout
integer or null
Default: 60000

The timeout in milliseconds for establishing a connection to the upstream server.

created_at
integer or null

Unix epoch when the resource was created.

enabled
boolean or null
Default: true

Whether the Service is active. If set to false, the proxy behavior will be as if any routes attached to it do not exist (404). Default: true.

host
required
string

The host of the upstream server. Note that the host value is case sensitive.

id
string or null
name
string or null

The Service name.

path
string or null

The path to be used in requests to the upstream server.

port
integer or null
Default: 80

The upstream server port.

protocol
string or null
Default: "http"
Enum: "grpc" "grpcs" "http" "https" "tcp" "tls" "tls_passthrough" "udp" "ws" "wss"

The protocol used to communicate with the upstream.

read_timeout
integer or null
Default: 60000

The timeout in milliseconds between two successive read operations for transmitting a request to the upstream server.

retries
integer or null
Default: 5

The number of retries to execute upon failure to proxy.

tags
Array of strings

An optional set of strings associated with the Service for grouping and filtering.

tls_verify
boolean or null

Whether to enable verification of upstream server TLS certificate. If set to null, then the Nginx default is respected.

tls_verify_depth
integer or null

Maximum depth of chain while verifying Upstream server's TLS certificate. If set to null, then the Nginx default is respected.

updated_at
integer or null

Unix epoch when the resource was last updated.

url
string

Helper field to set protocol, host, port and path using a URL. This field is write-only and is not returned in responses.

write_timeout
integer or null
Default: 60000

The timeout in milliseconds between two successive write operations for transmitting a request to the upstream server.

Responses

Request samples

Content type
application/json
{
  • "host": "example.internal",
  • "id": "49fd316e-c457-481c-9fc7-8079153e4f3c",
  • "name": "example-service",
  • "path": "/",
  • "port": 80,
  • "protocol": "http"
}

Response samples

Content type
application/json
{
  • "host": "example.internal",
  • "id": "49fd316e-c457-481c-9fc7-8079153e4f3c",
  • "name": "example-service",
  • "path": "/",
  • "port": 80,
  • "protocol": "http"
}

Delete a Service

Delete a Service

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

ServiceId
required
string
Example: 7fca84d6-7d37-4a74-a7b0-93e576089a41

ID of the Service to lookup

Responses

Response samples

Content type
application/json
Example
{
  • "message": "Duplicate API key found",
  • "status": 401
}

Fetch a Service

Get a Service using ID or name.

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
ServiceId
required
string
Example: 7fca84d6-7d37-4a74-a7b0-93e576089a41

ID of the Service to lookup

controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

Responses

Response samples

Content type
application/json
{
  • "host": "example.internal",
  • "id": "49fd316e-c457-481c-9fc7-8079153e4f3c",
  • "name": "example-service",
  • "path": "/",
  • "port": 80,
  • "protocol": "http"
}

Upsert a Service

Create or Update Service using ID or name.

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
ServiceId
required
string
Example: 7fca84d6-7d37-4a74-a7b0-93e576089a41

ID of the Service to lookup

controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

Request Body schema: application/json

Description of the Service

ca_certificates
Array of strings or null

Array of CA Certificate object UUIDs that are used to build the trust store while verifying upstream server's TLS certificate. If set to null when Nginx default is respected. If default CA list in Nginx are not specified and TLS verification is enabled, then handshake with upstream server will always fail (because no CA are trusted).

object or null

Certificate to be used as client certificate while TLS handshaking to the upstream server.

connect_timeout
integer or null
Default: 60000

The timeout in milliseconds for establishing a connection to the upstream server.

created_at
integer or null

Unix epoch when the resource was created.

enabled
boolean or null
Default: true

Whether the Service is active. If set to false, the proxy behavior will be as if any routes attached to it do not exist (404). Default: true.

host
required
string

The host of the upstream server. Note that the host value is case sensitive.

id
string or null
name
string or null

The Service name.

path
string or null

The path to be used in requests to the upstream server.

port
integer or null
Default: 80

The upstream server port.

protocol
string or null
Default: "http"
Enum: "grpc" "grpcs" "http" "https" "tcp" "tls" "tls_passthrough" "udp" "ws" "wss"

The protocol used to communicate with the upstream.

read_timeout
integer or null
Default: 60000

The timeout in milliseconds between two successive read operations for transmitting a request to the upstream server.

retries
integer or null
Default: 5

The number of retries to execute upon failure to proxy.

tags
Array of strings

An optional set of strings associated with the Service for grouping and filtering.

tls_verify
boolean or null

Whether to enable verification of upstream server TLS certificate. If set to null, then the Nginx default is respected.

tls_verify_depth
integer or null

Maximum depth of chain while verifying Upstream server's TLS certificate. If set to null, then the Nginx default is respected.

updated_at
integer or null

Unix epoch when the resource was last updated.

url
string

Helper field to set protocol, host, port and path using a URL. This field is write-only and is not returned in responses.

write_timeout
integer or null
Default: 60000

The timeout in milliseconds between two successive write operations for transmitting a request to the upstream server.

Responses

Request samples

Content type
application/json
{
  • "host": "example.internal",
  • "id": "49fd316e-c457-481c-9fc7-8079153e4f3c",
  • "name": "example-service",
  • "path": "/",
  • "port": 80,
  • "protocol": "http"
}

Response samples

Content type
application/json
{
  • "host": "example.internal",
  • "id": "49fd316e-c457-481c-9fc7-8079153e4f3c",
  • "name": "example-service",
  • "path": "/",
  • "port": 80,
  • "protocol": "http"
}

Routes

Route entities define rules to match client requests. Each route is associated with a service, and a service may have multiple routes associated to it. Every request matching a given route will be proxied to the associated service. You need at least one matching rule that applies to the protocol being matched by the route.

The combination of routes and services, and the separation of concerns between them, offers a powerful routing mechanism with which it is possible to define fine-grained entrypoints in Kong Gateway leading to different upstream services of your infrastructure.

Depending on the protocol, one of the following attributes must be set:

  • http: At least one of methods, hosts, headers, or paths
  • https: At least one of methods, hosts, headers, paths, or snis
  • tcp: At least one of sources or destinations
  • tls: at least one of sources, destinations, or snis
  • tls_passthrough: set snis
  • grpc: At least one of hosts, headers, or paths
  • grpcs: At least one of hosts, headers, paths, or snis
  • ws: At least one of hosts, headers, or paths
  • wss: At least one of hosts, headers, paths, or snis
    A route can't have both `tls` and `tls_passthrough` protocols at same time.

    Learn more about the router:
  • Configure routes using expressions
  • Router Expressions language reference

List all Routes

List all Routes

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

query Parameters
size
integer [ 1 .. 1000 ]
Default: 100

Number of resources to be returned.

offset
string

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

tags
string
Example: tags=tag1,tag2

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.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "next": "string",
  • "offset": "string"
}

Create a new Route

Create a new Route

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

Request Body schema: application/json

Description of the new Route for creation

One of
created_at
integer or null

Unix epoch when the resource was created.

Array of objects or null

A list of IP destinations of incoming connections that match this Route when using stream routing. Each entry is an object with fields "ip" (optionally in CIDR range notation) and/or "port".

object or null

One or more lists of values indexed by header name that will cause this Route to match if present in the request. The Host header cannot be used with this attribute: hosts should be specified using the hosts attribute. When headers contains only one value and that value starts with the special prefix ~*, the value is interpreted as a regular expression.

hosts
Array of strings or null

A list of domain names that match this Route. Note that the hosts value is case sensitive.

https_redirect_status_code
integer or null
Default: 426
Enum: 426 301 302 307 308

The status code Kong responds with when all properties of a Route match except the protocol i.e. if the protocol of the request is HTTP instead of HTTPS. Location header is injected by Kong if the field is set to 301, 302, 307 or 308. Note: This config applies only if the Route is configured to only accept the https protocol.

id
string or null
methods
Array of strings or null

A list of HTTP methods that match this Route.

name
string or null

The name of the Route. Route names must be unique, and they are case sensitive. For example, there can be two different Routes named "test" and "Test".

path_handling
string or null
Default: "v0"
Enum: "v0" "v1"

Controls how the Service path, Route path and requested path are combined when sending a request to the upstream. See above for a detailed description of each behavior.

paths
Array of strings or null

A list of paths that match this Route.

preserve_host
boolean or null
Default: false

When matching a Route via one of the hosts domain names, use the request Host header in the upstream request headers. If set to false, the upstream Host header will be that of the Service's host.

protocols
Array of strings or null
Default: ["http","https"]
Enum: "grpc" "grpcs" "http" "https" "tcp" "tls" "tls_passthrough" "udp" "ws" "wss"

An array of the protocols this Route should allow. See the Route Object section for a list of accepted protocols. When set to only "https", HTTP requests are answered with an upgrade error. When set to only "http", HTTPS requests are answered with an error.

regex_priority
integer or null
Default: 0

A number used to choose which route resolves a given request when several routes match it using regexes simultaneously. When two routes match the path and have the same regex_priority, the older one (lowest created_at) is used. Note that the priority for non-regex routes is different (longer non-regex routes are matched before shorter ones).

request_buffering
boolean or null
Default: true

Whether to enable request body buffering or not. With HTTP 1.1, it may make sense to turn this off on services that receive data with chunked transfer encoding.

response_buffering
boolean or null
Default: true

Whether to enable response body buffering or not. With HTTP 1.1, it may make sense to turn this off on services that send data with chunked transfer encoding.

object or null

The Service this Route is associated to. This is where the Route proxies traffic to.

snis
Array of strings or null

A list of SNIs that match this Route when using stream routing.

Array of objects or null

A list of IP sources of incoming connections that match this Route when using stream routing. Each entry is an object with fields "ip" (optionally in CIDR range notation) and/or "port".

strip_path
boolean or null
Default: true

When matching a Route via one of the paths, strip the matching prefix from the upstream request URL.

tags
Array of strings

An optional set of strings associated with the Route for grouping and filtering.

updated_at
integer or null

Unix epoch when the resource was last updated.

Responses

Request samples

Content type
application/json
Example
{
  • "hosts": [
    ],
  • "id": "56c4566c-14cc-4132-9011-4139fcbbe50a",
  • "name": "example-route",
  • "paths": [
    ],
  • "service": {
    }
}

Response samples

Content type
application/json
Example
{
  • "hosts": [
    ],
  • "id": "56c4566c-14cc-4132-9011-4139fcbbe50a",
  • "name": "example-route",
  • "paths": [
    ],
  • "service": {
    }
}

Delete a Route

Delete a Route

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

RouteId
required
string
Example: a4326a41-aa12-44e3-93e4-6b6e58bfb9d7

ID of the Route to lookup

Responses

Response samples

Content type
application/json
Example
{
  • "message": "Duplicate API key found",
  • "status": 401
}

Fetch a Route

Get a Route using ID or name.

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
RouteId
required
string
Example: a4326a41-aa12-44e3-93e4-6b6e58bfb9d7

ID of the Route to lookup

controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

Responses

Response samples

Content type
application/json
Example
{
  • "hosts": [
    ],
  • "id": "56c4566c-14cc-4132-9011-4139fcbbe50a",
  • "name": "example-route",
  • "paths": [
    ],
  • "service": {
    }
}

Upsert a Route

Create or Update Route using ID or name.

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
RouteId
required
string
Example: a4326a41-aa12-44e3-93e4-6b6e58bfb9d7

ID of the Route to lookup

controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

Request Body schema: application/json

Description of the Route

One of
created_at
integer or null

Unix epoch when the resource was created.

Array of objects or null

A list of IP destinations of incoming connections that match this Route when using stream routing. Each entry is an object with fields "ip" (optionally in CIDR range notation) and/or "port".

object or null

One or more lists of values indexed by header name that will cause this Route to match if present in the request. The Host header cannot be used with this attribute: hosts should be specified using the hosts attribute. When headers contains only one value and that value starts with the special prefix ~*, the value is interpreted as a regular expression.

hosts
Array of strings or null

A list of domain names that match this Route. Note that the hosts value is case sensitive.

https_redirect_status_code
integer or null
Default: 426
Enum: 426 301 302 307 308

The status code Kong responds with when all properties of a Route match except the protocol i.e. if the protocol of the request is HTTP instead of HTTPS. Location header is injected by Kong if the field is set to 301, 302, 307 or 308. Note: This config applies only if the Route is configured to only accept the https protocol.

id
string or null
methods
Array of strings or null

A list of HTTP methods that match this Route.

name
string or null

The name of the Route. Route names must be unique, and they are case sensitive. For example, there can be two different Routes named "test" and "Test".

path_handling
string or null
Default: "v0"
Enum: "v0" "v1"

Controls how the Service path, Route path and requested path are combined when sending a request to the upstream. See above for a detailed description of each behavior.

paths
Array of strings or null

A list of paths that match this Route.

preserve_host
boolean or null
Default: false

When matching a Route via one of the hosts domain names, use the request Host header in the upstream request headers. If set to false, the upstream Host header will be that of the Service's host.

protocols
Array of strings or null
Default: ["http","https"]
Enum: "grpc" "grpcs" "http" "https" "tcp" "tls" "tls_passthrough" "udp" "ws" "wss"

An array of the protocols this Route should allow. See the Route Object section for a list of accepted protocols. When set to only "https", HTTP requests are answered with an upgrade error. When set to only "http", HTTPS requests are answered with an error.

regex_priority
integer or null
Default: 0

A number used to choose which route resolves a given request when several routes match it using regexes simultaneously. When two routes match the path and have the same regex_priority, the older one (lowest created_at) is used. Note that the priority for non-regex routes is different (longer non-regex routes are matched before shorter ones).

request_buffering
boolean or null
Default: true

Whether to enable request body buffering or not. With HTTP 1.1, it may make sense to turn this off on services that receive data with chunked transfer encoding.

response_buffering
boolean or null
Default: true

Whether to enable response body buffering or not. With HTTP 1.1, it may make sense to turn this off on services that send data with chunked transfer encoding.

object or null

The Service this Route is associated to. This is where the Route proxies traffic to.

snis
Array of strings or null

A list of SNIs that match this Route when using stream routing.

Array of objects or null

A list of IP sources of incoming connections that match this Route when using stream routing. Each entry is an object with fields "ip" (optionally in CIDR range notation) and/or "port".

strip_path
boolean or null
Default: true

When matching a Route via one of the paths, strip the matching prefix from the upstream request URL.

tags
Array of strings

An optional set of strings associated with the Route for grouping and filtering.

updated_at
integer or null

Unix epoch when the resource was last updated.

Responses

Request samples

Content type
application/json
Example
{
  • "hosts": [
    ],
  • "id": "56c4566c-14cc-4132-9011-4139fcbbe50a",
  • "name": "example-route",
  • "paths": [
    ],
  • "service": {
    }
}

Response samples

Content type
application/json
Example
{
  • "hosts": [
    ],
  • "id": "56c4566c-14cc-4132-9011-4139fcbbe50a",
  • "name": "example-route",
  • "paths": [
    ],
  • "service": {
    }
}

List all Routes associated with a Service

List all Routes associated with a Service

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

ServiceId
required
string
Example: 7fca84d6-7d37-4a74-a7b0-93e576089a41

ID of the Service to lookup

query Parameters
size
integer [ 1 .. 1000 ]
Default: 100

Number of resources to be returned.

offset
string

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

tags
string
Example: tags=tag1,tag2

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.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "next": "string",
  • "offset": "string"
}

Create a new Route associated with a Service

Create a new Route associated with a Service

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

ServiceId
required
string
Example: 7fca84d6-7d37-4a74-a7b0-93e576089a41

ID of the Service to lookup

Request Body schema: application/json

Description of new Route for creation

One of
created_at
integer or null

Unix epoch when the resource was created.

Array of objects or null

A list of IP destinations of incoming connections that match this Route when using stream routing. Each entry is an object with fields "ip" (optionally in CIDR range notation) and/or "port".

object or null

One or more lists of values indexed by header name that will cause this Route to match if present in the request. The Host header cannot be used with this attribute: hosts should be specified using the hosts attribute. When headers contains only one value and that value starts with the special prefix ~*, the value is interpreted as a regular expression.

hosts
Array of strings or null

A list of domain names that match this Route. Note that the hosts value is case sensitive.

https_redirect_status_code
integer or null
Default: 426
Enum: 426 301 302 307 308

The status code Kong responds with when all properties of a Route match except the protocol i.e. if the protocol of the request is HTTP instead of HTTPS. Location header is injected by Kong if the field is set to 301, 302, 307 or 308. Note: This config applies only if the Route is configured to only accept the https protocol.

id
string or null
methods
Array of strings or null

A list of HTTP methods that match this Route.

name
string or null

The name of the Route. Route names must be unique, and they are case sensitive. For example, there can be two different Routes named "test" and "Test".

path_handling
string or null
Default: "v0"
Enum: "v0" "v1"

Controls how the Service path, Route path and requested path are combined when sending a request to the upstream. See above for a detailed description of each behavior.

paths
Array of strings or null

A list of paths that match this Route.

preserve_host
boolean or null
Default: false

When matching a Route via one of the hosts domain names, use the request Host header in the upstream request headers. If set to false, the upstream Host header will be that of the Service's host.

protocols
Array of strings or null
Default: ["http","https"]
Enum: "grpc" "grpcs" "http" "https" "tcp" "tls" "tls_passthrough" "udp" "ws" "wss"

An array of the protocols this Route should allow. See the Route Object section for a list of accepted protocols. When set to only "https", HTTP requests are answered with an upgrade error. When set to only "http", HTTPS requests are answered with an error.

regex_priority
integer or null
Default: 0

A number used to choose which route resolves a given request when several routes match it using regexes simultaneously. When two routes match the path and have the same regex_priority, the older one (lowest created_at) is used. Note that the priority for non-regex routes is different (longer non-regex routes are matched before shorter ones).

request_buffering
boolean or null
Default: true

Whether to enable request body buffering or not. With HTTP 1.1, it may make sense to turn this off on services that receive data with chunked transfer encoding.

response_buffering
boolean or null
Default: true

Whether to enable response body buffering or not. With HTTP 1.1, it may make sense to turn this off on services that send data with chunked transfer encoding.

object or null

The Service this Route is associated to. This is where the Route proxies traffic to.

snis
Array of strings or null

A list of SNIs that match this Route when using stream routing.

Array of objects or null

A list of IP sources of incoming connections that match this Route when using stream routing. Each entry is an object with fields "ip" (optionally in CIDR range notation) and/or "port".

strip_path
boolean or null
Default: true

When matching a Route via one of the paths, strip the matching prefix from the upstream request URL.

tags
Array of strings

An optional set of strings associated with the Route for grouping and filtering.

updated_at
integer or null

Unix epoch when the resource was last updated.

Responses

Request samples

Content type
application/json
Example
{
  • "hosts": [
    ],
  • "id": "56c4566c-14cc-4132-9011-4139fcbbe50a",
  • "name": "example-route",
  • "paths": [
    ],
  • "service": {
    }
}

Response samples

Content type
application/json
Example
{
  • "hosts": [
    ],
  • "id": "56c4566c-14cc-4132-9011-4139fcbbe50a",
  • "name": "example-route",
  • "paths": [
    ],
  • "service": {
    }
}

Delete a a Route associated with a Service

Delete a a Route associated with a Service using ID or name.

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

ServiceId
required
string
Example: 7fca84d6-7d37-4a74-a7b0-93e576089a41

ID of the Service to lookup

RouteId
required
string
Example: a4326a41-aa12-44e3-93e4-6b6e58bfb9d7

ID of the Route to lookup

Responses

Fetch a Route associated with a Service

Get a Route associated with a Service using ID or name.

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

ServiceId
required
string
Example: 7fca84d6-7d37-4a74-a7b0-93e576089a41

ID of the Service to lookup

RouteId
required
string
Example: a4326a41-aa12-44e3-93e4-6b6e58bfb9d7

ID of the Route to lookup

Responses

Response samples

Content type
application/json
Example
{
  • "hosts": [
    ],
  • "id": "56c4566c-14cc-4132-9011-4139fcbbe50a",
  • "name": "example-route",
  • "paths": [
    ],
  • "service": {
    }
}

Upsert a Route associated with a Service

Create or Update a Route associated with a Service using ID or name.

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

ServiceId
required
string
Example: 7fca84d6-7d37-4a74-a7b0-93e576089a41

ID of the Service to lookup

RouteId
required
string
Example: a4326a41-aa12-44e3-93e4-6b6e58bfb9d7

ID of the Route to lookup

Request Body schema: application/json

Description of the Route

One of
created_at
integer or null

Unix epoch when the resource was created.

Array of objects or null

A list of IP destinations of incoming connections that match this Route when using stream routing. Each entry is an object with fields "ip" (optionally in CIDR range notation) and/or "port".

object or null

One or more lists of values indexed by header name that will cause this Route to match if present in the request. The Host header cannot be used with this attribute: hosts should be specified using the hosts attribute. When headers contains only one value and that value starts with the special prefix ~*, the value is interpreted as a regular expression.

hosts
Array of strings or null

A list of domain names that match this Route. Note that the hosts value is case sensitive.

https_redirect_status_code
integer or null
Default: 426
Enum: 426 301 302 307 308

The status code Kong responds with when all properties of a Route match except the protocol i.e. if the protocol of the request is HTTP instead of HTTPS. Location header is injected by Kong if the field is set to 301, 302, 307 or 308. Note: This config applies only if the Route is configured to only accept the https protocol.

id
string or null
methods
Array of strings or null

A list of HTTP methods that match this Route.

name
string or null

The name of the Route. Route names must be unique, and they are case sensitive. For example, there can be two different Routes named "test" and "Test".

path_handling
string or null
Default: "v0"
Enum: "v0" "v1"

Controls how the Service path, Route path and requested path are combined when sending a request to the upstream. See above for a detailed description of each behavior.

paths
Array of strings or null

A list of paths that match this Route.

preserve_host
boolean or null
Default: false

When matching a Route via one of the hosts domain names, use the request Host header in the upstream request headers. If set to false, the upstream Host header will be that of the Service's host.

protocols
Array of strings or null
Default: ["http","https"]
Enum: "grpc" "grpcs" "http" "https" "tcp" "tls" "tls_passthrough" "udp" "ws" "wss"

An array of the protocols this Route should allow. See the Route Object section for a list of accepted protocols. When set to only "https", HTTP requests are answered with an upgrade error. When set to only "http", HTTPS requests are answered with an error.

regex_priority
integer or null
Default: 0

A number used to choose which route resolves a given request when several routes match it using regexes simultaneously. When two routes match the path and have the same regex_priority, the older one (lowest created_at) is used. Note that the priority for non-regex routes is different (longer non-regex routes are matched before shorter ones).

request_buffering
boolean or null
Default: true

Whether to enable request body buffering or not. With HTTP 1.1, it may make sense to turn this off on services that receive data with chunked transfer encoding.

response_buffering
boolean or null
Default: true

Whether to enable response body buffering or not. With HTTP 1.1, it may make sense to turn this off on services that send data with chunked transfer encoding.

object or null

The Service this Route is associated to. This is where the Route proxies traffic to.

snis
Array of strings or null

A list of SNIs that match this Route when using stream routing.

Array of objects or null

A list of IP sources of incoming connections that match this Route when using stream routing. Each entry is an object with fields "ip" (optionally in CIDR range notation) and/or "port".

strip_path
boolean or null
Default: true

When matching a Route via one of the paths, strip the matching prefix from the upstream request URL.

tags
Array of strings

An optional set of strings associated with the Route for grouping and filtering.

updated_at
integer or null

Unix epoch when the resource was last updated.

Responses

Request samples

Content type
application/json
Example
{
  • "hosts": [
    ],
  • "id": "56c4566c-14cc-4132-9011-4139fcbbe50a",
  • "name": "example-route",
  • "paths": [
    ],
  • "service": {
    }
}

Response samples

Content type
application/json
Example
{
  • "hosts": [
    ],
  • "id": "56c4566c-14cc-4132-9011-4139fcbbe50a",
  • "name": "example-route",
  • "paths": [
    ],
  • "service": {
    }
}

Plugins

A plugin entity represents a plugin configuration that will be executed during the HTTP request/response lifecycle. Plugins let you add functionality to services that run behind a Kong Gateway instance, like authentication or rate limiting. You can find more information about available plugins and which values each plugin accepts at the Plugin Hub.

When adding a plugin configuration to a service, the plugin will run on every request made by a client to that service. If a plugin needs to be tuned to different values for some specific consumers, you can do so by creating a separate plugin instance that specifies both the service and the consumer, through the service and consumer fields.

Plugins can be both tagged and filtered by tags.

List all Plugins associated with a Consumer Group

List all Plugins associated with a Consumer Group

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

ConsumerGroupId
required
string

ID of the Consumer Group to lookup

query Parameters
size
integer [ 1 .. 1000 ]
Default: 100

Number of resources to be returned.

offset
string

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

tags
string
Example: tags=tag1,tag2

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.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "next": "string",
  • "offset": "string"
}

Create a new Plugin associated with a Consumer Group

Create a new Plugin associated with a Consumer Group

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

ConsumerGroupId
required
string

ID of the Consumer Group to lookup

Request Body schema: application/json

Description of new Plugin for creation

object or null

The configuration properties for the Plugin which can be found on the plugins documentation page in the Kong Hub.

object or null

If set, the plugin will activate only for requests where the specified has been authenticated. (Note that some plugins can not be restricted to consumers this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer.

object or null
created_at
integer or null

Unix epoch when the resource was created.

enabled
boolean or null
Default: true

Whether the plugin is applied.

id
string or null
instance_name
string or null
name
required
string

The name of the Plugin that's going to be added. Currently, the Plugin must be installed in every Kong instance separately.

object or null
Array of objects or null
protocols
Array of strings or null
Default: ["grpc","grpcs","http","https"]
Enum: "grpc" "grpcs" "http" "https" "tcp" "tls" "tls_passthrough" "udp" "ws" "wss"

A list of the request protocols that will trigger this plugin. The default value, as well as the possible values allowed on this field, may change depending on the plugin type. For example, plugins that only work in stream mode will only support "tcp" and "tls".

object or null

If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the Route being used.

object or null

If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.

tags
Array of strings

An optional set of strings associated with the Plugin for grouping and filtering.

updated_at
integer or null

Unix epoch when the resource was last updated.

Responses

Request samples

Content type
application/json
{
  • "config": {
    },
  • "enabled": true,
  • "id": "3fd1eea1-885a-4011-b986-289943ff8177",
  • "name": "key-auth",
  • "partials": [
    ],
  • "protocols": [
    ]
}

Response samples

Content type
application/json
{
  • "config": {
    },
  • "enabled": true,
  • "id": "3fd1eea1-885a-4011-b986-289943ff8177",
  • "name": "key-auth",
  • "partials": [
    ],
  • "protocols": [
    ]
}

Delete a a Plugin associated with a Consumer Group

Delete a a Plugin associated with a Consumer Group using ID.

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

ConsumerGroupId
required
string

ID of the Consumer Group to lookup

PluginId
required
string
Example: 3473c251-5b6c-4f45-b1ff-7ede735a366d

ID of the Plugin to lookup

Responses

Fetch a Plugin associated with a Consumer Group

Get a Plugin associated with a Consumer Group using ID.

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

ConsumerGroupId
required
string

ID of the Consumer Group to lookup

PluginId
required
string
Example: 3473c251-5b6c-4f45-b1ff-7ede735a366d

ID of the Plugin to lookup

Responses

Response samples

Content type
application/json
{
  • "config": {
    },
  • "enabled": true,
  • "id": "3fd1eea1-885a-4011-b986-289943ff8177",
  • "name": "key-auth",
  • "partials": [
    ],
  • "protocols": [
    ]
}

Upsert a Plugin associated with a Consumer Group

Create or Update a Plugin associated with a Consumer Group using ID.

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

ConsumerGroupId
required
string

ID of the Consumer Group to lookup

PluginId
required
string
Example: 3473c251-5b6c-4f45-b1ff-7ede735a366d

ID of the Plugin to lookup

Request Body schema: application/json

Description of the Plugin

object or null

The configuration properties for the Plugin which can be found on the plugins documentation page in the Kong Hub.

object or null

If set, the plugin will activate only for requests where the specified has been authenticated. (Note that some plugins can not be restricted to consumers this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer.

object or null
created_at
integer or null

Unix epoch when the resource was created.

enabled
boolean or null
Default: true

Whether the plugin is applied.

id
string or null
instance_name
string or null
name
required
string

The name of the Plugin that's going to be added. Currently, the Plugin must be installed in every Kong instance separately.

object or null
Array of objects or null
protocols
Array of strings or null
Default: ["grpc","grpcs","http","https"]
Enum: "grpc" "grpcs" "http" "https" "tcp" "tls" "tls_passthrough" "udp" "ws" "wss"

A list of the request protocols that will trigger this plugin. The default value, as well as the possible values allowed on this field, may change depending on the plugin type. For example, plugins that only work in stream mode will only support "tcp" and "tls".

object or null

If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the Route being used.

object or null

If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.

tags
Array of strings

An optional set of strings associated with the Plugin for grouping and filtering.

updated_at
integer or null

Unix epoch when the resource was last updated.

Responses

Request samples

Content type
application/json
{
  • "config": {
    },
  • "enabled": true,
  • "id": "3fd1eea1-885a-4011-b986-289943ff8177",
  • "name": "key-auth",
  • "partials": [
    ],
  • "protocols": [
    ]
}

Response samples

Content type
application/json
{
  • "config": {
    },
  • "enabled": true,
  • "id": "3fd1eea1-885a-4011-b986-289943ff8177",
  • "name": "key-auth",
  • "partials": [
    ],
  • "protocols": [
    ]
}

List all Plugins associated with a Consumer

List all Plugins associated with a Consumer

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

ConsumerIdForNestedEntities
required
string
Example: f28acbfa-c866-4587-b688-0208ac24df21

Consumer ID for nested entities

query Parameters
size
integer [ 1 .. 1000 ]
Default: 100

Number of resources to be returned.

offset
string

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

tags
string
Example: tags=tag1,tag2

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.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "next": "string",
  • "offset": "string"
}

Create a new Plugin associated with a Consumer

Create a new Plugin associated with a Consumer

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

ConsumerIdForNestedEntities
required
string
Example: f28acbfa-c866-4587-b688-0208ac24df21

Consumer ID for nested entities

Request Body schema: application/json

Description of new Plugin for creation

object or null

The configuration properties for the Plugin which can be found on the plugins documentation page in the Kong Hub.

object or null

If set, the plugin will activate only for requests where the specified has been authenticated. (Note that some plugins can not be restricted to consumers this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer.

object or null
created_at
integer or null

Unix epoch when the resource was created.

enabled
boolean or null
Default: true

Whether the plugin is applied.

id
string or null
instance_name
string or null
name
required
string

The name of the Plugin that's going to be added. Currently, the Plugin must be installed in every Kong instance separately.

object or null
Array of objects or null
protocols
Array of strings or null
Default: ["grpc","grpcs","http","https"]
Enum: "grpc" "grpcs" "http" "https" "tcp" "tls" "tls_passthrough" "udp" "ws" "wss"

A list of the request protocols that will trigger this plugin. The default value, as well as the possible values allowed on this field, may change depending on the plugin type. For example, plugins that only work in stream mode will only support "tcp" and "tls".

object or null

If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the Route being used.

object or null

If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.

tags
Array of strings

An optional set of strings associated with the Plugin for grouping and filtering.

updated_at
integer or null

Unix epoch when the resource was last updated.

Responses

Request samples

Content type
application/json
{
  • "config": {
    },
  • "enabled": true,
  • "id": "3fd1eea1-885a-4011-b986-289943ff8177",
  • "name": "key-auth",
  • "partials": [
    ],
  • "protocols": [
    ]
}

Response samples

Content type
application/json
{
  • "config": {
    },
  • "enabled": true,
  • "id": "3fd1eea1-885a-4011-b986-289943ff8177",
  • "name": "key-auth",
  • "partials": [
    ],
  • "protocols": [
    ]
}

Delete a a Plugin associated with a Consumer

Delete a a Plugin associated with a Consumer using ID.

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

ConsumerIdForNestedEntities
required
string
Example: f28acbfa-c866-4587-b688-0208ac24df21

Consumer ID for nested entities

PluginId
required
string
Example: 3473c251-5b6c-4f45-b1ff-7ede735a366d

ID of the Plugin to lookup

Responses

Fetch a Plugin associated with a Consumer

Get a Plugin associated with a Consumer using ID.

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

ConsumerIdForNestedEntities
required
string
Example: f28acbfa-c866-4587-b688-0208ac24df21

Consumer ID for nested entities

PluginId
required
string
Example: 3473c251-5b6c-4f45-b1ff-7ede735a366d

ID of the Plugin to lookup

Responses

Response samples

Content type
application/json
{
  • "config": {
    },
  • "enabled": true,
  • "id": "3fd1eea1-885a-4011-b986-289943ff8177",
  • "name": "key-auth",
  • "partials": [
    ],
  • "protocols": [
    ]
}

Upsert a Plugin associated with a Consumer

Create or Update a Plugin associated with a Consumer using ID.

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

ConsumerIdForNestedEntities
required
string
Example: f28acbfa-c866-4587-b688-0208ac24df21

Consumer ID for nested entities

PluginId
required
string
Example: 3473c251-5b6c-4f45-b1ff-7ede735a366d

ID of the Plugin to lookup

Request Body schema: application/json

Description of the Plugin

object or null

The configuration properties for the Plugin which can be found on the plugins documentation page in the Kong Hub.

object or null

If set, the plugin will activate only for requests where the specified has been authenticated. (Note that some plugins can not be restricted to consumers this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer.

object or null
created_at
integer or null

Unix epoch when the resource was created.

enabled
boolean or null
Default: true

Whether the plugin is applied.

id
string or null
instance_name
string or null
name
required
string

The name of the Plugin that's going to be added. Currently, the Plugin must be installed in every Kong instance separately.

object or null
Array of objects or null
protocols
Array of strings or null
Default: ["grpc","grpcs","http","https"]
Enum: "grpc" "grpcs" "http" "https" "tcp" "tls" "tls_passthrough" "udp" "ws" "wss"

A list of the request protocols that will trigger this plugin. The default value, as well as the possible values allowed on this field, may change depending on the plugin type. For example, plugins that only work in stream mode will only support "tcp" and "tls".

object or null

If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the Route being used.

object or null

If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.

tags
Array of strings

An optional set of strings associated with the Plugin for grouping and filtering.

updated_at
integer or null

Unix epoch when the resource was last updated.

Responses

Request samples

Content type
application/json
{
  • "config": {
    },
  • "enabled": true,
  • "id": "3fd1eea1-885a-4011-b986-289943ff8177",
  • "name": "key-auth",
  • "partials": [
    ],
  • "protocols": [
    ]
}

Response samples

Content type
application/json
{
  • "config": {
    },
  • "enabled": true,
  • "id": "3fd1eea1-885a-4011-b986-289943ff8177",
  • "name": "key-auth",
  • "partials": [
    ],
  • "protocols": [
    ]
}

List all Plugins

List all Plugins

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

query Parameters
size
integer [ 1 .. 1000 ]
Default: 100

Number of resources to be returned.

offset
string

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

tags
string
Example: tags=tag1,tag2

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.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "next": "string",
  • "offset": "string"
}

Create a new Plugin

Create a new Plugin

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

Request Body schema: application/json

Description of the new Plugin for creation

object or null

The configuration properties for the Plugin which can be found on the plugins documentation page in the Kong Hub.

object or null

If set, the plugin will activate only for requests where the specified has been authenticated. (Note that some plugins can not be restricted to consumers this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer.

object or null
created_at
integer or null

Unix epoch when the resource was created.

enabled
boolean or null
Default: true

Whether the plugin is applied.

id
string or null
instance_name
string or null
name
required
string

The name of the Plugin that's going to be added. Currently, the Plugin must be installed in every Kong instance separately.

object or null
Array of objects or null
protocols
Array of strings or null
Default: ["grpc","grpcs","http","https"]
Enum: "grpc" "grpcs" "http" "https" "tcp" "tls" "tls_passthrough" "udp" "ws" "wss"

A list of the request protocols that will trigger this plugin. The default value, as well as the possible values allowed on this field, may change depending on the plugin type. For example, plugins that only work in stream mode will only support "tcp" and "tls".

object or null

If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the Route being used.

object or null

If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.

tags
Array of strings

An optional set of strings associated with the Plugin for grouping and filtering.

updated_at
integer or null

Unix epoch when the resource was last updated.

Responses

Request samples

Content type
application/json
{
  • "config": {
    },
  • "enabled": true,
  • "id": "3fd1eea1-885a-4011-b986-289943ff8177",
  • "name": "key-auth",
  • "partials": [
    ],
  • "protocols": [
    ]
}

Response samples

Content type
application/json
{
  • "config": {
    },
  • "enabled": true,
  • "id": "3fd1eea1-885a-4011-b986-289943ff8177",
  • "name": "key-auth",
  • "partials": [
    ],
  • "protocols": [
    ]
}

Delete a Plugin

Delete a Plugin

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

PluginId
required
string
Example: 3473c251-5b6c-4f45-b1ff-7ede735a366d

ID of the Plugin to lookup

Responses

Response samples

Content type
application/json
Example
{
  • "message": "Duplicate API key found",
  • "status": 401
}

Fetch a Plugin

Get a Plugin using ID.

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
PluginId
required
string
Example: 3473c251-5b6c-4f45-b1ff-7ede735a366d

ID of the Plugin to lookup

controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

Responses

Response samples

Content type
application/json
{
  • "config": {
    },
  • "enabled": true,
  • "id": "3fd1eea1-885a-4011-b986-289943ff8177",
  • "name": "key-auth",
  • "partials": [
    ],
  • "protocols": [
    ]
}

Upsert a Plugin

Create or Update Plugin using ID.

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
PluginId
required
string
Example: 3473c251-5b6c-4f45-b1ff-7ede735a366d

ID of the Plugin to lookup

controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

Request Body schema: application/json

Description of the Plugin

object or null

The configuration properties for the Plugin which can be found on the plugins documentation page in the Kong Hub.

object or null

If set, the plugin will activate only for requests where the specified has been authenticated. (Note that some plugins can not be restricted to consumers this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer.

object or null
created_at
integer or null

Unix epoch when the resource was created.

enabled
boolean or null
Default: true

Whether the plugin is applied.

id
string or null
instance_name
string or null
name
required
string

The name of the Plugin that's going to be added. Currently, the Plugin must be installed in every Kong instance separately.

object or null
Array of objects or null
protocols
Array of strings or null
Default: ["grpc","grpcs","http","https"]
Enum: "grpc" "grpcs" "http" "https" "tcp" "tls" "tls_passthrough" "udp" "ws" "wss"

A list of the request protocols that will trigger this plugin. The default value, as well as the possible values allowed on this field, may change depending on the plugin type. For example, plugins that only work in stream mode will only support "tcp" and "tls".

object or null

If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the Route being used.

object or null

If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.

tags
Array of strings

An optional set of strings associated with the Plugin for grouping and filtering.

updated_at
integer or null

Unix epoch when the resource was last updated.

Responses

Request samples

Content type
application/json
{
  • "config": {
    },
  • "enabled": true,
  • "id": "3fd1eea1-885a-4011-b986-289943ff8177",
  • "name": "key-auth",
  • "partials": [
    ],
  • "protocols": [
    ]
}

Response samples

Content type
application/json
{
  • "config": {
    },
  • "enabled": true,
  • "id": "3fd1eea1-885a-4011-b986-289943ff8177",
  • "name": "key-auth",
  • "partials": [
    ],
  • "protocols": [
    ]
}

List all Plugins associated with a Route

List all Plugins associated with a Route

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

RouteId
required
string
Example: a4326a41-aa12-44e3-93e4-6b6e58bfb9d7

ID of the Route to lookup

query Parameters
size
integer [ 1 .. 1000 ]
Default: 100

Number of resources to be returned.

offset
string

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

tags
string
Example: tags=tag1,tag2

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.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "next": "string",
  • "offset": "string"
}

Create a new Plugin associated with a Route

Create a new Plugin associated with a Route

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

RouteId
required
string
Example: a4326a41-aa12-44e3-93e4-6b6e58bfb9d7

ID of the Route to lookup

Request Body schema: application/json

Description of new Plugin for creation

object or null

The configuration properties for the Plugin which can be found on the plugins documentation page in the Kong Hub.

object or null

If set, the plugin will activate only for requests where the specified has been authenticated. (Note that some plugins can not be restricted to consumers this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer.

object or null
created_at
integer or null

Unix epoch when the resource was created.

enabled
boolean or null
Default: true

Whether the plugin is applied.

id
string or null
instance_name
string or null
name
required
string

The name of the Plugin that's going to be added. Currently, the Plugin must be installed in every Kong instance separately.

object or null
Array of objects or null
protocols
Array of strings or null
Default: ["grpc","grpcs","http","https"]
Enum: "grpc" "grpcs" "http" "https" "tcp" "tls" "tls_passthrough" "udp" "ws" "wss"

A list of the request protocols that will trigger this plugin. The default value, as well as the possible values allowed on this field, may change depending on the plugin type. For example, plugins that only work in stream mode will only support "tcp" and "tls".

object or null

If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the Route being used.

object or null

If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.

tags
Array of strings

An optional set of strings associated with the Plugin for grouping and filtering.

updated_at
integer or null

Unix epoch when the resource was last updated.

Responses

Request samples

Content type
application/json
{
  • "config": {
    },
  • "enabled": true,
  • "id": "3fd1eea1-885a-4011-b986-289943ff8177",
  • "name": "key-auth",
  • "partials": [
    ],
  • "protocols": [
    ]
}

Response samples

Content type
application/json
{
  • "config": {
    },
  • "enabled": true,
  • "id": "3fd1eea1-885a-4011-b986-289943ff8177",
  • "name": "key-auth",
  • "partials": [
    ],
  • "protocols": [
    ]
}

Delete a a Plugin associated with a Route

Delete a a Plugin associated with a Route using ID.

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

RouteId
required
string
Example: a4326a41-aa12-44e3-93e4-6b6e58bfb9d7

ID of the Route to lookup

PluginId
required
string
Example: 3473c251-5b6c-4f45-b1ff-7ede735a366d

ID of the Plugin to lookup

Responses

Fetch a Plugin associated with a Route

Get a Plugin associated with a Route using ID.

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

RouteId
required
string
Example: a4326a41-aa12-44e3-93e4-6b6e58bfb9d7

ID of the Route to lookup

PluginId
required
string
Example: 3473c251-5b6c-4f45-b1ff-7ede735a366d

ID of the Plugin to lookup

Responses

Response samples

Content type
application/json
{
  • "config": {
    },
  • "enabled": true,
  • "id": "3fd1eea1-885a-4011-b986-289943ff8177",
  • "name": "key-auth",
  • "partials": [
    ],
  • "protocols": [
    ]
}

Upsert a Plugin associated with a Route

Create or Update a Plugin associated with a Route using ID.

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

RouteId
required
string
Example: a4326a41-aa12-44e3-93e4-6b6e58bfb9d7

ID of the Route to lookup

PluginId
required
string
Example: 3473c251-5b6c-4f45-b1ff-7ede735a366d

ID of the Plugin to lookup

Request Body schema: application/json

Description of the Plugin

object or null

The configuration properties for the Plugin which can be found on the plugins documentation page in the Kong Hub.

object or null

If set, the plugin will activate only for requests where the specified has been authenticated. (Note that some plugins can not be restricted to consumers this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer.

object or null
created_at
integer or null

Unix epoch when the resource was created.

enabled
boolean or null
Default: true

Whether the plugin is applied.

id
string or null
instance_name
string or null
name
required
string

The name of the Plugin that's going to be added. Currently, the Plugin must be installed in every Kong instance separately.

object or null
Array of objects or null
protocols
Array of strings or null
Default: ["grpc","grpcs","http","https"]
Enum: "grpc" "grpcs" "http" "https" "tcp" "tls" "tls_passthrough" "udp" "ws" "wss"

A list of the request protocols that will trigger this plugin. The default value, as well as the possible values allowed on this field, may change depending on the plugin type. For example, plugins that only work in stream mode will only support "tcp" and "tls".

object or null

If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the Route being used.

object or null

If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.

tags
Array of strings

An optional set of strings associated with the Plugin for grouping and filtering.

updated_at
integer or null

Unix epoch when the resource was last updated.

Responses

Request samples

Content type
application/json
{
  • "config": {
    },
  • "enabled": true,
  • "id": "3fd1eea1-885a-4011-b986-289943ff8177",
  • "name": "key-auth",
  • "partials": [
    ],
  • "protocols": [
    ]
}

Response samples

Content type
application/json
{
  • "config": {
    },
  • "enabled": true,
  • "id": "3fd1eea1-885a-4011-b986-289943ff8177",
  • "name": "key-auth",
  • "partials": [
    ],
  • "protocols": [
    ]
}

Fetch plugin schema

Get the schema for a plugin

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
pluginName
required
string

The name of the plugin

controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

Responses

Response samples

Content type
application/json
{
  • "fields": [
    ]
}

List all Plugins associated with a Service

List all Plugins associated with a Service

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

ServiceId
required
string
Example: 7fca84d6-7d37-4a74-a7b0-93e576089a41

ID of the Service to lookup

query Parameters
size
integer [ 1 .. 1000 ]
Default: 100

Number of resources to be returned.

offset
string

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

tags
string
Example: tags=tag1,tag2

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.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "next": "string",
  • "offset": "string"
}

Create a new Plugin associated with a Service

Create a new Plugin associated with a Service

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

ServiceId
required
string
Example: 7fca84d6-7d37-4a74-a7b0-93e576089a41

ID of the Service to lookup

Request Body schema: application/json

Description of new Plugin for creation

object or null

The configuration properties for the Plugin which can be found on the plugins documentation page in the Kong Hub.

object or null

If set, the plugin will activate only for requests where the specified has been authenticated. (Note that some plugins can not be restricted to consumers this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer.

object or null
created_at
integer or null

Unix epoch when the resource was created.

enabled
boolean or null
Default: true

Whether the plugin is applied.

id
string or null
instance_name
string or null
name
required
string

The name of the Plugin that's going to be added. Currently, the Plugin must be installed in every Kong instance separately.

object or null
Array of objects or null
protocols
Array of strings or null
Default: ["grpc","grpcs","http","https"]
Enum: "grpc" "grpcs" "http" "https" "tcp" "tls" "tls_passthrough" "udp" "ws" "wss"

A list of the request protocols that will trigger this plugin. The default value, as well as the possible values allowed on this field, may change depending on the plugin type. For example, plugins that only work in stream mode will only support "tcp" and "tls".

object or null

If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the Route being used.

object or null

If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.

tags
Array of strings

An optional set of strings associated with the Plugin for grouping and filtering.

updated_at
integer or null

Unix epoch when the resource was last updated.

Responses

Request samples

Content type
application/json
{
  • "config": {
    },
  • "enabled": true,
  • "id": "3fd1eea1-885a-4011-b986-289943ff8177",
  • "name": "key-auth",
  • "partials": [
    ],
  • "protocols": [
    ]
}

Response samples

Content type
application/json
{
  • "config": {
    },
  • "enabled": true,
  • "id": "3fd1eea1-885a-4011-b986-289943ff8177",
  • "name": "key-auth",
  • "partials": [
    ],
  • "protocols": [
    ]
}

Delete a a Plugin associated with a Service

Delete a a Plugin associated with a Service using ID.

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

ServiceId
required
string
Example: 7fca84d6-7d37-4a74-a7b0-93e576089a41

ID of the Service to lookup

PluginId
required
string
Example: 3473c251-5b6c-4f45-b1ff-7ede735a366d

ID of the Plugin to lookup

Responses

Fetch a Plugin associated with a Service

Get a Plugin associated with a Service using ID.

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

ServiceId
required
string
Example: 7fca84d6-7d37-4a74-a7b0-93e576089a41

ID of the Service to lookup

PluginId
required
string
Example: 3473c251-5b6c-4f45-b1ff-7ede735a366d

ID of the Plugin to lookup

Responses

Response samples

Content type
application/json
{
  • "config": {
    },
  • "enabled": true,
  • "id": "3fd1eea1-885a-4011-b986-289943ff8177",
  • "name": "key-auth",
  • "partials": [
    ],
  • "protocols": [
    ]
}

Upsert a Plugin associated with a Service

Create or Update a Plugin associated with a Service using ID.

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

ServiceId
required
string
Example: 7fca84d6-7d37-4a74-a7b0-93e576089a41

ID of the Service to lookup

PluginId
required
string
Example: 3473c251-5b6c-4f45-b1ff-7ede735a366d

ID of the Plugin to lookup

Request Body schema: application/json

Description of the Plugin

object or null

The configuration properties for the Plugin which can be found on the plugins documentation page in the Kong Hub.

object or null

If set, the plugin will activate only for requests where the specified has been authenticated. (Note that some plugins can not be restricted to consumers this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer.

object or null
created_at
integer or null

Unix epoch when the resource was created.

enabled
boolean or null
Default: true

Whether the plugin is applied.

id
string or null
instance_name
string or null
name
required
string

The name of the Plugin that's going to be added. Currently, the Plugin must be installed in every Kong instance separately.

object or null
Array of objects or null
protocols
Array of strings or null
Default: ["grpc","grpcs","http","https"]
Enum: "grpc" "grpcs" "http" "https" "tcp" "tls" "tls_passthrough" "udp" "ws" "wss"

A list of the request protocols that will trigger this plugin. The default value, as well as the possible values allowed on this field, may change depending on the plugin type. For example, plugins that only work in stream mode will only support "tcp" and "tls".

object or null

If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the Route being used.

object or null

If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.

tags
Array of strings

An optional set of strings associated with the Plugin for grouping and filtering.

updated_at
integer or null

Unix epoch when the resource was last updated.

Responses

Request samples

Content type
application/json
{
  • "config": {
    },
  • "enabled": true,
  • "id": "3fd1eea1-885a-4011-b986-289943ff8177",
  • "name": "key-auth",
  • "partials": [
    ],
  • "protocols": [
    ]
}

Response samples

Content type
application/json
{
  • "config": {
    },
  • "enabled": true,
  • "id": "3fd1eea1-885a-4011-b986-289943ff8177",
  • "name": "key-auth",
  • "partials": [
    ],
  • "protocols": [
    ]
}

Consumers

The consumer object represents a consumer - or a user - of a service. You can either rely on Kong Gateway as the primary datastore, or you can map the consumer list with your database to keep consistency between Kong Gateway and your existing primary datastore.

List all Consumers

List all Consumers

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

query Parameters
size
integer [ 1 .. 1000 ]
Default: 100

Number of resources to be returned.

offset
string

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

tags
string
Example: tags=tag1,tag2

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.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "next": "string",
  • "offset": "string"
}

Create a new Consumer

Create a new Consumer

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

Request Body schema: application/json

Description of the new Consumer for creation

created_at
integer or null

Unix epoch when the resource was created.

custom_id
string or null

Field for storing an existing unique ID for the Consumer - useful for mapping Kong with users in your existing database. You must send either this field or username with the request.

id
string or null
tags
Array of strings

An optional set of strings associated with the Consumer for grouping and filtering.

updated_at
integer or null

Unix epoch when the resource was last updated.

username
string or null

The unique username of the Consumer. You must send either this field or custom_id with the request.

Responses

Request samples

Content type
application/json
{
  • "custom_id": "4200",
  • "id": "8a388226-80e8-4027-a486-25e4f7db5d21",
  • "tags": [
    ],
  • "username": "bob-the-builder"
}

Response samples

Content type
application/json
{
  • "custom_id": "4200",
  • "id": "8a388226-80e8-4027-a486-25e4f7db5d21",
  • "tags": [
    ],
  • "username": "bob-the-builder"
}

Delete a Consumer

Delete a Consumer

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

ConsumerId
required
string
Example: c1059869-6fa7-4329-a5f5-5946d14ca2c5

ID of the Consumer to lookup

Responses

Response samples

Content type
application/json
Example
{
  • "message": "Duplicate API key found",
  • "status": 401
}

Fetch a Consumer

Get a Consumer using ID or username.

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
ConsumerId
required
string
Example: c1059869-6fa7-4329-a5f5-5946d14ca2c5

ID of the Consumer to lookup

controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

Responses

Response samples

Content type
application/json
{
  • "custom_id": "4200",
  • "id": "8a388226-80e8-4027-a486-25e4f7db5d21",
  • "tags": [
    ],
  • "username": "bob-the-builder"
}

Upsert a Consumer

Create or Update Consumer using ID or username.

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
ConsumerId
required
string
Example: c1059869-6fa7-4329-a5f5-5946d14ca2c5

ID of the Consumer to lookup

controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

Request Body schema: application/json

Description of the Consumer

created_at
integer or null

Unix epoch when the resource was created.

custom_id
string or null

Field for storing an existing unique ID for the Consumer - useful for mapping Kong with users in your existing database. You must send either this field or username with the request.

id
string or null
tags
Array of strings

An optional set of strings associated with the Consumer for grouping and filtering.

updated_at
integer or null

Unix epoch when the resource was last updated.

username
string or null

The unique username of the Consumer. You must send either this field or custom_id with the request.

Responses

Request samples

Content type
application/json
{
  • "custom_id": "4200",
  • "id": "8a388226-80e8-4027-a486-25e4f7db5d21",
  • "tags": [
    ],
  • "username": "bob-the-builder"
}

Response samples

Content type
application/json
{
  • "custom_id": "4200",
  • "id": "8a388226-80e8-4027-a486-25e4f7db5d21",
  • "tags": [
    ],
  • "username": "bob-the-builder"
}

Consumer Groups

Consumer groups enable the organization and categorization of consumers (users or applications) within an API ecosystem. By grouping consumers together, you eliminate the need to manage them individually, providing a scalable, efficient approach to managing configurations.

List all Consumer Groups

List all Consumer Groups

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

query Parameters
size
integer [ 1 .. 1000 ]
Default: 100

Number of resources to be returned.

offset
string

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

tags
string
Example: tags=tag1,tag2

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.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "next": "string",
  • "offset": "string"
}

Create a new Consumer Group

Create a new Consumer Group

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

Request Body schema: application/json

Description of the new Consumer Group for creation

created_at
integer or null

Unix epoch when the resource was created.

id
string or null
name
required
string
tags
Array of strings
updated_at
integer or null

Unix epoch when the resource was last updated.

Responses

Request samples

Content type
application/json
{
  • "created_at": 0,
  • "id": "string",
  • "name": "string",
  • "tags": [
    ],
  • "updated_at": 0
}

Response samples

Content type
application/json
{
  • "created_at": 0,
  • "id": "string",
  • "name": "string",
  • "tags": [
    ],
  • "updated_at": 0
}

Delete a Consumer Group

Delete a Consumer Group

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

ConsumerGroupId
required
string

ID of the Consumer Group to lookup

Responses

Response samples

Content type
application/json
Example
{
  • "message": "Duplicate API key found",
  • "status": 401
}

Fetch a Consumer Group

Get a Consumer Group using ID.

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
ConsumerGroupId
required
string

ID of the Consumer Group to lookup

controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

Responses

Response samples

Content type
application/json
{
  • "consumer_group": {
    }
}

Upsert a Consumer Group

Create or Update Consumer Group using ID.

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
ConsumerGroupId
required
string

ID of the Consumer Group to lookup

controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

Request Body schema: application/json

Description of the Consumer Group

created_at
integer or null

Unix epoch when the resource was created.

id
string or null
name
required
string
tags
Array of strings
updated_at
integer or null

Unix epoch when the resource was last updated.

Responses

Request samples

Content type
application/json
{
  • "created_at": 0,
  • "id": "string",
  • "name": "string",
  • "tags": [
    ],
  • "updated_at": 0
}

Response samples

Content type
application/json
{
  • "created_at": 0,
  • "id": "string",
  • "name": "string",
  • "tags": [
    ],
  • "updated_at": 0
}

Remove consumers from consumer group

Pre-release Endpoint This endpoint is currently in beta and is subject to change.

Removes all consumers from a consumer groups. This operation does not delete the consumer group.

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
ConsumerGroupId
required
string
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

Responses

List all Consumers in a Consumer Group

List all consumers in a consumer group

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
ConsumerGroupId
required
string
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

query Parameters
size
integer [ 1 .. 1000 ]
Default: 100

Number of resources to be returned.

offset
string

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

tags
string
Example: tags=tag1,tag2

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.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "next": "string",
  • "offset": "string"
}

Add consumer to consumer group

Add a consumer to a consumer group

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
ConsumerGroupId
required
string
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

Request Body schema: application/json
consumer
string

Responses

Request samples

Content type
application/json
{
  • "consumer": "cf4c7e60-11db-49dd-b300-7c7e5f0f7e6b"
}

Response samples

Content type
application/json
{
  • "consumer_group": {
    },
  • "consumers": [
    ]
}

Remove consumer from consumer group

Remove a consumer from a consumer group

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
ConsumerGroupId
required
string
ConsumerId
required
string
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

Responses

Remove consumer from consumer group

Removes a consumer from all consumer groups. This operation does not delete the consumer group.

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

ConsumerId
required
string
Example: c1059869-6fa7-4329-a5f5-5946d14ca2c5

ID of the Consumer to lookup

Responses

List all Consumer Groups a Consumer belongs to

List all Consumer Groups a Consumer belongs to

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

ConsumerId
required
string
Example: c1059869-6fa7-4329-a5f5-5946d14ca2c5

ID of the Consumer to lookup

query Parameters
size
integer [ 1 .. 1000 ]
Default: 100

Number of resources to be returned.

offset
string

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

tags
string
Example: tags=tag1,tag2

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.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "next": "string",
  • "offset": "string"
}

Add consumer to a specific consumer group

Add a consumer to a consumer group

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

ConsumerId
required
string
Example: c1059869-6fa7-4329-a5f5-5946d14ca2c5

ID of the Consumer to lookup

Request Body schema: application/json
group
string

Responses

Request samples

Content type
application/json
{
  • "group": "fedee695-2ae2-4e45-877a-776d9b2fc793"
}

Response samples

Content type
application/json
{
  • "consumer": {
    },
  • "consumer_groups": [
    ]
}

Remove consumer from consumer group

Removes a consumer from a consumer group. This operation does not delete the consumer group.

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

ConsumerId
required
string
Example: c1059869-6fa7-4329-a5f5-5946d14ca2c5

ID of the Consumer to lookup

ConsumerGroupId
required
string

ID of the Consumer Group to lookup

Responses

Certificates

A certificate object represents a public certificate, and can be optionally paired with the corresponding private key. These objects are used by Kong Gateway to handle SSL/TLS termination for encrypted requests, or for use as a trusted CA store when validating peer certificate of client/service.

Certificates are optionally associated with SNI objects to tie a cert/key pair to one or more hostnames.

If intermediate certificates are required in addition to the main certificate, they should be concatenated together into one string.

List all Certificates

List all Certificates

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

query Parameters
size
integer [ 1 .. 1000 ]
Default: 100

Number of resources to be returned.

offset
string

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

tags
string
Example: tags=tag1,tag2

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.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "next": "string",
  • "offset": "string"
}

Create a new Certificate

Create a new Certificate

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

Request Body schema: application/json

Description of the new Certificate for creation

cert
required
string

PEM-encoded public certificate chain of the SSL key pair. This field is referenceable, which means it can be securely stored as a secret in a vault. References must follow a specific format.

cert_alt
string or null

PEM-encoded public certificate chain of the alternate SSL key pair. This should only be set if you have both RSA and ECDSA types of certificate available and would like Kong to prefer serving using ECDSA certs when client advertises support for it. This field is referenceable, which means it can be securely stored as a secret in a vault. References must follow a specific format.

created_at
integer or null

Unix epoch when the resource was created.

id
string or null
key
required
string

PEM-encoded private key of the SSL key pair. This field is referenceable, which means it can be securely stored as a secret in a vault. References must follow a specific format.

key_alt
string or null

PEM-encoded private key of the alternate SSL key pair. This should only be set if you have both RSA and ECDSA types of certificate available and would like Kong to prefer serving using ECDSA certs when client advertises support for it. This field is referenceable, which means it can be securely stored as a secret in a vault. References must follow a specific format.

snis
Array of strings or null
tags
Array of strings

An optional set of strings associated with the Certificate for grouping and filtering.

updated_at
integer or null

Unix epoch when the resource was last updated.

Responses

Request samples

Content type
application/json
{
  • "cert": "-----BEGIN CERTIFICATE-----\ncertificate-content\n-----END CERTIFICATE-----",
  • "id": "b2f34145-0343-41a4-9602-4c69dec2f269",
  • "key": "-----BEGIN PRIVATE KEY-----\nprivate-key-content\n-----END PRIVATE KEY-----"
}

Response samples

Content type
application/json
{
  • "cert": "-----BEGIN CERTIFICATE-----\ncertificate-content\n-----END CERTIFICATE-----",
  • "id": "b2f34145-0343-41a4-9602-4c69dec2f269",
  • "key": "-----BEGIN PRIVATE KEY-----\nprivate-key-content\n-----END PRIVATE KEY-----"
}

Delete a Certificate

Delete a Certificate

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

CertificateId
required
string
Example: ddf3cdaa-3329-4961-822a-ce6dbd38eff7

ID of the Certificate to lookup

Responses

Response samples

Content type
application/json
Example
{
  • "message": "Duplicate API key found",
  • "status": 401
}

Fetch a Certificate

Get a Certificate using ID.

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
CertificateId
required
string
Example: ddf3cdaa-3329-4961-822a-ce6dbd38eff7

ID of the Certificate to lookup

controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

Responses

Response samples

Content type
application/json
{
  • "cert": "-----BEGIN CERTIFICATE-----\ncertificate-content\n-----END CERTIFICATE-----",
  • "id": "b2f34145-0343-41a4-9602-4c69dec2f269",
  • "key": "-----BEGIN PRIVATE KEY-----\nprivate-key-content\n-----END PRIVATE KEY-----"
}

Upsert a Certificate

Create or Update Certificate using ID.

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
CertificateId
required
string
Example: ddf3cdaa-3329-4961-822a-ce6dbd38eff7

ID of the Certificate to lookup

controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

Request Body schema: application/json

Description of the Certificate

cert
required
string

PEM-encoded public certificate chain of the SSL key pair. This field is referenceable, which means it can be securely stored as a secret in a vault. References must follow a specific format.

cert_alt
string or null

PEM-encoded public certificate chain of the alternate SSL key pair. This should only be set if you have both RSA and ECDSA types of certificate available and would like Kong to prefer serving using ECDSA certs when client advertises support for it. This field is referenceable, which means it can be securely stored as a secret in a vault. References must follow a specific format.

created_at
integer or null

Unix epoch when the resource was created.

id
string or null
key
required
string

PEM-encoded private key of the SSL key pair. This field is referenceable, which means it can be securely stored as a secret in a vault. References must follow a specific format.

key_alt
string or null

PEM-encoded private key of the alternate SSL key pair. This should only be set if you have both RSA and ECDSA types of certificate available and would like Kong to prefer serving using ECDSA certs when client advertises support for it. This field is referenceable, which means it can be securely stored as a secret in a vault. References must follow a specific format.

snis
Array of strings or null
tags
Array of strings

An optional set of strings associated with the Certificate for grouping and filtering.

updated_at
integer or null

Unix epoch when the resource was last updated.

Responses

Request samples

Content type
application/json
{
  • "cert": "-----BEGIN CERTIFICATE-----\ncertificate-content\n-----END CERTIFICATE-----",
  • "id": "b2f34145-0343-41a4-9602-4c69dec2f269",
  • "key": "-----BEGIN PRIVATE KEY-----\nprivate-key-content\n-----END PRIVATE KEY-----"
}

Response samples

Content type
application/json
{
  • "cert": "-----BEGIN CERTIFICATE-----\ncertificate-content\n-----END CERTIFICATE-----",
  • "id": "b2f34145-0343-41a4-9602-4c69dec2f269",
  • "key": "-----BEGIN PRIVATE KEY-----\nprivate-key-content\n-----END PRIVATE KEY-----"
}

SNIs

An SNI object represents a many-to-one mapping of hostnames to a certificate.

A certificate object can have many hostnames associated with it. When Kong Gateway receives an SSL request, it uses the SNI field in the Client Hello to look up the certificate object based on the SNI associated with the certificate.

List all SNIs associated with a Certificate

List all SNIs associated with a Certificate

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

CertificateId
required
string
Example: ddf3cdaa-3329-4961-822a-ce6dbd38eff7

ID of the Certificate to lookup

query Parameters
size
integer [ 1 .. 1000 ]
Default: 100

Number of resources to be returned.

offset
string

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

tags
string
Example: tags=tag1,tag2

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.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "next": "string",
  • "offset": "string"
}

Create a new SNI associated with a Certificate

Create a new SNI associated with a Certificate

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

CertificateId
required
string
Example: ddf3cdaa-3329-4961-822a-ce6dbd38eff7

ID of the Certificate to lookup

Request Body schema: application/json

Description of new SNI for creation

object

The id (a UUID) of the certificate with which to associate the SNI hostname. The Certificate must have a valid private key associated with it to be used by the SNI object.

created_at
integer or null

Unix epoch when the resource was created.

id
string or null
name
required
string

The SNI name to associate with the given certificate.

tags
Array of strings

An optional set of strings associated with the SNIs for grouping and filtering.

updated_at
integer or null

Unix epoch when the resource was last updated.

Responses

Request samples

Content type
application/json
{
  • "id": "36c4566c-14cc-4132-9011-4139fcbbe50a",
  • "name": "some.example.org"
}

Response samples

Content type
application/json
{
  • "certificate": {
    },
  • "id": "36c4566c-14cc-4132-9011-4139fcbbe50a",
  • "name": "some.example.org"
}

Delete a an SNI associated with a Certificate

Delete a an SNI associated with a Certificate using ID or name.

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

CertificateId
required
string
Example: ddf3cdaa-3329-4961-822a-ce6dbd38eff7

ID of the Certificate to lookup

SNIId
required
string
Example: 64c17a1a-b7d7-4a65-a5a4-42e4a7016e7f

ID of the SNI to lookup

Responses

Fetch an SNI associated with a Certificate

Get an SNI associated with a Certificate using ID or name.

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

CertificateId
required
string
Example: ddf3cdaa-3329-4961-822a-ce6dbd38eff7

ID of the Certificate to lookup

SNIId
required
string
Example: 64c17a1a-b7d7-4a65-a5a4-42e4a7016e7f

ID of the SNI to lookup

Responses

Response samples

Content type
application/json
{
  • "certificate": {
    },
  • "id": "36c4566c-14cc-4132-9011-4139fcbbe50a",
  • "name": "some.example.org"
}

Upsert an SNI associated with a Certificate

Create or Update an SNI associated with a Certificate using ID or name.

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

CertificateId
required
string
Example: ddf3cdaa-3329-4961-822a-ce6dbd38eff7

ID of the Certificate to lookup

SNIId
required
string
Example: 64c17a1a-b7d7-4a65-a5a4-42e4a7016e7f

ID of the SNI to lookup

Request Body schema: application/json

Description of the SNI

object

The id (a UUID) of the certificate with which to associate the SNI hostname. The Certificate must have a valid private key associated with it to be used by the SNI object.

created_at
integer or null

Unix epoch when the resource was created.

id
string or null
name
required
string

The SNI name to associate with the given certificate.

tags
Array of strings

An optional set of strings associated with the SNIs for grouping and filtering.

updated_at
integer or null

Unix epoch when the resource was last updated.

Responses

Request samples

Content type
application/json
{
  • "id": "36c4566c-14cc-4132-9011-4139fcbbe50a",
  • "name": "some.example.org"
}

Response samples

Content type
application/json
{
  • "certificate": {
    },
  • "id": "36c4566c-14cc-4132-9011-4139fcbbe50a",
  • "name": "some.example.org"
}

List all SNIs

List all SNIs

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

query Parameters
size
integer [ 1 .. 1000 ]
Default: 100

Number of resources to be returned.

offset
string

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

tags
string
Example: tags=tag1,tag2

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.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "next": "string",
  • "offset": "string"
}

Create a new SNI

Create a new SNI

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

Request Body schema: application/json

Description of the new SNI for creation

required
object

The id (a UUID) of the certificate with which to associate the SNI hostname. The Certificate must have a valid private key associated with it to be used by the SNI object.

created_at
integer or null

Unix epoch when the resource was created.

id
string or null
name
required
string

The SNI name to associate with the given certificate.

tags
Array of strings

An optional set of strings associated with the SNIs for grouping and filtering.

updated_at
integer or null

Unix epoch when the resource was last updated.

Responses

Request samples

Content type
application/json
{
  • "certificate": {
    },
  • "id": "36c4566c-14cc-4132-9011-4139fcbbe50a",
  • "name": "some.example.org"
}

Response samples

Content type
application/json
{
  • "certificate": {
    },
  • "id": "36c4566c-14cc-4132-9011-4139fcbbe50a",
  • "name": "some.example.org"
}

Delete an SNI

Delete an SNI

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

SNIId
required
string
Example: 64c17a1a-b7d7-4a65-a5a4-42e4a7016e7f

ID of the SNI to lookup

Responses

Response samples

Content type
application/json
Example
{
  • "message": "Duplicate API key found",
  • "status": 401
}

Fetch an SNI

Get an SNI using ID or name.

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
SNIId
required
string
Example: 64c17a1a-b7d7-4a65-a5a4-42e4a7016e7f

ID of the SNI to lookup

controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

Responses

Response samples

Content type
application/json
{
  • "certificate": {
    },
  • "id": "36c4566c-14cc-4132-9011-4139fcbbe50a",
  • "name": "some.example.org"
}

Upsert a SNI

Create or Update SNI using ID or name.

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
SNIId
required
string
Example: 64c17a1a-b7d7-4a65-a5a4-42e4a7016e7f

ID of the SNI to lookup

controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

Request Body schema: application/json

Description of the SNI

required
object

The id (a UUID) of the certificate with which to associate the SNI hostname. The Certificate must have a valid private key associated with it to be used by the SNI object.

created_at
integer or null

Unix epoch when the resource was created.

id
string or null
name
required
string

The SNI name to associate with the given certificate.

tags
Array of strings

An optional set of strings associated with the SNIs for grouping and filtering.

updated_at
integer or null

Unix epoch when the resource was last updated.

Responses

Request samples

Content type
application/json
{
  • "certificate": {
    },
  • "id": "36c4566c-14cc-4132-9011-4139fcbbe50a",
  • "name": "some.example.org"
}

Response samples

Content type
application/json
{
  • "certificate": {
    },
  • "id": "36c4566c-14cc-4132-9011-4139fcbbe50a",
  • "name": "some.example.org"
}

CA Certificates

A CA certificate object represents a trusted certificate authority. These objects are used by Kong Gateway to verify the validity of a client or server certificate.

List all CA Certificates

List all CA Certificates

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

query Parameters
size
integer [ 1 .. 1000 ]
Default: 100

Number of resources to be returned.

offset
string

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

tags
string
Example: tags=tag1,tag2

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.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "next": "string",
  • "offset": "string"
}

Create a new CA Certificate

Create a new CA Certificate

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

Request Body schema: application/json

Description of the new CA Certificate for creation

cert
required
string

PEM-encoded public certificate of the CA.

cert_digest
string or null

SHA256 hex digest of the public certificate. This field is read-only and it cannot be set by the caller, the value is automatically computed.

created_at
integer or null

Unix epoch when the resource was created.

id
string or null
tags
Array of strings

An optional set of strings associated with the Certificate for grouping and filtering.

updated_at
integer or null

Unix epoch when the resource was last updated.

Responses

Request samples

Content type
application/json
{
  • "cert": "-----BEGIN CERTIFICATE-----\ncertificate-content\n-----END CERTIFICATE-----",
  • "id": "b2f34145-0343-41a4-9602-4c69dec2f260"
}

Response samples

Content type
application/json
{
  • "cert": "-----BEGIN CERTIFICATE-----\ncertificate-content\n-----END CERTIFICATE-----",
  • "id": "b2f34145-0343-41a4-9602-4c69dec2f260"
}

Delete a CA Certificate

Delete a CA Certificate

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

CACertificateId
required
string
Example: 3c31f18a-f27a-4f9b-8cd4-bf841554612f

ID of the CA Certificate to lookup

Responses

Response samples

Content type
application/json
Example
{
  • "message": "Duplicate API key found",
  • "status": 401
}

Fetch a CA Certificate

Get a CA Certificate using ID.

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
CACertificateId
required
string
Example: 3c31f18a-f27a-4f9b-8cd4-bf841554612f

ID of the CA Certificate to lookup

controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

Responses

Response samples

Content type
application/json
{
  • "cert": "-----BEGIN CERTIFICATE-----\ncertificate-content\n-----END CERTIFICATE-----",
  • "id": "b2f34145-0343-41a4-9602-4c69dec2f260"
}

Upsert a CA Certificate

Create or Update CA Certificate using ID.

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
CACertificateId
required
string
Example: 3c31f18a-f27a-4f9b-8cd4-bf841554612f

ID of the CA Certificate to lookup

controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

Request Body schema: application/json

Description of the CA Certificate

cert
required
string

PEM-encoded public certificate of the CA.

cert_digest
string or null

SHA256 hex digest of the public certificate. This field is read-only and it cannot be set by the caller, the value is automatically computed.

created_at
integer or null

Unix epoch when the resource was created.

id
string or null
tags
Array of strings

An optional set of strings associated with the Certificate for grouping and filtering.

updated_at
integer or null

Unix epoch when the resource was last updated.

Responses

Request samples

Content type
application/json
{
  • "cert": "-----BEGIN CERTIFICATE-----\ncertificate-content\n-----END CERTIFICATE-----",
  • "id": "b2f34145-0343-41a4-9602-4c69dec2f260"
}

Response samples

Content type
application/json
{
  • "cert": "-----BEGIN CERTIFICATE-----\ncertificate-content\n-----END CERTIFICATE-----",
  • "id": "b2f34145-0343-41a4-9602-4c69dec2f260"
}

Upstreams

The upstream object represents a virtual hostname and can be used to load balance incoming requests over multiple services (targets).

An upstream also includes a health checker, which can enable and disable targets based on their ability or inability to serve requests. The configuration for the health checker is stored in the upstream object, and applies to all of its targets.

List all Upstreams

List all Upstreams

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

query Parameters
size
integer [ 1 .. 1000 ]
Default: 100

Number of resources to be returned.

offset
string

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

tags
string
Example: tags=tag1,tag2

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.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "next": "string",
  • "offset": "string"
}

Create a new Upstream

Create a new Upstream

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

Request Body schema: application/json

Description of the new Upstream for creation

algorithm
string or null
Default: "round-robin"
Enum: "consistent-hashing" "least-connections" "round-robin" "latency"

Which load balancing algorithm to use.

object or null

If set, the certificate to be used as client certificate while TLS handshaking to the upstream server.

created_at
integer or null

Unix epoch when the resource was created.

hash_fallback
string or null
Default: "none"
Enum: "none" "consumer" "ip" "header" "cookie" "path" "query_arg" "uri_capture"

What to use as hashing input if the primary hash_on does not return a hash (eg. header is missing, or no Consumer identified). Not available if hash_on is set to cookie.

hash_fallback_header
string or null

The header name to take the value from as hash input. Only required when hash_fallback is set to header.

hash_fallback_query_arg
string or null

The name of the query string argument to take the value from as hash input. Only required when hash_fallback is set to query_arg.

hash_fallback_uri_capture
string or null

The name of the route URI capture to take the value from as hash input. Only required when hash_fallback is set to uri_capture.

hash_on
string or null
Default: "none"
Enum: "none" "consumer" "ip" "header" "cookie" "path" "query_arg" "uri_capture"

What to use as hashing input. Using none results in a weighted-round-robin scheme with no hashing.

hash_on_cookie
string or null

The cookie name to take the value from as hash input. Only required when hash_on or hash_fallback is set to cookie. If the specified cookie is not in the request, Kong will generate a value and set the cookie in the response.

hash_on_cookie_path
string or null
Default: "/"

The cookie path to set in the response headers. Only required when hash_on or hash_fallback is set to cookie.

hash_on_header
string or null

The header name to take the value from as hash input. Only required when hash_on is set to header.

hash_on_query_arg
string or null

The name of the query string argument to take the value from as hash input. Only required when hash_on is set to query_arg.

hash_on_uri_capture
string or null

The name of the route URI capture to take the value from as hash input. Only required when hash_on is set to uri_capture.

object or null
host_header
string or null

The hostname to be used as Host header when proxying requests through Kong.

id
string or null
name
required
string

This is a hostname, which must be equal to the host of a Service.

slots
integer or null
Default: 10000

The number of slots in the load balancer algorithm. If algorithm is set to round-robin, this setting determines the maximum number of slots. If algorithm is set to consistent-hashing, this setting determines the actual number of slots in the algorithm. Accepts an integer in the range 10-65536.

tags
Array of strings

An optional set of strings associated with the Upstream for grouping and filtering.

updated_at
integer or null

Unix epoch when the resource was last updated.

use_srv_name
boolean or null
Default: false

If set, the balancer will use SRV hostname(if DNS Answer has SRV record) as the proxy upstream Host.

Responses

Request samples

Content type
application/json
{
  • "algorithm": "round-robin",
  • "hash_fallback": "none",
  • "hash_on": "none",
  • "hash_on_cookie_path": "/",
  • "healthchecks": {
    },
  • "id": "6eed5e9c-5398-4026-9a4c-d48f18a2431e",
  • "name": "api.example.internal",
  • "slots": 10000
}

Response samples

Content type
application/json
{
  • "algorithm": "round-robin",
  • "hash_fallback": "none",
  • "hash_on": "none",
  • "hash_on_cookie_path": "/",
  • "healthchecks": {
    },
  • "id": "6eed5e9c-5398-4026-9a4c-d48f18a2431e",
  • "name": "api.example.internal",
  • "slots": 10000
}

Delete an Upstream

Delete an Upstream

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

UpstreamId
required
string
Example: 426d620c-7058-4ae6-aacc-f85a3204a2c5

ID of the Upstream to lookup

Responses

Response samples

Content type
application/json
Example
{
  • "message": "Duplicate API key found",
  • "status": 401
}

Fetch an Upstream

Get an Upstream using ID or name.

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
UpstreamId
required
string
Example: 426d620c-7058-4ae6-aacc-f85a3204a2c5

ID of the Upstream to lookup

controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

Responses

Response samples

Content type
application/json
{
  • "algorithm": "round-robin",
  • "hash_fallback": "none",
  • "hash_on": "none",
  • "hash_on_cookie_path": "/",
  • "healthchecks": {
    },
  • "id": "6eed5e9c-5398-4026-9a4c-d48f18a2431e",
  • "name": "api.example.internal",
  • "slots": 10000
}

Upsert a Upstream

Create or Update Upstream using ID or name.

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
UpstreamId
required
string
Example: 426d620c-7058-4ae6-aacc-f85a3204a2c5

ID of the Upstream to lookup

controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

Request Body schema: application/json

Description of the Upstream

algorithm
string or null
Default: "round-robin"
Enum: "consistent-hashing" "least-connections" "round-robin" "latency"

Which load balancing algorithm to use.

object or null

If set, the certificate to be used as client certificate while TLS handshaking to the upstream server.

created_at
integer or null

Unix epoch when the resource was created.

hash_fallback
string or null
Default: "none"
Enum: "none" "consumer" "ip" "header" "cookie" "path" "query_arg" "uri_capture"

What to use as hashing input if the primary hash_on does not return a hash (eg. header is missing, or no Consumer identified). Not available if hash_on is set to cookie.

hash_fallback_header
string or null

The header name to take the value from as hash input. Only required when hash_fallback is set to header.

hash_fallback_query_arg
string or null

The name of the query string argument to take the value from as hash input. Only required when hash_fallback is set to query_arg.

hash_fallback_uri_capture
string or null

The name of the route URI capture to take the value from as hash input. Only required when hash_fallback is set to uri_capture.

hash_on
string or null
Default: "none"
Enum: "none" "consumer" "ip" "header" "cookie" "path" "query_arg" "uri_capture"

What to use as hashing input. Using none results in a weighted-round-robin scheme with no hashing.

hash_on_cookie
string or null

The cookie name to take the value from as hash input. Only required when hash_on or hash_fallback is set to cookie. If the specified cookie is not in the request, Kong will generate a value and set the cookie in the response.

hash_on_cookie_path
string or null
Default: "/"

The cookie path to set in the response headers. Only required when hash_on or hash_fallback is set to cookie.

hash_on_header
string or null

The header name to take the value from as hash input. Only required when hash_on is set to header.

hash_on_query_arg
string or null

The name of the query string argument to take the value from as hash input. Only required when hash_on is set to query_arg.

hash_on_uri_capture
string or null

The name of the route URI capture to take the value from as hash input. Only required when hash_on is set to uri_capture.

object or null
host_header
string or null

The hostname to be used as Host header when proxying requests through Kong.

id
string or null
name
required
string

This is a hostname, which must be equal to the host of a Service.

slots
integer or null
Default: 10000

The number of slots in the load balancer algorithm. If algorithm is set to round-robin, this setting determines the maximum number of slots. If algorithm is set to consistent-hashing, this setting determines the actual number of slots in the algorithm. Accepts an integer in the range 10-65536.

tags
Array of strings

An optional set of strings associated with the Upstream for grouping and filtering.

updated_at
integer or null

Unix epoch when the resource was last updated.

use_srv_name
boolean or null
Default: false

If set, the balancer will use SRV hostname(if DNS Answer has SRV record) as the proxy upstream Host.

Responses

Request samples

Content type
application/json
{
  • "algorithm": "round-robin",
  • "hash_fallback": "none",
  • "hash_on": "none",
  • "hash_on_cookie_path": "/",
  • "healthchecks": {
    },
  • "id": "6eed5e9c-5398-4026-9a4c-d48f18a2431e",
  • "name": "api.example.internal",
  • "slots": 10000
}

Response samples

Content type
application/json
{
  • "algorithm": "round-robin",
  • "hash_fallback": "none",
  • "hash_on": "none",
  • "hash_on_cookie_path": "/",
  • "healthchecks": {
    },
  • "id": "6eed5e9c-5398-4026-9a4c-d48f18a2431e",
  • "name": "api.example.internal",
  • "slots": 10000
}

Vaults

Vault objects are used to configure different vault connectors for managing secrets. Configuring a vault lets you reference secrets from other entities. This allows for a proper separation of secrets and configuration and prevents secret sprawl.

For example, you could store a certificate and a key in a vault, then reference them from a certificate entity. This way, the certificate and key are not stored in the entity directly and are more secure.

Secrets rotation can be managed using TTLs.

List all Vaults

List all Vaults

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

query Parameters
size
integer [ 1 .. 1000 ]
Default: 100

Number of resources to be returned.

offset
string

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

tags
string
Example: tags=tag1,tag2

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.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "next": "string",
  • "offset": "string"
}

Create a new Vault

Create a new Vault

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

Request Body schema: application/json

Description of the new Vault for creation

required
object

The configuration properties for the Vault which can be found on the vaults' documentation page.

created_at
integer or null

Unix epoch when the resource was created.

description
string or null

The description of the Vault entity.

id
string or null
name
required
string

The name of the Vault that's going to be added. Currently, the Vault implementation must be installed in every Kong instance.

prefix
required
string

The unique prefix (or identifier) for this Vault configuration. The prefix is used to load the right Vault configuration and implementation when referencing secrets with the other entities.

tags
Array of strings

An optional set of strings associated with the Vault for grouping and filtering.

updated_at
integer or null

Unix epoch when the resource was last updated.

Responses

Request samples

Content type
application/json
{
  • "config": {
    },
  • "description": "environment variable based vault",
  • "id": "2747d1e5-8246-4f65-a939-b392f1ee17f8",
  • "name": "env",
  • "prefix": "env",
  • "tags": [
    ]
}

Response samples

Content type
application/json
{
  • "config": {
    },
  • "description": "environment variable based vault",
  • "id": "2747d1e5-8246-4f65-a939-b392f1ee17f8",
  • "name": "env",
  • "prefix": "env",
  • "tags": [
    ]
}

Delete a Vault

Delete a Vault

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

VaultId
required
string
Example: 9d4d6d19-77c6-428e-a965-9bc9647633e9

ID of the Vault to lookup

Responses

Response samples

Content type
application/json
Example
{
  • "message": "Duplicate API key found",
  • "status": 401
}

Fetch a Vault

Get a Vault using ID or prefix.

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
VaultId
required
string
Example: 9d4d6d19-77c6-428e-a965-9bc9647633e9

ID of the Vault to lookup

controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

Responses

Response samples

Content type
application/json
{
  • "config": {
    },
  • "description": "environment variable based vault",
  • "id": "2747d1e5-8246-4f65-a939-b392f1ee17f8",
  • "name": "env",
  • "prefix": "env",
  • "tags": [
    ]
}

Upsert a Vault

Create or Update Vault using ID or prefix.

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
VaultId
required
string
Example: 9d4d6d19-77c6-428e-a965-9bc9647633e9

ID of the Vault to lookup

controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

Request Body schema: application/json

Description of the Vault

required
object

The configuration properties for the Vault which can be found on the vaults' documentation page.

created_at
integer or null

Unix epoch when the resource was created.

description
string or null

The description of the Vault entity.

id
string or null
name
required
string

The name of the Vault that's going to be added. Currently, the Vault implementation must be installed in every Kong instance.

prefix
required
string

The unique prefix (or identifier) for this Vault configuration. The prefix is used to load the right Vault configuration and implementation when referencing secrets with the other entities.

tags
Array of strings

An optional set of strings associated with the Vault for grouping and filtering.

updated_at
integer or null

Unix epoch when the resource was last updated.

Responses

Request samples

Content type
application/json
{
  • "config": {
    },
  • "description": "environment variable based vault",
  • "id": "2747d1e5-8246-4f65-a939-b392f1ee17f8",
  • "name": "env",
  • "prefix": "env",
  • "tags": [
    ]
}

Response samples

Content type
application/json
{
  • "config": {
    },
  • "description": "environment variable based vault",
  • "id": "2747d1e5-8246-4f65-a939-b392f1ee17f8",
  • "name": "env",
  • "prefix": "env",
  • "tags": [
    ]
}

Keys

A key object holds a representation of asymmetric keys in various formats. When Kong Gateway or a Kong plugin requires a specific public or private key to perform certain operations, it can use this entity.

List all Keys associated with a KeySet

List all Keys associated with a KeySet

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

KeySetId
required
string
Example: 6cc34248-50b4-4a81-9201-3bdf7a83f712

ID of the KeySet to lookup

query Parameters
size
integer [ 1 .. 1000 ]
Default: 100

Number of resources to be returned.

offset
string

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

tags
string
Example: tags=tag1,tag2

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.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "next": "string",
  • "offset": "string"
}

Create a new Key associated with a KeySet

Create a new Key associated with a KeySet

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

KeySetId
required
string
Example: 6cc34248-50b4-4a81-9201-3bdf7a83f712

ID of the KeySet to lookup

Request Body schema: application/json

Description of new Key for creation

created_at
integer or null

Unix epoch when the resource was created.

id
string or null
jwk
string or null

A JSON Web Key represented as a string.

kid
required
string

A unique identifier for a key.

name
string or null

The name to associate with the given keys.

object or null

A keypair in PEM format.

object or null

The id (an UUID) of the key-set with which to associate the key.

tags
Array of strings

An optional set of strings associated with the Key for grouping and filtering.

updated_at
integer or null

Unix epoch when the resource was last updated.

x5t
string or null

Responses

Request samples

Content type
application/json
{
  • "id": "d958f66b-8e99-44d2-b0b4-edd5bbf24658",
  • "jwk": "{\"alg\":\"RSA\", \"kid\": \"42\", ...}",
  • "kid": "42",
  • "name": "a-key",
  • "pem": {
    },
  • "set": {
    }
}

Response samples

Content type
application/json
{
  • "id": "d958f66b-8e99-44d2-b0b4-edd5bbf24658",
  • "jwk": "{\"alg\":\"RSA\", \"kid\": \"42\", ...}",
  • "kid": "42",
  • "name": "a-key",
  • "pem": {
    },
  • "set": {
    }
}

Delete a a Key associated with a KeySet

Delete a a Key associated with a KeySet using ID or name.

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

KeySetId
required
string
Example: 6cc34248-50b4-4a81-9201-3bdf7a83f712

ID of the KeySet to lookup

KeyId
required
string
Example: bba22c06-a632-42be-a018-1b9ff357b5b9

ID of the Key to lookup

Responses

Fetch a Key associated with a KeySet

Get a Key associated with a KeySet using ID or name.

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

KeySetId
required
string
Example: 6cc34248-50b4-4a81-9201-3bdf7a83f712

ID of the KeySet to lookup

KeyId
required
string
Example: bba22c06-a632-42be-a018-1b9ff357b5b9

ID of the Key to lookup

Responses

Response samples

Content type
application/json
{
  • "id": "d958f66b-8e99-44d2-b0b4-edd5bbf24658",
  • "jwk": "{\"alg\":\"RSA\", \"kid\": \"42\", ...}",
  • "kid": "42",
  • "name": "a-key",
  • "pem": {
    },
  • "set": {
    }
}

Upsert a Key associated with a KeySet

Create or Update a Key associated with a KeySet using ID or name.

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

KeySetId
required
string
Example: 6cc34248-50b4-4a81-9201-3bdf7a83f712

ID of the KeySet to lookup

KeyId
required
string
Example: bba22c06-a632-42be-a018-1b9ff357b5b9

ID of the Key to lookup

Request Body schema: application/json

Description of the Key

created_at
integer or null

Unix epoch when the resource was created.

id
string or null
jwk
string or null

A JSON Web Key represented as a string.

kid
required
string

A unique identifier for a key.

name
string or null

The name to associate with the given keys.

object or null

A keypair in PEM format.

object or null

The id (an UUID) of the key-set with which to associate the key.

tags
Array of strings

An optional set of strings associated with the Key for grouping and filtering.

updated_at
integer or null

Unix epoch when the resource was last updated.

x5t
string or null

Responses

Request samples

Content type
application/json
{
  • "id": "d958f66b-8e99-44d2-b0b4-edd5bbf24658",
  • "jwk": "{\"alg\":\"RSA\", \"kid\": \"42\", ...}",
  • "kid": "42",
  • "name": "a-key",
  • "pem": {
    },
  • "set": {
    }
}

Response samples

Content type
application/json
{
  • "id": "d958f66b-8e99-44d2-b0b4-edd5bbf24658",
  • "jwk": "{\"alg\":\"RSA\", \"kid\": \"42\", ...}",
  • "kid": "42",
  • "name": "a-key",
  • "pem": {
    },
  • "set": {
    }
}

List all Keys

List all Keys

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

query Parameters
size
integer [ 1 .. 1000 ]
Default: 100

Number of resources to be returned.

offset
string

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

tags
string
Example: tags=tag1,tag2

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.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "next": "string",
  • "offset": "string"
}

Create a new Key

Create a new Key

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

Request Body schema: application/json

Description of the new Key for creation

created_at
integer or null

Unix epoch when the resource was created.

id
string or null
jwk
string or null

A JSON Web Key represented as a string.

kid
required
string

A unique identifier for a key.

name
string or null

The name to associate with the given keys.

object or null

A keypair in PEM format.

object or null

The id (an UUID) of the key-set with which to associate the key.

tags
Array of strings

An optional set of strings associated with the Key for grouping and filtering.

updated_at
integer or null

Unix epoch when the resource was last updated.

x5t
string or null

Responses

Request samples

Content type
application/json
{
  • "id": "d958f66b-8e99-44d2-b0b4-edd5bbf24658",
  • "jwk": "{\"alg\":\"RSA\", \"kid\": \"42\", ...}",
  • "kid": "42",
  • "name": "a-key",
  • "pem": {
    },
  • "set": {
    }
}

Response samples

Content type
application/json
{
  • "id": "d958f66b-8e99-44d2-b0b4-edd5bbf24658",
  • "jwk": "{\"alg\":\"RSA\", \"kid\": \"42\", ...}",
  • "kid": "42",
  • "name": "a-key",
  • "pem": {
    },
  • "set": {
    }
}

Delete a Key

Delete a Key

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

KeyId
required
string
Example: bba22c06-a632-42be-a018-1b9ff357b5b9

ID of the Key to lookup

Responses

Response samples

Content type
application/json
Example
{
  • "message": "Duplicate API key found",
  • "status": 401
}

Fetch a Key

Get a Key using ID or name.

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
KeyId
required
string
Example: bba22c06-a632-42be-a018-1b9ff357b5b9

ID of the Key to lookup

controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

Responses

Response samples

Content type
application/json
{
  • "id": "d958f66b-8e99-44d2-b0b4-edd5bbf24658",
  • "jwk": "{\"alg\":\"RSA\", \"kid\": \"42\", ...}",
  • "kid": "42",
  • "name": "a-key",
  • "pem": {
    },
  • "set": {
    }
}

Upsert a Key

Create or Update Key using ID or name.

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
KeyId
required
string
Example: bba22c06-a632-42be-a018-1b9ff357b5b9

ID of the Key to lookup

controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

Request Body schema: application/json

Description of the Key

created_at
integer or null

Unix epoch when the resource was created.

id
string or null
jwk
string or null

A JSON Web Key represented as a string.

kid
required
string

A unique identifier for a key.

name
string or null

The name to associate with the given keys.

object or null

A keypair in PEM format.

object or null

The id (an UUID) of the key-set with which to associate the key.

tags
Array of strings

An optional set of strings associated with the Key for grouping and filtering.

updated_at
integer or null

Unix epoch when the resource was last updated.

x5t
string or null

Responses

Request samples

Content type
application/json
{
  • "id": "d958f66b-8e99-44d2-b0b4-edd5bbf24658",
  • "jwk": "{\"alg\":\"RSA\", \"kid\": \"42\", ...}",
  • "kid": "42",
  • "name": "a-key",
  • "pem": {
    },
  • "set": {
    }
}

Response samples

Content type
application/json
{
  • "id": "d958f66b-8e99-44d2-b0b4-edd5bbf24658",
  • "jwk": "{\"alg\":\"RSA\", \"kid\": \"42\", ...}",
  • "kid": "42",
  • "name": "a-key",
  • "pem": {
    },
  • "set": {
    }
}

KeySets

A JSON Web key set. Key sets are the preferred way to expose keys to plugins because they tell the plugin where to look for keys or have a scoping mechanism to restrict plugins to specific keys.

List all KeySets

List all KeySets

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

query Parameters
size
integer [ 1 .. 1000 ]
Default: 100

Number of resources to be returned.

offset
string

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

tags
string
Example: tags=tag1,tag2

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.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "next": "string",
  • "offset": "string"
}

Create a new KeySet

Create a new KeySet

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

Request Body schema: application/json

Description of the new KeySet for creation

created_at
integer or null

Unix epoch when the resource was created.

id
string or null
name
string or null
tags
Array of strings
updated_at
integer or null

Unix epoch when the resource was last updated.

Responses

Request samples

Content type
application/json
{
  • "id": "b58c7d9d-e54f-444c-b24d-cdfc4159f61e",
  • "name": "example-key-set",
  • "tags": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "b58c7d9d-e54f-444c-b24d-cdfc4159f61e",
  • "name": "example-key-set",
  • "tags": [
    ]
}

Delete a KeySet

Delete a KeySet

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

KeySetId
required
string
Example: 6cc34248-50b4-4a81-9201-3bdf7a83f712

ID of the KeySet to lookup

Responses

Response samples

Content type
application/json
Example
{
  • "message": "Duplicate API key found",
  • "status": 401
}

Fetch a KeySet

Get a KeySet using ID or name.

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
KeySetId
required
string
Example: 6cc34248-50b4-4a81-9201-3bdf7a83f712

ID of the KeySet to lookup

controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

Responses

Response samples

Content type
application/json
{
  • "id": "b58c7d9d-e54f-444c-b24d-cdfc4159f61e",
  • "name": "example-key-set",
  • "tags": [
    ]
}

Upsert a KeySet

Create or Update KeySet using ID or name.

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
KeySetId
required
string
Example: 6cc34248-50b4-4a81-9201-3bdf7a83f712

ID of the KeySet to lookup

controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

Request Body schema: application/json

Description of the KeySet

created_at
integer or null

Unix epoch when the resource was created.

id
string or null
name
string or null
tags
Array of strings
updated_at
integer or null

Unix epoch when the resource was last updated.

Responses

Request samples

Content type
application/json
{
  • "id": "b58c7d9d-e54f-444c-b24d-cdfc4159f61e",
  • "name": "example-key-set",
  • "tags": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "b58c7d9d-e54f-444c-b24d-cdfc4159f61e",
  • "name": "example-key-set",
  • "tags": [
    ]
}

API-keys

List all API-keys associated with a Consumer

List all API-keys associated with a Consumer

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

ConsumerIdForNestedEntities
required
string
Example: f28acbfa-c866-4587-b688-0208ac24df21

Consumer ID for nested entities

query Parameters
size
integer [ 1 .. 1000 ]
Default: 100

Number of resources to be returned.

offset
string

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

tags
string
Example: tags=tag1,tag2

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.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "next": "string",
  • "offset": "string"
}

Create a new API-key associated with a Consumer

Create a new API-key associated with a Consumer

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

ConsumerIdForNestedEntities
required
string
Example: f28acbfa-c866-4587-b688-0208ac24df21

Consumer ID for nested entities

Request Body schema: application/json

Description of new API-key for creation

object or null
created_at
integer or null

Unix epoch when the resource was created.

id
string or null
key
required
string
tags
Array of strings

Responses

Request samples

Content type
application/json
{
  • "id": "b2f34145-0343-41a4-9602-4c69dec2f269",
  • "key": "IL1deIyHyQA40WpeLeA1bIUXuvTwlGjo"
}

Response samples

Content type
application/json
{
  • "consumer": {
    },
  • "id": "b2f34145-0343-41a4-9602-4c69dec2f269",
  • "key": "IL1deIyHyQA40WpeLeA1bIUXuvTwlGjo"
}

Delete a an API-key associated with a Consumer

Delete a an API-key associated with a Consumer using ID.

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

ConsumerIdForNestedEntities
required
string
Example: f28acbfa-c866-4587-b688-0208ac24df21

Consumer ID for nested entities

KeyAuthId
required
string

ID of the API-key to lookup

Responses

Fetch an API-key associated with a Consumer

Get an API-key associated with a Consumer using ID.

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

ConsumerIdForNestedEntities
required
string
Example: f28acbfa-c866-4587-b688-0208ac24df21

Consumer ID for nested entities

KeyAuthId
required
string

ID of the API-key to lookup

Responses

Response samples

Content type
application/json
{
  • "consumer": {
    },
  • "id": "b2f34145-0343-41a4-9602-4c69dec2f269",
  • "key": "IL1deIyHyQA40WpeLeA1bIUXuvTwlGjo"
}

Upsert an API-key associated with a Consumer

Create or Update an API-key associated with a Consumer using ID.

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

ConsumerIdForNestedEntities
required
string
Example: f28acbfa-c866-4587-b688-0208ac24df21

Consumer ID for nested entities

KeyAuthId
required
string

ID of the API-key to lookup

Request Body schema: application/json

Description of the API-key

object or null
created_at
integer or null

Unix epoch when the resource was created.

id
string or null
key
required
string
tags
Array of strings

Responses

Request samples

Content type
application/json
{
  • "id": "b2f34145-0343-41a4-9602-4c69dec2f269",
  • "key": "IL1deIyHyQA40WpeLeA1bIUXuvTwlGjo"
}

Response samples

Content type
application/json
{
  • "consumer": {
    },
  • "id": "b2f34145-0343-41a4-9602-4c69dec2f269",
  • "key": "IL1deIyHyQA40WpeLeA1bIUXuvTwlGjo"
}

List all API-keys

List all API-keys

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

query Parameters
size
integer [ 1 .. 1000 ]
Default: 100

Number of resources to be returned.

offset
string

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

tags
string
Example: tags=tag1,tag2

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.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "next": "string",
  • "offset": "string"
}

Fetch an API-key

Get an API-key using ID.

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
KeyAuthId
required
string

ID of the API-key to lookup

controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

Responses

Response samples

Content type
application/json
{
  • "consumer": {
    },
  • "id": "b2f34145-0343-41a4-9602-4c69dec2f269",
  • "key": "IL1deIyHyQA40WpeLeA1bIUXuvTwlGjo"
}

Basic-auth credentials

List all Basic-auth credentials

List all Basic-auth credentials

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

query Parameters
size
integer [ 1 .. 1000 ]
Default: 100

Number of resources to be returned.

offset
string

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

tags
string
Example: tags=tag1,tag2

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.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "next": "string",
  • "offset": "string"
}

Fetch a Basic-auth credential

Get a Basic-auth credential using ID.

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
BasicAuthId
required
string
Example: 80db1b58-ca7c-4d21-b92a-64eb07725872

ID of the Basic-auth credential to lookup

controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

Responses

Response samples

Content type
application/json
{
  • "consumer": {
    },
  • "id": "b2f34145-0343-41a4-9602-4c69dec2f269",
  • "password": "hashedsoopersecretvalue",
  • "username": "darius"
}

List all Basic-auth credentials associated with a Consumer

List all Basic-auth credentials associated with a Consumer

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

ConsumerIdForNestedEntities
required
string
Example: f28acbfa-c866-4587-b688-0208ac24df21

Consumer ID for nested entities

query Parameters
size
integer [ 1 .. 1000 ]
Default: 100

Number of resources to be returned.

offset
string

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

tags
string
Example: tags=tag1,tag2

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.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "next": "string",
  • "offset": "string"
}

Create a new Basic-auth credential associated with a Consumer

Create a new Basic-auth credential associated with a Consumer

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

ConsumerIdForNestedEntities
required
string
Example: f28acbfa-c866-4587-b688-0208ac24df21

Consumer ID for nested entities

Request Body schema: application/json

Description of new Basic-auth credential for creation

object or null
created_at
integer or null

Unix epoch when the resource was created.

id
string or null
password
required
string
tags
Array of strings
username
required
string

Responses

Request samples

Content type
application/json
{
  • "id": "b2f34145-0343-41a4-9602-4c69dec2f269",
  • "password": "hashedsoopersecretvalue",
  • "username": "darius"
}

Response samples

Content type
application/json
{
  • "consumer": {
    },
  • "id": "b2f34145-0343-41a4-9602-4c69dec2f269",
  • "password": "hashedsoopersecretvalue",
  • "username": "darius"
}

Delete a a Basic-auth credential associated with a Consumer

Delete a a Basic-auth credential associated with a Consumer using ID.

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

ConsumerIdForNestedEntities
required
string
Example: f28acbfa-c866-4587-b688-0208ac24df21

Consumer ID for nested entities

BasicAuthId
required
string
Example: 80db1b58-ca7c-4d21-b92a-64eb07725872

ID of the Basic-auth credential to lookup

Responses

Fetch a Basic-auth credential associated with a Consumer

Get a Basic-auth credential associated with a Consumer using ID.

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

ConsumerIdForNestedEntities
required
string
Example: f28acbfa-c866-4587-b688-0208ac24df21

Consumer ID for nested entities

BasicAuthId
required
string
Example: 80db1b58-ca7c-4d21-b92a-64eb07725872

ID of the Basic-auth credential to lookup

Responses

Response samples

Content type
application/json
{
  • "consumer": {
    },
  • "id": "b2f34145-0343-41a4-9602-4c69dec2f269",
  • "password": "hashedsoopersecretvalue",
  • "username": "darius"
}

Upsert a Basic-auth credential associated with a Consumer

Create or Update a Basic-auth credential associated with a Consumer using ID.

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

ConsumerIdForNestedEntities
required
string
Example: f28acbfa-c866-4587-b688-0208ac24df21

Consumer ID for nested entities

BasicAuthId
required
string
Example: 80db1b58-ca7c-4d21-b92a-64eb07725872

ID of the Basic-auth credential to lookup

Request Body schema: application/json

Description of the Basic-auth credential

object or null
created_at
integer or null

Unix epoch when the resource was created.

id
string or null
password
required
string
tags
Array of strings
username
required
string

Responses

Request samples

Content type
application/json
{
  • "id": "b2f34145-0343-41a4-9602-4c69dec2f269",
  • "password": "hashedsoopersecretvalue",
  • "username": "darius"
}

Response samples

Content type
application/json
{
  • "consumer": {
    },
  • "id": "b2f34145-0343-41a4-9602-4c69dec2f269",
  • "password": "hashedsoopersecretvalue",
  • "username": "darius"
}

JWTs

List all JWTs associated with a Consumer

List all JWTs associated with a Consumer

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

ConsumerIdForNestedEntities
required
string
Example: f28acbfa-c866-4587-b688-0208ac24df21

Consumer ID for nested entities

query Parameters
size
integer [ 1 .. 1000 ]
Default: 100

Number of resources to be returned.

offset
string

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

tags
string
Example: tags=tag1,tag2

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.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "next": "string",
  • "offset": "string"
}

Create a new JWT associated with a Consumer

Create a new JWT associated with a Consumer

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

ConsumerIdForNestedEntities
required
string
Example: f28acbfa-c866-4587-b688-0208ac24df21

Consumer ID for nested entities

Request Body schema: application/json

Description of new JWT for creation

algorithm
string or null
Default: "HS256"
Enum: "HS256" "HS384" "HS512" "RS256" "RS384" "RS512" "ES256" "ES384" "ES512" "PS256" "PS384" "PS512" "EdDSA"
object or null
created_at
integer or null

Unix epoch when the resource was created.

id
string or null
key
string or null
rsa_public_key
string or null
secret
string or null
tags
Array of strings

Responses

Request samples

Content type
application/json
{
  • "algorithm": "HS256",
  • "id": "75695322-e8a0-4109-aed4-5416b0308d85",
  • "key": "YJdmaDvVTJxtcWRCvkMikc8oELgAVNcz",
  • "secret": "C50k0bcahDhLNhLKSUBSR1OMiFGzNZ7X"
}

Response samples

Content type
application/json
{
  • "algorithm": "HS256",
  • "consumer": {
    },
  • "id": "75695322-e8a0-4109-aed4-5416b0308d85",
  • "key": "YJdmaDvVTJxtcWRCvkMikc8oELgAVNcz",
  • "secret": "C50k0bcahDhLNhLKSUBSR1OMiFGzNZ7X"
}

Delete a a JWT associated with a Consumer

Delete a a JWT associated with a Consumer using ID.

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

ConsumerIdForNestedEntities
required
string
Example: f28acbfa-c866-4587-b688-0208ac24df21

Consumer ID for nested entities

JWTId
required
string
Example: 4a7f5faa-8c96-46d6-8214-c87573ef2ac4

ID of the JWT to lookup

Responses

Fetch a JWT associated with a Consumer

Get a JWT associated with a Consumer using ID.

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

ConsumerIdForNestedEntities
required
string
Example: f28acbfa-c866-4587-b688-0208ac24df21

Consumer ID for nested entities

JWTId
required
string
Example: 4a7f5faa-8c96-46d6-8214-c87573ef2ac4

ID of the JWT to lookup

Responses

Response samples

Content type
application/json
{
  • "algorithm": "HS256",
  • "consumer": {
    },
  • "id": "75695322-e8a0-4109-aed4-5416b0308d85",
  • "key": "YJdmaDvVTJxtcWRCvkMikc8oELgAVNcz",
  • "secret": "C50k0bcahDhLNhLKSUBSR1OMiFGzNZ7X"
}

Upsert a JWT associated with a Consumer

Create or Update a JWT associated with a Consumer using ID.

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

ConsumerIdForNestedEntities
required
string
Example: f28acbfa-c866-4587-b688-0208ac24df21

Consumer ID for nested entities

JWTId
required
string
Example: 4a7f5faa-8c96-46d6-8214-c87573ef2ac4

ID of the JWT to lookup

Request Body schema: application/json

Description of the JWT

algorithm
string or null
Default: "HS256"
Enum: "HS256" "HS384" "HS512" "RS256" "RS384" "RS512" "ES256" "ES384" "ES512" "PS256" "PS384" "PS512" "EdDSA"
object or null
created_at
integer or null

Unix epoch when the resource was created.

id
string or null
key
string or null
rsa_public_key
string or null
secret
string or null
tags
Array of strings

Responses

Request samples

Content type
application/json
{
  • "algorithm": "HS256",
  • "id": "75695322-e8a0-4109-aed4-5416b0308d85",
  • "key": "YJdmaDvVTJxtcWRCvkMikc8oELgAVNcz",
  • "secret": "C50k0bcahDhLNhLKSUBSR1OMiFGzNZ7X"
}

Response samples

Content type
application/json
{
  • "algorithm": "HS256",
  • "consumer": {
    },
  • "id": "75695322-e8a0-4109-aed4-5416b0308d85",
  • "key": "YJdmaDvVTJxtcWRCvkMikc8oELgAVNcz",
  • "secret": "C50k0bcahDhLNhLKSUBSR1OMiFGzNZ7X"
}

List all JWTs

List all JWTs

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

query Parameters
size
integer [ 1 .. 1000 ]
Default: 100

Number of resources to be returned.

offset
string

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

tags
string
Example: tags=tag1,tag2

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.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "next": "string",
  • "offset": "string"
}

Fetch a JWT

Get a JWT using ID.

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
JWTId
required
string
Example: 4a7f5faa-8c96-46d6-8214-c87573ef2ac4

ID of the JWT to lookup

controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

Responses

Response samples

Content type
application/json
{
  • "algorithm": "HS256",
  • "consumer": {
    },
  • "id": "75695322-e8a0-4109-aed4-5416b0308d85",
  • "key": "YJdmaDvVTJxtcWRCvkMikc8oELgAVNcz",
  • "secret": "C50k0bcahDhLNhLKSUBSR1OMiFGzNZ7X"
}

HMAC-auth credentials

List all HMAC-auth credentials associated with a Consumer

List all HMAC-auth credentials associated with a Consumer

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

ConsumerIdForNestedEntities
required
string
Example: f28acbfa-c866-4587-b688-0208ac24df21

Consumer ID for nested entities

query Parameters
size
integer [ 1 .. 1000 ]
Default: 100

Number of resources to be returned.

offset
string

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

tags
string
Example: tags=tag1,tag2

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.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "next": "string",
  • "offset": "string"
}

Create a new HMAC-auth credential associated with a Consumer

Create a new HMAC-auth credential associated with a Consumer

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

ConsumerIdForNestedEntities
required
string
Example: f28acbfa-c866-4587-b688-0208ac24df21

Consumer ID for nested entities

Request Body schema: application/json

Description of new HMAC-auth credential for creation

object or null
created_at
integer or null

Unix epoch when the resource was created.

id
string or null
secret
string or null
tags
Array of strings
username
required
string

Responses

Request samples

Content type
application/json
{
  • "id": "75695322-e8a0-4109-aed4-5416b0308d85",
  • "secret": "wQazJ304DW5huJklHgUfjfiSyCyTAEDZ",
  • "username": "xerxes"
}

Response samples

Content type
application/json
{
  • "consumer": {
    },
  • "id": "75695322-e8a0-4109-aed4-5416b0308d85",
  • "secret": "wQazJ304DW5huJklHgUfjfiSyCyTAEDZ",
  • "username": "xerxes"
}

Delete a a HMAC-auth credential associated with a Consumer

Delete a a HMAC-auth credential associated with a Consumer using ID.

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

ConsumerIdForNestedEntities
required
string
Example: f28acbfa-c866-4587-b688-0208ac24df21

Consumer ID for nested entities

HMACAuthId
required
string
Example: 70e7b00b-72f2-471b-a5ce-9c4171775360

ID of the HMAC-auth credential to lookup

Responses

Fetch a HMAC-auth credential associated with a Consumer

Get a HMAC-auth credential associated with a Consumer using ID.

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

ConsumerIdForNestedEntities
required
string
Example: f28acbfa-c866-4587-b688-0208ac24df21

Consumer ID for nested entities

HMACAuthId
required
string
Example: 70e7b00b-72f2-471b-a5ce-9c4171775360

ID of the HMAC-auth credential to lookup

Responses

Response samples

Content type
application/json
{
  • "consumer": {
    },
  • "id": "75695322-e8a0-4109-aed4-5416b0308d85",
  • "secret": "wQazJ304DW5huJklHgUfjfiSyCyTAEDZ",
  • "username": "xerxes"
}

Upsert a HMAC-auth credential associated with a Consumer

Create or Update a HMAC-auth credential associated with a Consumer using ID.

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

ConsumerIdForNestedEntities
required
string
Example: f28acbfa-c866-4587-b688-0208ac24df21

Consumer ID for nested entities

HMACAuthId
required
string
Example: 70e7b00b-72f2-471b-a5ce-9c4171775360

ID of the HMAC-auth credential to lookup

Request Body schema: application/json

Description of the HMAC-auth credential

object or null
created_at
integer or null

Unix epoch when the resource was created.

id
string or null
secret
string or null
tags
Array of strings
username
required
string

Responses

Request samples

Content type
application/json
{
  • "id": "75695322-e8a0-4109-aed4-5416b0308d85",
  • "secret": "wQazJ304DW5huJklHgUfjfiSyCyTAEDZ",
  • "username": "xerxes"
}

Response samples

Content type
application/json
{
  • "consumer": {
    },
  • "id": "75695322-e8a0-4109-aed4-5416b0308d85",
  • "secret": "wQazJ304DW5huJklHgUfjfiSyCyTAEDZ",
  • "username": "xerxes"
}

List all HMAC-auth credentials

List all HMAC-auth credentials

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

query Parameters
size
integer [ 1 .. 1000 ]
Default: 100

Number of resources to be returned.

offset
string

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

tags
string
Example: tags=tag1,tag2

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.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "next": "string",
  • "offset": "string"
}

Fetch a HMAC-auth credential

Get a HMAC-auth credential using ID.

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
HMACAuthId
required
string
Example: 70e7b00b-72f2-471b-a5ce-9c4171775360

ID of the HMAC-auth credential to lookup

controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

Responses

Response samples

Content type
application/json
{
  • "consumer": {
    },
  • "id": "75695322-e8a0-4109-aed4-5416b0308d85",
  • "secret": "wQazJ304DW5huJklHgUfjfiSyCyTAEDZ",
  • "username": "xerxes"
}

MTLS-auth credentials

List all MTLS-auth credentials associated with a Consumer

List all MTLS-auth credentials associated with a Consumer

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

ConsumerIdForNestedEntities
required
string
Example: f28acbfa-c866-4587-b688-0208ac24df21

Consumer ID for nested entities

query Parameters
size
integer [ 1 .. 1000 ]
Default: 100

Number of resources to be returned.

offset
string

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

tags
string
Example: tags=tag1,tag2

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.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "next": "string",
  • "offset": "string"
}

Create a new MTLS-auth credential associated with a Consumer

Create a new MTLS-auth credential associated with a Consumer

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

ConsumerIdForNestedEntities
required
string
Example: f28acbfa-c866-4587-b688-0208ac24df21

Consumer ID for nested entities

Request Body schema: application/json

Description of new MTLS-auth credential for creation

object
object or null
created_at
integer or null

Unix epoch when the resource was created.

id
string or null
subject_name
required
string
tags
Array of strings

Responses

Request samples

Content type
application/json
{
  • "ca_certificate": {
    },
  • "id": "b2f34145-0343-41a4-9602-4c69dec2f269",
  • "subject_name": "CA_Subject_Name"
}

Response samples

Content type
application/json
{
  • "ca_certificate": {
    },
  • "consumer": {
    },
  • "id": "b2f34145-0343-41a4-9602-4c69dec2f269",
  • "subject_name": "CA_Subject_Name"
}

Delete a a MTLS-auth credential associated with a Consumer

Delete a a MTLS-auth credential associated with a Consumer using ID.

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

ConsumerIdForNestedEntities
required
string
Example: f28acbfa-c866-4587-b688-0208ac24df21

Consumer ID for nested entities

MTLSAuthId
required
string

ID of the MTLS-auth credential to lookup

Responses

Fetch a MTLS-auth credential associated with a Consumer

Get a MTLS-auth credential associated with a Consumer using ID.

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

ConsumerIdForNestedEntities
required
string
Example: f28acbfa-c866-4587-b688-0208ac24df21

Consumer ID for nested entities

MTLSAuthId
required
string

ID of the MTLS-auth credential to lookup

Responses

Response samples

Content type
application/json
{
  • "ca_certificate": {
    },
  • "consumer": {
    },
  • "id": "b2f34145-0343-41a4-9602-4c69dec2f269",
  • "subject_name": "CA_Subject_Name"
}

Upsert a MTLS-auth credential associated with a Consumer

Create or Update a MTLS-auth credential associated with a Consumer using ID.

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

ConsumerIdForNestedEntities
required
string
Example: f28acbfa-c866-4587-b688-0208ac24df21

Consumer ID for nested entities

MTLSAuthId
required
string

ID of the MTLS-auth credential to lookup

Request Body schema: application/json

Description of the MTLS-auth credential

object
object or null
created_at
integer or null

Unix epoch when the resource was created.

id
string or null
subject_name
required
string
tags
Array of strings

Responses

Request samples

Content type
application/json
{
  • "ca_certificate": {
    },
  • "id": "b2f34145-0343-41a4-9602-4c69dec2f269",
  • "subject_name": "CA_Subject_Name"
}

Response samples

Content type
application/json
{
  • "ca_certificate": {
    },
  • "consumer": {
    },
  • "id": "b2f34145-0343-41a4-9602-4c69dec2f269",
  • "subject_name": "CA_Subject_Name"
}

List all MTLS-auth credentials

List all MTLS-auth credentials

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

query Parameters
size
integer [ 1 .. 1000 ]
Default: 100

Number of resources to be returned.

offset
string

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

tags
string
Example: tags=tag1,tag2

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.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "next": "string",
  • "offset": "string"
}

Fetch a MTLS-auth credential

Get a MTLS-auth credential using ID.

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
MTLSAuthId
required
string

ID of the MTLS-auth credential to lookup

controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

Responses

Response samples

Content type
application/json
{
  • "ca_certificate": {
    },
  • "consumer": {
    },
  • "id": "b2f34145-0343-41a4-9602-4c69dec2f269",
  • "subject_name": "CA_Subject_Name"
}

ACLs

List all ACLs

List all ACLs

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

query Parameters
size
integer [ 1 .. 1000 ]
Default: 100

Number of resources to be returned.

offset
string

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

tags
string
Example: tags=tag1,tag2

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.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "next": "string",
  • "offset": "string"
}

Fetch an ACL

Get an ACL using ID.

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
ACLId
required
string
Example: f28acbfa-c866-4587-b688-0208ac24df21

ID of the ACL to lookup

controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

Responses

Response samples

Content type
application/json
{
  • "consumer": {
    },
  • "group": "foo",
  • "id": "b1f34145-0343-41a4-9602-4c69dec2f269"
}

List all ACLs associated with a Consumer

List all ACLs associated with a Consumer

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

ConsumerIdForNestedEntities
required
string
Example: f28acbfa-c866-4587-b688-0208ac24df21

Consumer ID for nested entities

query Parameters
size
integer [ 1 .. 1000 ]
Default: 100

Number of resources to be returned.

offset
string

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

tags
string
Example: tags=tag1,tag2

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.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "next": "string",
  • "offset": "string"
}

Create a new ACL associated with a Consumer

Create a new ACL associated with a Consumer

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

ConsumerIdForNestedEntities
required
string
Example: f28acbfa-c866-4587-b688-0208ac24df21

Consumer ID for nested entities

Request Body schema: application/json

Description of new ACL for creation

object or null
created_at
integer or null

Unix epoch when the resource was created.

group
required
string
id
string or null
tags
Array of strings

Responses

Request samples

Content type
application/json
{
  • "group": "foo",
  • "id": "b1f34145-0343-41a4-9602-4c69dec2f269"
}

Response samples

Content type
application/json
{
  • "consumer": {
    },
  • "group": "foo",
  • "id": "b1f34145-0343-41a4-9602-4c69dec2f269"
}

Delete a an ACL associated with a Consumer

Delete a an ACL associated with a Consumer using ID.

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

ConsumerIdForNestedEntities
required
string
Example: f28acbfa-c866-4587-b688-0208ac24df21

Consumer ID for nested entities

ACLId
required
string
Example: f28acbfa-c866-4587-b688-0208ac24df21

ID of the ACL to lookup

Responses

Fetch an ACL associated with a Consumer

Get an ACL associated with a Consumer using ID.

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

ConsumerIdForNestedEntities
required
string
Example: f28acbfa-c866-4587-b688-0208ac24df21

Consumer ID for nested entities

ACLId
required
string
Example: f28acbfa-c866-4587-b688-0208ac24df21

ID of the ACL to lookup

Responses

Response samples

Content type
application/json
{
  • "consumer": {
    },
  • "group": "foo",
  • "id": "b1f34145-0343-41a4-9602-4c69dec2f269"
}

Upsert an ACL associated with a Consumer

Create or Update an ACL associated with a Consumer using ID.

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

ConsumerIdForNestedEntities
required
string
Example: f28acbfa-c866-4587-b688-0208ac24df21

Consumer ID for nested entities

ACLId
required
string
Example: f28acbfa-c866-4587-b688-0208ac24df21

ID of the ACL to lookup

Request Body schema: application/json

Description of the ACL

object or null
created_at
integer or null

Unix epoch when the resource was created.

group
required
string
id
string or null
tags
Array of strings

Responses

Request samples

Content type
application/json
{
  • "group": "foo",
  • "id": "b1f34145-0343-41a4-9602-4c69dec2f269"
}

Response samples

Content type
application/json
{
  • "consumer": {
    },
  • "group": "foo",
  • "id": "b1f34145-0343-41a4-9602-4c69dec2f269"
}

OIDC JWKs

Partials

List all Partials

List all Partials

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

query Parameters
size
integer [ 1 .. 1000 ]
Default: 100

Number of resources to be returned.

offset
string

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

tags
string
Example: tags=tag1,tag2

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.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "next": "string",
  • "offset": "string"
}

Create a new Partial

Create a new Partial

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

Request Body schema: application/json

Description of the new Partial for creation

required
object
created_at
integer or null

Unix epoch when the resource was created.

id
string or null
name
string or null
tags
Array of strings
type
required
string
updated_at
integer or null

Unix epoch when the resource was last updated.

Responses

Request samples

Content type
application/json
{
  • "config": { },
  • "created_at": 0,
  • "id": "string",
  • "name": "string",
  • "tags": [
    ],
  • "type": "string",
  • "updated_at": 0
}

Response samples

Content type
application/json
{
  • "config": { },
  • "created_at": 0,
  • "id": "string",
  • "name": "string",
  • "tags": [
    ],
  • "type": "string",
  • "updated_at": 0
}

Delete a Partial

Delete a Partial

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

PartialId
required
string

ID of the Partial to lookup

Responses

Response samples

Content type
application/json
Example
{
  • "message": "Duplicate API key found",
  • "status": 401
}

Fetch a Partial

Get a Partial using ID.

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
PartialId
required
string

ID of the Partial to lookup

controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

Responses

Response samples

Content type
application/json
{
  • "config": { },
  • "created_at": 0,
  • "id": "string",
  • "name": "string",
  • "tags": [
    ],
  • "type": "string",
  • "updated_at": 0
}

Upsert a Partial

Create or Update Partial using ID.

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
PartialId
required
string

ID of the Partial to lookup

controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

Request Body schema: application/json

Description of the Partial

required
object
created_at
integer or null

Unix epoch when the resource was created.

id
string or null
name
string or null
tags
Array of strings
type
required
string
updated_at
integer or null

Unix epoch when the resource was last updated.

Responses

Request samples

Content type
application/json
{
  • "config": { },
  • "created_at": 0,
  • "id": "string",
  • "name": "string",
  • "tags": [
    ],
  • "type": "string",
  • "updated_at": 0
}

Response samples

Content type
application/json
{
  • "config": { },
  • "created_at": 0,
  • "id": "string",
  • "name": "string",
  • "tags": [
    ],
  • "type": "string",
  • "updated_at": 0
}

Nodes

Create or update a node

Create or update a node.

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

nodeId
required
string <uuid>
Example: d32d905a-ed33-46a3-a093-d8f536af9a8a

Node identifier

Request Body schema: application/json
hostname
string
type
string
version
string
config_version
string
Array of objects (A Node Error)

Responses

Request samples

Content type
application/json
{
  • "hostname": "node1.my.domain.com",
  • "type": "knep",
  • "version": "1.0",
  • "config_version": "string",
  • "errors": [
    ]
}

Response samples

Content type
application/json
{
  • "item": {
    }
}

Declarative Configuration

Create or Update the declarative config

Create or Update the declarative config

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

Request Body schema: application/json
config
string

The configuration as string. Must be valid yaml or json.

Responses

Request samples

Content type
application/json
{
  • "config": "string"
}

Response samples

Content type
application/json
{
  • "config": "string",
  • "version": "5f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
  • "created_at": "2022-11-04T20:10:06.927Z",
  • "updated_at": "2022-11-04T20:10:06.927Z"
}

Get the declarative configuration

Returns the declarative configuration set for the control plane.

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

Responses

Response samples

Content type
application/json
{
  • "config": "string",
  • "version": "5f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
  • "created_at": "2022-11-04T20:10:06.927Z",
  • "updated_at": "2022-11-04T20:10:06.927Z"
}

Delete the declarative config

Delete the declarative config

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

Responses

Response samples

Content type
application/problem+json
{
  • "status": 401,
  • "title": "Unauthorized",
  • "instance": "kong:trace:8347343766220159418",
  • "detail": "Unauthorized"
}

Get the event gateway declarative configuration

Returns the declarative configuration formatted for an event gateway.

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

Responses

Response samples

Content type
application/json
{
  • "config": { },
  • "version": "5f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
  • "created_at": "2022-11-04T20:10:06.927Z",
  • "updated_at": "2022-11-04T20:10:06.927Z"
}

Get the http gateway declarative configuration

Returns the declarative configuration formatted for an http gateway.

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

Responses

Targets

List all Targets associated with an Upstream

List all Targets associated with an Upstream

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

UpstreamIdForTarget
required
string
Example: 5a078780-5d4c-4aae-984a-bdc6f52113d8

ID or target of the Target to lookup

query Parameters
size
integer [ 1 .. 1000 ]
Default: 100

Number of resources to be returned.

offset
string

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

tags
string
Example: tags=tag1,tag2

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.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "next": "string",
  • "offset": "string"
}

Create a new Target associated with an Upstream

Create a new Target associated with an Upstream

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

UpstreamIdForTarget
required
string
Example: 5a078780-5d4c-4aae-984a-bdc6f52113d8

ID or target of the Target to lookup

Request Body schema: application/json

Description of new Target for creation

created_at
number or null

Unix epoch when the resource was created.

id
string or null
tags
Array of strings

An optional set of strings associated with the Target for grouping and filtering.

target
string or null

The target address (ip or hostname) and port. If the hostname resolves to an SRV record, the port value will be overridden by the value from the DNS record.

updated_at
number or null

Unix epoch when the resource was last updated.

object or null
weight
integer or null
Default: 100

The weight this target gets within the upstream loadbalancer (0-65535). If the hostname resolves to an SRV record, the weight value will be overridden by the value from the DNS record.

Responses

Request samples

Content type
application/json
{
  • "id": "089292a7-ba3d-4d88-acf0-97b4b2e2621a",
  • "target": "203.0.113.42",
  • "weight": 100
}

Response samples

Content type
application/json
{
  • "id": "089292a7-ba3d-4d88-acf0-97b4b2e2621a",
  • "target": "203.0.113.42",
  • "upstream": {
    },
  • "weight": 100
}

Delete a a Target associated with an Upstream

Delete a a Target associated with an Upstream using ID or target.

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

UpstreamIdForTarget
required
string
Example: 5a078780-5d4c-4aae-984a-bdc6f52113d8

ID or target of the Target to lookup

TargetId
required
string
Example: 5a078780-5d4c-4aae-984a-bdc6f52113d8

ID of the Target to lookup

Responses

Fetch a Target associated with an Upstream

Get a Target associated with an Upstream using ID or target.

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

UpstreamIdForTarget
required
string
Example: 5a078780-5d4c-4aae-984a-bdc6f52113d8

ID or target of the Target to lookup

TargetId
required
string
Example: 5a078780-5d4c-4aae-984a-bdc6f52113d8

ID of the Target to lookup

Responses

Response samples

Content type
application/json
{
  • "id": "089292a7-ba3d-4d88-acf0-97b4b2e2621a",
  • "target": "203.0.113.42",
  • "upstream": {
    },
  • "weight": 100
}

Upsert a Target associated with an Upstream

Create or Update a Target associated with an Upstream using ID or target.

Authorizations:
konnectAccessTokenpersonalAccessToken
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

UpstreamIdForTarget
required
string
Example: 5a078780-5d4c-4aae-984a-bdc6f52113d8

ID or target of the Target to lookup

TargetId
required
string
Example: 5a078780-5d4c-4aae-984a-bdc6f52113d8

ID of the Target to lookup

Request Body schema: application/json

Description of the Target

created_at
number or null

Unix epoch when the resource was created.

id
string or null
tags
Array of strings

An optional set of strings associated with the Target for grouping and filtering.

target
string or null

The target address (ip or hostname) and port. If the hostname resolves to an SRV record, the port value will be overridden by the value from the DNS record.

updated_at
number or null

Unix epoch when the resource was last updated.

object or null
weight
integer or null
Default: 100

The weight this target gets within the upstream loadbalancer (0-65535). If the hostname resolves to an SRV record, the weight value will be overridden by the value from the DNS record.

Responses

Request samples

Content type
application/json
{
  • "id": "089292a7-ba3d-4d88-acf0-97b4b2e2621a",
  • "target": "203.0.113.42",
  • "weight": 100
}

Response samples

Content type
application/json
{
  • "id": "089292a7-ba3d-4d88-acf0-97b4b2e2621a",
  • "target": "203.0.113.42",
  • "upstream": {
    },
  • "weight": 100
}