API docs by Redocly

Konnect API (0.0.1)

Download OpenAPI specification:Download

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

The Konnect platform API

Documentation for Kong Gateway and its APIs

AI Manager Models

A composite object that conceptually represents the concept of an AI Model. The object contains a service object and a plugin object defined on that service. The service object represents the LLM endpoint and the plugin object represents the configuration of the LLM endpoint. The plugin will be one of: ai-proxy or ai-proxy-advanced.

Get AI Manager Models, a composite object containing a plugin and service that represent an LLM integration.

Returns a list of composite objects representing ai-manager-models for the organization ID represented in the JWT claim.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenclientTokenserviceAccessTokenbearerAuth
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": {
    }
}

Explore

Explore metrics in the analyticcs platform

Post a query to the endpoint to retrieve aggregated metrics down to the minute. Data can be requested to group by any 2 dimensions, and any number of filter conditions.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenclientTokenserviceAccessTokenbearerAuth
Request Body schema: application/json
metrics
required
Array of strings
Items Enum: "request_count" "request_per_minute" "response_latency_p99" "response_latency_p95" "response_latency_p50" "response_latency_average" "upstream_latency_p99" "upstream_latency_p95" "upstream_latency_p50" "upstream_latency_average" "kong_latency_p99" "kong_latency_p95" "kong_latency_p50" "kong_latency_average" "response_size_p99" "response_size_p95" "response_size_p50" "request_size_p99" "request_size_p95" "request_size_p50" "request_size_average" "response_size_average"

List of aggregated metrics to collect across the requested time span.

dimensions
Array of strings [ 0 .. 2 ] items
Items Enum: "api_product" "api_product_version" "application" "consumer" "control_plane" "control_plane_group" "data_plane_node" "gateway_service" "route" "status_code" "status_code_grouped" "time"

List of attributes or entity types to group by.

Array of objects (ExploreFilter)

A list of filters to apply to the query.

granularity
string
Enum: "minute" "hour" "day" "week" "trend"

Force time grouping into buckets of the specified duration. Only has an effect if "time" is in the "dimensions" list.

If "trend" is chosen, the time range covered by the query will be twice the specified time range, and the granularity will be set such that two time buckets are returned, one for the given time range and one for the same time range prior. For example:

time range: last 24 hours granularity: trend

will return 2 time buckets (assuming both have data):

  • 48 hours ago to 24 hours ago
  • 24 hours ago to now

Another example:

time range: 2020-05-01 to 2020-05-15 granularity: trend

will return 2 time buckets:

  • 2020-04-15 through 2020-04-30
  • 2020-05-01 through 2020-05-15

The granularity of the result may be coarser than requested. The finest allowed granularity depends on the query's time range: data farther in the past may have coarser granularity. The exact result granularity will be reported in the response meta.granularity_ms field.

If granularity is not specified and "time" is in the dimensions list, a default will be chosen based on the time range requested.

any
Default: {"type":"relative","time_range":"1h"}

The time range to query.

meta
object

Responses

Request samples

Content type
application/json
{
  • "time_range": {
    },
  • "dimensions": [
    ],
  • "filters": [
    ],
  • "granularity": "hour",
  • "metrics": [
    ]
}

Response samples

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

Custom Reports

List Custom Reports

Returns a list of custom reports.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenclientTokenserviceAccessTokenbearerAuth
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[number]
integer
Example: page[number]=1

Determines which page of the entities to retrieve.

Responses

Response samples

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

New Custom Report

Creates a new custom report.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenclientTokenserviceAccessTokenbearerAuth
Request Body schema: application/json

The request schema for the create report request.

If you pass the same name and description of an existing report in the request, a report with the same name and description will be created. The two reports will have different id values to differentiate them.

Note that all fields are optional: if you pass an empty JSON object as the request ({}), a new report will be created with a default configuration.

name
string [ 1 .. 255 ] characters

The user-provided name for the report. If not provided, the report will be named "Untitled Report" with a timestamp suffix.

description
string

An optional extended description for the report.

chart_type
string
Default: "HORIZONTAL_BAR"
Enum: "HORIZONTAL_BAR" "VERTICAL_BAR" "LINE"

Visualization type selected for this report.

any (TimeRange)
Default: {"type":"RELATIVE","time_period":"24H"}

The period of time to return data. Relative time ranges are relative to the current moment. Absolute time ranges specify an unchanging period of time. If not specified, a default relative timeframe of last 24 hours will be chosen.

object

Responses

Request samples

Content type
application/json
Example

A vertical bar chart grouping data first by API product, then by status code, for the past 24 hours.

{
  • "name": "Status codes by service",
  • "chart_type": "VERTICAL_BAR",
  • "time_range": {
    },
  • "query": {
    }
}

Response samples

Content type
application/json
{
  • "summary": "Bar chart of status codes by API product for the past 24 hours",
  • "description": "A vertical bar chart grouping data first by API product, then by status code, for the past 24 hours.",
  • "value": {
    }
}

Fetch Custom Report

Returns a single report.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenclientTokenserviceAccessTokenbearerAuth
path Parameters
reportId
required
string <uuid>
Example: d32d905a-ed33-46a3-a093-d8f536af9a8a

The report's ID

Responses

Response samples

Content type
application/json
{
  • "summary": "Bar chart of status codes by API product for the past 24 hours",
  • "description": "A vertical bar chart grouping data first by API product, then by status code, for the past 24 hours.",
  • "value": {
    }
}

Update Report

Updates a custom report.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenclientTokenserviceAccessTokenbearerAuth
path Parameters
reportId
required
string <uuid>
Example: d32d905a-ed33-46a3-a093-d8f536af9a8a

The report's ID

Request Body schema: application/json

The request schema for the update report request.

name
string [ 1 .. 255 ] characters

The user-provided name for the report. If not provided, the report will be named "Untitled Report" with a timestamp suffix.

description
string

An optional extended description for the report.

chart_type
string
Default: "HORIZONTAL_BAR"
Enum: "HORIZONTAL_BAR" "VERTICAL_BAR" "LINE"

Visualization type selected for this report.

any (TimeRange)
Default: {"type":"RELATIVE","time_period":"24H"}

The period of time to return data. Relative time ranges are relative to the current moment. Absolute time ranges specify an unchanging period of time. If not specified, a default relative timeframe of last 24 hours will be chosen.

object

Responses

Request samples

Content type
application/json
Example

A vertical bar chart grouping data first by API product, then by status code, for the past 24 hours.

{
  • "name": "Status codes by service",
  • "chart_type": "VERTICAL_BAR",
  • "time_range": {
    },
  • "query": {
    }
}

Response samples

Content type
application/json
{
  • "summary": "Bar chart of status codes by API product for the past 24 hours",
  • "description": "A vertical bar chart grouping data first by API product, then by status code, for the past 24 hours.",
  • "value": {
    }
}

Delete Custom Report

Deletes a custom report. Returns 404 if the report is not found.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenclientTokenserviceAccessTokenbearerAuth
path Parameters
reportId
required
string <uuid>
Example: d32d905a-ed33-46a3-a093-d8f536af9a8a

The report's ID

Responses

Response samples

Content type
application/problem+json
{
  • "status": 0,
  • "title": "string",
  • "type": "string",
  • "instance": "string",
  • "detail": "string",
  • "invalid_parameters": [
    ]
}

Export as CSV

Exports report data in CSV format.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenclientTokenserviceAccessTokenbearerAuth
path Parameters
reportId
required
string <uuid>
Example: d32d905a-ed33-46a3-a093-d8f536af9a8a

The ID of the report to export

query Parameters
tz
string
Example: tz=Etc/UTC

The timezone to use for the report. This impacts several things:

  • The timestamps returned, if time is a dimension.
  • Day boundaries for reports, meaning that if the report implicitly has a granularity of DAILY or higher, the same query may return different data depending on the timezone selected.
utc_format
boolean

If true, export timestamps in "programmer friendly" format (ISO-8601, UTC timezone). If false, export in "spreadsheet friendly" format (local time without timezone specifier).

Note: this does NOT impact the timezone of the report, merely the format of the time column if one is present.

Responses

Response samples

Content type
text/csv
Example
TIMESTAMP,UTC_OFFSET,API_PRODUCT,TOTAL_REQUESTS
2023-01-01 00:00:00,-04:00,ProductA,2497079
2023-01-01 00:00:00,-04:00,ProductB,2029907

Networks

List Networks

Returns a paginated list of networks.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenclientTokenserviceAccessTokenbearerAuth
query Parameters
object (NetworksFilterParameters)

Filters supported for networks.

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[number]
integer
Example: page[number]=1

Determines which page of the entities to retrieve.

Responses

Response samples

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

Create Network

Creates a new network for a given provider account.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenclientTokenserviceAccessTokenbearerAuth
Request Body schema: application/json
name
required
string (Network Name)

Human-readable name of the network.

cloud_gateway_provider_account_id
required
string <uuid> (ProviderAccountId)
region
required
string (Provider Region ID)

Region ID for cloud provider region.

availability_zones
required
Array of strings (NetworkAvailabilityZones)

List of availability zones that the network is attached to.

cidr_block
required
string (Network CIDR Block)

CIDR block configuration for the network.

object (Network Firewall Config)

Firewall configuration for a network.

ddos_protection
boolean (Network DDOS Protection)

Whether DDOS protection is enabled for the network.

state
string (Network Create State)
Default: "initializing"
Enum: "initializing" "offline"

Initial state for creating a network.

Responses

Request samples

Content type
application/json
{
  • "name": "us-east-2 network",
  • "cloud_gateway_provider_account_id": "929b2449-c69f-44c4-b6ad-9ecec6f811ae",
  • "region": "us-east-2",
  • "availability_zones": [
    ],
  • "cidr_block": "10.0.0.0/8",
  • "firewall": {
    },
  • "ddos_protection": false,
  • "state": "initializing"
}

Response samples

Content type
application/json
{
  • "id": "36ae63d3-efd1-4bec-b246-62aa5d3f5695",
  • "name": "us-east-2 network",
  • "default": false,
  • "cloud_gateway_provider_account_id": "929b2449-c69f-44c4-b6ad-9ecec6f811ae",
  • "region": "us-east-2",
  • "availability_zones": [
    ],
  • "cidr_block": "10.0.0.0/8",
  • "firewall": {
    },
  • "ddos_protection": false,
  • "state": "created",
  • "provider_metadata": {
    },
  • "transit_gateway_count": 0,
  • "configuration_reference_count": 0,
  • "entity_version": 1,
  • "created_at": "2022-11-04T20:10:06.927Z",
  • "updated_at": "2022-11-04T20:10:06.927Z"
}

Update Network

Updates a network by ID.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenclientTokenserviceAccessTokenbearerAuth
path Parameters
networkId
required
string <uuid> (NetworkId)
Example: 36ae63d3-efd1-4bec-b246-62aa5d3f5695

The network to operate on.

Request Body schema: application/json
name
string (Network Name)

Human-readable name of the network.

object (Network Firewall Config)

Firewall configuration for a network.

Responses

Request samples

Content type
application/json
{
  • "name": "us-east-2 network",
  • "firewall": {
    }
}

Response samples

Content type
application/json
{
  • "id": "36ae63d3-efd1-4bec-b246-62aa5d3f5695",
  • "name": "us-east-2 network",
  • "default": false,
  • "cloud_gateway_provider_account_id": "929b2449-c69f-44c4-b6ad-9ecec6f811ae",
  • "region": "us-east-2",
  • "availability_zones": [
    ],
  • "cidr_block": "10.0.0.0/8",
  • "firewall": {
    },
  • "ddos_protection": false,
  • "state": "created",
  • "provider_metadata": {
    },
  • "transit_gateway_count": 0,
  • "configuration_reference_count": 0,
  • "entity_version": 1,
  • "created_at": "2022-11-04T20:10:06.927Z",
  • "updated_at": "2022-11-04T20:10:06.927Z"
}

