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

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

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