Private DNS

List Private DNS

Returns a paginated collection of Private DNS for a given network.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenclientTokenserviceAccessTokenbearerAuth
path Parameters
networkId
required
string <uuid> (NetworkId)
Example: 36ae63d3-efd1-4bec-b246-62aa5d3f5695

The network to operate on.

query Parameters
object (PrivateDnsFilterParameters)

Filters supported for Private DNS.

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[number]
integer
Example: page[number]=1

Determines which page of the entities to retrieve.

Responses

Response samples

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

Create Private DNS

Creates a new Private DNS for a given network.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenclientTokenserviceAccessTokenbearerAuth
path Parameters
networkId
required
string <uuid> (NetworkId)
Example: 36ae63d3-efd1-4bec-b246-62aa5d3f5695

The network to operate on.

Request Body schema: application/json
One of
name
required
string (Private DNS Name)

Human-readable name of the Private DNS.

required
object (AWS Private Hosted Zone Attachment Config)

Responses

Request samples

Content type
application/json
{
  • "name": "us-east-2 private dns",
  • "private_dns_attachment_config": {
    }
}

Response samples

Content type
application/json
{
  • "name": "us-east-2 private dns",
  • "private_dns_attachment_config": {
    },
  • "id": "1850820b-c69f-4a2a-b9be-bbcdbc5cd618",
  • "state": "created",
  • "entity_version": 1,
  • "created_at": "2022-11-04T20:10:06.927Z",
  • "updated_at": "2022-11-04T20:10:06.927Z"
}

Get Private DNS

Retrieves a Private DNS by ID for a given network.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenclientTokenserviceAccessTokenbearerAuth
path Parameters
networkId
required
string <uuid> (NetworkId)
Example: 36ae63d3-efd1-4bec-b246-62aa5d3f5695

The network to operate on.

privateDnsId
required
string <uuid> (PrivateDnsId)
Example: 1850820b-c69f-4a2a-b9be-bbcdbc5cd618

The ID of the Private DNS to operate on.

Responses

Response samples

Content type
application/json
{
  • "name": "us-east-2 private dns",
  • "private_dns_attachment_config": {
    },
  • "id": "1850820b-c69f-4a2a-b9be-bbcdbc5cd618",
  • "state": "created",
  • "entity_version": 1,
  • "created_at": "2022-11-04T20:10:06.927Z",
  • "updated_at": "2022-11-04T20:10:06.927Z"
}

Delete Private DNS

Deletes a Private DNS by ID for a given network.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenclientTokenserviceAccessTokenbearerAuth
path Parameters
networkId
required
string <uuid> (NetworkId)
Example: 36ae63d3-efd1-4bec-b246-62aa5d3f5695

The network to operate on.

privateDnsId
required
string <uuid> (PrivateDnsId)
Example: 1850820b-c69f-4a2a-b9be-bbcdbc5cd618

The ID of the Private DNS to operate on.

Responses

Response samples

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

Resource Availability

Get Resource Availability JSON

Get Cloud Gateways Availability JSON document for describing cloud provider and region availability, pricing, gateway version availability, and instance type information.

Responses

Response samples

Content type
application/json
{
  • "versions": [
    ],
  • "instance_types": [
    ],
  • "providers": [
    ]
}

Tracing Sessions

Tracing Session APIs

List all debug sessions for a control plane

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenclientTokenserviceAccessTokenbearerAuth
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:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenclientTokenserviceAccessTokenbearerAuth
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:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenclientTokenserviceAccessTokenbearerAuth
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:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenclientTokenserviceAccessTokenbearerAuth
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
Example
{
  • "status": 401,
  • "title": "Unauthorized",
  • "instance": "kong:trace:8347343766220159418",
  • "detail": "Unauthorized"
}

Stops an active Debug Session

Stops an active Debug Session

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenclientTokenserviceAccessTokenbearerAuth
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
{ }

Marks the target as completed in an active debug session

Marks the target as completed in an active debug session

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenclientTokenserviceAccessTokenbearerAuth
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

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

Unique identifier of the data plane node.

Responses

Response samples

Content type
application/json
{ }

Gets data for a debug session (internal only)

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenclientTokenserviceAccessTokenbearerAuth
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
{ }

Roles

Get Predefined Roles

Retrieves the predefined, or system managed, roles.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenclientTokenserviceAccessTokenbearerAuth

Responses

Response samples

Content type
application/json
{
  • "control_planes": {
    },
  • "api_products": {
    },
  • "audit_logs": {
    },
  • "identity": {
    },
  • "mesh_control_planes": {
    }
}

CMEK

Customer Managed Encryption Keys

List CMEKs

List customer managed encryption keys

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenclientTokenserviceAccessTokenbearerAuth
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.

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

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

object

Filter CMEKs returned in the response.

Responses

Response samples

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

Get a CMEK

Get a customer managed encryption key

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenclientTokenserviceAccessTokenbearerAuth
path Parameters
cmekId
required
string
Example: default

Id of the CMEK

Responses

Response samples

Content type
application/json
{
  • "id": "default",
  • "name": "My KMS Key",
  • "description": "My Key Description",
  • "key_arn": "arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012",
  • "created_at": "2023-03-20T09:29:14.52Z",
  • "updated_at": "2023-03-21T09:29:14.52Z"
}

Replace a CMEK

Replace a customer managed encryption key

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenclientTokenserviceAccessTokenbearerAuth
path Parameters
cmekId
required
string
Example: default

Id of the CMEK

Request Body schema: application/json

Request body schema for putting a CMEK.

key_arn
required
string

The ARN of the KMS key to use for encryption

name
string
description
string

Responses

Request samples

Content type
application/json
{
  • "name": "My KMS Key",
  • "description": "My Key Description",
  • "key_arn": "arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012"
}

Response samples

Content type
application/json
{
  • "id": "default",
  • "name": "My KMS Key",
  • "description": "My Key Description",
  • "key_arn": "arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012",
  • "created_at": "2023-03-20T09:29:14.52Z",
  • "updated_at": "2023-03-21T09:29:14.52Z"
}

Delete a CMEK

Delete a customer managed encryption key

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenclientTokenserviceAccessTokenbearerAuth
path Parameters
cmekId
required
string
Example: default

Id of the CMEK

Responses

Response samples

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

Blobs

Encrypted data blobs

Get a raw blob

Get a raw decrypted blob

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenclientTokenserviceAccessTokenbearerAuth
path Parameters
blobId
required
string
Example: 680ed2c45c18562ab4448d54c6f962ff:reqres

Id of the Blob

Responses

Response samples

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

Store a raw blob

Store a raw blob of data

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenclientTokenserviceAccessTokenbearerAuth
path Parameters
blobId
required
string
Example: 680ed2c45c18562ab4448d54c6f962ff:reqres

Id of the Blob

header Parameters
X-Konnect-Expires-In
integer
Default: 259200

Retention time (TTL) of the blob in seconds

X-Konnect-CMEK-Id
string
Default: default

The CMEK ID to use for encryption

Request Body schema: *

Raw blob data

string

Responses

Response samples

Content type
application/problem+json
{
  • "status": 0,
  • "title": "string",
  • "type": "string",
  • "instance": "string",
  • "detail": "string",
  • "invalid_parameters": [
    ]
}

Search

Search Konnect Analytics

Retrieves a list of Konnect entities matching the search query provided. It requires reports#list permission.

Learn more about search query syntax.
Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenclientTokenserviceAccessTokenbearerAuth
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.

Request Body schema: application/json

Analytics search request payload

One of
query
required
string

The query that defines the search criteria. Supports Lucene-like syntax for filtering results. Learn more about search query syntax here.

Responses

Request samples

Content type
application/json
Example
{
  • "query": "type:consumer AND @scope:realm AND id:(abc OR xyz OR 123)"
}

Response samples

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

Portals

APIs related to Configuration of Konnect Developer Portals.

Get a portal configuration

Get the configuration of the portal

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenclientTokenserviceAccessTokenbearerAuth
path Parameters
portalId
required
string <uuid>
Example: f32d905a-ed33-46a3-a093-d8f536af9a8a

ID of the portal.

Responses

Response samples

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

Replace a portal configuration

Update the configuration of the portal

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenclientTokenserviceAccessTokenbearerAuth
path Parameters
portalId
required
string <uuid>
Example: f32d905a-ed33-46a3-a093-d8f536af9a8a

ID of the portal.

Request Body schema: application/json
required
object

Responses

Request samples

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

Response samples

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

Update a portal configuration

Update the configuration of the portal

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenclientTokenserviceAccessTokenbearerAuth
path Parameters
portalId
required
string <uuid>
Example: f32d905a-ed33-46a3-a093-d8f536af9a8a

ID of the portal.

Request Body schema: application/json

Request schema to replace the portal configuration.

required
object

Responses

Request samples

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

Response samples

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

Portal Customization

APIs related to Konnect Developer Portal Customization.

Get Customization

Returns the portal customization options.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenclientTokenserviceAccessTokenbearerAuth
path Parameters
portalId
required
string <uuid>
Example: f32d905a-ed33-46a3-a093-d8f536af9a8a

ID of the portal.

Responses

Response samples

Content type
application/json
{
  • "theme": {
    },
  • "layout": "string",
  • "css": "string",
  • "js": {
    },
  • "menu": {
    },
  • "spec_renderer": {
    },
  • "robots": "string"
}

Replace Customization

Replace the portal customization options.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenclientTokenserviceAccessTokenbearerAuth
path Parameters
portalId
required
string <uuid>
Example: f32d905a-ed33-46a3-a093-d8f536af9a8a

ID of the portal.

Request Body schema: application/json
object
layout
string
css
string or null
object
object
object
robots
string or null

Responses

Request samples

Content type
application/json
{
  • "theme": {
    },
  • "layout": "string",
  • "css": "string",
  • "js": {
    },
  • "menu": {
    },
  • "spec_renderer": {
    },
  • "robots": "string"
}

Response samples

Content type
application/json
{
  • "theme": {
    },
  • "layout": "string",
  • "css": "string",
  • "js": {
    },
  • "menu": {
    },
  • "spec_renderer": {
    },
  • "robots": "string"
}

Update Portal Customization

Update the portal customization options, merging properties.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenclientTokenserviceAccessTokenbearerAuth
path Parameters
portalId
required
string <uuid>
Example: f32d905a-ed33-46a3-a093-d8f536af9a8a

ID of the portal.

Request Body schema: application/json
object
layout
string
css
string or null
object
object
object
robots
string or null

Responses

Request samples

Content type
application/json
{
  • "theme": {
    },
  • "layout": "string",
  • "css": "string",
  • "js": {
    },
  • "menu": {
    },
  • "spec_renderer": {
    },
  • "robots": "string"
}

Response samples

Content type
application/json
{
  • "theme": {
    },
  • "layout": "string",
  • "css": "string",
  • "js": {
    },
  • "menu": {
    },
  • "spec_renderer": {
    },
  • "robots": "string"
}

realms

realms

List realms

list realms

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenclientTokenserviceAccessTokenbearerAuth
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[before]
string
Example: page[before]=ewogICJpZCI6ICJoZWxsbyB3b3JsZCIKfQ

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

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 a realm

create realm

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenclientTokenserviceAccessTokenbearerAuth
Request Body schema: application/json
name
required
string
allowed_control_planes
Array of strings (AllowedControlPlanes) [ items unique ]

List of control plane ids that are allowed to use the realm. An entry with '*' makes all control planes able to use the given realm.

ttl
integer >= 5
Default: 10

Time to Live in minutes of the consumer for this realm in the gateway cache.

negative_ttl
integer >= 5
Default: 10

Time to Live in minutes of the negative consumer for this realm in the gateway cache.

consumer_groups
Array of strings (ConsumerGroups) [ items unique ]

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "allowed_control_planes": [
    ],
  • "ttl": 10,
  • "negative_ttl": 10,
  • "consumer_groups": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "ttl": 0,
  • "negative_ttl": 0,
  • "consumer_groups": [
    ],
  • "allowed_control_planes": [
    ],
  • "created_at": "2022-11-04T20:10:06.927Z",
  • "updated_at": "2022-11-04T20:10:06.927Z"
}

Get a realm

get realm

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenclientTokenserviceAccessTokenbearerAuth
path Parameters
realmId
required
string <uuid>

Id of the realm

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "ttl": 0,
  • "negative_ttl": 0,
  • "consumer_groups": [
    ],
  • "allowed_control_planes": [
    ],
  • "created_at": "2022-11-04T20:10:06.927Z",
  • "updated_at": "2022-11-04T20:10:06.927Z"
}

Update a realm

update realm

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenclientTokenserviceAccessTokenbearerAuth
path Parameters
realmId
required
string <uuid>

Id of the realm

Request Body schema: application/json
name
string
allowed_control_planes
Array of strings (AllowedControlPlanes) [ items unique ]

List of control plane ids that are allowed to use the realm. An entry with '*' makes all control planes able to use the given realm.

consumer_groups
Array of strings (ConsumerGroups) [ items unique ]
ttl
integer >= 5

Time to Live in minutes of the consumer for this realm in the gateway cache.

negative_ttl
integer >= 5

Time to Live in minutes of the negative consumer for this realm in the gateway cache

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "allowed_control_planes": [
    ],
  • "consumer_groups": [
    ],
  • "ttl": 5,
  • "negative_ttl": 5
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "ttl": 0,
  • "negative_ttl": 0,
  • "consumer_groups": [
    ],
  • "allowed_control_planes": [
    ],
  • "created_at": "2022-11-04T20:10:06.927Z",
  • "updated_at": "2022-11-04T20:10:06.927Z"
}

Delete a realm

delete realm

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenclientTokenserviceAccessTokenbearerAuth
path Parameters
realmId
required
string <uuid>

Id of the realm

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

If true, delete specified realm and all underlying entities (consumers/apiKeys). If false, do not allow deletion if there are underlying entities.

Responses

Response samples

Content type
application/problem+json
{
  • "status": 0,
  • "title": "string",
  • "type": "string",
  • "instance": "string",
  • "detail": "string",
  • "invalid_parameters": [
    ]
}

regional-consumers

regional consumers

List realm consumers

list realm consumers

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenclientTokenserviceAccessTokenbearerAuth
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[before]
string
Example: page[before]=ewogICJpZCI6ICJoZWxsbyB3b3JsZCIKfQ

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

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

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

object (RealmConsumerFilterParameters)

Filters Consumers in the response.

Responses

Response samples

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

List consumers

list consumers

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenclientTokenserviceAccessTokenbearerAuth
path Parameters
realmId
required
string <uuid>

Id of the realm

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[before]
string
Example: page[before]=ewogICJpZCI6ICJoZWxsbyB3b3JsZCIKfQ

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

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

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

object (ConsumerFilterParameters)

Filters Consumers in the response.

Responses

Response samples

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

Create a consumer

create consumer

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenclientTokenserviceAccessTokenbearerAuth
path Parameters
realmId
required
string <uuid>

Id of the realm

Request Body schema: application/json
username
required
string
consumer_groups
Array of strings (ConsumerGroups) [ items unique ]
custom_id
string
type
string
tags
Array of strings (Tags) unique

Responses

Request samples

Content type
application/json
{
  • "username": "string",
  • "consumer_groups": [
    ],
  • "custom_id": "string",
  • "type": "string",
  • "tags": [
    ]
}

Response samples

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

Get a consumer

get consumer

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenclientTokenserviceAccessTokenbearerAuth
path Parameters
realmId
required
string <uuid>

Id of the realm

consumerId
required
string

Id of the of the consumer

Responses

Response samples

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

Update a consumer

update consumer

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenclientTokenserviceAccessTokenbearerAuth
path Parameters
realmId
required
string <uuid>

Id of the realm

consumerId
required
string

Id of the of the consumer

Request Body schema: application/json
custom_id
string
username
string
type
string
tags
Array of strings (Tags) unique
consumer_groups
Array of strings (ConsumerGroups) [ items unique ]

Responses

Request samples

Content type
application/json
{
  • "custom_id": "string",
  • "username": "string",
  • "type": "string",
  • "tags": [
    ],
  • "consumer_groups": [
    ]
}

Response samples

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

Delete a consumer

delete consumer

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenclientTokenserviceAccessTokenbearerAuth
path Parameters
realmId
required
string <uuid>

Id of the realm

consumerId
required
string

Id of the of the consumer

Responses

Change the realm of a consumer

move consumer

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenclientTokenserviceAccessTokenbearerAuth
path Parameters
realmId
required
string <uuid>

Id of the realm

consumerId
required
string

Id of the of the consumer

Request Body schema: application/json
target_realm_id
required
string

Responses

Request samples

Content type
application/json
{
  • "target_realm_id": "string"
}

Response samples

Content type
application/json
{
  • "realm_id": "string"
}

keys

keys

List keys

list keys

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenclientTokenserviceAccessTokenbearerAuth
path Parameters
realmId
required
string <uuid>

Id of the realm

consumerId
required
string

Id of the of the consumer

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[before]
string
Example: page[before]=ewogICJpZCI6ICJoZWxsbyB3b3JsZCIKfQ

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

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 a key

create key

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenclientTokenserviceAccessTokenbearerAuth
path Parameters
realmId
required
string <uuid>

Id of the realm

consumerId
required
string

Id of the of the consumer

Request Body schema: application/json
One of
type
string
Default: "new"
Value: "new"
tags
Array of strings (Tags) unique

Responses

Request samples

Content type
application/json
Example
{
  • "type": "new",
  • "tags": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "type": "legacy",
  • "secret": "string",
  • "created_at": "2022-11-04T20:10:06.927Z",
  • "updated_at": "2022-11-04T20:10:06.927Z",
  • "tags": [
    ]
}

Get a key

get key

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenclientTokenserviceAccessTokenbearerAuth
path Parameters
realmId
required
string <uuid>

Id of the realm

consumerId
required
string

Id of the of the consumer

keyId
required
string

Id of the key

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "created_at": "2022-11-04T20:10:06.927Z",
  • "tags": [
    ],
  • "type": "legacy"
}

Delete a key

delete key

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenclientTokenserviceAccessTokenbearerAuth
path Parameters
realmId
required
string <uuid>

Id of the realm

consumerId
required
string

Id of the of the consumer

keyId
required
string

Id of the key

Responses

Serverless Cloud Gateways

Update the serverless cloud gateway

Update an individual serverless cloud gateway.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenclientTokenserviceAccessTokenbearerAuth
path Parameters
controlPlaneId
required
string <uuid>
Example: bf138ba2-c9b1-4229-b268-04d9d8a6410b

Id of the Serverless Cloud Gateway control plane

Request Body schema: application/json
cp_prefix
string

The prefix of the serverless cloud gateway CP.

cp_region
string (Control plane region)
Enum: "us" "eu" "au"

The control plane region.

object (Labels)

Labels to facilitate tagged search on serverless cloud gateways. Keys must be of length 1-63 characters, and cannot start with 'kong', 'konnect', 'mesh', 'kic', or '_'.

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "control_plane": {
    },
  • "gateway_endpoint": "kong-518da50bf7euab123.kongcloud.dev",
  • "created_at": "2023-01-11T02:30:42.227Z",
  • "updated_at": "2023-01-11T02:30:42.227Z",
  • "labels": {
    }
}

Add-ons

List Add-ons

Returns a paginated collection of add-ons.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenclientTokenserviceAccessTokenbearerAuth
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[number]
integer
Example: page[number]=1

Determines which page of the entities to retrieve.

object (AddonFilterParameters)

Filters a collection of add-ons.

sort
string (SortQuery)
Example: sort=name,created_at desc

Sorts a collection of add-ons. Supported sort attributes are:

  • name
  • display_name

Responses

Response samples

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

Installed Add-ons

List Installed Add-ons

Returns a paginated collection of installed add-ons.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenclientTokenserviceAccessTokenbearerAuth
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[number]
integer
Example: page[number]=1

Determines which page of the entities to retrieve.

object (InstalledAddonFilterParameters)

Filters a collection of installed add-ons.

sort
string (SortQuery)
Example: sort=name,created_at desc

Sorts a collection of installed add-ons. Supported sort attributes are:

  • name
  • enabled

Responses

Response samples

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

Fetch Installed Add-on

Returns information about a specific installed add-on.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenclientTokenserviceAccessTokenbearerAuth
path Parameters
addon
required
string
Example: gateway-manager

Machine name of the add-on.

Responses

Response samples

Content type
application/json
{
  • "id": "747368bc-d836-45e6-b855-ab9a3defb3c1",
  • "name": "gateway-manager",
  • "enabled": true,
  • "config": {},
  • "created_at": "2022-03-30T07:20:50Z",
  • "updated_at": "2022-06-21T17:20:12Z"
}

Install Add-on

Installs the given add-on.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenclientTokenserviceAccessTokenbearerAuth
path Parameters
addon
required
string
Example: gateway-manager

Machine name of the add-on.

Request Body schema: application/json

Request body schema for installing an add-on.

enabled
required
boolean

Whether the add-on is enabled

object (InstalledAddonConfig)
Default: {}

JSON object containing the configuration values for the add-on.

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "id": "747368bc-d836-45e6-b855-ab9a3defb3c1",
  • "name": "gateway-manager",
  • "enabled": true,
  • "config": {},
  • "created_at": "2022-03-30T07:20:50Z",
  • "updated_at": "2022-06-21T17:20:12Z"
}

Update Installed Add-on

Updates the given installed add-on.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenclientTokenserviceAccessTokenbearerAuth
path Parameters
addon
required
string
Example: gateway-manager

Machine name of the add-on.

Request Body schema: application/json

Request body schema for updating an installed add-on.

enabled
boolean

Whether the add-on is enabled

object (InstalledAddonConfig)
Default: {}

JSON object containing the configuration values for the add-on.

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "id": "747368bc-d836-45e6-b855-ab9a3defb3c1",
  • "name": "gateway-manager",
  • "enabled": true,
  • "config": {},
  • "created_at": "2022-03-30T07:20:50Z",
  • "updated_at": "2022-06-21T17:20:12Z"
}

Delete Installed Add-on

Deletes an installed add-on. Returns 404 if the add-on is not installed or not found.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenclientTokenserviceAccessTokenbearerAuth
path Parameters
addon
required
string
Example: gateway-manager

Machine name of the add-on.

Responses

Response samples

Content type
application/problem+json
{
  • "status": 0,
  • "title": "string",
  • "type": "string",
  • "instance": "string",
  • "detail": "string",
  • "invalid_parameters": [
    ]
}

Service Hub Services

List Services

Returns a paginated collection of services.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenclientTokenserviceAccessTokenbearerAuth
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[number]
integer
Example: page[number]=1

Determines which page of the entities to retrieve.

object (ServiceFilterParameters)

Filters a collection of services.

sort
string (SortQuery)
Example: sort=name,created_at desc

Sorts a collection of services. Supported sort attributes are:

  • name
  • created_at
  • updated_at

Responses

Response samples

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

Create Service

Creates a service.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenclientTokenserviceAccessTokenbearerAuth
Request Body schema: application/json

Request body schema for creating a service.

name
required
string [ 1 .. 120 ] characters ^[0-9a-z.-]+$

The name of the Service.

description
string or null <= 2048 characters

The description of the Service.

display_name
required
string [ 1 .. 120 ] characters

The display name of the Service.

object (Labels) <= 50 properties

Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.

Keys must be of length 1-63 characters, and cannot start with "kong", "konnect", "mesh", "kic", or "_".

object (Metadata)

Contains key value pairs information about entity's metadata.

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "id": "7f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
  • "name": "user-svc",
  • "description": "string",
  • "display_name": "User Service",
  • "labels": {
    },
  • "integrations": [
    ],
  • "metadata": {},
  • "created_at": "2022-03-30T07:20:50Z",
  • "updated_at": "2022-06-21T17:20:12Z"
}

Fetch Service

Returns information about a service from a given service ID.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenclientTokenserviceAccessTokenbearerAuth
path Parameters
serviceId
required
string <uuid>
Example: 7f9fd312-a987-4628-b4c5-bb4f4fddd5f7

ID of the service.

Responses

Response samples

Content type
application/json
{
  • "id": "7f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
  • "name": "user-svc",
  • "description": "string",
  • "display_name": "User Service",
  • "labels": {
    },
  • "integrations": [
    ],
  • "metadata": {},
  • "created_at": "2022-03-30T07:20:50Z",
  • "updated_at": "2022-06-21T17:20:12Z"
}

Update Service

Updates an individual service.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenclientTokenserviceAccessTokenbearerAuth
path Parameters
serviceId
required
string <uuid>
Example: 7f9fd312-a987-4628-b4c5-bb4f4fddd5f7

ID of the service.

Request Body schema: application/json

Request body schema for updating a service.

name
string [ 1 .. 120 ] characters ^[0-9a-z.-]+$

The name of the Service.

description
string or null <= 2048 characters

The description of the Service.

display_name
string [ 1 .. 120 ] characters

The display name of the Service.

object (LabelsPatch)

JSON Merge Patch object for updating labels fields. To delete an existing label, provide the label key with a null value.

object (Metadata)

Contains key value pairs information about entity's metadata.

Responses

Request samples

Content type
application/json
{
  • "name": "user-svc",
  • "description": "string",
  • "display_name": "User Service",
  • "labels": {
    },
  • "metadata": {}
}

Response samples

Content type
application/json
{
  • "id": "7f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
  • "name": "user-svc",
  • "description": "string",
  • "display_name": "User Service",
  • "labels": {
    },
  • "integrations": [
    ],
  • "metadata": {},
  • "created_at": "2022-03-30T07:20:50Z",
  • "updated_at": "2022-06-21T17:20:12Z"
}

Delete Service

Deletes an individual service. Returns 404 if the service is not found.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenclientTokenserviceAccessTokenbearerAuth
path Parameters
serviceId
required
string <uuid>
Example: 7f9fd312-a987-4628-b4c5-bb4f4fddd5f7

ID of the service.

Responses

Response samples

Content type
application/problem+json
{
  • "status": 0,
  • "title": "string",
  • "type": "string",
  • "instance": "string",
  • "detail": "string",
  • "invalid_parameters": [
    ]
}

Integrations

Integration Proxy Request

Proxies a request to an external API made by a Service Hub integration.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenclientTokenserviceAccessTokenbearerAuth
path Parameters
integration
required
string
Example: pagerduty

Machine name of the integration.

Request Body schema: application/json

Request body schema for an integration proxy request.

method
required
string
Enum: "DELETE" "GET" "PATCH" "POST" "PUT"

The HTTP request method.

base_url
required
string <uri>

The base URL of the proxied API as defined in the integration manifest.

path
required
string

The URL path of the proxied API request as defined in the integration manifest.

object

JSON object representing the request body that will be sent to the proxied API.

object

JSON object representing the query parameters that will be sent to the proxied API.

object

JSON object representing the request headers that will be sent to the proxied API.

Responses

Request samples

Content type
application/json
{
  • "method": "GET",
  • "base_url": "https://api.pagerduty.com",
  • "path": "/incidents",
  • "body": {
    },
  • "query": {
    },
  • "headers": {
    }
}

Response samples

Content type
application/problem+json
{
  • "status": 0,
  • "title": "string",
  • "type": "string",
  • "instance": "string",
  • "detail": "string",
  • "invalid_parameters": [
    ]
}

List Integrations for Service

Returns a paginated collection of Service Hub integrations associated to the given service.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenclientTokenserviceAccessTokenbearerAuth
path Parameters
serviceId
required
string <uuid>
Example: d32d905a-ed33-46a3-a093-d8f536af9a8a

ID of the service.

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[number]
integer
Example: page[number]=1

Determines which page of the entities to retrieve.

object (ServiceIntegrationFilterParameters)

Filters a collection of Service Hub integrations associated to a service.

sort
string (SortQuery)
Example: sort=name,created_at desc

Sorts a collection of Service Hub integrations associated to a service. Supported sort attributes are:

  • name

Responses

Response samples

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

Create Service Integration

Creates an association between the given integration and service using the data binding provided in the request.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenclientTokenserviceAccessTokenbearerAuth
path Parameters
serviceId
required
string <uuid>
Example: d32d905a-ed33-46a3-a093-d8f536af9a8a

ID of the service.

integration
required
string
Example: gateway-manager

Machine name of the integration.

Request Body schema: application/json

Request body schema for creating a service integration.

binding
required
string

The integration binding object name.

required
object

JSON object containing the data which binds the integration to the service.

required
object (Labels) <= 50 properties

Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.

Keys must be of length 1-63 characters, and cannot start with "kong", "konnect", "mesh", "kic", or "_".

Responses

Request samples

Content type
application/json
{
  • "binding": "pagerduty_service",
  • "data": {
    },
  • "labels": {
    }
}

Response samples

Content type
application/json
{
  • "id": "6c1118d3-0fe3-4695-ae55-84d6ea020916",
  • "name": "pagerduty",
  • "service_id": "7f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
  • "binding": "pagerduty_service",
  • "data": {
    },
  • "labels": {
    },
  • "created_at": "2022-03-30T07:20:50Z",
  • "updated_at": "2022-06-21T17:20:12Z"
}

Update Service Integration

Updates the association between the given integration and service.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenclientTokenserviceAccessTokenbearerAuth
path Parameters
serviceId
required
string <uuid>
Example: d32d905a-ed33-46a3-a093-d8f536af9a8a

ID of the service.

integration
required
string
Example: gateway-manager

Machine name of the integration.

serviceIntegrationId
required
string
Example: 123e4567-e89b-12d3-a456-426614174000

ID of the service integration.

Request Body schema: application/json

Request body schema for updating a service integration.

binding
required
string

The integration binding object name.

required
object

JSON object containing the data which binds the integration to the service.

required
object (Labels) <= 50 properties

Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.

Keys must be of length 1-63 characters, and cannot start with "kong", "konnect", "mesh", "kic", or "_".

Responses

Request samples

Content type
application/json
{
  • "binding": "pagerduty_service",
  • "data": {
    },
  • "labels": {
    }
}

Response samples

Content type
application/json
{
  • "id": "6c1118d3-0fe3-4695-ae55-84d6ea020916",
  • "name": "pagerduty",
  • "service_id": "7f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
  • "binding": "pagerduty_service",
  • "data": {
    },
  • "labels": {
    },
  • "created_at": "2022-03-30T07:20:50Z",
  • "updated_at": "2022-06-21T17:20:12Z"
}

Delete Service Integration

Deletes a Service integration. Returns 404 if the given service or integration is not found.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenclientTokenserviceAccessTokenbearerAuth
path Parameters
serviceId
required
string <uuid>
Example: d32d905a-ed33-46a3-a093-d8f536af9a8a

ID of the service.

integration
required
string
Example: gateway-manager

Machine name of the integration.

serviceIntegrationId
required
string
Example: 123e4567-e89b-12d3-a456-426614174000

ID of the service integration.

Responses

Response samples

Content type
application/problem+json
{
  • "status": 0,
  • "title": "string",
  • "type": "string",
  • "instance": "string",
  • "detail": "string",
  • "invalid_parameters": [
    ]
}

Integration Auth Credentials

List Installed Integration Auth Credentials

Returns a paginated collection of installed integration auth credentials.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenclientTokenserviceAccessTokenbearerAuth
path Parameters
integration
required
string
Example: pagerduty

Machine name of the integration.

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[number]
integer
Example: page[number]=1

Determines which page of the entities to retrieve.

Responses

Response samples

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

Create Installed Integration Auth Credential

Creates an auth credential for the integration.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenclientTokenserviceAccessTokenbearerAuth
path Parameters
integration
required
string
Example: pagerduty

Machine name of the integration.

Request Body schema: application/json

Request body schema for creating an auth credential for an installed integration.

One of
type
required
string
Value: "oauth"

The authorization type corresponding to the credential

required
object

Responses

Request samples

Content type
application/json
Example
{}

Response samples

Content type
application/json
{
  • "id": "95e4f10a-bf10-4724-9378-c3591ad8c6ed",
  • "type": "oauth",
  • "expires_at": "2024-03-30T07:20:50Z",
  • "created_at": "2022-03-30T07:20:50Z"
}

Fetch Installed Integration Auth Credential

Returns context associated to an auth credential for the given installed integration.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenclientTokenserviceAccessTokenbearerAuth
path Parameters
integration
required
string
Example: pagerduty

Machine name of the integration.

authCredentialId
required
string <uuid>
Example: 95e4f10a-bf10-4724-9378-c3591ad8c6ed

ID of the auth credential.

Responses

Response samples

Content type
application/json
{
  • "id": "95e4f10a-bf10-4724-9378-c3591ad8c6ed",
  • "type": "oauth",
  • "expires_at": "2024-03-30T07:20:50Z",
  • "created_at": "2022-03-30T07:20:50Z"
}

Delete Installed Integration Auth Credential

Deletes an auth credential for an integration. Returns 404 if the given credential is not found.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenclientTokenserviceAccessTokenbearerAuth
path Parameters
integration
required
string
Example: pagerduty

Machine name of the integration.

authCredentialId
required
string <uuid>
Example: 95e4f10a-bf10-4724-9378-c3591ad8c6ed

ID of the auth credential.

Responses

Response samples

Content type
application/problem+json
{
  • "status": 0,
  • "title": "string",
  • "type": "string",
  • "instance": "string",
  • "detail": "string",
  • "invalid_parameters": [
    ]
}

Discovery Settings

Fetch Service Discovery Settings for Integration

Returns information about the service discovery settings for the given integration.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenclientTokenserviceAccessTokenbearerAuth
path Parameters
integration
required
string
Example: gateway-manager

Machine name of the integration.

Responses

Response samples

Content type
application/json
{
  • "integration": "pagerduty",
  • "enabled": true,
  • "created_at": "2022-03-30T07:20:50Z",
  • "updated_at": "2022-06-21T17:20:12Z"
}

Upsert Service Discovery Settings for Integration

Updates service discovery settings for the given integration.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenclientTokenserviceAccessTokenbearerAuth
path Parameters
integration
required
string
Example: gateway-manager

Machine name of the integration.

Request Body schema: application/json

Request body schema for updating service discovery settings for an integration.

enabled
required
boolean

Whether discovery is enabled for the integration.

Responses

Request samples

Content type
application/json
{
  • "enabled": true
}

Response samples

Content type
application/json
{
  • "integration": "pagerduty",
  • "enabled": true,
  • "created_at": "2022-03-30T07:20:50Z",
  • "updated_at": "2022-06-21T17:20:12Z"
}

Service Documents

List Service Documents

Returns a paginated collection of documents belonging to the given service.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenclientTokenserviceAccessTokenbearerAuth
path Parameters
serviceId
required
string <uuid>
Example: 7f9fd312-a987-4628-b4c5-bb4f4fddd5f7

ID of the service.

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[number]
integer
Example: page[number]=1

Determines which page of the entities to retrieve.

header Parameters
Accept
string (DocumentContentTypeEnum)
Default: application/json
Enum: "application/json" "application/vnd.konnect.document-tree+json"

Responses

Response samples

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

Create Service Document

Creates a document associated to the given service.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenclientTokenserviceAccessTokenbearerAuth
path Parameters
serviceId
required
string <uuid>
Example: 7f9fd312-a987-4628-b4c5-bb4f4fddd5f7

ID of the service.

Request Body schema: application/json

Request body schema for creating a document.

title
required
string

document title

parent_document_id
string <uuid>

parent document id

slug
required
string (Slug) <= 80 characters ^[\w-]+$

document slug

status
string (PublishStatus)
Enum: "published" "unpublished"

document publish status

raw_content
required
string <byte>

base64 encoded string of the document content

metadata
object or null

metadata of the document

filename
required
string

name of the uploaded file

Responses

Request samples

Content type
application/json
{
  • "title": "How to create a document in Service Hub.",
  • "parent_document_id": "dd4e1b98-3629-4dd3-acc0-759a726ffee2",
  • "slug": "string",
  • "status": "published",
  • "raw_content": "YmFzZTY0LWVuY29kZWQgdGV4dCBzdHJpbmc=",
  • "metadata": {
    },
  • "filename": "my_doc.md"
}

Response samples

Content type
application/json
{
  • "document_id": "d32d905a-ed33-46a3-a093-d8f536af9a8a",
  • "revision_id": "ecfb698d-77a8-4ab5-91fa-45ee383b48ba"
}

Fetch Service Document

Returns information about a document belonging to a given service.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenclientTokenserviceAccessTokenbearerAuth
path Parameters
serviceId
required
string <uuid>
Example: 7f9fd312-a987-4628-b4c5-bb4f4fddd5f7

ID of the service.

documentId
required
string <uuid>
Example: 6c1118d3-0fe3-4695-ae55-84d6ea020916

ID of the document belonging to the given service.

header Parameters
Accept
string (DocumentFormatContentTypeEnum)
Default: application/json
Enum: "application/json" "application/vnd.konnect.document-nodes+json"

Responses

Response samples

Content type
{
  • "id": "d32d905a-ed33-46a3-a093-d8f536af9a8a",
  • "parent_document_id": "dd4e1b98-3629-4dd3-acc0-759a726ffee2",
  • "slug": "getting-started",
  • "revision": {
    }
}

Update Service Document

Updates a document belonging to a given service.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenclientTokenserviceAccessTokenbearerAuth
path Parameters
serviceId
required
string <uuid>
Example: 7f9fd312-a987-4628-b4c5-bb4f4fddd5f7

ID of the service.

documentId
required
string <uuid>
Example: 6c1118d3-0fe3-4695-ae55-84d6ea020916

ID of the document belonging to the given service.

Request Body schema: application/json

Request body schema for updating a document.

parent_document_id
string or null <uuid>

Parent document Id. If this value is explicitly set to null, the document will be put as a top level document at the bottom of the tree.

slug
string (Slug) <= 80 characters ^[\w-]+$

document slug

status
string (PublishStatus)
Enum: "published" "unpublished"

document publish status

title
string

document title

raw_content
string <byte>

base64 encoded string of the document content

filename
string

name of the uploaded file

metadata
object or null

metadata of the document

Responses

Request samples

Content type
application/json
{
  • "parent_document_id": "dd4e1b98-3629-4dd3-acc0-759a726ffee2",
  • "slug": "string",
  • "status": "published",
  • "title": "How to update a document in Konnect DocumentHub",
  • "raw_content": "YmFzZTY0LWVuY29kZWQgdGV4dCBzdHJpbmc=",
  • "filename": "my_doc.md",
  • "metadata": {
    }
}

Response samples

Content type
application/json
{
  • "id": "6c1118d3-0fe3-4695-ae55-84d6ea020916",
  • "parent_document_id": "dd4e1b98-3629-4dd3-acc0-759a726ffee2",
  • "slug": "string",
  • "status": "published",
  • "revision": {
    },
  • "created_at": "2022-03-30T07:20:50Z",
  • "updated_at": "2022-06-21T17:20:12Z"
}

Delete Service Document

Deletes an individual document belonging to the given service. Returns 404 if either the service or document is not found.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenclientTokenserviceAccessTokenbearerAuth
path Parameters
serviceId
required
string <uuid>
Example: 7f9fd312-a987-4628-b4c5-bb4f4fddd5f7

ID of the service.

documentId
required
string <uuid>
Example: 6c1118d3-0fe3-4695-ae55-84d6ea020916

ID of the document belonging to the given service.

Responses

Response samples

Content type
application/problem+json
{
  • "status": 0,
  • "title": "string",
  • "type": "string",
  • "instance": "string",
  • "detail": "string",
  • "invalid_parameters": [
    ]
}

Move Service Document

Moves a document within the document tree under the given service, using parameters parent_document_id and index.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenclientTokenserviceAccessTokenbearerAuth
path Parameters
serviceId
required
string <uuid>
Example: 7f9fd312-a987-4628-b4c5-bb4f4fddd5f7

ID of the service.

documentId
required
string <uuid>
Example: 6c1118d3-0fe3-4695-ae55-84d6ea020916

ID of the document belonging to the given service.

Request Body schema: application/json

Request body schema for moving a document.

parent_document_id
string <uuid>

Represents the document's parent document Id. If this field is not provided, the document will be placed at the top level of the document tree.

index
integer

Represents a zero-indexed document order relative to its siblings under the same parent. For example, if we want to put the document at top level in first position we would send empty parent_document_id and index: 0. This api also supports using a negative index to count backwards from the end of the document list, which means you can put the document in last position by using index: -1.

Responses

Request samples

Content type
application/json
{
  • "parent_document_id": "dd4e1b98-3629-4dd3-acc0-759a726ffee2",
  • "index": 1
}

Response samples

Content type
application/problem+json
{
  • "status": 0,
  • "title": "string",
  • "type": "string",
  • "instance": "string",
  • "detail": "string",
  • "invalid_parameters": [
    ]
}

Discovered Entities

List Discovered Entities

Returns a paginated collection of discovered entities.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenclientTokenserviceAccessTokenbearerAuth
query Parameters
page[before]
string
Example: page[before]=ewogICJpZCI6ICJoZWxsbyB3b3JsZCIKfQ

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

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

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

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.

object (DiscoveredEntityFilterParameters)

Filters a collection of discovered entities.

sort
string (SortQuery)
Example: sort=name,created_at desc

Sorts a collection of discovered entities. Supported sort attributes are:

  • integration
  • created_at
  • updated_at

Responses

Response samples

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

Fetch Discovered Entity

Returns information about a discovered entity.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenclientTokenserviceAccessTokenbearerAuth
path Parameters
discoveredEntityId
required
string <uuid>
Example: cbf06770-fa76-4e94-9226-ec9086938e62

ID of the discovered entity.

Responses

Response samples

Content type
application/json
{
  • "id": "fa3db80f-b661-434e-bd7a-e6c561c3a15c",
  • "integration": "gateway-manager",
  • "deduplication_id": "2f3adee0-3740-4962-a26b-2a75e550535c",
  • "entity_name": "My Service",
  • "scope": "service",
  • "binding": "pagerduty_service",
  • "integration_record": {
    },
  • "data": {
    },
  • "suggestion_rule_evaluation_error": {
    },
  • "created_at": "2022-03-30T07:20:50Z",
  • "updated_at": "2022-06-21T17:20:12Z"
}

Upsert Discovered Entities

Upserts Discovered Entities. The request is transactional, that is, a single failed operation will result in a failed state for all operations.

The maximum amount of entities that can be ingested in a single request is 100.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenclientTokenserviceAccessTokenbearerAuth
path Parameters
integration
required
string
Example: gateway-manager

Machine name of the integration.

Request Body schema: application/json

Request body schema for upserting discovered entities for an integration.

required
Array of objects (UpsertDiscoveredEntity)

Responses

Request samples

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

Response samples

Content type
application/problem+json
{
  • "status": 0,
  • "title": "string",
  • "type": "string",
  • "instance": "string",
  • "detail": "string",
  • "invalid_parameters": [
    ]
}

Suggestion Rules

Create Suggestion Rule for Integration

Creates a suggestion rule for the given integration.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenclientTokenserviceAccessTokenbearerAuth
path Parameters
integration
required
string
Example: gateway-manager

Machine name of the integration.

Request Body schema: application/json

Request body schema for creating a suggestion rule for an integration.

name
required
string [ 1 .. 120 ] characters

The display name of the suggestion rule

description
string or null [ 1 .. 2048 ] characters
Default: null

The description of the suggestion rule

binding
required
string

The integration binding object name

active
required
boolean

Determines if this suggestion rule should be evaluated when generating suggested actions.

auto_accept
required
boolean

Determines if the suggested action should be applied automatically.

  • true: Suggested action will be applied automatically
  • false: Suggested action will not be automatically applied, user input required
discovery_selector
required
string <= 2048 characters

A boolean string or JQ expression that must evaluate to a boolean value. Supports JQ expressions syntax on discovered entity's integration_record property.

required
IgnoreAction (object) or MapAction (object) (SuggestedRuleAction)
RankAfterPayload (object) or RankBeforePayload (object)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "Suggestion rule description",
  • "binding": "pagerduty_service",
  • "active": true,
  • "auto_accept": true,
  • "discovery_selector": ".gateway_service.tags | contains([\"_KonnectDeployment:\"])",
  • "action": {
    },
  • "rank": {
    }
}

Response samples

Content type
application/json
{
  • "id": "22f72bd1-2897-473e-9471-302de3ccf38b",
  • "name": "string",
  • "description": "Suggestion rule description",
  • "binding": "pagerduty_service",
  • "active": true,
  • "auto_accept": true,
  • "discovery_selector": ".gateway_service.tags | contains([\"_KonnectDeployment:\"])",
  • "action": {
    },
  • "created_at": "2022-03-30T07:20:50Z",
  • "updated_at": "2022-06-21T17:20:12Z"
}

List Suggestion Rules

Returns a paginated collection of a suggestion rules.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenclientTokenserviceAccessTokenbearerAuth
path Parameters
integration
required
string
Example: gateway-manager

Machine name of the integration.

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[number]
integer
Example: page[number]=1

Determines which page of the entities to retrieve.

object (DiscoverySuggestionRuleFilterParameters)

Filters a collection of discovery suggestion rules.

Responses

Response samples

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

Fetch Suggestion Rule

Returns information about a suggestion rule from a given suggestion rule ID.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenclientTokenserviceAccessTokenbearerAuth
path Parameters
integration
required
string
Example: gateway-manager

Machine name of the integration.

suggestionRuleId
required
string <uuid>
Example: 22f72bd1-2897-473e-9471-302de3ccf38b

ID of the suggestion rule.

Responses

Response samples

Content type
application/json
{
  • "id": "22f72bd1-2897-473e-9471-302de3ccf38b",
  • "name": "string",
  • "description": "Suggestion rule description",
  • "binding": "pagerduty_service",
  • "active": true,
  • "auto_accept": true,
  • "discovery_selector": ".gateway_service.tags | contains([\"_KonnectDeployment:\"])",
  • "action": {
    },
  • "created_at": "2022-03-30T07:20:50Z",
  • "updated_at": "2022-06-21T17:20:12Z"
}

Update Suggestion Rule

Updates the given suggestion rule.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenclientTokenserviceAccessTokenbearerAuth
path Parameters
integration
required
string
Example: gateway-manager

Machine name of the integration.

suggestionRuleId
required
string <uuid>
Example: 22f72bd1-2897-473e-9471-302de3ccf38b

ID of the suggestion rule.

Request Body schema: application/json

Request body schema for creating a suggestion rule for an integration.

name
required
string [ 1 .. 120 ] characters

The display name of the suggestion rule

description
string or null [ 1 .. 2048 ] characters
Default: null

The description of the suggestion rule

binding
required
string

The integration binding object name

active
required
boolean

Determines if this suggestion rule should be evaluated when generating suggested actions.

auto_accept
required
boolean

Determines if the suggested action should be applied automatically.

  • true: Suggested action will be applied automatically
  • false: Suggested action will not be automatically applied, user input required
discovery_selector
required
string <= 2048 characters

A boolean string or JQ expression that must evaluate to a boolean value. Supports JQ expressions syntax on discovered entity's integration_record property.

required
IgnoreAction (object) or MapAction (object) (SuggestedRuleAction)
RankAfterPayload (object) or RankBeforePayload (object)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "Suggestion rule description",
  • "binding": "pagerduty_service",
  • "active": true,
  • "auto_accept": true,
  • "discovery_selector": ".gateway_service.tags | contains([\"_KonnectDeployment:\"])",
  • "action": {
    },
  • "rank": {
    }
}

Response samples

Content type
application/json
{
  • "id": "22f72bd1-2897-473e-9471-302de3ccf38b",
  • "name": "string",
  • "description": "Suggestion rule description",
  • "binding": "pagerduty_service",
  • "active": true,
  • "auto_accept": true,
  • "discovery_selector": ".gateway_service.tags | contains([\"_KonnectDeployment:\"])",
  • "action": {
    },
  • "created_at": "2022-03-30T07:20:50Z",
  • "updated_at": "2022-06-21T17:20:12Z"
}

Delete Suggestion Rule

Deletes the given suggestion rule.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenclientTokenserviceAccessTokenbearerAuth
path Parameters
integration
required
string
Example: gateway-manager

Machine name of the integration.

suggestionRuleId
required
string <uuid>
Example: 22f72bd1-2897-473e-9471-302de3ccf38b

ID of the suggestion rule.

Responses

Response samples

Content type
application/problem+json
{
  • "status": 0,
  • "title": "string",
  • "type": "string",
  • "instance": "string",
  • "detail": "string",
  • "invalid_parameters": [
    ]
}

Test a Suggestion Rule Configuration

Test suggestion rule configuration against an integration record.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenclientTokenserviceAccessTokenbearerAuth
path Parameters
integration
required
string
Example: gateway-manager

Machine name of the integration.

Request Body schema: application/json

Request body schema for testing a suggestion rule configuration against an integration record.

binding
required
string

The integration binding object name

discovery_selector
required
string <= 2048 characters

A boolean string or JQ expression that must evaluate to a boolean value. Supports JQ expressions syntax on discovered entity's integration_record property.

required
IgnoreAction (object) or MapAction (object) (SuggestedRuleAction)
required
object

JSON object that may contain additional context about the entity.

Responses

Request samples

Content type
application/json
{
  • "binding": "pagerduty_service",
  • "discovery_selector": ".gateway_service.tags | contains([\"_KonnectDeployment:\"])",
  • "action": {
    },
  • "integration_record": {
    }
}

Response samples

Content type
application/json
{
  • "evaluation": {
    },
  • "errors": [
    ]
}

List System Suggestion Rules

Returns a paginated collection of a system defined suggestion rules.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenclientTokenserviceAccessTokenbearerAuth
path Parameters
integration
required
string
Example: gateway-manager

Machine name of the integration.

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[number]
integer
Example: page[number]=1

Determines which page of the entities to retrieve.

Responses

Response samples

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

Suggested Discovery Actions

List Suggested Discovery Actions

Returns a paginated collection of a suggested discovery actions.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenclientTokenserviceAccessTokenbearerAuth
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[number]
integer
Example: page[number]=1

Determines which page of the entities to retrieve.

object (SuggestedDiscoveryActionFilterParameters)

Filters a collection of suggested discovery actions.

sort
string (SortQuery)
Example: sort=name,created_at desc

Sorts a collection of suggested discovery actions. Supported sort attributes are:

  • created_at
  • updated_at

Responses

Response samples

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

Fetch Suggested Discovery Action

Returns information about a suggested discovery action.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenclientTokenserviceAccessTokenbearerAuth
path Parameters
suggestedDiscoveryActionId
required
string <uuid>
Example: 76ca0689-f08e-4c04-b2a6-4c992d89d554

ID of the suggested discovery action.

Responses

Response samples

Content type
application/json
{
  • "id": "76ca0689-f08e-4c04-b2a6-4c992d89d554",
  • "integration": "gateway-manager",
  • "suggestion_rule_id": "22f72bd1-2897-473e-9471-302de3ccf38b",
  • "discovered_entity_id": "287ead32-a7da-4f2e-89cb-802ae6208f18",
  • "entity_name": "My Service",
  • "scope": "service",
  • "service_id": "7f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
  • "ignored": false,
  • "action": {
    },
  • "created_at": "2022-03-30T07:20:50Z",
  • "updated_at": "2022-06-21T17:20:12Z"
}

Update Suggested Discovery Action

Updates the given suggested discovery.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenclientTokenserviceAccessTokenbearerAuth
path Parameters
suggestedDiscoveryActionId
required
string <uuid>
Example: 76ca0689-f08e-4c04-b2a6-4c992d89d554

ID of the suggested discovery action.

Request Body schema: application/json

Request body schema for updating a suggested discovery action.

ignored
required
boolean

Determines if this suggested action has been ignored or not.

  • true: Suggested action has been ignored
  • false: Suggested action is ready to be accepted or ignored

Responses

Request samples

Content type
application/json
{
  • "ignored": false
}

Response samples

Content type
application/json
{
  • "id": "76ca0689-f08e-4c04-b2a6-4c992d89d554",
  • "integration": "gateway-manager",
  • "suggestion_rule_id": "22f72bd1-2897-473e-9471-302de3ccf38b",
  • "discovered_entity_id": "287ead32-a7da-4f2e-89cb-802ae6208f18",
  • "entity_name": "My Service",
  • "scope": "service",
  • "service_id": "7f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
  • "ignored": false,
  • "action": {
    },
  • "created_at": "2022-03-30T07:20:50Z",
  • "updated_at": "2022-06-21T17:20:12Z"
}

Discovery Actions

Create Discovery Action

Creates a discovery action.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenclientTokenserviceAccessTokenbearerAuth
Request Body schema: application/json

Request body schema for creating a service discovery action.

discovered_entity_id
required
string <uuid>

The identifier of the discovered entity associated to this discovery action.

required
CreateAndMapServiceActionPayload (object) or IgnoreAction (object) or RestoreAction (object) or MapServiceAction (object)

Responses

Request samples

Content type
application/json
{
  • "discovered_entity_id": "287ead32-a7da-4f2e-89cb-802ae6208f18",
  • "action": {
    }
}

Response samples

Content type
application/json
{
  • "id": "76ca0689-f08e-4c04-b2a6-4c992d89d554",
  • "discovered_entity_id": "287ead32-a7da-4f2e-89cb-802ae6208f18",
  • "entity_name": "My Service",
  • "action": {
    },
  • "user_id": "699f1021-4ed8-4f97-8ed3-779fba89d9c7",
  • "cause": "user-action",
  • "integration": "gateway-manager",
  • "outputs": { },
  • "created_at": "2022-03-30T07:20:50Z"
}

List Discovery Actions

Returns a paginated collection of discovery actions.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenclientTokenserviceAccessTokenbearerAuth
query Parameters
page[before]
string
Example: page[before]=ewogICJpZCI6ICJoZWxsbyB3b3JsZCIKfQ

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

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

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

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.

object (DiscoveryActionFilterParameters)

Filters a collection of discovery actions.

sort
string (SortQuery)
Example: sort=name,created_at desc

Sorts a collection of discovery actions. Supported sort attributes are:

  • created_at

Responses

Response samples

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

Fetch Discovery Actions

Returns information about a discovery action.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenclientTokenserviceAccessTokenbearerAuth
path Parameters
discoveryActionId
required
string <uuid>
Example: ffa82ca6-3753-42d9-a69e-65e02dd9d9a1

ID of the discovery action.

Responses

Response samples

Content type
application/json
{
  • "id": "76ca0689-f08e-4c04-b2a6-4c992d89d554",
  • "discovered_entity_id": "287ead32-a7da-4f2e-89cb-802ae6208f18",
  • "entity_name": "My Service",
  • "action": {
    },
  • "user_id": "699f1021-4ed8-4f97-8ed3-779fba89d9c7",
  • "cause": "user-action",
  • "integration": "gateway-manager",
  • "outputs": { },
  • "created_at": "2022-03-30T07:20:50Z"
}

Discovery Ingestion

Schedule Discovery Ingestion

Schedules a discovery ingestion job for the given integration.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenclientTokenserviceAccessTokenbearerAuth
path Parameters
integration
required
string
Example: gateway-manager

Machine name of the integration.

Request Body schema: application/json

Request body schema for scheduling a discovery ingestion job.

ingest_from
string <date-time>

A timestamp indicating when to start ingestion from. RFC-3339 format is used with a "T" character separating date from time within the field value. Omitting this property indicates ingestion will be triggered from the beginning of time until the present.

Responses

Request samples

Content type
application/json
{
  • "ingest_from": "2023-02-15T07:20:50Z"
}

Response samples

Content type
application/json
{
  • "last_scheduled": "2023-02-15T07:20:50Z"
}

Fetch Discovery Ingestion Status

Fetches the status of discovery ingestion for the given integration.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenclientTokenserviceAccessTokenbearerAuth
path Parameters
integration
required
string
Example: gateway-manager

Machine name of the integration.

Responses

Response samples

Content type
application/json
{
  • "last_scheduled": "2023-02-15T07:20:50Z"
}

Metadata Field

List Metadata Schemas

Returns a paginated collection of metadata schemas.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenclientTokenserviceAccessTokenbearerAuth
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[number]
integer
Example: page[number]=1

Determines which page of the entities to retrieve.

object (MetadataSchemaFilterParameters)

Filters a collection of metadata schemas.

sort
string (SortQuery)
Example: sort=name,created_at desc

Sorts a collection of metadata schemas. Supported sort attributes are:

  • created_at
  • updated_at
  • name

Responses

Response samples

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

authserver

Auth server management API

List all auth servers

List all auth servers

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenclientTokenserviceAccessTokenbearerAuth
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[number]
integer
Example: page[number]=1

Determines which page of the entities to retrieve.

Responses

Response samples

Content type
application/json
{}

Create a new auth server

Create a new auth server

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenclientTokenserviceAccessTokenbearerAuth
Request Body schema: application/json

Auth server to be created

name
required
string (AuthServerName)

The name of the auth server.

description
string (AuthServerDescription)

The description of the auth server.

audience
required
string (Audience)

The recipients that the tokens are intended for. This becomes the 'aud' claim in an access token.

object (Labels) <= 50 properties

Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.

Keys must be of length 1-63 characters, and cannot start with "kong", "konnect", "mesh", "kic", or "_".

Responses

Request samples

Content type
application/json
{
  • "name": "Auth Server",
  • "description": "Auth Server Description",
  • "audience": "api://default"
}

Response samples

Content type
application/json
{}

Get an auth server

Get an auth server

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenclientTokenserviceAccessTokenbearerAuth
path Parameters
authServerId
required
string <uuid>
Example: d32d905a-ed33-46a3-a093-d8f536af9a8a

The auth server ID

Responses

Response samples

Content type
application/json
{}

Update an auth server

Update an auth server

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenclientTokenserviceAccessTokenbearerAuth
path Parameters
authServerId
required
string <uuid>
Example: d32d905a-ed33-46a3-a093-d8f536af9a8a

The auth server ID

Request Body schema: application/json

Auth server to be updated

name
string (AuthServerName)

The name of the auth server.

description
string (AuthServerDescription)

The description of the auth server.

audience
string (Audience)

The recipients that the tokens are intended for. This becomes the 'aud' claim in an access token.

object or null (LabelsUpdate) <= 50 properties

Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.

Labels are intended to store INTERNAL metadata.

Keys must be of length 1-63 characters, and cannot start with "kong", "konnect", "mesh", "kic", or "_".

Responses

Request samples

Content type
application/json
{
  • "name": "Updated Auth Server",
  • "description": "Updated Auth Server Description",
  • "audience": "api://default"
}

Response samples

Content type
application/json
{}

Delete an auth server

Delete an auth server

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenclientTokenserviceAccessTokenbearerAuth
path Parameters
authServerId
required
string <uuid>
Example: d32d905a-ed33-46a3-a093-d8f536af9a8a

The auth server ID

Responses

Response samples

Content type
application/problem+json
{
  • "status": 404,
  • "title": "Not Found",
  • "instance": "kong:trace:6816496025408232265",
  • "detail": "Not Found"
}

List all auth server claims

List all the claims for a given auth server

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenclientTokenserviceAccessTokenbearerAuth
path Parameters
authServerId
required
string <uuid>
Example: d32d905a-ed33-46a3-a093-d8f536af9a8a

The auth server ID

Responses

Response samples

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

Create a new auth server claim

Create a new claim for a given auth server

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenclientTokenserviceAccessTokenbearerAuth
path Parameters
authServerId
required
string <uuid>
Example: d32d905a-ed33-46a3-a093-d8f536af9a8a

The auth server ID

Request Body schema: application/json

Claim to be created

name
required
string (ClaimName)

The name of the claim.

value
required
string (ClaimValue)

Specifies the value of the claim.

include_in_token
boolean (ClaimIncludeInToken)
Default: false

Specifies whether to include claim in the token. If the value is set to 'false' for a claim, the client instead uses the access token to get claims from the '/userinfo' endpoint.

include_in_all_scopes
boolean (ClaimIncludeInAllScopes)
Default: false

Specifies whether to include the claim in all scopes. If the value is set to 'false' for a claim, the claim is only included in the scopes that explicitly list it.

include_in_scopes
Array of strings (ClaimIncludeInScopes)

Specifies the scopes in which the claim is included.

enabled
boolean (ClaimEnabled)
Default: true

Specifies whether the claim is enabled.

Responses

Request samples

Content type
application/json
{
  • "name": "Claim",
  • "value": "Claim Value",
  • "include_in_token": true,
  • "include_in_all_scopes": false,
  • "include_in_scopes": [
    ],
  • "enabled": true
}

Response samples

Content type
application/json
{
  • "id": "07d05309-45cc-4b37-92fb-1524846deec3",
  • "name": "Claim 1",
  • "value": "Claim 1 Value",
  • "include_in_token": true,
  • "include_in_all_scopes": false,
  • "include_in_scopes": [
    ],
  • "enabled": true,
  • "created_at": "2023-03-20T09:29:14.52Z",
  • "updated_at": "2023-03-21T09:29:14.52Z"
}

Get an auth server claim

Get a claim for given auth server

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenclientTokenserviceAccessTokenbearerAuth
path Parameters
authServerId
required
string <uuid>
Example: d32d905a-ed33-46a3-a093-d8f536af9a8a

The auth server ID

claimId
required
string <uuid>
Example: 07d05309-45cc-4b37-92fb-1524846deec3

The claim ID

Responses

Response samples

Content type
application/json
{
  • "id": "07d05309-45cc-4b37-92fb-1524846deec3",
  • "name": "Claim 1",
  • "value": "Claim 1 Value",
  • "include_in_token": true,
  • "include_in_all_scopes": false,
  • "include_in_scopes": [
    ],
  • "enabled": true,
  • "created_at": "2023-03-20T09:29:14.52Z",
  • "updated_at": "2023-03-21T09:29:14.52Z"
}

Update an auth server claim

Update a claim for a given auth server

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenclientTokenserviceAccessTokenbearerAuth
path Parameters
authServerId
required
string <uuid>
Example: d32d905a-ed33-46a3-a093-d8f536af9a8a

The auth server ID

claimId
required
string <uuid>
Example: 07d05309-45cc-4b37-92fb-1524846deec3

The claim ID

Request Body schema: application/json

Claim to be updated

name
string (ClaimName)

The name of the claim.

value
string (ClaimValue)

Specifies the value of the claim.

include_in_token
boolean (ClaimIncludeInToken)
Default: false

Specifies whether to include claim in the token. If the value is set to 'false' for a claim, the client instead uses the access token to get claims from the '/userinfo' endpoint.

include_in_all_scopes
boolean (ClaimIncludeInAllScopes)
Default: false

Specifies whether to include the claim in all scopes. If the value is set to 'false' for a claim, the claim is only included in the scopes that explicitly list it.

include_in_scopes
Array of strings (ClaimIncludeInScopes)

Specifies the scopes in which the claim is included.

enabled
boolean (ClaimEnabled)
Default: true

Specifies whether the claim is enabled.

Responses

Request samples

Content type
application/json
{
  • "name": "Updated Claim",
  • "value": "Updated Claim Value",
  • "include_in_token": true,
  • "include_in_all_scopes": true,
  • "include_in_scopes": [
    ],
  • "enabled": false
}

Response samples

Content type
application/json
{
  • "id": "07d05309-45cc-4b37-92fb-1524846deec3",
  • "name": "Claim 1",
  • "value": "Claim 1 Value",
  • "include_in_token": true,
  • "include_in_all_scopes": false,
  • "include_in_scopes": [
    ],
  • "enabled": true,
  • "created_at": "2023-03-20T09:29:14.52Z",
  • "updated_at": "2023-03-21T09:29:14.52Z"
}

Delete an auth server claim

Delete a claim for a given auth server

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenclientTokenserviceAccessTokenbearerAuth
path Parameters
authServerId
required
string <uuid>
Example: d32d905a-ed33-46a3-a093-d8f536af9a8a

The auth server ID

claimId
required
string <uuid>
Example: 07d05309-45cc-4b37-92fb-1524846deec3

The claim ID

Responses

Response samples

Content type
application/problem+json
{
  • "status": 404,
  • "title": "Not Found",
  • "instance": "kong:trace:6816496025408232265",
  • "detail": "Not Found"
}

List all auth server clients

List all the clients for a given auth server

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenclientTokenserviceAccessTokenbearerAuth
path Parameters
authServerId
required
string <uuid>
Example: d32d905a-ed33-46a3-a093-d8f536af9a8a

The auth server ID

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[number]
integer
Example: page[number]=1

Determines which page of the entities to retrieve.

Responses

Response samples

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

Create a new auth server client

Create a new client for a given auth server

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenclientTokenserviceAccessTokenbearerAuth
path Parameters
authServerId
required
string <uuid>
Example: d32d905a-ed33-46a3-a093-d8f536af9a8a

The auth server ID

Request Body schema: application/json

Client to be created

name
required
string (ClientName)

The name of the client.

grant_types
required
Array of strings (GrantTypes) unique
Items Enum: "authorization_code" "implicit" "client_credentials"

Array of OAuth 2.0 grant type strings.

response_types
required
Array of strings (ResponseTypes)
Items Enum: "none" "token" "code" "id_token"

array of OAuth 2.0 reponse type string.

redirect_uris
Array of strings <uri> (RedirectURIs)

The URIs that the client is allowed to redirect to after authentication in interactive flows. All redirect URIs must be absolute URIs, be secure (HTTPS), and must not include a fragment component.

login_uri
string or null <uri> (LoginURI)

The URI of the login page where the user is redirected to authenticate in interactive flows. The login page must be secure (HTTPS).

allow_all_scopes
boolean (ClientAllowAllScopes)
Default: false

Specifies whether the client is allowed to request all scopes.

allow_scopes
Array of strings (ClientAllowScopes)

Specifies the scopes that the client is allowed to request.

object (Labels) <= 50 properties

Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.

Keys must be of length 1-63 characters, and cannot start with "kong", "konnect", "mesh", "kic", or "_".

Responses

Request samples

Content type
application/json
{
  • "name": "Client",
  • "grant_types": [
    ],
  • "allow_all_scopes": false,
  • "allow_scopes": [
    ],
  • "redirect_uris": [],
  • "login_uri": "https://client.com/login",
  • "response_types": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "kYa9iQFU5xPDSIUH9z1z",
  • "name": "Client 1",
  • "grant_types": [
    ],
  • "allow_all_scopes": false,
  • "allow_scopes": [
    ],
  • "redirect_uris": [],
  • "login_uri": "https://client.com/login",
  • "labels": {
    },
  • "response_types": [
    ],
  • "created_at": "2023-03-20T09:29:14.52Z",
  • "updated_at": "2023-03-21T09:29:14.52Z",
  • "client_secret": "YAzsyUlNZ5gNGeKS9H3VAdxVPzhPo4ae"
}

Get an auth server client

Get a client for given auth server

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenclientTokenserviceAccessTokenbearerAuth
path Parameters
authServerId
required
string <uuid>
Example: d32d905a-ed33-46a3-a093-d8f536af9a8a

The auth server ID

clientId
required
string (ClientId) [ 1 .. 36 ] characters [-_\w]+
Example: kYa9iQFU5xPDSIUH9z1z

The OAuth 2.0 client ID

Responses

Response samples

Content type
application/json
{
  • "id": "kYa9iQFU5xPDSIUH9z1z",
  • "name": "Client 1",
  • "grant_types": [
    ],
  • "allow_all_scopes": false,
  • "allow_scopes": [
    ],
  • "redirect_uris": [],
  • "login_uri": "https://client.com/login",
  • "labels": {
    },
  • "response_types": [
    ],
  • "created_at": "2023-03-20T09:29:14.52Z",
  • "updated_at": "2023-03-21T09:29:14.52Z"
}

Update an auth server client

Update a client for a given auth server

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenclientTokenserviceAccessTokenbearerAuth
path Parameters
authServerId
required
string <uuid>
Example: d32d905a-ed33-46a3-a093-d8f536af9a8a

The auth server ID

clientId
required
string (ClientId) [ 1 .. 36 ] characters [-_\w]+
Example: kYa9iQFU5xPDSIUH9z1z

The OAuth 2.0 client ID

Request Body schema: application/json

Client to be updated

name
string (ClientName)

The name of the client.

client_secret
string non-empty

Secret of the client

grant_types
Array of strings (GrantTypes) unique
Items Enum: "authorization_code" "implicit" "client_credentials"

Array of OAuth 2.0 grant type strings.

response_types
Array of strings (ResponseTypes)
Items Enum: "none" "token" "code" "id_token"

array of OAuth 2.0 reponse type string.

redirect_uris
Array of strings <uri> (RedirectURIs)

The URIs that the client is allowed to redirect to after authentication in interactive flows. All redirect URIs must be absolute URIs, be secure (HTTPS), and must not include a fragment component.

login_uri
string or null <uri> (LoginURI)

The URI of the login page where the user is redirected to authenticate in interactive flows. The login page must be secure (HTTPS).

allow_all_scopes
boolean (ClientAllowAllScopes)
Default: false

Specifies whether the client is allowed to request all scopes.

allow_scopes
Array of strings (ClientAllowScopes)

Specifies the scopes that the client is allowed to request.

object or null (LabelsUpdate) <= 50 properties

Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.

Labels are intended to store INTERNAL metadata.

Keys must be of length 1-63 characters, and cannot start with "kong", "konnect", "mesh", "kic", or "_".

Responses

Request samples

Content type
application/json
{
  • "name": "Updated Client"
}

Response samples

Content type
application/json
{
  • "id": "kYa9iQFU5xPDSIUH9z1z",
  • "name": "Client 1",
  • "grant_types": [
    ],
  • "allow_all_scopes": false,
  • "allow_scopes": [
    ],
  • "redirect_uris": [],
  • "login_uri": "https://client.com/login",
  • "labels": {
    },
  • "response_types": [
    ],
  • "created_at": "2023-03-20T09:29:14.52Z",
  • "updated_at": "2023-03-21T09:29:14.52Z"
}

Replace an auth server client

Replace a client for a given auth server

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenclientTokenserviceAccessTokenbearerAuth
path Parameters
authServerId
required
string <uuid>
Example: d32d905a-ed33-46a3-a093-d8f536af9a8a

The auth server ID

clientId
required
string (ClientId) [ 1 .. 36 ] characters [-_\w]+
Example: kYa9iQFU5xPDSIUH9z1z

The OAuth 2.0 client ID

Request Body schema: application/json

Client to be replaced

name
required
string (ClientName)

The name of the client.

client_secret
required
string non-empty

Secret of the client

grant_types
required
Array of strings (GrantTypes) unique
Items Enum: "authorization_code" "implicit" "client_credentials"

Array of OAuth 2.0 grant type strings.

response_types
required
Array of strings (ResponseTypes)
Items Enum: "none" "token" "code" "id_token"

array of OAuth 2.0 reponse type string.

redirect_uris
Array of strings <uri> (RedirectURIs)

The URIs that the client is allowed to redirect to after authentication in interactive flows. All redirect URIs must be absolute URIs, be secure (HTTPS), and must not include a fragment component.

login_uri
string or null <uri> (LoginURI)

The URI of the login page where the user is redirected to authenticate in interactive flows. The login page must be secure (HTTPS).

allow_all_scopes
boolean (ClientAllowAllScopes)
Default: false

Specifies whether the client is allowed to request all scopes.

allow_scopes
Array of strings (ClientAllowScopes)

Specifies the scopes that the client is allowed to request.

object (Labels) <= 50 properties

Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.

Keys must be of length 1-63 characters, and cannot start with "kong", "konnect", "mesh", "kic", or "_".

Responses

Request samples

Content type
application/json
{
  • "name": "Replace Client",
  • "client_secret": "SecretPassword",
  • "grant_types": [
    ],
  • "response_types": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "kYa9iQFU5xPDSIUH9z1z",
  • "name": "Client 1",
  • "grant_types": [
    ],
  • "allow_all_scopes": false,
  • "allow_scopes": [
    ],
  • "redirect_uris": [],
  • "login_uri": "https://client.com/login",
  • "labels": {
    },
  • "response_types": [
    ],
  • "created_at": "2023-03-20T09:29:14.52Z",
  • "updated_at": "2023-03-21T09:29:14.52Z"
}

Delete an auth server client

Delete a client for a given auth server

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenclientTokenserviceAccessTokenbearerAuth
path Parameters
authServerId
required
string <uuid>
Example: d32d905a-ed33-46a3-a093-d8f536af9a8a

The auth server ID

clientId
required
string (ClientId) [ 1 .. 36 ] characters [-_\w]+
Example: kYa9iQFU5xPDSIUH9z1z

The OAuth 2.0 client ID

Responses

Response samples

Content type
application/problem+json
{
  • "status": 404,
  • "title": "Not Found",
  • "instance": "kong:trace:6816496025408232265",
  • "detail": "Not Found"
}

List all auth server client tokens

List all the tokens for a given client and auth server

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenclientTokenserviceAccessTokenbearerAuth
path Parameters
authServerId
required
string <uuid>
Example: d32d905a-ed33-46a3-a093-d8f536af9a8a

The auth server ID

clientId
required
string (ClientId) [ 1 .. 36 ] characters [-_\w]+
Example: kYa9iQFU5xPDSIUH9z1z

The OAuth 2.0 client ID

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[number]
integer
Example: page[number]=1

Determines which page of the entities to retrieve.

Responses

Response samples

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

Delete all auth server client tokens

Revoke all tokens for a given client and auth server

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenclientTokenserviceAccessTokenbearerAuth
path Parameters
authServerId
required
string <uuid>
Example: d32d905a-ed33-46a3-a093-d8f536af9a8a

The auth server ID

clientId
required
string (ClientId) [ 1 .. 36 ] characters [-_\w]+
Example: kYa9iQFU5xPDSIUH9z1z

The OAuth 2.0 client ID

Responses

Response samples

Content type
application/problem+json
{
  • "status": 404,
  • "title": "Not Found",
  • "instance": "kong:trace:6816496025408232265",
  • "detail": "Not Found"
}

Get an auth server client token

Get a token for given client and auth server

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenclientTokenserviceAccessTokenbearerAuth
path Parameters
authServerId
required
string <uuid>
Example: d32d905a-ed33-46a3-a093-d8f536af9a8a

The auth server ID

clientId
required
string (ClientId) [ 1 .. 36 ] characters [-_\w]+
Example: kYa9iQFU5xPDSIUH9z1z

The OAuth 2.0 client ID

tokenId
required
string <uuid>
Example: 2cec70a4-d197-495c-8f3e-c0a1199d1da4

The token ID

Responses

Response samples

Content type
application/json
{
  • "id": "2cec70a4-d197-495c-8f3e-c0a1199d1da4",
  • "created_at": "2023-03-20T09:29:14.52Z",
  • "expires_at": "2022-11-04T20:10:06.927Z"
}

Delete an auth server client token

Revoke a token for a given client and auth server

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenclientTokenserviceAccessTokenbearerAuth
path Parameters
authServerId
required
string <uuid>
Example: d32d905a-ed33-46a3-a093-d8f536af9a8a

The auth server ID

clientId
required
string (ClientId) [ 1 .. 36 ] characters [-_\w]+
Example: kYa9iQFU5xPDSIUH9z1z

The OAuth 2.0 client ID

tokenId
required
string <uuid>
Example: 2cec70a4-d197-495c-8f3e-c0a1199d1da4

The token ID

Responses

Response samples

Content type
application/problem+json
{
  • "status": 404,
  • "title": "Not Found",
  • "instance": "kong:trace:6816496025408232265",
  • "detail": "Not Found"
}

List all auth server scopes

List all the scopes for a given auth server

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenclientTokenserviceAccessTokenbearerAuth
path Parameters
authServerId
required
string <uuid>
Example: d32d905a-ed33-46a3-a093-d8f536af9a8a

The auth server ID

Responses

Response samples

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

Create a new auth server scope

Create a new scope for a given auth server

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenclientTokenserviceAccessTokenbearerAuth
path Parameters
authServerId
required
string <uuid>
Example: d32d905a-ed33-46a3-a093-d8f536af9a8a

The auth server ID

Request Body schema: application/json

Scope to be created

name
required
string (ScopeName)

The name of the scope.

description
string (ScopeDescription)

Description of the scope.

default
boolean (ScopeDefault)
Default: false

Specifies whether the scope is a default scope.

include_in_metadata
boolean (ScopeIncludeInMetadata)
Default: false

Specifies whether to include the scope in the metadata document.

enabled
boolean (ScopeEnabled)
Default: true

Specifies whether the scope is enabled.

Responses

Request samples

Content type
application/json
{
  • "name": "Scope",
  • "description": "Scope Description",
  • "default": false,
  • "include_in_metadata": false,
  • "enabled": true
}

Response samples

Content type
application/json
{
  • "id": "c5e12516-182c-4928-ae04-05374b3b1cca",
  • "name": "Scope 1",
  • "description": "Scope 1 Description",
  • "default": false,
  • "include_in_metadata": false,
  • "enabled": true,
  • "created_at": "2023-03-20T09:29:14.52Z",
  • "updated_at": "2023-03-21T09:29:14.52Z"
}

Get an auth server scope

Get a scope for given auth server

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenclientTokenserviceAccessTokenbearerAuth
path Parameters
authServerId
required
string <uuid>
Example: d32d905a-ed33-46a3-a093-d8f536af9a8a

The auth server ID

scopeId
required
string <uuid>
Example: c5e12516-182c-4928-ae04-05374b3b1cca

The scope ID

Responses

Response samples

Content type
application/json
{
  • "id": "c5e12516-182c-4928-ae04-05374b3b1cca",
  • "name": "Scope 1",
  • "description": "Scope 1 Description",
  • "default": false,
  • "include_in_metadata": false,
  • "enabled": true,
  • "created_at": "2023-03-20T09:29:14.52Z",
  • "updated_at": "2023-03-21T09:29:14.52Z"
}

Update an auth server scope

Update a scope for a given auth server

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenclientTokenserviceAccessTokenbearerAuth
path Parameters
authServerId
required
string <uuid>
Example: d32d905a-ed33-46a3-a093-d8f536af9a8a

The auth server ID

scopeId
required
string <uuid>
Example: c5e12516-182c-4928-ae04-05374b3b1cca

The scope ID

Request Body schema: application/json

Scope to be updated

name
string (ScopeName)

The name of the scope.

description
string (ScopeDescription)

Description of the scope.

default
boolean (ScopeDefault)
Default: false

Specifies whether the scope is a default scope.

include_in_metadata
boolean (ScopeIncludeInMetadata)
Default: false

Specifies whether to include the scope in the metadata document.

enabled
boolean (ScopeEnabled)
Default: true

Specifies whether the scope is enabled.

Responses

Request samples

Content type
application/json
{
  • "name": "Updated Scope",
  • "description": "Updated Scope Description",
  • "default": true,
  • "include_in_metadata": true,
  • "enabled": false
}

Response samples

Content type
application/json
{
  • "id": "c5e12516-182c-4928-ae04-05374b3b1cca",
  • "name": "Scope 1",
  • "description": "Scope 1 Description",
  • "default": false,
  • "include_in_metadata": false,
  • "enabled": true,
  • "created_at": "2023-03-20T09:29:14.52Z",
  • "updated_at": "2023-03-21T09:29:14.52Z"
}

Delete an auth server scope

Delete a scope for a given auth server

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenclientTokenserviceAccessTokenbearerAuth
path Parameters
authServerId
required
string <uuid>
Example: d32d905a-ed33-46a3-a093-d8f536af9a8a

The auth server ID

scopeId
required
string <uuid>
Example: c5e12516-182c-4928-ae04-05374b3b1cca

The scope ID

Responses

Response samples

Content type
application/problem+json
{
  • "status": 404,
  • "title": "Not Found",
  • "instance": "kong:trace:6816496025408232265",
  • "detail": "Not Found"
}

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

Declarative Configuration

Create or Update the declarative config

Create or Update the declarative config

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenclientTokenserviceAccessTokenbearerAuth
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:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenclientTokenserviceAccessTokenbearerAuth
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:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenclientTokenserviceAccessTokenbearerAuth
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
Example
{
  • "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:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenclientTokenserviceAccessTokenbearerAuth
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:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenclientTokenserviceAccessTokenbearerAuth
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

Nodes

Create or update a node

Create or update a node.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenclientTokenserviceAccessTokenbearerAuth
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": {
    }
}