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

Metrics

Query metrics in the advanced analytics 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:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
Request Body schema: application/json
metrics
required
Array of strings <= 3 items
Items Enum: "kong_latency_average" "kong_latency_p50" "kong_latency_p95" "kong_latency_p99" "request_count" "request_per_minute" "request_size_average" "request_size_p50" "request_size_p95" "request_size_p99" "request_size_sum" "response_latency_average" "response_latency_p50" "response_latency_p95" "response_latency_p99" "response_size_average" "response_size_p50" "response_size_p95" "response_size_p99" "response_size_sum" "upstream_latency_average" "upstream_latency_p50" "upstream_latency_p95" "upstream_latency_p99"

List of aggregated metrics to collect across the requested time span. If no metrics are specified, request_count will be computed by default.

dimensions
Array of strings <= 2 items
Items Enum: "api_product" "api_product_version" "application" "consumer" "control_plane" "control_plane_group" "data_plane_node" "data_plane_node_version" "gateway_service" "response_source" "route" "status_code" "status_code_grouped" "time" "upstream_status_code" "upstream_status_code_grouped"

List of attributes or entity types to group by.

Array of (MetricsApiProductFilterByField (Multiselect filters (object) or Empty filters (object))) or (MetricsApiProductVersionFilterByField (Multiselect filters (object) or Empty filters (object))) or (MetricsApplicationFilterByField (Multiselect filters (object) or Empty filters (object))) or (MetricsConsumerFilterByField (Multiselect filters (object) or Empty filters (object))) or (MetricsControlPlaneFilterByField (Multiselect filters (object) or Empty filters (object))) or (MetricsControlPlaneGroupFilterByField (Multiselect filters (object) or Empty filters (object))) or (MetricsDataPlaneNodeFilterByField (Multiselect filters (object) or Empty filters (object))) or (MetricsDataPlaneNodeVersionFilterByField (Multiselect filters (object) or Empty filters (object))) or (MetricsGatewayServiceFilterByField (Multiselect filters (object) or Empty filters (object))) or (MetricsResponseSourceFilterByField (Multiselect filters (object) or Empty filters (object))) or (MetricsRouteFilterByField (Multiselect filters (object) or Empty filters (object))) or (MetricsStatusCodeFilterByField (Multiselect filters (object) or Empty filters (object))) or (MetricsStatusCodeGroupedFilterByField (Multiselect filters (object) or Empty filters (object))) or (MetricsUpstreamStatusCodeFilterByField (Multiselect filters (object) or Empty filters (object))) or (MetricsUpstreamStatusCodeGroupedFilterByField (Multiselect filters (object) or Empty filters (object)))

A list of filters to apply to the query.

granularity
string
Enum: "tenSecondly" "thirtySecondly" "minutely" "fiveMinutely" "tenMinutely" "thirtyMinutely" "hourly" "twoHourly" "twelveHourly" "daily" "weekly"

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

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.

Different relative times support different granularities:

  • 15m => tenSecondly, thirtySecondly, minutely
  • 1h => tenSecondly, thirtySecondly, minutely, fiveMinutely, tenMinutely
  • 6h => thirtySecondly, minutely, fiveMinutely, tenMinutely, thirtyMinutely, hourly
  • 12h => minutely, fiveMinutely, tenMinutely, thirtyMinutely, hourly
  • 24h => fiveMinutely, tenMinutely, thirtyMinutely, hourly
  • 7d => thirtyMinutely, hourly, twoHourly, twelveHourly, daily
  • 30d => hourly, twoHourly, twelveHourly, daily, weekly

For special time ranges:

  • current_week, previous_week => thirtyMinutely, hourly, twoHourly, twelveHourly, daily
  • current_month, previous_month => hourly, twoHourly, twelveHourly, daily, weekly

For absolute time ranges, daily will be used.

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

The time range to query.

Responses

Request samples

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

Response samples

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

API Requests

Query API Requests

Returns API requests that were proxied through the Kong Gateway.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
Request Body schema: application/json
One of
Array of (ApiProductFilterByField (Multiselect filters (object) or Single select filters (object) or Empty filters (object))) or (ApiProductVersionFilterByField (Multiselect filters (object) or Single select filters (object) or Empty filters (object))) or (ApplicationFilterByField (Multiselect filters (object) or Single select filters (object) or Empty filters (object))) or (AuthTypeFilterByField (Multiselect filters (object) or Single select filters (object) or Wildcard filters (object) or Empty filters (object))) or (ClientIpFilterByField (Multiselect filters (object) or Single select filters (object) or Wildcard filters (object) or Empty filters (object))) or (ConsumerFilterByField (Multiselect filters (object) or Single select filters (object) or Empty filters (object))) or (ControlPlaneFilterByField (Multiselect filters (object) or Single select filters (object) or Empty filters (object))) or (ControlPlaneGroupFilterByField (Multiselect filters (object) or Single select filters (object) or Empty filters (object))) or (DataPlaneNodeFilterByField (Multiselect filters (object) or Single select filters (object) or Empty filters (object))) or (DataPlaneNodeVersionFilterByField (Multiselect filters (object) or Single select filters (object) or Wildcard filters (object) or Empty filters (object))) or (GatewayServiceFilterByField (Multiselect filters (object) or Single select filters (object) or Empty filters (object))) or (HeaderHostFilterByField (Multiselect filters (object) or Single select filters (object) or Wildcard filters (object) or Empty filters (object))) or (HeaderUserAgentFilterByField (Multiselect filters (object) or Single select filters (object) or Wildcard filters (object) or Empty filters (object))) or (HttpMethodFilterByField (Multiselect filters (object) or Single select filters (object) or Wildcard filters (object) or Empty filters (object))) or (LatenciesKongGatewayMsFilterByField (Multiselect filters (object) or Numeric filters (object) or Empty filters (object))) or (LatenciesResponseMsFilterByField (Multiselect filters (object) or Numeric filters (object) or Empty filters (object))) or (LatenciesUpstreamMsFilterByField (Multiselect filters (object) or Numeric filters (object) or Empty filters (object))) or (ResponseBodySizeFilterByField (Multiselect filters (object) or Numeric filters (object) or Empty filters (object))) or (ResponseHeaderContentLengthFilterByField (Multiselect filters (object) or Numeric filters (object) or Empty filters (object))) or (ResponseSourceFilterByField (Multiselect filters (object) or Single select filters (object) or Wildcard filters (object) or Empty filters (object))) or (RequestBodySizeFilterByField (Multiselect filters (object) or Numeric filters (object) or Empty filters (object))) or (RequestIdFilterByField (Multiselect filters (object) or Single select filters (object) or Wildcard filters (object) or Empty filters (object))) or (RequestUriFilterByField (Multiselect filters (object) or Single select filters (object) or Wildcard filters (object) or Empty filters (object))) or (ResponseHeaderContentTypeFilterByField (Multiselect filters (object) or Single select filters (object) or Wildcard filters (object) or Empty filters (object))) or (RouteFilterByField (Multiselect filters (object) or Single select filters (object) or Empty filters (object))) or (ServicePortFilterByField (Multiselect filters (object) or Single select filters (object) or Wildcard filters (object) or Empty filters (object))) or (ServiceProtocolFilterByField (Multiselect filters (object) or Single select filters (object) or Wildcard filters (object) or Empty filters (object))) or (StatusCodeFilterByField (Multiselect filters (object) or Single select filters (object) or Empty filters (object))) or (StatusCodeGroupedFilterByField (Multiselect filters (object) or Single select filters (object) or Empty filters (object))) or (TraceIdFilterByField (Multiselect filters (object) or Single select filters (object) or Wildcard filters (object) or Empty filters (object))) or (UpstreamStatusCodeFilterByField (Multiselect filters (object) or Single select filters (object) or Empty filters (object))) or (UpstreamStatusCodeGroupedFilterByField (Multiselect filters (object) or Single select filters (object) or Empty filters (object))) or (UpstreamUriFilterByField (Multiselect filters (object) or Single select filters (object) or Wildcard filters (object) or Empty filters (object)))
Default: []
any (FilterTimeRange)
Default: {"type":"relative","time_range":"1H"}

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 1 hour will be chosen.

order
string (FilterOrder)
Default: "descending"
Enum: "ascending" "descending"

Order of results sorted by time.

size
integer (FilterSize)
Default: 100

Number of requests to be returned.

offset
integer (FilterOffset)
Default: 0

Number of requests to be skipped when returning results.

Responses

Request samples

Content type
application/json
Example
{
  • "time_range": {
    },
  • "filters": [
    ]
}

Response samples

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

API

Create API

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

Creates an API.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
Request Body schema: application/json
name
required
string [ 1 .. 255 ] characters

The name of your API. The name + version combination must be unique for each API you publish.

description
string or null

A description of your API. Will be visible on your live Portal.

version
string or null [ 1 .. 255 ] characters

An optional version for your API. Leave this empty if your API is unversioned.

deprecated
boolean
Default: false

Marks this API as deprecated.

slug
string or null^[\w-]+$

The slug is used in generated URLs to provide human readable paths.

Defaults to slugify(name + version)

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 (PublicLabels) <= 50 properties

Public labels store information about an entity that can be used for filtering a list of objects.

Public labels are intended to store PUBLIC 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
Example
{
  • "name": "myAPI"
}

Response samples

Content type
application/json
{
  • "id": "9f5061ce-78f6-4452-9108-ad7c02821fd5",
  • "name": "myAPI",
  • "version": "v1",
  • "labels": {
    },
  • "public_labels": { },
  • "description": "My API",
  • "deprecated": false,
  • "created_at": "2023-01-01T00:00:00.000Z",
  • "updated_at": "2023-01-01T00:00:00.000Z",
  • "slug": "my-api-v1",
  • "portals": [
    ]
}

List APIs

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

Returns a collection of all APIs.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
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 (API Filter Parameters)

Filters APIs in the response.

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

Sorts a collection of APIs. Supported sort attributes are:

  • name
  • version
  • created_at
  • updated_at

Responses

Response samples

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

Fetch API

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

Fetches an API.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
apiId
required
string <uuid>
Example: 9f5061ce-78f6-4452-9108-ad7c02821fd5

The UUID API identifier

Responses

Response samples

Content type
application/json
{
  • "id": "9f5061ce-78f6-4452-9108-ad7c02821fd5",
  • "name": "myAPI",
  • "version": "v1",
  • "labels": {
    },
  • "public_labels": { },
  • "description": "My API",
  • "deprecated": false,
  • "created_at": "2023-01-01T00:00:00.000Z",
  • "updated_at": "2023-01-01T00:00:00.000Z",
  • "slug": "my-api-v1",
  • "portals": [
    ]
}

Update API

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

Updates an API.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
apiId
required
string <uuid>
Example: 9f5061ce-78f6-4452-9108-ad7c02821fd5

The UUID API identifier

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

The name of your API. The name + version combination must be unique for each API you publish.

description
string or null

A description of your API. Will be visible on your live Portal.

version
string or null [ 1 .. 255 ] characters

An optional version for your API. Leave this empty if your API is unversioned.

deprecated
boolean
Default: false

Marks this API as deprecated.

slug
string or null^[\w-]+$

The slug is used in generated URLs to provide human readable paths.

Defaults to slugify(name + version)

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 "_".

object (PublicLabelsUpdate) <= 50 properties

Public labels store information about an entity that can be used for filtering a list of objects.

Public labels are intended to store PUBLIC 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
Example
{
  • "name": "new API name"
}

Response samples

Content type
application/json
{
  • "id": "9f5061ce-78f6-4452-9108-ad7c02821fd5",
  • "name": "myAPI",
  • "version": "v1",
  • "labels": {
    },
  • "public_labels": { },
  • "description": "My API",
  • "deprecated": false,
  • "created_at": "2023-01-01T00:00:00.000Z",
  • "updated_at": "2023-01-01T00:00:00.000Z",
  • "slug": "my-api-v1",
  • "portals": [
    ]
}

Delete API

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

Deletes an API.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
apiId
required
string <uuid>
Example: 9f5061ce-78f6-4452-9108-ad7c02821fd5

The UUID API identifier

Responses

Response samples

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

API Documentation

Create API Document

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

Publish a new document attached to an API.

All configuration options may be provided in the frontmatter section of content. If you set values in both the POST request and in the frontmatter, the values in the POST request will take precedence.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
apiId
required
string <uuid>
Example: 9f5061ce-78f6-4452-9108-ad7c02821fd5

The UUID API identifier

Request Body schema: application/json
content
required
string (API Document Content)

Raw markdown content to display in your Portal

title
string (API Document Title)

The title of the document. Used to populate the <title> tag for the page

slug
string (API Document Slug) ^[\w-]+$

The slug is used in generated URLs to provide human readable paths.

Defaults to slugify(title)

status
string (ApiDocumentStatus)
Default: "unpublished"
Enum: "published" "unpublished"

If status=published the document will be visible in your live portal

parent_document_id
string or null <uuid> (API Document Parent Document ID)

API Documents may be rendered as a tree of files.

Specify the id of another API Document as the parent_document_id to add some heirarchy do your documents.

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
Example
{
  • "slug": "api-document",
  • "status": "published",
  • "title": "API Document",
  • "content": "# API Document Header"
}

Response samples

Content type
application/json
{
  • "id": "de5c9818-be5c-42e6-b514-e3d4bc30ddeb",
  • "parent_document_id": null,
  • "title": "API Document",
  • "slug": "api-document",
  • "status": "published",
  • "content": "# API Document Header",
  • "labels": {
    },
  • "created_at": "2023-01-01T00:00:00.000Z",
  • "updated_at": "2023-01-01T00:00:00.000Z"
}

List API Documents

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

Returns a collection of all documents for an API.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
apiId
required
string <uuid>
Example: 9f5061ce-78f6-4452-9108-ad7c02821fd5

The UUID API identifier

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

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

page[number]
integer
Example: page[number]=1

Determines which page of the entities to retrieve.

object (API Document Filter Parameters)

Filters API Documents in the response.

Responses

Response samples

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

Fetch API Document

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

Returns a document for the API.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
apiId
required
string <uuid>
Example: 9f5061ce-78f6-4452-9108-ad7c02821fd5

The UUID API identifier

documentId
required
string <uuid>
Example: de5c9818-be5c-42e6-b514-e3d4bc30ddeb

The document identifier related to the API

Responses

Response samples

Content type
application/json
{
  • "id": "de5c9818-be5c-42e6-b514-e3d4bc30ddeb",
  • "parent_document_id": null,
  • "title": "API Document",
  • "slug": "api-document",
  • "status": "published",
  • "content": "# API Document Header",
  • "labels": {
    },
  • "created_at": "2023-01-01T00:00:00.000Z",
  • "updated_at": "2023-01-01T00:00:00.000Z"
}

Update API Document

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

Updates a document for an API.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
apiId
required
string <uuid>
Example: 9f5061ce-78f6-4452-9108-ad7c02821fd5

The UUID API identifier

documentId
required
string <uuid>
Example: de5c9818-be5c-42e6-b514-e3d4bc30ddeb

The document identifier related to the API

Request Body schema: application/json
content
string (API Document Content)

Raw markdown content to display in your Portal

title
string (API Document Title)

The title of the document. Used to populate the <title> tag for the page

slug
string (API Document Slug) ^[\w-]+$

The slug is used in generated URLs to provide human readable paths.

Defaults to slugify(title)

status
string (ApiDocumentStatus)
Default: "unpublished"
Enum: "published" "unpublished"

If status=published the document will be visible in your live portal

parent_document_id
string or null <uuid> (API Document Parent Document ID)

API Documents may be rendered as a tree of files.

Specify the id of another API Document as the parent_document_id to add some heirarchy do your documents.

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
Example
{
  • "parent_document_id": "dd4e1b98-3629-4dd3-acc0-759a726ffee2",
  • "slug": "api-document",
  • "status": "published",
  • "title": "API Document"
}

Response samples

Content type
application/json
{
  • "id": "de5c9818-be5c-42e6-b514-e3d4bc30ddeb",
  • "parent_document_id": null,
  • "title": "API Document",
  • "slug": "api-document",
  • "status": "published",
  • "content": "# API Document Header",
  • "labels": {
    },
  • "created_at": "2023-01-01T00:00:00.000Z",
  • "updated_at": "2023-01-01T00:00:00.000Z"
}

Delete API Documentation

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

Removes a document from an API.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
apiId
required
string <uuid>
Example: 9f5061ce-78f6-4452-9108-ad7c02821fd5

The UUID API identifier

documentId
required
string <uuid>
Example: de5c9818-be5c-42e6-b514-e3d4bc30ddeb

The document identifier related to the API

Responses

Response samples

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

Move API Documentation

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

This api allows the user to move a document within the document tree using the parameters parent_document_id and index. If parent_document_id is not provided, the document will be placed at the top level of the document tree. index 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 parent_document_id: null 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.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
apiId
required
string <uuid>
Example: 9f5061ce-78f6-4452-9108-ad7c02821fd5

The UUID API identifier

documentId
required
string <uuid>
Example: de5c9818-be5c-42e6-b514-e3d4bc30ddeb

The document identifier related to the API

Request Body schema: application/json

move document

parent_document_id
string <uuid>

parent document id

index
integer

index of the document in the parent document's children

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": 401,
  • "title": "ApiUnauthorized",
  • "instance": "kong:trace:8347343766220159418",
  • "detail": "ApiUnauthorized"
}

API Specification

Create API Specification

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

Creates a specification for an API. Note: You can only have one specification for an API.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
apiId
required
string <uuid>
Example: 9f5061ce-78f6-4452-9108-ad7c02821fd5

The UUID API identifier

Request Body schema: application/json
content
required
string

The raw content of your API specification.

type
string (API Spec Type)
Enum: "oas3" "asyncapi"

The type of specification being stored. This allows us to render the specification correctly.

If this field is not set, it will be autodetected from content

Responses

Request samples

Content type
application/json
{
  • "content": "{\"openapi\":\"3.0.3\",\"info\":{\"title\":\"Example API\",\"version\":\"1.0.0\"},\"paths\":{\"/example\":{\"get\":{\"summary\":\"Example endpoint\",\"responses\":{\"200\":{\"description\":\"Successful response\"}}}}}}",
  • "type": "oas3"
}

Response samples

Content type
application/json
{
  • "id": "7710d5c4-d902-410b-992f-18b814155b53",
  • "content": "{\"openapi\":\"3.0.3\",\"info\":{\"title\":\"Example API\",\"version\":\"1.0.0\"},\"paths\":{\"/example\":{\"get\":{\"summary\":\"Example endpoint\",\"responses\":{\"200\":{\"description\":\"Successful response\"}}}}}}",
  • "type": "oas3",
  • "created_at": "2023-01-01T00:00:00.000Z",
  • "updated_at": "2023-01-01T00:00:00.000Z"
}

List API Specifications

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

Returns a list of specifications for an API. Note: You can only have one specification for an API.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
apiId
required
string <uuid>
Example: 9f5061ce-78f6-4452-9108-ad7c02821fd5

The UUID API identifier

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

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

page[number]
integer
Example: page[number]=1

Determines which page of the entities to retrieve.

object (API Spec Filter Parameters)

Filters API Specs in the response.

Responses

Response samples

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

Fetch API Specification

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

Fetches the specification of an API.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
apiId
required
string <uuid>
Example: 9f5061ce-78f6-4452-9108-ad7c02821fd5

The UUID API identifier

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

The API specification identifier

Responses

Response samples

Content type
application/json
{
  • "id": "7710d5c4-d902-410b-992f-18b814155b53",
  • "content": "{\"openapi\":\"3.0.3\",\"info\":{\"title\":\"Example API\",\"version\":\"1.0.0\"},\"paths\":{\"/example\":{\"get\":{\"summary\":\"Example endpoint\",\"responses\":{\"200\":{\"description\":\"Successful response\"}}}}}}",
  • "type": "oas3",
  • "created_at": "2023-01-01T00:00:00.000Z",
  • "updated_at": "2023-01-01T00:00:00.000Z"
}

Update API Specification

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

Updates the specification of an API.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
apiId
required
string <uuid>
Example: 9f5061ce-78f6-4452-9108-ad7c02821fd5

The UUID API identifier

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

The API specification identifier

Request Body schema: application/json
content
string

The raw content of your API specification.

type
string (API Spec Type)
Enum: "oas3" "asyncapi"

The type of specification being stored. This allows us to render the specification correctly.

If this field is not set, it will be autodetected from content

Responses

Request samples

Content type
application/json
{
  • "content": "{\"openapi\":\"3.0.3\",\"info\":{\"title\":\"Example API\",\"version\":\"1.0.1\"},\"paths\":{\"/example\":{\"get\":{\"summary\":\"Example endpoint\",\"responses\":{\"200\":{\"description\":\"Successful response\"}}}}}}"
}

Response samples

Content type
application/json
{
  • "id": "7710d5c4-d902-410b-992f-18b814155b53",
  • "content": "{\"openapi\":\"3.0.3\",\"info\":{\"title\":\"Example API\",\"version\":\"1.0.0\"},\"paths\":{\"/example\":{\"get\":{\"summary\":\"Example endpoint\",\"responses\":{\"200\":{\"description\":\"Successful response\"}}}}}}",
  • "type": "oas3",
  • "created_at": "2023-01-01T00:00:00.000Z",
  • "updated_at": "2023-01-01T00:00:00.000Z"
}

Delete API Specification

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

Deletes the specification of an API.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
apiId
required
string <uuid>
Example: 9f5061ce-78f6-4452-9108-ad7c02821fd5

The UUID API identifier

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

The API specification identifier

Responses

Response samples

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

API Publication

List Publications

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

Returns a collection of all API Publications.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
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 (API Publication Filter Parameters)

Filters API Publications in the response.

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

Sorts a collection of API publications. Supported sort attributes are:

  • portal_id
  • portal_name
  • api_id
  • api_name
  • created_at
  • updated_at

Responses

Response samples

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

Publish API

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

Publish an API to a portal.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
apiId
required
string <uuid>
Example: 9f5061ce-78f6-4452-9108-ad7c02821fd5

The UUID API identifier

portalId
required
string <uuid>
Example: f32d905a-ed33-46a3-a093-d8f536af9a8a

ID of the portal.

Request Body schema: application/json
auto_approve_registrations
boolean (Auto Approve Registrations)

Whether the application registration auto approval on this portal for the api is enabled. If set to false, fallbacks on portal's auto_approve_applications value.

auth_strategy_ids
Array of strings or null <uuid> (API Publication Auth Strategy IDs) = 1 items

The auth strategy the API enforces for applications in the portal. Omitting this property means the portal's default application auth strategy will be used. Setting to null means the API will not require application authentication. DCR support for application registration is currently in development.

visibility
string (API Publication Visibility)
Default: "private"
Enum: "public" "private"

The visibility of the API in the portal. Public API publications do not require authentication to view and retrieve information about them. Private API publications require authentication to retrieve information about them.

Responses

Request samples

Content type
application/json
{
  • "auto_approve_registrations": true,
  • "auth_strategy_ids": [
    ],
  • "visibility": "public"
}

Response samples

Content type
application/json
{
  • "auto_approve_registrations": true,
  • "auth_strategy_ids": [
    ],
  • "visibility": "public",
  • "created_at": "2022-11-04T20:10:06.927Z",
  • "updated_at": "2022-11-04T20:10:06.927Z"
}

Fetch Publication

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

Retrieve an API's publication in a portal. If the API is not published to the portal, a 404 response is returned.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
apiId
required
string <uuid>
Example: 9f5061ce-78f6-4452-9108-ad7c02821fd5

The UUID API identifier

portalId
required
string <uuid>
Example: f32d905a-ed33-46a3-a093-d8f536af9a8a

ID of the portal.

Responses

Response samples

Content type
application/json
{
  • "auto_approve_registrations": true,
  • "auth_strategy_ids": [
    ],
  • "visibility": "public",
  • "created_at": "2022-11-04T20:10:06.927Z",
  • "updated_at": "2022-11-04T20:10:06.927Z"
}

Delete Publication

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

Unpublish an API from a portal.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
apiId
required
string <uuid>
Example: 9f5061ce-78f6-4452-9108-ad7c02821fd5

The UUID API identifier

portalId
required
string <uuid>
Example: f32d905a-ed33-46a3-a093-d8f536af9a8a

ID of the portal.

Responses

Response samples

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

API Implementation

List API Implementations

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

List gateway implementations for this API

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
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 (API Implementation Filter Parameters)

Filters APIs in the response.

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

Sorts a collection of API implementations. Supported sort attributes are:

  • id
  • api_id
  • control_plane_id
  • service_id
  • created_at
  • updated_at

Responses

Response samples

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

Create API Implementation

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

Creates an implementation for an API. An API can be implemented by a single Gateway Service.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
apiId
required
string <uuid>
Example: 9f5061ce-78f6-4452-9108-ad7c02821fd5

The UUID API identifier

Request Body schema: application/json
required
object (API Implementation Service)

A Gateway service that implements an API

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "id": "5f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
  • "created_at": "2022-11-04T20:10:06.927Z",
  • "updated_at": "2022-11-04T20:10:06.927Z",
  • "service": {
    }
}

Fetch API Implementation

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

Retrieve a gateway implementation for this API

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
apiId
required
string <uuid>
Example: 9f5061ce-78f6-4452-9108-ad7c02821fd5

The UUID API identifier

implementationId
required
string <uuid>
Example: 032d905a-ed33-46a3-a093-d8f536af9a8a

The Portal identifier

Responses

Response samples

Content type
application/json
{
  • "id": "5f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
  • "created_at": "2022-11-04T20:10:06.927Z",
  • "updated_at": "2022-11-04T20:10:06.927Z",
  • "service": {
    }
}

Delete API Implementation

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

Unlink a gateway implementation from this API

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
apiId
required
string <uuid>
Example: 9f5061ce-78f6-4452-9108-ad7c02821fd5

The UUID API identifier

implementationId
required
string <uuid>
Example: 032d905a-ed33-46a3-a093-d8f536af9a8a

The Portal identifier

Responses

Response samples

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

API Products

Create API Product

An API Product packages together associated APIs and their operations, backed by thorough documentation, with the objective of making API consumption straightforward for developers.

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

The name of the API product.

description
string or null
Default: null

The description of the API product.

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 (PublicLabels) <= 50 properties

Public labels store information about an entity that can be used for filtering a list of objects.

Public labels are intended to store PUBLIC metadata.

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

portal_ids
Array of strings <uuid> >= 0 items unique

The list of portal identifiers which this API product should be published to

Responses

Request samples

Content type
application/json
Example
{
  • "name": "API Product"
}

Response samples

Content type
application/json
{
  • "id": "e7a4f6c0-5777-4a37-bcb9-2d37d3b362ee",
  • "name": "API Product",
  • "description": "Text describing the API product",
  • "portal_ids": [ ],
  • "portals": [ ],
  • "created_at": "2023-01-01T00:00:00.000Z",
  • "updated_at": "2023-01-01T00:00:00.000Z",
  • "version_count": 10,
  • "labels": {
    },
  • "public_labels": {
    }
}

List API Products

Returns a collection of API products.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
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 (APIProductFilterParameters)

Filters API Products in the response.

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

Sorts a collection of API products. Supported sort attributes are:

  • name
labels
string
Example: labels=key:value,keyExists

Filters requested resource by associated labels.

public_labels
string
Example: public_labels=key:value,keyExists

Filters requested resource by associated public labels.

Responses

Response samples

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

Fetch API product

Returns an API product.

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

API product identifier

Responses

Response samples

Content type
application/json
{
  • "id": "e7a4f6c0-5777-4a37-bcb9-2d37d3b362ee",
  • "name": "API Product",
  • "description": "Text describing the API product",
  • "portal_ids": [ ],
  • "portals": [ ],
  • "created_at": "2023-01-01T00:00:00.000Z",
  • "updated_at": "2023-01-01T00:00:00.000Z",
  • "version_count": 10,
  • "labels": {
    },
  • "public_labels": {
    }
}

Update an individual API product

Updates an API product.

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

API product identifier

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

The name for the API product.

description
string or null

The description of the API product.

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 "_".

object (PublicLabelsUpdate) <= 50 properties

Public labels store information about an entity that can be used for filtering a list of objects.

Public labels are intended to store PUBLIC metadata.

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

portal_ids
Array of strings <uuid> >= 0 items unique

The list of portal identifiers which this API product should be published to

Responses

Request samples

Content type
application/json
Example
{
  • "name": "API Product with Update Name",
  • "description": "Updated text describing the API product"
}

Response samples

Content type
application/json
{
  • "id": "e7a4f6c0-5777-4a37-bcb9-2d37d3b362ee",
  • "name": "API Product",
  • "description": "Text describing the API product",
  • "portal_ids": [ ],
  • "portals": [ ],
  • "created_at": "2023-01-01T00:00:00.000Z",
  • "updated_at": "2023-01-01T00:00:00.000Z",
  • "version_count": 10,
  • "labels": {
    },
  • "public_labels": {
    }
}

Delete API Product

Removes an individual API product.

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

API product identifier

Responses

Response samples

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

Publish Multiples Products

Publish or Unpublish multiple API Products to this developer portal.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
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
{
  • "api_products": {
    }
}

Response samples

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

API Product Documentation

Create API Product Document

Creates a document for an API product.

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

The API product identifier

Request Body schema: application/json
parent_document_id
string or null <uuid>
Default: null

parent document id

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

document slug. must be unique accross documents belonging to an api product

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

document publish status

title
required
string non-empty

document title

content
string

Can be markdown string content or base64 encoded string

metadata
object
Default: {}

metadata of the document

Responses

Request samples

Content type
application/json
Example
{
  • "slug": "api-product-document",
  • "status": "published",
  • "title": "API Product Document",
  • "content": "IyBBUEkgUHJvZHVjdCBEb2N1bWVudCBIZWFkZXIKQVBJIHByb2R1Y3QgZG9jdW1lbnQgY29udGVudA=="
}

Response samples

Content type
application/json
{
  • "id": "de5c9818-be5c-42e6-b514-e3d4bc30ddeb",
  • "parent_document_id": null,
  • "title": "API Product Document",
  • "slug": "api-product-document",
  • "status": "published",
  • "content": "# API Product Document Header",
  • "ast": [
    ],
  • "metadata": { },
  • "created_at": "2023-01-01T00:00:00.000Z",
  • "updated_at": "2023-01-01T00:00:00.000Z"
}

List API Product Documents

Returns a collection of all documents for an API product.

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

The API product identifier

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

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

page[number]
integer
Example: page[number]=1

Determines which page of the entities to retrieve.

Responses

Response samples

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

Fetch API Product Document

Returns a document for the API product.

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

The API product identifier

id
required
string <uuid>
Example: de5c9818-be5c-42e6-b514-e3d4bc30ddeb

The document identifier related to the API product

Responses

Response samples

Content type
application/json
{
  • "id": "de5c9818-be5c-42e6-b514-e3d4bc30ddeb",
  • "parent_document_id": null,
  • "title": "API Product Document",
  • "slug": "api-product-document",
  • "status": "published",
  • "content": "# API Product Document Header",
  • "ast": [
    ],
  • "metadata": { },
  • "created_at": "2023-01-01T00:00:00.000Z",
  • "updated_at": "2023-01-01T00:00:00.000Z"
}

Update an API Product Document

Updates a document for an API product.

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

The API product identifier

id
required
string <uuid>
Example: de5c9818-be5c-42e6-b514-e3d4bc30ddeb

The document identifier related to the API product

Request Body schema: application/json
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 <= 80 characters ^[\w-]+$

document slug. must be unique accross documents belonging to an api product

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

document publish status

title
string non-empty

document title

content
string

Can be markdown string content or base64 encoded string

metadata
object

Responses

Request samples

Content type
application/json
Example
{
  • "parent_document_id": "dd4e1b98-3629-4dd3-acc0-759a726ffee2",
  • "slug": "api-product-document",
  • "status": "published",
  • "title": "API Product Document",
  • "metadata": {
    }
}

Response samples

Content type
application/json
{
  • "id": "de5c9818-be5c-42e6-b514-e3d4bc30ddeb",
  • "parent_document_id": null,
  • "title": "API Product Document",
  • "slug": "api-product-document",
  • "status": "published",
  • "content": "# API Product Document Header",
  • "ast": [
    ],
  • "metadata": { },
  • "created_at": "2023-01-01T00:00:00.000Z",
  • "updated_at": "2023-01-01T00:00:00.000Z"
}

Delete API Product Documentation

Removes a document from an API product.

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

The API product identifier

id
required
string <uuid>
Example: de5c9818-be5c-42e6-b514-e3d4bc30ddeb

The document identifier related to the API product

Responses

Response samples

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

API Product Versions

Create API Product Version

Creates a version of an API product.

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

The API Product ID

Request Body schema: application/json
name
required
string non-empty

The version name of the API product version.

publish_status
string
Deprecated
Default: "unpublished"
Enum: "unpublished" "published"

The publish status of the API product version. Applies publish status to all related portal product versions. This field is deprecated: Use PortalProductVersion.publish_status instead.

deprecated
boolean
Deprecated
Default: false

Indicates if the version of the API product is deprecated. Applies deprecation or removes deprecation from all related portal product versions. This field is deprecated: Use PortalProductVersion.deprecated instead.

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 "_".

(GatewayServicePayload (object or null)) or (LegacyGatewayServicePayload (object or null))

Responses

Request samples

Content type
application/json
Example
{
  • "name": "v1"
}

Response samples

Content type
application/json
{
  • "id": "9f5061ce-78f6-4452-9108-ad7c02821fd5",
  • "name": "v1",
  • "gateway_service": {
    },
  • "publish_status": "unpublished",
  • "deprecated": false,
  • "labels": {
    },
  • "portals": [
    ],
  • "created_at": "2023-01-01T00:00:00.000Z",
  • "updated_at": "2023-01-01T00:00:00.000Z"
}

List API Product Versions

Returns a collection of all versions for an API product.

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

The API Product 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.

object (APIProductVersionFilterParameters)

Filters API Product Versions in the response.

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

Sorts a collection of API products versions. Supported sort attributes are:

  • name

Responses

Response samples

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

Fetch API Product Version

Returns a version of an API product.

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

The API product identifier

id
required
string <uuid>
Example: 9f5061ce-78f6-4452-9108-ad7c02821fd5

The API product version identifier

Responses

Response samples

Content type
application/json
{
  • "id": "9f5061ce-78f6-4452-9108-ad7c02821fd5",
  • "name": "v1",
  • "gateway_service": {
    },
  • "publish_status": "unpublished",
  • "deprecated": false,
  • "labels": {
    },
  • "portals": [
    ],
  • "created_at": "2023-01-01T00:00:00.000Z",
  • "updated_at": "2023-01-01T00:00:00.000Z"
}

Update an API Product Version

Updates an API product version.

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

The API product identifier

id
required
string <uuid>
Example: 9f5061ce-78f6-4452-9108-ad7c02821fd5

The API product version identifier

Request Body schema: application/json
name
string non-empty

The version name of the API product version.

publish_status
string
Deprecated
Enum: "unpublished" "published"

The publish status of the API product version. Applies publish status to all related portal product versions. This field is deprecated: Use PortalProductVersion.publish_status instead.

deprecated
boolean
Deprecated

Indicates if the version of the API product is deprecated. Applies deprecation or removes deprecation from all related portal product versions. This field is deprecated: Use PortalProductVersion.deprecated instead.

notify
boolean

When set to true, and all the following conditions are true:

  • version of the API product deprecation has changed from false -> true
  • version of the API product is published

then consumers of the now deprecated verion of the API product will be notified.

(GatewayServicePayload (object or null)) or (LegacyGatewayServicePayload (object or null))
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
Example
{
  • "gateway_service": {
    }
}

Response samples

Content type
application/json
{
  • "id": "9f5061ce-78f6-4452-9108-ad7c02821fd5",
  • "name": "v1",
  • "gateway_service": {
    },
  • "publish_status": "unpublished",
  • "deprecated": false,
  • "labels": {
    },
  • "portals": [
    ],
  • "created_at": "2023-01-01T00:00:00.000Z",
  • "updated_at": "2023-01-01T00:00:00.000Z"
}

Delete API Product Version

Removes an API product version.

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

The API product identifier

id
required
string <uuid>
Example: 9f5061ce-78f6-4452-9108-ad7c02821fd5

The API product version identifier

Responses

Response samples

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

API Product Version Specification

Create API Product Version Specification

Creates a specification for a version of an API product. Note: You can only have one specification for a product version.

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

The API product identifier

apiProductVersionId
required
string <uuid>
Example: 9f5061ce-78f6-4452-9108-ad7c02821fd5

The API product version identifier

Request Body schema: application/json
name
required
string [ 1 .. 255 ] characters ^.+(?:\.yaml|\.yml|\.json)$

The name of the API product version specification

content
required
string <byte> non-empty

The base64 encoded contents of the API product version specification

Responses

Request samples

Content type
application/json
{
  • "name": "oas.yaml",
  • "content": "TXkgWUFNTCBvciBKU09OIGZvcm1hdHRlZCBPQVMgY29udGVudA=="
}

Response samples

Content type
application/json
{
  • "id": "7710d5c4-d902-410b-992f-18b814155b53",
  • "name": "oas.yaml",
  • "content": "My YAML or JSON formatted OAS content",
  • "created_at": "2023-01-01T00:00:00.000Z",
  • "updated_at": "2023-01-01T00:00:00.000Z"
}

Fetch API Product Version Specifications

Returns a list of specification for the version of an API product. Note: You can only have one specification for a product version.

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

The API product identifier

apiProductVersionId
required
string <uuid>
Example: 9f5061ce-78f6-4452-9108-ad7c02821fd5

The API product version identifier

Responses

Response samples

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

Fetch API Product Version Specification

Returns a specification for the version of an API product.

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

The API product identifier

apiProductVersionId
required
string <uuid>
Example: 9f5061ce-78f6-4452-9108-ad7c02821fd5

The API product version identifier

specificationId
required
string <uuid>
Example: 742ff9f1-fb89-4aeb-a599-f0e278c7aeaa

The API product version specification identifier

Responses

Response samples

Content type
application/json
{
  • "id": "7710d5c4-d902-410b-992f-18b814155b53",
  • "name": "oas.yaml",
  • "content": "My YAML or JSON formatted OAS content",
  • "created_at": "2023-01-01T00:00:00.000Z",
  • "updated_at": "2023-01-01T00:00:00.000Z"
}

Update an API Product Version Specification

Updates a specification from an API product version.

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

The API product identifier

apiProductVersionId
required
string <uuid>
Example: 9f5061ce-78f6-4452-9108-ad7c02821fd5

The API product version identifier

specificationId
required
string <uuid>
Example: 742ff9f1-fb89-4aeb-a599-f0e278c7aeaa

The API product version specification identifier

Request Body schema: application/json
name
string [ 1 .. 255 ] characters ^.+(?:\.yaml|\.yml|\.json)$

The name of the API product version specification

content
string <byte> non-empty

The base64 encoded contents of the API product version specification

Responses

Request samples

Content type
application/json
Example
{
  • "content": "TXkgWUFNTCBvciBKU09OIGZvcm1hdHRlZCBPQVMgY29udGVudA=="
}

Response samples

Content type
application/json
{
  • "id": "7710d5c4-d902-410b-992f-18b814155b53",
  • "name": "oas.yaml",
  • "content": "My YAML or JSON formatted OAS content",
  • "created_at": "2023-01-01T00:00:00.000Z",
  • "updated_at": "2023-01-01T00:00:00.000Z"
}

Delete API Product Version Specification

Removes a specification from a verion of an API product.

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

The API product identifier

apiProductVersionId
required
string <uuid>
Example: 9f5061ce-78f6-4452-9108-ad7c02821fd5

The API product version identifier

specificationId
required
string <uuid>
Example: 742ff9f1-fb89-4aeb-a599-f0e278c7aeaa

The API product version specification identifier

Responses

Response samples

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

DCR Providers

Dynamic Client Registration Providers are configurations representing an external Identity Provider whose clients (i.e. Applications) Konnect will be authorized to manage. For instance, they will be able to perform dynamic client registration (DCR) with the provider. The DCR provider provides credentials to each DCR-enabled application in Konnect that can be used to access Product Versions that the app is registered for.

Create DCR provider

Creates a DCR provider.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
Request Body schema: application/json
provider_type
required
string
required
object (DcrConfigAuth0InRequest)

Payload to create an Auth0 DCR provider.

name
required
string (DcrProviderName) [ 1 .. 256 ] characters

The name of the DCR provider. This is used to identify the DCR provider in the Konnect UI.

display_name
string (DcrProviderDisplayName) [ 1 .. 256 ] characters

The display name of the DCR provider. This is used to identify the DCR provider in the Portal UI.

issuer
required
string <url> <= 256 characters
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
Example
{}

Response samples

Content type
application/json
Example
{
  • "id": "93f8380e-7798-4566-99e3-2edf2b57d289",
  • "name": "DCR Okta 1 - Segment A",
  • "provider_type": "okta",
  • "issuer": "https://my-issuer.okta.com/default",
  • "active": true,
  • "dcr_config": { },
  • "created_at": "2023-01-01T00:00:00.000Z",
  • "updated_at": "2023-01-01T00:00:00.000Z"
}

List DCR Providers

Returns a paginated collection of DCR providers.

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

sort
string

Sorts a collection of DCR Providers. Supported sort attributes are:

  • created_at
  • updated_at
  • provider_type
  • issuer
  • name
filter[id][eq]
string

filters DCR Providers by their id

filter[id]
string

filters DCR Providers by their id (alias for filter[id][eq])

filter[id][contains]
string

filters DCR Providers by their id with a supplied substring

filter[issuer][eq]
string

filters DCR Providers by their issuer

filter[issuer]
string

filters DCR Providers by their issuer (alias for filter[issuer][eq])

filter[issuer][contains]
string

filters DCR Providers by their issuer with a supplied substring

filter[name][eq]
string

filters DCR Providers by their name

filter[name]
string

filters DCR Providers by their name (alias for filter[name][eq])

filter[name][contains]
string

filters DCR Providers by their name with a supplied substring

filter[provider_type][eq]
string

filters DCR Providers by their provider type

filter[provider_type]
string

filters DCR Providers by their provider type (alias for filter[provider_type][eq])

filter[initial_client_id][eq]
string

filters DCR Providers by their initial client id

filter[initial_client_id]
string

filters DCR Providers by their initial client id (alias for filter[initial_client_id][eq])

filter[initial_client_id][contains]
string

filters DCR Providers by their initial client id with a supplied substring

filter[initial_client_audience][eq]
string

filters DCR Providers by their initial client audience

filter[initial_client_audience]
string

filters DCR Providers by their initial client audience (alias for filter[initial_client_audience][eq])

filter[initial_client_audience][contains]
string

filters DCR Providers by their initial client audience with a supplied substring

Responses

Response samples

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

Fetch DCR provider

Returns a DCR provider.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
dcrProviderId
required
string <uuid> (UUID)
Example: 5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

DCR provider identifier

Responses

Response samples

Content type
application/json
Example
{
  • "id": "93f8380e-7798-4566-99e3-2edf2b57d289",
  • "name": "DCR Auth0 1 - Segment A",
  • "display_name": "Auth0 DCR provider",
  • "provider_type": "auth0",
  • "issuer": "https://my-issuer.auth0.com/api/v2/",
  • "active": true,
  • "dcr_config": {},
  • "created_at": "2023-01-01T00:00:00.000Z",
  • "updated_at": "2023-01-01T00:00:00.000Z"
}

Update DCR provider

Updates a DCR provider.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
dcrProviderId
required
string <uuid> (UUID)
Example: 5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

DCR provider identifier

Request Body schema: application/json
name
string (DcrProviderName) [ 1 .. 256 ] characters

The name of the DCR provider. This is used to identify the DCR provider in the Konnect UI.

display_name
string (DcrProviderDisplayName) [ 1 .. 256 ] characters

The display name of the DCR provider. This is used to identify the DCR provider in the Portal UI.

issuer
string <url> <= 256 characters
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 "_".

DcrConfigAuth0InRequest (object) or DcrConfigAzureAdInRequest (object) or DcrConfigCurityInRequest (object) or DcrConfigOktaInRequest (object) or CreateDcrConfigHttpInRequest (object)

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
Example
{
  • "id": "93f8380e-7798-4566-99e3-2edf2b57d289",
  • "name": "DCR Auth0 1 - Segment A",
  • "display_name": "Auth0 DCR provider",
  • "provider_type": "auth0",
  • "issuer": "https://my-issuer.auth0.com/api/v2/",
  • "active": true,
  • "dcr_config": {},
  • "created_at": "2023-01-01T00:00:00.000Z",
  • "updated_at": "2023-01-01T00:00:00.000Z"
}

Delete DCR provider

Deletes a DCR provider.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
dcrProviderId
required
string <uuid> (UUID)
Example: 5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

DCR provider identifier

Responses

Response samples

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

Verify DCR provider configuration.

Verifies if a DCR provider is configured properly. Returns 200 for success, 4xx for failure.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
dcrProviderId
required
string <uuid> (UUID)
Example: 5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

DCR provider identifier

Responses

Response samples

Content type
application/json
Example
{
  • "status": "success",
  • "errors": [ ]
}

App Auth Strategies

Application Auth Strategies are sets of plugin configurations that represent how the gateway will perform authentication and authorization for a Product Version. Called “Auth Strategy” for short in the context of portals/applications. The plugins are synced to any Gateway Service that is currently linked or becomes linked to the Product Version.

Create App Auth Strategy

Creates an application auth strategy.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
Request Body schema: application/json
name
required
string (AuthStrategyName) [ 1 .. 256 ] characters

The name of the auth strategy. This is used to identify the auth strategy in the Konnect UI.

display_name
required
string (AuthStrategyDisplayName) <= 256 characters

The display name of the Auth strategy. This is used to identify the Auth strategy in the Portal UI.

strategy_type
required
string
required
object

JSON-B object containing the configuration for the Key Auth strategy

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
Example
{
  • "name": "auth strategy 1",
  • "display_name": "API Key Auth",
  • "strategy_type": "key_auth",
  • "configs": {
    }
}

Response samples

Content type
application/json
{
  • "id": "22f8380e-7798-4566-99e3-2edf2b57d289",
  • "name": "auth strategy 1",
  • "display_name": "Client Credentials",
  • "strategy_type": "openid_connect",
  • "active": false,
  • "configs": {},
  • "dcr_provider": {
    },
  • "labels": { },
  • "created_at": "2023-01-01T00:00:00.000Z",
  • "updated_at": "2023-01-01T00:00:00.000Z"
}

List App Auth Strategies

Returns a paginated collection of application auth strategies.

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

sort
string

Sorts a collection of application auth strategies. Supported sort attributes are:

  • created_at
  • updated_at
  • strategy_type
  • name
  • display_name
  • dcr_provider_id
  • dcr_provider_name
  • dcr_provider_type
object

Filter application auth strategies returned in the response.

Responses

Response samples

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

Get App Auth Strategy

Returns an application auth strategy.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
authStrategyId
required
string <uuid> (UUID)
Example: 5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

Application auth strategy identifier

Responses

Response samples

Content type
application/json
{
  • "id": "22f8380e-7798-4566-99e3-2edf2b57d289",
  • "name": "auth strategy 1",
  • "display_name": "Client Credentials",
  • "strategy_type": "openid_connect",
  • "active": false,
  • "configs": {},
  • "dcr_provider": {
    },
  • "labels": { },
  • "created_at": "2023-01-01T00:00:00.000Z",
  • "updated_at": "2023-01-01T00:00:00.000Z"
}

Replace App Auth Strategy

Replaces an application auth strategy.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
authStrategyId
required
string <uuid> (UUID)
Example: 5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

Application auth strategy identifier

Request Body schema: application/json
name
required
string (AuthStrategyName) [ 1 .. 256 ] characters

The name of the auth strategy. This is used to identify the auth strategy in the Konnect UI.

display_name
required
string (AuthStrategyDisplayName) <= 256 characters

The display name of the Auth strategy. This is used to identify the Auth strategy in the Portal UI.

strategy_type
required
string
required
object

JSON-B object containing the configuration for the Key Auth strategy

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
Example
{
  • "name": "auth strategy 1",
  • "display_name": "API Key Auth",
  • "strategy_type": "key_auth",
  • "configs": {
    }
}

Response samples

Content type
application/json
{
  • "id": "22f8380e-7798-4566-99e3-2edf2b57d289",
  • "name": "auth strategy 1",
  • "display_name": "Client Credentials",
  • "strategy_type": "openid_connect",
  • "active": false,
  • "configs": {},
  • "dcr_provider": {
    },
  • "labels": { },
  • "created_at": "2023-01-01T00:00:00.000Z",
  • "updated_at": "2023-01-01T00:00:00.000Z"
}

Update App Auth Strategy

Updates an application auth strategy.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
authStrategyId
required
string <uuid> (UUID)
Example: 5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

Application auth strategy identifier

Request Body schema: application/json
name
string (AuthStrategyName) [ 1 .. 256 ] characters

The name of the auth strategy. This is used to identify the auth strategy in the Konnect UI.

display_name
string (AuthStrategyDisplayName) <= 256 characters

The display name of the Auth strategy. This is used to identify the Auth strategy in the Portal UI.

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 "_".

dcr_provider_id
string or null <uuid>
object or object

JSON-B object containing the configuration for the OIDC strategy under the key 'openid-connect' or the configuration for the Key Auth strategy under the key 'key-auth'

Responses

Request samples

Content type
application/json
Example
{
  • "display_name": "API Key"
}

Response samples

Content type
application/json
{
  • "id": "22f8380e-7798-4566-99e3-2edf2b57d289",
  • "name": "auth strategy 1",
  • "display_name": "Client Credentials",
  • "strategy_type": "openid_connect",
  • "active": false,
  • "configs": {},
  • "dcr_provider": {
    },
  • "labels": { },
  • "created_at": "2023-01-01T00:00:00.000Z",
  • "updated_at": "2023-01-01T00:00:00.000Z"
}

Delete App Auth Strategy

Deletes an application auth strategy. An application auth strategy can be deleted ONLY if it's not used by any product version within any portal regardless of their publication statuses. If an application auth strategy is still in use the request will result in an HTTP 409 CONFLICT.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
authStrategyId
required
string <uuid> (UUID)
Example: 5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

Application auth strategy identifier

Responses

Response samples

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

Audit Logs

Get Audit Log Destinations

Returns configuration for the audit log destinations.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
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 destinations returned in the response.

Responses

Response samples

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

Create Audit Log Destination

Creates a configuration for the audit log destination.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
Request Body schema: application/json

The request schema to create an audit log destination.

name
required
string

The name of the audit log destination.

endpoint
required
string

The endpoint that will receive audit log messages.

authorization
string

The value to include in the Authorization header when sending audit logs to the webhook.

log_format
required
string
Default: "cef"
Enum: "cef" "json"

The output format of each log message.

skip_ssl_verification
boolean
Default: false

Indicates if the SSL certificate verification of the host endpoint should be skipped when delivering payloads. We strongly recommend not setting this to 'true' as you are subject to man-in-the-middle and other attacks. This option should be considered only for self-signed SSL certificates used in a non-production environment.

Responses

Request samples

Content type
application/json
{
  • "id": "07ec3858-066b-4629-bdc5-d4aa893b424d",
  • "name": "My Destination",
  • "endpoint": "https://example.com/audit-log",
  • "authorization": "Bearer token",
  • "log_format": "cef",
  • "skip_ssl_verification": false
}

Response samples

Content type
application/json
{
  • "id": "07ec3858-066b-4629-bdc5-d4aa893b424d",
  • "name": "My Destination",
  • "endpoint": "https://example.com/audit-log",
  • "log_format": "cef",
  • "skip_ssl_verification": false,
  • "created_at": "2023-03-20T09:29:14.52Z",
  • "updated_at": "2023-03-21T09:29:14.52Z"
}

Get Audit Log Destination

Returns configuration for the audit log destination.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
auditLogDestinationId
required
string <uuid>

ID of the Audit Log Destination.

Responses

Response samples

Content type
application/json
{
  • "id": "07ec3858-066b-4629-bdc5-d4aa893b424d",
  • "name": "My Destination",
  • "endpoint": "https://example.com/audit-log",
  • "log_format": "cef",
  • "skip_ssl_verification": false,
  • "created_at": "2023-03-20T09:29:14.52Z",
  • "updated_at": "2023-03-21T09:29:14.52Z"
}

Update Audit Log Destination

Updates configuration for the audit log destination.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
auditLogDestinationId
required
string <uuid>

ID of the Audit Log Destination.

Request Body schema: application/json

The request schema to modify an audit log destination.

name
string

The name of the audit log destination.

endpoint
string

The endpoint that will receive audit log messages.

authorization
string

The value to include in the Authorization header when sending audit logs to the webhook.

log_format
string
Default: "cef"
Enum: "cef" "json"

The output format of each log message.

skip_ssl_verification
boolean
Default: false

Indicates if the SSL certificate verification of the host endpoint should be skipped when delivering payloads. We strongly recommend not setting this to 'true' as you are subject to man-in-the-middle and other attacks. This option should be considered only for self-signed SSL certificates used in a non-production environment.

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "id": "07ec3858-066b-4629-bdc5-d4aa893b424d",
  • "name": "My Destination",
  • "endpoint": "https://example.com/audit-log",
  • "log_format": "cef",
  • "skip_ssl_verification": false,
  • "created_at": "2023-03-20T09:29:14.52Z",
  • "updated_at": "2023-03-21T09:29:14.52Z"
}

Delete Audit Log Destination

Deletes configuration for the audit log destination.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
auditLogDestinationId
required
string <uuid>

ID of the Audit Log Destination.

Responses

Response samples

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

Update Audit Log Replay Job

Updates a job to re-send audit logs to an organization's webhook.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
Request Body schema: application/json

The request schema to replace an audit log replay job.

start_at
required
string <date-time>

The start of a date-time range in RFC3339 format e.g. 2017-07-21T17:32:28Z. Must be within the last 7 days.

end_at
required
string <date-time>

The end of a date-time range in RFC3339 format e.g. 2017-07-21T17:32:28Z. Must be within the last 7 days.

Responses

Request samples

Content type
application/json
{
  • "start_at": "2019-08-24T14:15:22Z",
  • "end_at": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "start_at": "2017-07-21T17:32:28Z",
  • "end_at": "2017-07-21T17:32:28Z",
  • "status": "unconfigured",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Get Audit Log Replay Job

Returns the audit log replay job's configuration and status.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth

Responses

Response samples

Content type
application/json
{
  • "start_at": "2017-07-21T17:32:28Z",
  • "end_at": "2017-07-21T17:32:28Z",
  • "status": "unconfigured",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Update Audit Log Webhook

Updates the configuration for a webhook to receive audit logs.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
Request Body schema: application/json

The request schema to modify an audit log webhook.

endpoint
string

The endpoint that will receive audit log messages.

authorization
string

The value to include in the Authorization header when sending audit logs to the webhook.

enabled
boolean
Default: false

Indicates if the data should be sent to the webhook.

log_format
string
Default: "cef"
Enum: "cef" "json"

The output format of each log message.

skip_ssl_verification
boolean
Default: false

Indicates if the SSL certificate verification of the host endpoint should be skipped when delivering payloads. We strongly recommend not setting this to 'true' as you are subject to man-in-the-middle and other attacks. This option should be considered only for self-signed SSL certificates used in a non-production environment.

Responses

Request samples

Content type
application/json
Example
{
  • "enabled": false
}

Response samples

Content type
application/json
{
  • "endpoint": "https://example.com/audit-log",
  • "enabled": true,
  • "log_format": "cef",
  • "skip_ssl_verification": false,
  • "updated_at": "2023-03-21T09:29:14.52Z"
}

Get Audit Log Webhook

Returns configuration for the audit log webhook.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth

Responses

Response samples

Content type
application/json
{
  • "endpoint": "https://example.com/audit-log",
  • "enabled": true,
  • "log_format": "cef",
  • "skip_ssl_verification": false,
  • "updated_at": "2023-03-21T09:29:14.52Z"
}

Get Audit Log JSON Web Keys

Returns the public keys used to sign audit log entries in order to verify the validity of audit log entries.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth

Responses

Response samples

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

Get Audit Log Webhook Status

Returns status of the audit log webhook.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth

Responses

Response samples

Content type
application/json
{
  • "webhook_enabled": true,
  • "webhook_status": "inactive",
  • "last_attempt_at": "2023-03-21T09:29:14.52Z",
  • "last_response_code": 401,
  • "last_response_message": "Unauthorized"
}

Data-Plane Group Configurations

List Configurations

Returns a paginated collection of configurations across control-planes for an organization (restricted by permitted control-plane reads).

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
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 (ConfigurationsFilterParameters)

Filters supported for configurations.

Responses

Response samples

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

Create Configuration

Creates a new configuration for a control-plane (restricted by permitted control-plane permissions for configurations). This request will replace any existing configuration for the requested control_plane_id and control_plane_geo by performing a diff. From this diff, new resources detected in the requested configuration will be added, resources not found in the request configuration but in the previous will be deleted, and resources found in both will be updated to the requested configuration. Networks referenced in this request that are in an offline state will automatically initialize (i.e. move to an initializing state).

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
Request Body schema: application/json
control_plane_id
required
string <uuid> (ControlPlaneId)
control_plane_geo
required
string (Control-Plane Geo)
Enum: "us" "eu" "au" "me" "in"

Set of control-plane geos supported for deploying cloud-gateways configurations.

version
required
string (Gateway Version)

Supported gateway version.

required
Array of objects (CreateConfigurationDataPlaneGroup)

List of data-plane groups that describe where to deploy instances, along with how many instances.

api_access
string (ApiAccess)
Default: "private+public"
Enum: "private" "public" "private+public"

Type of API access data-plane groups will support for a configuration.

Responses

Request samples

Content type
application/json
{
  • "control_plane_id": "0949471e-b759-45ba-87ab-ee63fb781388",
  • "control_plane_geo": "us",
  • "version": "3.2",
  • "dataplane_groups": [
    ],
  • "api_access": "private"
}

Response samples

Content type
application/json
{
  • "id": "edaf40f9-9fb0-4ffe-bb74-4e763a6bd471",
  • "version": "3.2",
  • "api_access": "private",
  • "dataplane_group_config": [
    ],
  • "dataplane_groups": [
    ],
  • "entity_version": 1,
  • "created_at": "2022-11-04T20:10:06.927Z",
  • "updated_at": "2022-11-04T20:10:06.927Z",
  • "control_plane_id": "0949471e-b759-45ba-87ab-ee63fb781388",
  • "control_plane_geo": "us"
}

Get Configuration

Retrieves a configuration by ID (restricted by permitted control-plane read).

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
configurationId
required
string <uuid> (ConfigurationId)
Example: edaf40f9-9fb0-4ffe-bb74-4e763a6bd471

The ID of the configuration to operate on.

Responses

Response samples

Content type
application/json
{
  • "id": "edaf40f9-9fb0-4ffe-bb74-4e763a6bd471",
  • "version": "3.2",
  • "api_access": "private",
  • "dataplane_group_config": [
    ],
  • "dataplane_groups": [
    ],
  • "entity_version": 1,
  • "created_at": "2022-11-04T20:10:06.927Z",
  • "updated_at": "2022-11-04T20:10:06.927Z",
  • "control_plane_id": "0949471e-b759-45ba-87ab-ee63fb781388",
  • "control_plane_geo": "us"
}

Networks

List Networks

Returns a paginated list of networks.

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

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",
  • "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",
  • "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"
}

Get Network

Retrieves a network by ID.

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

The network to operate on.

Responses

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",
  • "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:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
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.

Responses

Request samples

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

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",
  • "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"
}

Delete Network

Deletes a network by ID.

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

The network 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": [
    ]
}

Returns a paginated collection of configurations that reference a network.

List Network Configuration References

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

The network to operate on.

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": [
    ]
}

Transit Gateways

List Transit Gateways

Returns a paginated collection of transit gateways for a given network.

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

The network to operate on.

query Parameters
object (TransitGatewaysFilterParameters)

Filters supported for transit gateways.

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 Transit Gateway

Creates a new transit gateway for a given network.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
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 (Transit Gateway Name)

Human-readable name of the transit gateway.

Array of objects (Transit Gateway DNS Config)

List of mappings from remote DNS server IP address sets to proxied internal domains, for a transit gateway attachment.

cidr_blocks
required
Array of strings (Transit Gateway CIDR Blocks)

CIDR blocks for constructing a route table for the transit gateway, when attaching to the owning network.

required
object (AWS Transit Gateway Attachment Config)

Responses

Request samples

Content type
application/json
Example
{
  • "name": "us-east-2 transit gateway",
  • "dns_config": [
    ],
  • "cidr_blocks": [
    ],
  • "transit_gateway_attachment_config": {
    }
}

Response samples

Content type
application/json
Example
{
  • "name": "us-east-2 transit gateway",
  • "dns_config": [
    ],
  • "cidr_blocks": [
    ],
  • "transit_gateway_attachment_config": {
    },
  • "id": "0850820b-d153-4a2a-b9be-7d2204779139",
  • "state": "created",
  • "entity_version": 1,
  • "created_at": "2022-11-04T20:10:06.927Z",
  • "updated_at": "2022-11-04T20:10:06.927Z"
}

Get Transit Gateway

Retrieves a transit gateway by ID for a given network.

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

The network to operate on.

transitGatewayId
required
string <uuid> (TransitGatewayId)
Example: 0850820b-d153-4a2a-b9be-7d2204779139

The ID of the transit gateway to operate on.

Responses

Response samples

Content type
application/json
Example
{
  • "name": "us-east-2 transit gateway",
  • "dns_config": [
    ],
  • "cidr_blocks": [
    ],
  • "transit_gateway_attachment_config": {
    },
  • "id": "0850820b-d153-4a2a-b9be-7d2204779139",
  • "state": "created",
  • "entity_version": 1,
  • "created_at": "2022-11-04T20:10:06.927Z",
  • "updated_at": "2022-11-04T20:10:06.927Z"
}

Delete Transit Gateway

Deletes a transit gateway by ID for a given network.

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

The network to operate on.

transitGatewayId
required
string <uuid> (TransitGatewayId)
Example: 0850820b-d153-4a2a-b9be-7d2204779139

The ID of the transit gateway 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": [
    ]
}

Provider Accounts

List Provider Accounts

Returns a a paginated collection of provider accounts for an organization.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
query Parameters
object (ProviderAccountsFilterParameters)

Filters supported for provider accounts.

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": [
    ]
}

Get Provider Account

Retrieves a provider account by ID.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
providerAccountId
required
string <uuid> (ProviderAccountId)
Example: 929b2449-c69f-44c4-b6ad-9ecec6f811ae

The ID of the provider account to operate on.

Responses

Response samples

Content type
application/json
{
  • "id": "929b2449-c69f-44c4-b6ad-9ecec6f811ae",
  • "provider": "aws",
  • "provider_account_id": "string",
  • "created_at": "2022-11-04T20:10:06.927Z",
  • "updated_at": "2022-11-04T20:10:06.927Z"
}

Custom Domains

List Custom Domains

Returns a paginated collection of custom domains across control-planes for an organization (restricted by permitted control-plane reads).

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
query Parameters
object (CustomDomainsFilterParameters)

Filters supported for custom domains on the global API.

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 Custom Domain

Creates a new custom domain for a control-plane (restricted by permitted control-plane associate-custom-domain action).

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
Request Body schema: application/json
control_plane_id
required
string <uuid> (ControlPlaneId)
control_plane_geo
required
string (Control-Plane Geo)
Enum: "us" "eu" "au" "me" "in"

Set of control-plane geos supported for deploying cloud-gateways configurations.

domain
required
string (Custom Domain Name)

Domain name of the custom domain.

Responses

Request samples

Content type
application/json
{
  • "control_plane_id": "0949471e-b759-45ba-87ab-ee63fb781388",
  • "control_plane_geo": "us",
  • "domain": "example.com"
}

Response samples

Content type
application/json
{
  • "id": "39ed3790-085d-4605-9627-f96d86aaf425",
  • "control_plane_id": "0949471e-b759-45ba-87ab-ee63fb781388",
  • "control_plane_geo": "us",
  • "domain": "example.com",
  • "certificate_id": "3b7cbeee-fbec-440e-a5ef-89e7dec3b9d0",
  • "sni_id": "a8f11ea8-af09-4422-9735-5d4f8910aba1",
  • "state": "created",
  • "state_metadata": {
    },
  • "entity_version": 1,
  • "created_at": "2022-11-04T20:10:06.927Z",
  • "updated_at": "2022-11-04T20:10:06.927Z"
}

Get Custom Domain

Retrieves a custom domain by ID (restricted by permitted control-plane reads).

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
customDomainId
required
string <uuid> (CustomDomainId)
Example: 39ed3790-085d-4605-9627-f96d86aaf425

ID of the custom domain to operate on.

Responses

Response samples

Content type
application/json
{
  • "id": "39ed3790-085d-4605-9627-f96d86aaf425",
  • "control_plane_id": "0949471e-b759-45ba-87ab-ee63fb781388",
  • "control_plane_geo": "us",
  • "domain": "example.com",
  • "certificate_id": "3b7cbeee-fbec-440e-a5ef-89e7dec3b9d0",
  • "sni_id": "a8f11ea8-af09-4422-9735-5d4f8910aba1",
  • "state": "created",
  • "state_metadata": {
    },
  • "entity_version": 1,
  • "created_at": "2022-11-04T20:10:06.927Z",
  • "updated_at": "2022-11-04T20:10:06.927Z"
}

Delete Custom Domain

Deletes a custom domain by ID (restricted by permitted control-plane reads).

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
customDomainId
required
string <uuid> (CustomDomainId)
Example: 39ed3790-085d-4605-9627-f96d86aaf425

ID of the custom domain 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": [
    ]
}

Get Custom Domain Online Status

Retrieves the CNAME and SSL status of a custom domain.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
customDomainId
required
string <uuid> (CustomDomainId)
Example: 39ed3790-085d-4605-9627-f96d86aaf425

ID of the custom domain to operate on.

Responses

Response samples

Content type
application/json
{
  • "cname": "verified",
  • "ssl": "verified"
}

Cloud Gateways Resource Quotas

List Default Resource Quotas

Returns a paginated collection of default resource quotas for cloud-gateways, along with organizationally-defined overrides for those resource quotas.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
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": [
    ]
}

List Resource Quotas

Returns a paginated collection of resource quotas for an organization.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
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": [
    ]
}

Get Resource Quota

Retrieves a resource quota by ID.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
resourceQuotaId
required
string <uuid> (ResourceQuotaId)
Example: 9678f205-49a1-47bb-82d9-d01cafa42a0d

The ID of the resource quota to operate on.

Responses

Response samples

Content type
application/json
{
  • "id": "9678f205-49a1-47bb-82d9-d01cafa42a0d",
  • "resource": "count/provider-accounts.per-provider",
  • "name": "Active Networks",
  • "description": "Across the organization, the aggregate number of active networks cannot exceed this value.",
  • "value": 2,
  • "created_at": "2022-11-04T20:10:06.927Z",
  • "updated_at": "2022-11-04T20:10:06.927Z"
}

Resource Configurations

List Default Resource Configurations

Returns a paginated collection of default resource configurations for cloud-gateways, along with organizationally-defined overrides for those resource configurations. Resource configurations are settings that are applied to all cloud gateway resources in an organization. For example, the "data-plane-group-idle-timeout-minutes" resource configuration sets the idle timeout for all data plane groups in an organization.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
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": [
    ]
}

List Resource Configurations

Returns a paginated collection of resource configurations for an organization. Resource configurations are settings that are applied to all cloud gateway resources in an organization. For example, the "data-plane-group-idle-timeout-minutes" resource configuration sets the idle timeout for all data plane groups in an organization.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
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": [
    ]
}

Get Resource Configuration

Retrieves a resource configuration by ID.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
resourceConfigurationId
required
string <uuid> (ResourceConfigurationId)
Example: 9678f205-49a1-47bb-82d9-d01cafa42a0d

The ID of the resource configuration to operate on.

Responses

Response samples

Content type
application/json
{
  • "id": "9678f205-49a1-47bb-82d9-d01cafa42a0d",
  • "qualifier": "data-plane-group-idle-timeout-minutes",
  • "value": 45
}

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": [
    ]
}

Control Planes

List Control Planes

Returns an array of control plane objects containing information about the Konnect Control Planes.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
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 (ControlPlaneFilterParameters)

Filters a collection of control-planes.

labels
string
Example: labels=key:value,existCheck

Filter control planes in the response by associated labels.

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

Sorts a collection of control-planes. Supported sort attributes are:

  • created_at

Responses

Response samples

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

Create Control Plane

Create a control plane in the Konnect Organization.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
Request Body schema: application/json
name
required
string

The name of the control plane.

description
string

The description of the control plane in Konnect.

cluster_type
string
Enum: "CLUSTER_TYPE_CONTROL_PLANE" "CLUSTER_TYPE_K8S_INGRESS_CONTROLLER" "CLUSTER_TYPE_CONTROL_PLANE_GROUP" "CLUSTER_TYPE_SERVERLESS"

The ClusterType value of the cluster associated with the Control Plane.

auth_type
string
Enum: "pinned_client_certs" "pki_client_certs"

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

cloud_gateway
boolean

Whether this control-plane can be used for cloud-gateways.

Array of objects (ProxyURLs)

Array of proxy URLs associated with reaching the data-planes connected to a control-plane.

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": "Test Control Plane",
  • "description": "A test control plane for exploration.",
  • "cluster_type": "CLUSTER_TYPE_K8S_INGRESS_CONTROLLER",
  • "cloud_gateway": false,
  • "proxy_urls": [
    ],
  • "labels": {
    }
}

Response samples

Content type
application/json
{
  • "id": "7f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
  • "name": "Test Control Plane",
  • "description": "A test control plane for exploration.",
  • "labels": {
    },
  • "config": {},
  • "created_at": "2022-11-04T20:10:06.927Z",
  • "updated_at": "2022-11-04T20:10:06.927Z"
}

Fetch Control Plane

Returns information about an individual control plane.

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

The control plane ID

Responses

Response samples

Content type
application/json
{
  • "id": "7f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
  • "name": "Test Control Plane",
  • "description": "A test control plane for exploration.",
  • "labels": {
    },
  • "config": {},
  • "created_at": "2022-11-04T20:10:06.927Z",
  • "updated_at": "2022-11-04T20:10:06.927Z"
}

Update Control Plane

Update an individual control plane.

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

The control plane ID

Request Body schema: application/json
name
string

The name of the control plane.

description
string

The description of the control plane in Konnect.

auth_type
string
Enum: "pinned_client_certs" "pki_client_certs"

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

Array of objects (ProxyURLs)

Array of proxy URLs associated with reaching the data-planes connected to a control-plane.

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": "Test Control Plane",
  • "description": "A test control plane for exploration.",
  • "proxy_urls": [
    ],
  • "labels": {
    }
}

Response samples

Content type
application/json
{
  • "id": "7f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
  • "name": "Test Control Plane",
  • "description": "A test control plane for exploration.",
  • "labels": {
    },
  • "config": {},
  • "created_at": "2022-11-04T20:10:06.927Z",
  • "updated_at": "2022-11-04T20:10:06.927Z"
}

Delete Control Plane

Delete an individual control plane.

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

The control plane ID

Responses

Response samples

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

Control Plane Groups

Control Plane Group Member Status

Determines the group membership status of a control plane.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
id
required
string

ID of a control plane

Responses

Response samples

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

List Control Plane Group Memberships

Returns an array of control planes that are a member of this control plane group.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
id
required
string

ID of a control plane group

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
{
  • "meta": {
    },
  • "data": [
    ]
}

Upsert Control Plane Group Members

Adds one or more control planes as a member of a control plane group.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
id
required
string

ID of a control plane group

Request Body schema: application/json

Request body for upserting a list of child control planes to a control plane group membership.

required
Array of objects

Responses

Request samples

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

Response samples

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

Add Control Plane Group Members

Adds one or more control planes as a member of a control plane group.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
id
required
string

ID of a control plane group

Request Body schema: application/json

Request body for adding a list of child control planes to a control plane group membership.

required
Array of objects

Responses

Request samples

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

Response samples

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

Remove Control Plane Group Members

Removes one or more control planes from the members of a control plane group.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
id
required
string

ID of a control plane group

Request Body schema: application/json

Request body for removing a list of child control planes from a control plane group membership.

required
Array of objects

Responses

Request samples

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

Response samples

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

Get Control Plane Group Status

Returns the status of a control plane group, including existing conflicts.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
id
required
string

ID of a control plane group

Responses

Response samples

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

Auth Settings

Get Auth Settings

Returns authentication configuration, which determines how users can log in and how they are assigned to teams.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth

Responses

Response samples

Content type
application/json
{
  • "oidc_auth_enabled": true,
  • "saml_auth_enabled": false,
  • "basic_auth_enabled": false,
  • "idp_mapping_enabled": false,
  • "konnect_mapping_enabled": true
}

Update Auth Settings

Updates authentication configuration.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
Request Body schema: application/json

The request schema to update an organization's authentication settings.

basic_auth_enabled
boolean

The organization has basic auth enabled.

oidc_auth_enabled
boolean

The organization has OIDC disabled.

saml_auth_enabled
boolean

The organization has SAML disabled.

idp_mapping_enabled
boolean

Whether IdP groups determine the Konnect teams a user has.

konnect_mapping_enabled
boolean

Whether a Konnect Identity Admin assigns teams to a user.

Responses

Request samples

Content type
application/json
{
  • "oidc_auth_enabled": false,
  • "saml_auth_enabled": false,
  • "basic_auth_enabled": true,
  • "idp_mapping_enabled": false,
  • "konnect_mapping_enabled": true
}

Response samples

Content type
application/json
{
  • "oidc_auth_enabled": true,
  • "saml_auth_enabled": false,
  • "basic_auth_enabled": false,
  • "idp_mapping_enabled": false,
  • "konnect_mapping_enabled": true
}

Fetch IdP Configuration

Fetch the IdP configuration.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth

Responses

Response samples

Content type
application/json
{
  • "issuer": "https://myidp.com/oauth2",
  • "login_path": "myapp",
  • "client_id": "YOUR_CLIENT_ID",
  • "scopes": [
    ],
  • "claim_mappings": {
    }
}

Update IdP Configuration

Update the IdP configuration.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
Request Body schema: application/json

The request schema for the update IdP configuration request.

issuer
string <uri>
login_path
string
client_id
string
client_secret
string
scopes
Array of strings
Default: ["email","openid","profile"]
object >= 3 properties

Responses

Request samples

Content type
application/json
{
  • "issuer": "https://myidp.com/oauth2",
  • "login_path": "myapp",
  • "client_id": "YOUR_CLIENT_ID",
  • "client_secret": "YOUR_CLIENT_SECRET",
  • "scopes": [
    ],
  • "claim_mappings": {
    }
}

Response samples

Content type
application/json
{
  • "issuer": "https://myidp.com/oauth2",
  • "login_path": "myapp",
  • "client_id": "YOUR_CLIENT_ID",
  • "scopes": [
    ],
  • "claim_mappings": {
    }
}

Fetch Team Group Mappings

Retrieves the mappings between Konnect Teams and Identity Provider Groups. Returns a 400 error if an Identity Provider has not yet been configured.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
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": [
    ]
}

Patch Mappings by Team ID

Allows partial updates to the mappings between Konnect Teams and Identity Provider Groups. The request body must be keyed on team ID. For a given team ID, the given group list is a complete replacement. To remove all mappings for a given team, provide an empty group list.

Returns a 400 error if an Identity Provider has not yet been configured, or if a team ID in the request body is not found or is not a UUID.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
Request Body schema: application/json

The request schema for a partial update of mappings from Konnect Teams to IdP Groups.

Array of objects

The IdP groups to map to the given team.

Responses

Request samples

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

Response samples

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

Update Team Mappings

Updates the IdP group to Konnect team mapping.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
Request Body schema: application/json

The request schema for updating IdP team mappings.

Array of objects

The mappings object.

Responses

Request samples

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

Response samples

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

Fetch Team Mapping

Fetch the IdP group to Konnect team mapping.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
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": [
    ]
}

Retrieve Identity Providers

Retrieves the identity providers available within the organization. This operation provides information about various identity providers for SAML or OIDC authentication integrations.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
query Parameters
object

Filter identity providers returned in the response.

Responses

Response samples

Content type
application/json
[]

Create Identity Provider

Creates a new identity provider. This operation allows the creation of a new identity provider for authentication purposes.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
Request Body schema: application/json

An object representing the configuration for creating a new identity provider. This configuration may pertain to either an OIDC or a SAML identity provider.

type
string (IdentityProviderType)
Enum: "oidc" "saml"

Specifies the type of identity provider.

login_path
string (Identity Provider Login Path Property)

The path used for initiating login requests with the identity provider.

OIDC Identity Provider Config (object) or SAML Identity Provider Config (object)

Responses

Request samples

Content type
application/json
Example
{
  • "type": "oidc",
  • "login_path": "the-oidc-konnect-org",
  • "config": {
    }
}

Response samples

Content type
application/json
Example
{
  • "id": "66da2d42-469d-48cd-9ff3-0db135dd82d8",
  • "type": "oidc",
  • "enabled": false,
  • "login_path": "the-oidc-konnect-org",
  • "config": {
    },
  • "created_at": "2022-02-07T17:46:57.52Z",
  • "updated_at": "2022-02-07T17:46:57.52Z"
}

Get Identity Provider

Retrieves the configuration of a single identity provider. This operation returns information about a specific identity provider's settings and authentication integration details.

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

ID of the identity provider.

Responses

Response samples

Content type
application/json
Example
{
  • "id": "66da2d42-469d-48cd-9ff3-0db135dd82d8",
  • "type": "oidc",
  • "enabled": false,
  • "login_path": "the-oidc-konnect-org",
  • "config": {
    },
  • "created_at": "2022-02-07T17:46:57.52Z",
  • "updated_at": "2022-02-07T17:46:57.52Z"
}

Update Identity Provider

Updates the configuration of an existing identity provider. This operation allows modifications to be made to an existing identity provider's configuration.

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

ID of the identity provider.

Request Body schema: application/json

An object representing the configuration for updating an identity provider. This configuration may pertain to either an OIDC or a SAML identity provider.

enabled
boolean (Identity Provider Enabled Property)
Default: false

Indicates whether the identity provider is enabled. Only one identity provider can be active at a time, such as SAML or OIDC.

login_path
string (Identity Provider Login Path Property)

The path used for initiating login requests with the identity provider.

OIDC Identity Provider Config (object) or SAML Identity Provider Config (object)

Responses

Request samples

Content type
application/json
Example
{
  • "enabled": true,
  • "login_path": "the-oidc-konnect-org",
  • "config": {
    }
}

Response samples

Content type
application/json
Example
{
  • "id": "66da2d42-469d-48cd-9ff3-0db135dd82d8",
  • "type": "oidc",
  • "enabled": false,
  • "login_path": "the-oidc-konnect-org",
  • "config": {
    },
  • "created_at": "2022-02-07T17:46:57.52Z",
  • "updated_at": "2022-02-07T17:46:57.52Z"
}

Delete Identity Provider

Deletes an existing identity provider configuration. This operation removes a specific identity provider from the organization.

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

ID of the identity provider.

Responses

Response samples

Content type
application/problem+json
Example
{
  • "status": 400,
  • "title": "Bad Request",
  • "detail": "Could not parse request body",
  • "instance": "konnect:trace:3674017986744198214",
  • "invalid_parameters": [
    ]
}

Invites

Invite User

Sends an invitation email to invite a user to the Konnect organization. The email contains a link with a one time token to accept the invitation. Upon accepting the invitation, the user is directed to https://cloud.konghq.com/login to complete registration.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
Request Body schema: application/json

The request schema for the invite user request.

If you pass an email that is not already an active user in the request, a fresh invitation email will be created and sent to the new user.

email
required
string <email>

Responses

Request samples

Content type
application/json
{
  • "email": "james.c.woods@example.com"
}

Response samples

Content type
application/problem+json
Example
{
  • "status": 400,
  • "title": "Bad Request",
  • "detail": "Could not parse request body",
  • "instance": "konnect:trace:3674017986744198214",
  • "invalid_parameters": [
    ]
}

Roles

Get Predefined Roles

Retrieves the predefined, or system managed, roles.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth

Responses

Response samples

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

List Team Roles

Lists the roles belonging to a team. Returns 400 if any filter parameters are invalid.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
teamId
required
string <uuid>
Example: e81bc3e5-e9db-4764-b7dd-e81e39072cbe

The team ID

query Parameters
object

Filter roles returned in the response.

Responses

Response samples

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

Assign Team Role

Assigns a role to a team. Returns 409 if role is already assigned.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
teamId
required
string <uuid>
Example: e81bc3e5-e9db-4764-b7dd-e81e39072cbe

The team ID

Request Body schema: application/json

The request schema for assigning a role.

role_name
string
Enum: "Admin" "Appearance Maintainer" "Application Registration" "Certificate Admin" "Cloud Gateway Cluster Admin" "Cloud Gateway Cluster Viewer" "Consumer Admin" "Connector" "Creator" "Deployer" "Discovery Admin" "Discovery Viewer" "Gateway Service Admin" "Integration Admin" "Integration Viewer" "Key Admin" "Maintainer" "Network Admin" "Network Creator" "Network Viewer" "Plugin Admin" "Plugins Admin" "Product Publisher" "Publisher" "Route Admin" "SNI Admin" "Service Admin" "Service Creator" "Service Viewer" "Upstream Admin" "Vault Admin" "Viewer"

The desired role.

entity_id
string <uuid>

The ID of the entity.

entity_type_name
string
Enum: "APIs" "API Products" "Application Auth Strategies" "Audit Logs" "Control Planes" "DCR Providers" "Identity" "Mesh Control Planes" "Networks" "Portals" "Service Hub"

The type of entity.

entity_region
string
Enum: "us" "eu" "au" "me" "in" "*"

Region of the team.

Responses

Request samples

Content type
application/json
Example
{
  • "role_name": "Viewer",
  • "entity_id": "18ee2573-dec0-4b83-be99-fa7700bcdc61",
  • "entity_type_name": "Control Planes",
  • "entity_region": "us"
}

Response samples

Content type
application/json
{
  • "id": "eaf7adf1-32c8-4bbf-b960-d1f8456afe67",
  • "role_name": "Viewer",
  • "entity_id": "817d0422-45c9-4d88-8d64-45aef05c1ae7",
  • "entity_type_name": "Control Planes",
  • "entity_region": "eu"
}

Remove Team Role

Removes an assigned role from a team. Returns 404 if the requested team or assigned role were not found.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
teamId
required
string <uuid>
Example: e81bc3e5-e9db-4764-b7dd-e81e39072cbe

The team ID.

roleId
required
string <uuid>
Example: 8350205f-a305-4e39-abe9-bc082a80091a

The role ID.

Responses

Response samples

Content type
application/problem+json
Example
{
  • "status": 400,
  • "title": "Bad Request",
  • "detail": "Could not parse request body",
  • "instance": "konnect:trace:3674017986744198214",
  • "invalid_parameters": [
    ]
}

List User Roles

Lists the roles assigned to a user. Returns 400 if any filter parameters are invalid.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
userId
required
string <uuid>
Example: e81bc3e5-e9db-4764-b7dd-e81e39072cbe

The user ID

query Parameters
object

Filter roles returned in the response.

Responses

Response samples

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

Assign Role

Assigns a role to a user. Returns 409 if role is already assigned.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
userId
required
string <uuid>
Example: e81bc3e5-e9db-4764-b7dd-e81e39072cbe

The user ID

Request Body schema: application/json

The request schema for assigning a role.

role_name
string
Enum: "Admin" "Appearance Maintainer" "Application Registration" "Certificate Admin" "Cloud Gateway Cluster Admin" "Cloud Gateway Cluster Viewer" "Consumer Admin" "Connector" "Creator" "Deployer" "Discovery Admin" "Discovery Viewer" "Gateway Service Admin" "Integration Admin" "Integration Viewer" "Key Admin" "Maintainer" "Network Admin" "Network Creator" "Network Viewer" "Plugin Admin" "Plugins Admin" "Product Publisher" "Publisher" "Route Admin" "SNI Admin" "Service Admin" "Service Creator" "Service Viewer" "Upstream Admin" "Vault Admin" "Viewer"

The desired role.

entity_id
string <uuid>

The ID of the entity.

entity_type_name
string
Enum: "APIs" "API Products" "Application Auth Strategies" "Audit Logs" "Control Planes" "DCR Providers" "Identity" "Mesh Control Planes" "Networks" "Portals" "Service Hub"

The type of entity.

entity_region
string
Enum: "us" "eu" "au" "me" "in" "*"

Region of the team.

Responses

Request samples

Content type
application/json
Example
{
  • "role_name": "Viewer",
  • "entity_id": "18ee2573-dec0-4b83-be99-fa7700bcdc61",
  • "entity_type_name": "Control Planes",
  • "entity_region": "us"
}

Response samples

Content type
application/json
{
  • "id": "eaf7adf1-32c8-4bbf-b960-d1f8456afe67",
  • "role_name": "Viewer",
  • "entity_id": "817d0422-45c9-4d88-8d64-45aef05c1ae7",
  • "entity_type_name": "Control Planes",
  • "entity_region": "eu"
}

Remove Role

Removes an assigned role from a user. Returns 404 if the requested user or assigned role were not found.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
userId
required
string <uuid>
Example: e81bc3e5-e9db-4764-b7dd-e81e39072cbe

ID of the user.

roleId
required
string <uuid>
Example: 8350205f-a305-4e39-abe9-bc082a80091a

ID of the role.

Responses

Response samples

Content type
application/problem+json
Example
{
  • "status": 400,
  • "title": "Bad Request",
  • "detail": "Could not parse request body",
  • "instance": "konnect:trace:3674017986744198214",
  • "invalid_parameters": [
    ]
}

Team Membership

List Team Users

Returns a paginated list of users that belong to the team specified in the path parameter.

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

ID of the team.

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

Filter users returned in the response.

Responses

Response samples

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

Add User

Adds a user to a team.

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

ID of the team.

Request Body schema: application/json

The request schema for adding a user to a team.

id
required
string <uuid>

The user ID for the user being added to a team.

Responses

Request samples

Content type
application/json
{
  • "id": "df120cb4-f60b-47bc-a2f8-6a28e6a3c63b"
}

Response samples

Content type
application/problem+json
Example
{
  • "status": 400,
  • "title": "Bad Request",
  • "detail": "Could not parse request body",
  • "instance": "konnect:trace:3674017986744198214",
  • "invalid_parameters": [
    ]
}

Remove User

Removes a user from a team. If the user was removed, returns a 204 empty response. Returns 404 if the user or team were not found.

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

User ID

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

Team ID.

Responses

Response samples

Content type
application/problem+json
Example
{
  • "status": 400,
  • "title": "Bad Request",
  • "detail": "Could not parse request body",
  • "instance": "konnect:trace:3674017986744198214",
  • "invalid_parameters": [
    ]
}

List User Teams

Returns a paginated list of a teams that the user belongs to.

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

The user 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.

object

Filter teams returned in the response.

Responses

Response samples

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

Teams

List Teams

Returns an array of team objects containing information about the Konnect Teams.

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

Filter teams returned in the response.

Responses

Response samples

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

Create Team

Creates a team in the Konnect Organization.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
Request Body schema: application/json

The request schema for the create team request.

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

name
required
string^[\w \W]+$

A name for the team being created.

description
string <= 250 characters

The description of the new team.

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": "IDM - Developers",
  • "description": "The Identity Management (IDM) team.",
  • "labels": {
    }
}

Response samples

Content type
application/json
{
  • "id": "7f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
  • "name": "IDM - Developers",
  • "description": "The developers for the IDM API.",
  • "system_team": false,
  • "labels": {
    },
  • "created_at": "2022-02-07T17:46:57.52Z",
  • "updated_at": "2022-09-25T13:00:00.00Z"
}

Fetch Team

Returns information about a team from a given team ID.

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

The team ID

Responses

Response samples

Content type
application/json
{
  • "id": "7f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
  • "name": "IDM - Developers",
  • "description": "The developers for the IDM API.",
  • "system_team": false,
  • "labels": {
    },
  • "created_at": "2022-02-07T17:46:57.52Z",
  • "updated_at": "2022-09-25T13:00:00.00Z"
}

Update Team

Updates an individual team.

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

The team ID

Request Body schema: application/json

The request schema for the update team request.

name
string^[\w \W]+$

The name of the team.

description
string <= 250 characters

The description of the team.

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": "IDM - Developers",
  • "description": "The Identity Management (IDM) API team.",
  • "labels": {
    }
}

Response samples

Content type
application/json
{
  • "id": "7f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
  • "name": "IDM - Developers",
  • "description": "The developers for the IDM API.",
  • "system_team": false,
  • "labels": {
    },
  • "created_at": "2022-02-07T17:46:57.52Z",
  • "updated_at": "2022-09-25T13:00:00.00Z"
}

Delete Team

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

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

The team ID

Responses

Response samples

Content type
application/problem+json
Example
{
  • "status": 400,
  • "title": "Bad Request",
  • "detail": "Could not parse request body",
  • "instance": "konnect:trace:3674017986744198214",
  • "invalid_parameters": [
    ]
}

Users

List Users

Returns a paginated list of user objects.

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

Filter users returned in the response.

Responses

Response samples

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

Fetch User

Returns the user object for the user ID specified as a path parameter.

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

The ID of the user being deleted.

Responses

Response samples

Content type
application/json
{
  • "id": "7f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
  • "email": "james.woods@email.com",
  • "full_name": "James Woods",
  • "preferred_name": "Jimmy",
  • "active": true,
  • "created_at": "1992-02-07T17:46:57.52Z",
  • "updated_at": "2022-02-07T17:00:00.52Z"
}

Update User

Update an individual user.

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

The ID of the user being deleted.

Request Body schema: application/json

The request schema for the update user request.

full_name
string^[\w \W]+$

The user's full name.

preferred_name
string <= 250 characters

The user's desired name.

Responses

Request samples

Content type
application/json
{
  • "full_name": "James C Woods",
  • "preferred_name": "Jimmy"
}

Response samples

Content type
application/json
{
  • "id": "7f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
  • "email": "james.woods@email.com",
  • "full_name": "James Woods",
  • "preferred_name": "Jimmy",
  • "active": true,
  • "created_at": "1992-02-07T17:46:57.52Z",
  • "updated_at": "2022-02-07T17:00:00.52Z"
}

Delete User

Deletes an individual user. Returns 404 if the requested user was not found.

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

The ID of the user being deleted.

Responses

Response samples

Content type
application/problem+json
{
  • "status": 404,
  • "title": "Not Found",
  • "instance": "konnect:trace:2287285207635123011",
  • "detail": "The requested team was not found"
}

System Accounts

List System Accounts

Returns an array of system accounts (SA) in the organization. Returns 400 if any filter parameters are invalid.

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

Filter system accounts returned in the response.

Responses

Response samples

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

Create System Account

Creates a system account. Returns a 409 if a system account with the same name already exists.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
Request Body schema: application/json

The request schema to create a system account.

name
required
string

Name of the system account.

description
required
string

Description of the system account. Useful when the system account name is not sufficient to differentiate one system account from another.

konnect_managed
boolean

The system account is managed by Konnect (true/false).

Responses

Request samples

Content type
application/json
{
  • "name": "Sample System Account",
  • "description": "This is a sample system account description.",
  • "konnect_managed": false
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "Sample System Account",
  • "description": "This is a sample system account description.",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "konnect_managed": false
}

Fetch System Account

Returns the system account (SA) for the SA ID specified as a path parameter.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
accountId
required
string

ID of the system account.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "Sample System Account",
  • "description": "This is a sample system account description.",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "konnect_managed": false
}

Update System Account

Updates the specified system account. Returns a 409 if the updated name is the same as another system account in the organization.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
accountId
required
string

ID of the system account.

Request Body schema: application/json

The request schema for the update system account request.

name
string

Name of the system account.

description
string

Description of the system account.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "Sample System Account",
  • "description": "This is a sample system account description.",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "konnect_managed": false
}

Delete System Account

Deletes the specified system account. Returns 404 if the requested account was not found.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
accountId
required
string

ID of the system account.

Responses

Response samples

Content type
application/problem+json
{
  • "status": 401,
  • "title": "Unauthenticated",
  • "instance": "konnect:trace:952172606039454040",
  • "detail": "A valid token is required"
}

System Accounts - Access Tokens

List System Account Access Tokens

Returns the access tokens for the specified system account. Returns 400 if any filter parameters are invalid.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
accountId
required
string

ID of the system account.

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

Filter access tokens returned in the response.

Responses

Response samples

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

Create System Account Access Token

Creates an access token for the specified system account (SA). The access token can be used for authenticating API and CLI requests. The token will only be displayed once on creation. Returns a 409 if the system account already has a token with the same name.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
accountId
required
string

ID of the system account.

Request Body schema: application/json

The request body to create a system account access token.

name
string
expires_at
string <date-time>

Responses

Request samples

Content type
application/json
{
  • "name": "Sample Access Token",
  • "expires_at": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "Sample Access Token",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "expires_at": "2019-08-24T14:15:22Z",
  • "last_used_at": "2019-08-24T14:15:22Z",
  • "token": "npat_12345678901234567890123456789012345678901234567890"
}

Fetch System Account Access Token

Returns the system account (SA) access token for the SA Access Token ID specified as a path parameter.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
accountId
required
string

ID of the system account.

tokenId
required
string

ID of the system account access token.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "Sample Access Token",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "expires_at": "2019-08-24T14:15:22Z",
  • "last_used_at": "2019-08-24T14:15:22Z"
}

Update System Account Access Token

Updates the specified access token. Returns a 409 if the updated name is the same as another token belonging to the specified system user.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
accountId
required
string

ID of the system account.

tokenId
required
string

ID of the system account access token.

Request Body schema: application/json
name
string

Name of the system account access token.

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "Sample Access Token",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "expires_at": "2019-08-24T14:15:22Z",
  • "last_used_at": "2019-08-24T14:15:22Z"
}

Delete System Account Access Token

Deletes the specified token. Returns 404 if the token was not found.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
accountId
required
string

ID of the system account.

tokenId
required
string

ID of the system account access token.

Responses

Response samples

Content type
application/problem+json
{
  • "status": 401,
  • "title": "Unauthenticated",
  • "instance": "konnect:trace:952172606039454040",
  • "detail": "A valid token is required"
}

System Accounts - Roles

Fetch Assigned Roles for System Account

Lists the roles belonging to a system account. Returns 400 if any filter parameters are invalid.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
accountId
required
string

ID of the system account.

query Parameters
object

Filter roles returned in the response.

Responses

Response samples

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

Create Assigned Role for System Account

Assigns a role to a system account. Returns 409 if role is already assigned.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
accountId
required
string

ID of the system account.

Request Body schema: application/json

The request schema for assigning a role.

role_name
string
Enum: "Admin" "Appearance Maintainer" "Application Registration" "Certificate Admin" "Cloud Gateway Cluster Admin" "Cloud Gateway Cluster Viewer" "Consumer Admin" "Connector" "Creator" "Deployer" "Discovery Admin" "Discovery Viewer" "Gateway Service Admin" "Integration Admin" "Integration Viewer" "Key Admin" "Maintainer" "Network Admin" "Network Creator" "Network Viewer" "Plugin Admin" "Plugins Admin" "Product Publisher" "Publisher" "Route Admin" "SNI Admin" "Service Admin" "Service Creator" "Service Viewer" "Upstream Admin" "Vault Admin" "Viewer"

The desired role.

entity_id
string <uuid>

The ID of the entity.

entity_type_name
string
Enum: "APIs" "API Products" "Application Auth Strategies" "Audit Logs" "Control Planes" "DCR Providers" "Identity" "Mesh Control Planes" "Networks" "Portals" "Service Hub"

The type of entity.

entity_region
string
Enum: "us" "eu" "au" "me" "in" "*"

Region of the team.

Responses

Request samples

Content type
application/json
Example
{
  • "role_name": "Viewer",
  • "entity_id": "18ee2573-dec0-4b83-be99-fa7700bcdc61",
  • "entity_type_name": "Control Planes",
  • "entity_region": "us"
}

Response samples

Content type
application/json
{
  • "id": "eaf7adf1-32c8-4bbf-b960-d1f8456afe67",
  • "role_name": "Viewer",
  • "entity_id": "817d0422-45c9-4d88-8d64-45aef05c1ae7",
  • "entity_type_name": "Control Planes",
  • "entity_region": "eu"
}

Delete Assigned Role from System Account

Removes an assigned role from a system account. Returns 404 if the system account or assigned role were not found.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
accountId
required
string

ID of the system account.

roleId
required
string

ID of the role.

Responses

Response samples

Content type
application/problem+json
{
  • "status": 401,
  • "title": "Unauthenticated",
  • "instance": "konnect:trace:952172606039454040",
  • "detail": "A valid token is required"
}

System Accounts - Team Membership

List Teams for a System Account

Returns a paginated list of a teams that the system account belongs to.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
accountId
required
string

ID of the system account.

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

Filter teams returned in the response.

Responses

Response samples

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

List System Accounts on a Team

Returns a paginated list of system accounts that belong to the team specified in the path parameter.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
teamId
required
string

ID of the team.

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

Filter system accounts returned in the response.

Responses

Response samples

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

Add System Account to a Team

Adds a system account to a team. Returns a 409 if the system account is already a member of the team.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
teamId
required
string

ID of the team.

Request Body schema: application/json

The request schema for adding a system account to a team.

id
string <uuid>

ID of the system account.

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}

Response samples

Content type
application/problem+json
{
  • "status": 401,
  • "title": "Unauthenticated",
  • "instance": "konnect:trace:952172606039454040",
  • "detail": "A valid token is required"
}

Remove System Account From Team

Removes a system account from a team. Returns 404 if the team or system account were not found.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
teamId
required
string

ID of the team.

accountId
required
string

ID of the system account.

Responses

Response samples

Content type
application/problem+json
{
  • "status": 401,
  • "title": "Unauthenticated",
  • "instance": "konnect:trace:952172606039454040",
  • "detail": "A valid token is required"
}

Me

Retrieve My Organization

Returns the organization of the user identified in the token of the request.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth

Responses

Response samples

Content type
application/json
{
  • "created_at": "2023-01-18T11:35:45.130Z",
  • "id": "023bfa42-3513-4cbf-b059-a9ddb4ea995d",
  • "name": "Acme Co.",
  • "owner_id": "e02c829c-0e2d-44b5-9057-07714ea613a3",
  • "login_path": "acme",
  • "updated_at": "2023-01-23T17:22:52.150Z",
  • "state": "active",
  • "retention_period_days": 90
}

Retrieve My User Account

Returns the user account for the user identified in the token of the request.

Authorizations:
personalAccessTokenkonnectAccessToken

Responses

Response samples

Content type
application/json
{
  • "id": "7f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
  • "email": "james.woods@email.com",
  • "full_name": "James Woods",
  • "preferred_name": "Jimmy",
  • "active": true,
  • "created_at": "1992-02-07T17:46:57.52Z",
  • "updated_at": "2022-02-07T17:00:00.52Z"
}

Authentication

SSO Callback

Callback for authenticating via an organization's IdP

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
organizationLoginPath
required
string

The login path for the organization.

query Parameters
return_to
string

Return destination for the callback.

Responses

Response samples

Content type
application/problem+json
Example
{
  • "status": 400,
  • "title": "Bad Request",
  • "detail": "Could not parse request body",
  • "instance": "konnect:trace:3674017986744198214",
  • "invalid_parameters": [
    ]
}

Impersonation Settings

Get Impersonation Settings

Returns Impersonation Settings, which determines if user impersonation is allowed for an organization.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth

Responses

Response samples

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

Update Impersonation Settings

Updates Impersonation Settings.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
Request Body schema: application/json

The request schema for adding a system account to a team.

enabled
boolean

Indicates if user impersonation is allowed for the organization.

Responses

Request samples

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

Response samples

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

Search

List Search Types

Retrieves a list of searchable Konnect entity types.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth

Responses

Response samples

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

Mesh

List Control Planes

Returns an array of control planes objects.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
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 a new control plane

Create a new control plane

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
Request Body schema: application/json
name
required
string (MeshControlPlaneName) [ 1 .. 100 ] characters ^[a-z0-9A-Z]{1}.*$

The name of the control plane.

description
string (MeshControlPlaneDescription) <= 250 characters
Array of objects (MeshControlPlaneFeatures)
object or null (Labels) <= 10 properties

Labels to facilitate tagged search on control planes. Keys must be of length 1-63 characters.

Responses

Request samples

Content type
application/json
{
  • "name": "Test Control Plane",
  • "description": "A test control plane for exploration.",
  • "labels": {
    }
}

Response samples

Content type
application/json
{
  • "id": "7f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
  • "name": "Test Control Plane",
  • "description": "A test control plane for exploration.",
  • "labels": {
    },
  • "config": {},
  • "created_at": "2022-11-04T20:10:06.927Z",
  • "updated_at": "2022-11-04T20:10:06.927Z"
}

Get the control plane

Get the control plane

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

Id of the Konnect resource

Responses

Response samples

Content type
application/json
{
  • "id": "7f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
  • "name": "Test Control Plane",
  • "description": "A test control plane for exploration.",
  • "labels": {
    },
  • "config": {},
  • "created_at": "2022-11-04T20:10:06.927Z",
  • "updated_at": "2022-11-04T20:10:06.927Z"
}

Delete the control plane

Delete the control plane

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

Id of the Konnect resource

Responses

Response samples

Content type
application/problem+json
{}

Update a whole control plane

Update a whole control plane

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

Id of the Konnect resource

Request Body schema: application/json
name
required
string (MeshControlPlaneName) [ 1 .. 100 ] characters ^[a-z0-9A-Z]{1}.*$

The name of the control plane.

description
string (MeshControlPlaneDescription) <= 250 characters
object or null (Labels) <= 10 properties

Labels to facilitate tagged search on control planes. Keys must be of length 1-63 characters.

Responses

Request samples

Content type
application/json
{
  • "name": "Test Control Plane",
  • "description": "A test control plane for exploration.",
  • "labels": {
    }
}

Response samples

Content type
application/json
{
  • "id": "7f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
  • "name": "Test Control Plane",
  • "description": "A test control plane for exploration.",
  • "labels": {
    },
  • "config": {},
  • "created_at": "2022-11-04T20:10:06.927Z",
  • "updated_at": "2022-11-04T20:10:06.927Z"
}

Patch parts of control plane

Update an individual control plane.

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

Id of the Konnect resource

Request Body schema: application/json
name
string (MeshControlPlaneName) [ 1 .. 100 ] characters ^[a-z0-9A-Z]{1}.*$

The name of the control plane.

description
string <= 250 characters
object or null (Labels) <= 10 properties

Labels to facilitate tagged search on control planes. Keys must be of length 1-63 characters.

Responses

Request samples

Content type
application/json
{
  • "name": "Test Control Plane",
  • "description": "A test control plane for exploration.",
  • "labels": {
    }
}

Response samples

Content type
application/json
{
  • "id": "7f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
  • "name": "Test Control Plane",
  • "description": "A test control plane for exploration.",
  • "labels": {
    },
  • "config": {},
  • "created_at": "2022-11-04T20:10:06.927Z",
  • "updated_at": "2022-11-04T20:10:06.927Z"
}

Notifications

Operations related to notifications

List available user configurations.

List available user configurations.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
query Parameters
object (ConfigurationFilterParameters)

Filters a collection of configurations.

Responses

Response samples

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

List event subscriptions.

List event subscriptions.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
eventId
required
string
Example: invoice-ready

Formatted string ID of the notification event.

Responses

Response samples

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

Create a new subscription for an event.

Create a new subscription for an event.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
eventId
required
string
Example: invoice-ready

Formatted string ID of the notification event.

Request Body schema: application/json

Request body schema for creating/updating event subscription.

regions
required
Array of strings (NotificationRegion)
Items Enum: "US" "EU" "AU" "*"
entities
required
Array of strings
required
Array of objects (NotificationChannel)
enabled
required
boolean

Enable/Disable complete subscription within an event.

Responses

Request samples

Content type
application/json
{
  • "regions": [
    ],
  • "entities": [
    ],
  • "channels": [
    ],
  • "enabled": true,
  • "created_at": "2023-01-01T00:00:00.000Z",
  • "updated_at": "2023-01-01T00:00:00.000Z"
}

Response samples

Content type
application/json
{
  • "id": "93f8380e-7798-4566-99e3-2edf2b57d292",
  • "regions": [
    ],
  • "entities": [
    ],
  • "channels": [
    ],
  • "enabled": true,
  • "created_at": "2023-01-01T00:00:00.000Z",
  • "updated_at": "2023-01-01T00:00:00.000Z"
}

Get subscription for an event.

Get subscription for an event.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
eventId
required
string
Example: invoice-ready

Formatted string ID of the notification event.

subscriptionId
required
string

Subscription ID of the user configuration.

Responses

Response samples

Content type
application/json
{
  • "id": "93f8380e-7798-4566-99e3-2edf2b57d292",
  • "regions": [
    ],
  • "entities": [
    ],
  • "channels": [
    ],
  • "enabled": true,
  • "created_at": "2023-01-01T00:00:00.000Z",
  • "updated_at": "2023-01-01T00:00:00.000Z"
}

Update subscription for an event.

Update subscription for an event.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
eventId
required
string
Example: invoice-ready

Formatted string ID of the notification event.

subscriptionId
required
string

Subscription ID of the user configuration.

Request Body schema: application/json

Request body schema for creating/updating event subscription.

regions
required
Array of strings (NotificationRegion)
Items Enum: "US" "EU" "AU" "*"
entities
required
Array of strings
required
Array of objects (NotificationChannel)
enabled
required
boolean

Enable/Disable complete subscription within an event.

Responses

Request samples

Content type
application/json
{
  • "regions": [
    ],
  • "entities": [
    ],
  • "channels": [
    ],
  • "enabled": true,
  • "created_at": "2023-01-01T00:00:00.000Z",
  • "updated_at": "2023-01-01T00:00:00.000Z"
}

Response samples

Content type
application/json
{
  • "id": "93f8380e-7798-4566-99e3-2edf2b57d292",
  • "regions": [
    ],
  • "entities": [
    ],
  • "channels": [
    ],
  • "enabled": true,
  • "created_at": "2023-01-01T00:00:00.000Z",
  • "updated_at": "2023-01-01T00:00:00.000Z"
}

Delete subscription associated with event.

Delete subscription associated with event.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
eventId
required
string
Example: invoice-ready

Formatted string ID of the notification event.

subscriptionId
required
string

Subscription ID of the user configuration.

Responses

Response samples

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

List available notifications.

List available notifications.

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

object (NotificationFilterParameters)

Filters a collection of notifications.

Responses

Response samples

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

Get notification details.

Get notification details.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
notificationId
required
string

ID of the notification.

Responses

Response samples

Content type
application/json
{
  • "id": "93f8380e-7798-4566-99e3-2edf2b57d290",
  • "title": "Unpaid invoice reminder",
  • "description": "Reminder for an unpaid invoice.",
  • "status": "UNREAD",
  • "region": "EU",
  • "namespace": "plan-and-usage",
  • "entity_id": "invoice-1",
  • "details": {
    },
  • "created_at": "2023-01-01T00:00:00.000Z",
  • "updated_at": "2023-01-01T00:00:00.000Z"
}

Update notification.

Update notification.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
notificationId
required
string

ID of the notification.

Request Body schema: application/json

Request body schema for updating notification status.

status
required
string (NotificationStatus)
Enum: "READ" "UNREAD" "ARCHIVED"

Status of the notification.

Responses

Request samples

Content type
application/json
{
  • "status": "READ"
}

Response samples

Content type
application/json
{
  • "id": "93f8380e-7798-4566-99e3-2edf2b57d290",
  • "title": "Unpaid invoice reminder",
  • "description": "Reminder for an unpaid invoice.",
  • "status": "UNREAD",
  • "region": "EU",
  • "namespace": "plan-and-usage",
  • "entity_id": "invoice-1",
  • "details": {
    },
  • "created_at": "2023-01-01T00:00:00.000Z",
  • "updated_at": "2023-01-01T00:00:00.000Z"
}

Delete notification.

Delete notification.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
notificationId
required
string

ID of the notification.

Responses

Response samples

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

Mark a list of notifications to a status.

Mark a list of notifications to a status.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
Request Body schema: application/json

Request body schema for bulk status update.

ids
required
Array of strings [ 1 .. 100 ] items unique
status
required
string (NotificationStatus)
Enum: "READ" "UNREAD" "ARCHIVED"

Status of the notification.

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ],
  • "status": "READ"
}

Response samples

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

Portals

APIs related to Configuration of Konnect Developer Portals.

List Portals

Lists developer portals defined in this region for this organization. Each developer portal is available at a unique address and has isolated appearance, configuration, developers, and applications.

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

sort
string

Sorts a collection of portals. Supported sort attributes are:

  • name
  • description
  • is_public
  • rbac_enabled
  • auto_approve_applications
  • auto_approve_developers
  • default_domain
  • custom_domain
  • custom_client_domain
  • created_at
  • updated_at
object

Filter portals returned in the response.

Responses

Response samples

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

Create Portal

Creates a new developer portal scoped in this region for this organization.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
Request Body schema: application/json

Create a portal.

name
required
string (PortalName) [ 1 .. 255 ] characters

The name of the portal, used to distinguish it from other portals. Name must be unique.

display_name
string (PortalDisplayName) [ 1 .. 255 ] characters

The display name of the portal. This value will be the portal's name in Portal API.

description
string or null (PortalDescription) <= 512 characters

The description of the portal.

is_public
boolean

Whether the portal catalog can be accessed publicly without any developer authentication. Developer accounts and applications cannot be created if the portal is public.

rbac_enabled
boolean

Whether the portal resources are protected by Role Based Access Control (RBAC). If enabled, developers view or register for products until unless assigned to teams with access to view and consume specific products.

auto_approve_applications
boolean

Whether the requests from applications to register for products will be automatically approved, or if they will be set to pending until approved by an admin.

auto_approve_developers
boolean

Whether the developer account registrations will be automatically approved, or if they will be set to pending until approved by an admin.

custom_domain
string or null <hostname> <= 1024 characters

The custom domain to access the developer portal. A CNAME for the portal's default domain must be able to be set for the custom domain for it to be valid. After setting a valid CNAME, an SSL/TLS certificate will be automatically manged for the custom domain, and traffic will be able to use the custom domain to route to the portal's web client and API.

custom_client_domain
string or null <hostname> <= 1024 characters

The custom domain to access a self-hosted customized developer portal client. If this is set, the Konnect-hosted portal will no longer be available. custom_domain must be also set for this value to be set. See https://github.com/Kong/konnect-portal for information on how to get started deploying and customizing your own Konnect portal.

default_application_auth_strategy_id
string or null <uuid> (DefaultApplicationAuthStratID)

Default strategy ID applied on applications for the portal

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
Example
{
  • "name": "MyDevPortal",
  • "is_public": false,
  • "rbac_enabled": true,
  • "auto_approve_applications": false,
  • "auto_approve_developers": false,
  • "custom_domain": "api.example.com",
  • "custom_client_domain": "portal.example.com"
}

Response samples

Content type
application/json
{
  • "id": "9f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
  • "created_at": "2022-02-07T17:46:57.52Z",
  • "updated_at": "2022-10-08T17:00:00.52Z",
  • "name": "Portal A",
  • "display_name": "Developer Portal A",
  • "description": "The Portal A",
  • "default_domain": "123455678abcd.us.portal.konghq.com",
  • "is_public": false,
  • "rbac_enabled": true,
  • "auto_approve_applications": false,
  • "auto_approve_developers": true,
  • "custom_domain": "api.example.com",
  • "custom_client_domain": "portal.example.com",
  • "application_count": 0,
  • "developer_count": 0,
  • "published_product_count": 0
}

Get Portal

Returns the configuration for a single developer portal. This allows you to understand the current visibility, access, and domain settings.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
portalId
required
string <uuid>

ID of the portal.

Responses

Response samples

Content type
application/json
{
  • "id": "9f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
  • "created_at": "2022-02-07T17:46:57.52Z",
  • "updated_at": "2022-10-08T17:00:00.52Z",
  • "name": "Portal A",
  • "display_name": "Developer Portal A",
  • "description": "The Portal A",
  • "default_domain": "123455678abcd.us.portal.konghq.com",
  • "is_public": false,
  • "rbac_enabled": true,
  • "auto_approve_applications": false,
  • "auto_approve_developers": true,
  • "custom_domain": "api.example.com",
  • "custom_client_domain": "portal.example.com",
  • "application_count": 0,
  • "developer_count": 0,
  • "published_product_count": 0
}

Update Portal

Updates the configuration for a single portal including the visibility, access, and custom domain settings.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
portalId
required
string <uuid>

ID of the portal.

Request Body schema: application/json

Update a portal's settings.

name
string (PortalName) [ 1 .. 255 ] characters

The name of the portal, used to distinguish it from other portals. Name must be unique.

display_name
string (PortalDisplayName) [ 1 .. 255 ] characters

The display name of the portal. This value will be the portal's name in Portal API.

description
string or null (PortalDescription) <= 512 characters

The description of the portal.

is_public
boolean

Whether the portal catalog can be accessed publicly without any developer authentication. Developer accounts and applications cannot be created if the portal is public.

rbac_enabled
boolean

Whether the portal resources are protected by Role Based Access Control (RBAC). If enabled, developers view or register for products until unless assigned to teams with access to view and consume specific products.

auto_approve_applications
boolean

Whether the requests from applications to register for products will be automatically approved, or if they will be set to pending until approved by an admin.

auto_approve_developers
boolean

Whether the developer account registrations will be automatically approved, or if they will be set to pending until approved by an admin.

custom_domain
string or null <hostname> <= 1024 characters

The custom domain to access the developer portal. A CNAME for the portal's default domain must be able to be set for the custom domain for it to be valid. After setting a valid CNAME, an SSL/TLS certificate will be automatically manged for the custom domain, and traffic will be able to use the custom domain to route to the portal's web client and API.

custom_client_domain
string or null <hostname> <= 1024 characters

The custom domain to access a self-hosted customized developer portal client. If this is set, the Konnect-hosted portal will no longer be available. custom_domain must be also set for this value to be set. See https://github.com/Kong/konnect-portal for information on how to get started deploying and customizing your own Konnect portal.

default_application_auth_strategy_id
string or null <uuid> (DefaultApplicationAuthStratID)

Default strategy ID applied on applications for the portal

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
Example
{
  • "is_public": false,
  • "rbac_enabled": true,
  • "auto_approve_applications": false,
  • "auto_approve_developers": false,
  • "custom_domain": "api.example.com",
  • "custom_client_domain": "portal.example.com"
}

Response samples

Content type
application/json
{
  • "id": "9f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
  • "created_at": "2022-02-07T17:46:57.52Z",
  • "updated_at": "2022-10-08T17:00:00.52Z",
  • "name": "Portal A",
  • "display_name": "Developer Portal A",
  • "description": "The Portal A",
  • "default_domain": "123455678abcd.us.portal.konghq.com",
  • "is_public": false,
  • "rbac_enabled": true,
  • "auto_approve_applications": false,
  • "auto_approve_developers": true,
  • "custom_domain": "api.example.com",
  • "custom_client_domain": "portal.example.com",
  • "application_count": 0,
  • "developer_count": 0,
  • "published_product_count": 0
}

Delete Portal

Deletes a single portal, along with all related entities. Will not allow deletion if there are developers registered to portal or if there are portal product versions with application registration enabled, unless force=true query param is included in the request.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
portalId
required
string <uuid>

ID of the portal.

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

If true, delete specified portal and all related entities, even if there are developers registered to portal or if there are portal product versions with application registration enabled. If false, do not allow deletion if there are developers registered to portal or if there are portal product versions with application registration enabled.

Responses

Response samples

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

Verify Custom Domains

Verifies the current status of the custom hosted domain for this portal, indicating whether the appropriate CNAME properties have propagated and if a corresponding SSL certificate has been generated.

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

ID of the portal.

Responses

Response samples

Content type
application/json
{
  • "is_cname_verified": true,
  • "is_ssl_issued": false
}

Portal Developers

APIs related to Konnect Developer Portal Developers.

List Developers

Lists the developers that have registered for this portal. Each developer can be registered to one portal and must be approved to login unless using the developer auto-approve setting.

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

ID of the portal.

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.

sort
string

Sorts a collection of developers. Supported sort attributes are:

  • created_at
  • updated_at
  • email
  • name
  • status
object

Filter developers returned in the response.

Responses

Response samples

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

Get Developer

Returns information about a single developer in this portal. Each developer manages a set applications, providing them credentials to access registered API product versions. Developer registration access can be limited to specific API products using RBAC.

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

ID of the portal.

developerId
required
string <uuid> (UUID)
Example: 5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

The developer ID

Responses

Response samples

Content type
application/json
{
  • "id": "7cd9feff-b4da-4a9f-ba49-cbe83c75ff22",
  • "email": "developer@example.com",
  • "full_name": "Jane Dev",
  • "status": "approved",
  • "application_count": 3,
  • "created_at": "2022-11-15T20:37:41.457Z",
  • "updated_at": "2022-11-15T20:37:47.456Z"
}

Update Developer

Updates the status of a particular developer. Approved developers have access to login to the portal. Revoked, rejected, or pending are not allowed to login. Even if a developer's status is no longer approved, they will still be able to using any existing credentials generated while they were approved, until each application registration is revoked or deleted.

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

ID of the portal.

developerId
required
string <uuid> (UUID)
Example: 5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

The developer ID

Request Body schema: application/json

Update a developer.

status
string (DeveloperStatus)
Enum: "approved" "pending" "revoked" "rejected"

The status of a developer in a portal. Approved developers can log in, create applications, and view and register for products they have access to. Pending, revoked, and rejected developers cannot login or view any non-public portal information, or create or modify applications or registrations.

Responses

Request samples

Content type
application/json
Example
{
  • "status": "approved"
}

Response samples

Content type
application/json
{
  • "id": "7cd9feff-b4da-4a9f-ba49-cbe83c75ff22",
  • "email": "developer@example.com",
  • "full_name": "Jane Dev",
  • "status": "approved",
  • "application_count": 3,
  • "created_at": "2022-11-15T20:37:41.457Z",
  • "updated_at": "2022-11-15T20:37:47.456Z"
}

Delete Developer

Deletes a developer, which will discontinue their ability to login, view any non-public resources, and delete all applications owned by them. All credentials issued to the developer will no longer provide access to any API Products. A deleted developer's unique email must be re-registered and approved to gain access again.

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

ID of the portal.

developerId
required
string <uuid> (UUID)
Example: 5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

The developer ID

Responses

Response samples

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

Portal Teams

APIs related to Konnect Developer Portal Developer Teams.

List Teams

Lists the developer teams in a portal. Each team can contain any developer and developers can be part of multiple teams.

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

ID of the portal.

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

Filter teams returned in the response.

Responses

Response samples

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

Create Team

Creates a developer team in a portal. Developers can be added to teams to provide RBAC access to API products. Teams can be assigned roles that grant permissions to perform an action on a resource.

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

ID of the portal.

Request Body schema: application/json

Create a team in a portal.

name
required
string^[\w \W]+$
description
string <= 250 characters

Responses

Request samples

Content type
application/json
{
  • "name": "IDM - Developers",
  • "description": "The Identity Management (IDM) API team."
}

Response samples

Content type
application/json
{
  • "id": "7f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
  • "name": "Gold Tier",
  • "description": "Team with access to APIs in the Gold tier",
  • "created_at": "2022-02-07T17:46:57.52Z",
  • "updated_at": "2022-09-25T13:00:00.00Z"
}

Get Team

Get an individual team.

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

ID of the team.

portalId
required
string <uuid>
Example: f32d905a-ed33-46a3-a093-d8f536af9a8a

ID of the portal.

Responses

Response samples

Content type
application/json
{
  • "id": "7f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
  • "name": "Gold Tier",
  • "description": "Team with access to APIs in the Gold tier",
  • "created_at": "2022-02-07T17:46:57.52Z",
  • "updated_at": "2022-09-25T13:00:00.00Z"
}

Update Team

Updates an individual developer team for a portal.

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

ID of the team.

portalId
required
string <uuid>
Example: f32d905a-ed33-46a3-a093-d8f536af9a8a

ID of the portal.

Request Body schema: application/json

Update a team in a portal.

name
string^[\w \W]+$
description
string <= 250 characters

Responses

Request samples

Content type
application/json
{
  • "name": "IDM - Developers",
  • "description": "The Identity Management (IDM) API team."
}

Response samples

Content type
application/json
{
  • "id": "7f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
  • "name": "Gold Tier",
  • "description": "Team with access to APIs in the Gold tier",
  • "created_at": "2022-02-07T17:46:57.52Z",
  • "updated_at": "2022-09-25T13:00:00.00Z"
}

Delete Team

Deletes a developer team from a portal. Deleting a team also deletes its assigned roles. Members of the team are not deleted, but they will lose any access provided through the team.

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

ID of the team.

portalId
required
string <uuid>
Example: f32d905a-ed33-46a3-a093-d8f536af9a8a

ID of the portal.

Responses

Response samples

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

Portal Team Membership

APIs related to Developer Membership in Konnect Developer Portal Developer Teams.

List Developer Teams

Lists the teams to which a developer belongs. Each team a developer is a member of grants them various roles that provide permissions to perform actions on certain resources.

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

ID of the developer.

portalId
required
string <uuid>
Example: f32d905a-ed33-46a3-a093-d8f536af9a8a

ID of the portal.

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": [
    ]
}

List Team Developers

List a team's developers.

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

ID of the portal.

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

ID of the team.

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

Filter developers returned in the response.

Responses

Response samples

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

Add Developer to Team

Adds a developer to a team. This associates them with all of the roles that have been assigned to the team, providing specific permissions to perform actions on resources.

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

ID of the portal.

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

ID of the team.

Request Body schema: application/json

Add a developer to a team.

id
required
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "id": "df120cb4-f60b-47bc-a2f8-6a28e6a3c63b"
}

Response samples

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

Remove Developer from Team

Removes a developer from a team. This removes the association of the team's roles from the developer.

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

ID of the portal.

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

ID of the developer.

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

ID of the team.

Responses

Response samples

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

Portal Team Roles

APIs related to Team Roles in Konnect Developer Portal.

List Portal Roles

List roles that can be assigned to teams in a portal. Each role provides a set of permissions to perform an action on a resource.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth

Responses

Response samples

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

List Team Roles

Lists the roles belonging to a developer team. Each role provides permissions to perform actions on a specified resource or collection.

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

ID of the portal.

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

ID of the team.

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": [
    ]
}

Assign Role

Assign a role to a developer team. This associates the set of permissions in a role with the team, so that they will be applied to any developer who is a member of the team.

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

ID of the portal.

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

ID of the team.

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.

Request Body schema: application/json

Assign a role to a team.

role_name
string
entity_id
string <uuid>
entity_type_name
string
entity_region
string
Enum: "us" "eu" "au" "me" "in" "*"

Region of the entity.

Responses

Request samples

Content type
application/json
Example
{
  • "role_name": "API Viewer",
  • "entity_id": "18ee2573-dec0-4b83-be99-fa7700bcdc61",
  • "entity_type_name": "Services",
  • "entity_region": "us"
}

Response samples

Content type
application/json
Example
{
  • "id": "1a3c2169-27f8-4594-926b-41df3432d5dc",
  • "role_name": "API Viewer",
  • "entity_id": "18ee2573-dec0-4b83-be99-fa7700bcdc61",
  • "entity_type_name": "Services",
  • "entity_region": "us"
}

Remove Role

Removes an assigned role from a developer team. This deletes the association of the role with team and each of its members.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
roleId
required
string <uuid>
Example: 8350205f-a305-4e39-abe9-bc082a80091a
portalId
required
string <uuid>
Example: f32d905a-ed33-46a3-a093-d8f536af9a8a

ID of the portal.

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

ID of the team.

Responses

Response samples

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

Portal Applications

APIs related to Konnect Developer Portal Applications.

Get Application

Returns the configuration of a single application in any portal. If an application is linked to a DCR Provider, the dcr_provider.id and reference_id can be used to correlate it. An application manages a set of credentials and registrations for specific API product versions.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
applicationId
required
string <uuid> (UUID)
Example: 5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

The application ID

Responses

Response samples

Content type
application/json
Example
{
  • "id": "b15e2460-ba40-431d-9df0-4957fcffacda",
  • "labels": {
    },
  • "name": "App 1",
  • "description": "An easy to manage app in a Konnect developer portal",
  • "reference_id": "df66b180-97df-4ddb-8b45-8b7d5eac56da",
  • "registration_count": 4,
  • "portal": {
    },
  • "dcr_provider": null,
  • "granted_scopes": null,
  • "developer": {
    },
  • "created_at": "2022-12-22T19:09:30.712Z",
  • "updated_at": "2022-12-22T19:09:30.712Z"
}

List Applications

Lists applications created by developers in this portal. Each application can be registered for various API Products (by version), issuing credentials for API request access. If using DCR, an application will be linked to an Identity Provider's application by its reference_id.

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

ID of the portal.

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.

sort
string

Sorts a collection of applications. Supported sort attributes are:

  • created_at
  • developer_id
  • name
object

Filter applications returned in the response.

Responses

Response samples

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

Get Application by Portal

Returns the configuration of a single application in this portal. If an application is linked to a DCR Provider, the dcr_provider.id and reference_id can be used to correlate it. An application manages a set of credentials and registrations for specific API product versions.

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

ID of the portal.

applicationId
required
string <uuid> (UUID)
Example: 5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

The application ID

Responses

Response samples

Content type
application/json
Example
{
  • "id": "b15e2460-ba40-431d-9df0-4957fcffacda",
  • "labels": {
    },
  • "name": "App 1",
  • "description": "An easy to manage app in a Konnect developer portal",
  • "reference_id": "df66b180-97df-4ddb-8b45-8b7d5eac56da",
  • "registration_count": 4,
  • "portal": {
    },
  • "dcr_provider": null,
  • "granted_scopes": null,
  • "developer": {
    },
  • "created_at": "2022-12-22T19:09:30.712Z",
  • "updated_at": "2022-12-22T19:09:30.712Z"
}

Delete Application by Portal

Delete a single application in this portal, along with its registrations and credentials.

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

ID of the portal.

applicationId
required
string <uuid> (UUID)
Example: 5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

The application ID

Responses

Response samples

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

Portal Application Registrations

APIs related to Konnect Developer Portal Application Registrations.

List Application Registrations by Portal

Lists all of the application registrations and their current status (e.g., approved or pending) for this portal. Each registration is associated with a single API product version. Access is provided through the credentials issued to the application that contains each registration.

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

ID of the portal.

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.

sort
string

Sorts a collection of application registrations. Supported sort attributes are:

  • created_at
  • updated_at
  • developer_id
  • status
object

Filter application registrations returned in the response.

Responses

Response samples

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

List Registrations by Application

Lists each API product version that this application is registered for and their current status (e.g., pending, approved, rejected, revoked).

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

ID of the portal.

applicationId
required
string <uuid> (UUID)
Example: 5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

The application 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.

sort
string

Sorts a set of registrations for an application. Supported sort attributes are:

  • created_at
  • updated_at
  • status
object

Filter application registrations returned in the response.

Responses

Response samples

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

Get Application Registration

Returns information about an application's registration status for a particular API product version.

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

ID of the portal.

applicationId
required
string <uuid> (UUID)
Example: 5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

The application ID

registrationId
required
string <uuid> (UUID)
Example: 5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

The application registration ID

Responses

Response samples

Content type
application/json
{
  • "id": "c300cc33-2d33-4754-b086-a98e0fcd36fb",
  • "status": "approved",
  • "application": {
    },
  • "product": {
    },
  • "product_version": {
    },
  • "developer": {
    },
  • "granted_scopes": [
    ],
  • "created_at": "2022-12-22T20:13:07.305Z",
  • "updated_at": "2022-12-22T20:13:36.710Z"
}

Update Application Registration

Updates the status of a particular application registration to an API Product Version. Approved application registrations will allow API traffic to the corresponding API. Revoked, rejected, or pending will not allow API traffic.

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

ID of the portal.

applicationId
required
string <uuid> (UUID)
Example: 5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

The application ID

registrationId
required
string <uuid> (UUID)
Example: 5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

The application registration ID

Request Body schema: application/json

Update an application registration.

status
string (ApplicationRegistrationStatus)
Enum: "approved" "pending" "revoked" "rejected"

The status of an application registration request. Each registration is linked to a single version of a product, and application credentials will not grant access to the product version until the registration is approved. Pending, revoked, and rejected registrations will not provide access to the product version.

Responses

Request samples

Content type
application/json
Example
{
  • "status": "approved"
}

Response samples

Content type
application/json
{
  • "id": "c300cc33-2d33-4754-b086-a98e0fcd36fb",
  • "status": "approved",
  • "application": {
    },
  • "product": {
    },
  • "product_version": {
    },
  • "developer": {
    },
  • "granted_scopes": [
    ],
  • "created_at": "2022-12-22T20:13:07.305Z",
  • "updated_at": "2022-12-22T20:13:36.710Z"
}

Delete Application Registration

Deletes an application registration, which if currently approved will immediately block API traffic to the API product version. Note: Developers can request a new application registration for the given API product version as long as they have RBAC access to consume.

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

ID of the portal.

applicationId
required
string <uuid> (UUID)
Example: 5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

The application ID

registrationId
required
string <uuid> (UUID)
Example: 5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

The application registration ID

Responses

Response samples

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

List Granted Scopes

Lists the granted scopes for this application registration. This is the list of scopes that will be sent to the API when making requests.

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

ID of the portal.

applicationId
required
string <uuid> (UUID)
Example: 5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

The application ID

registrationId
required
string <uuid> (UUID)
Example: 5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

The application registration ID

Responses

Response samples

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

Portal Products

APIs related to API Products Published to Konnect Developer Portals.

List Portal Products

Lists the API products that are published to this developer portal. An API product packages together multiple versions of each API, displaying each version with its set of operations and documentation. Developers can browse API Products to learn about and register for them. API Products access can be limited to certain developers using RBAC and developer teams.

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

ID of the portal.

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.

sort
string

Sorts a collection of Portal Products. Supported sort attributes are:

  • created_at
  • name
  • description
object (PortalProductFilters)

Filters a collection of Portal Products.

Responses

Response samples

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

Portal Auth Settings

APIs related to Konnect Developer Portal Authentication Settings.

Get Auth Settings

Returns the developer authentication configuration for a portal, which determines how developers can log in and how they are assigned to teams.

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

ID of the portal.

Responses

Response samples

Content type
application/json
{
  • "basic_auth_enabled": true,
  • "oidc_auth_enabled": true,
  • "saml_auth_enabled": true,
  • "oidc_team_mapping_enabled": true,
  • "konnect_mapping_enabled": true,
  • "idp_mapping_enabled": true,
  • "oidc_config": {
    }
}

Update Auth Settings

Updates the developer authentication configuration for a portal. Developers can be allowed to login using basic auth (email & password) or use Single-Sign-On (SSO) through an OIDC Identity Provider (IdP). Developers can be automatically assigned to teams by mapping claims from thier IdP account.

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

ID of the portal.

Request Body schema: application/json

Update a portal's developer authentication settings.

basic_auth_enabled
boolean

The organization has basic auth enabled.

oidc_auth_enabled
boolean

The organization has OIDC disabled.

saml_auth_enabled
boolean

The portal has SAML enabled or disabled.

oidc_team_mapping_enabled
boolean

Whether IdP groups determine the Konnect Portal teams a developer has.

konnect_mapping_enabled
boolean

Whether a Konnect Identity Admin assigns teams to a developer.

idp_mapping_enabled
boolean

Whether IdP groups determine the Konnect Portal teams a developer has. This will soon replace oidc_team_mapping_enabled.

oidc_issuer
string
oidc_client_id
string
oidc_client_secret
string
oidc_scopes
Array of strings
Default: ["email","openid","profile"]
object (PortalClaimMappings) [ 0 .. 3 ] properties

Mappings from a portal developer atribute to an Identity Provider claim.

Responses

Request samples

Content type
application/json
Example
{
  • "basic_auth_enabled": true,
  • "oidc_auth_enabled": true,
  • "saml_auth_enabled": true,
  • "oidc_team_mapping_enabled": true,
  • "konnect_mapping_enabled": false,
  • "idp_mapping_enabled": true,
  • "oidc_issuer": "https://identity.example.com/v2",
  • "oidc_client_id": "x7id0o42lklas0blidl2",
  • "oidc_scopes": [
    ],
  • "oidc_claim_mappings": {
    }
}

Response samples

Content type
application/json
{
  • "basic_auth_enabled": true,
  • "oidc_auth_enabled": true,
  • "saml_auth_enabled": true,
  • "oidc_team_mapping_enabled": true,
  • "konnect_mapping_enabled": true,
  • "idp_mapping_enabled": true,
  • "oidc_config": {
    }
}

List Team Group Mappings

Lists mappings between Konnect portal teams and Identity Provider (IdP) groups. Returns a 400 error if an IdP has not yet been configured.

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

ID of the portal.

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": [
    ]
}

Update Team Group Mappings

Allows partial updates to the mappings between Konnect portal teams and Identity Provider (IdP) groups. The request body must be keyed on team ID. For a given team ID, the given group list is a complete replacement. To remove all mappings for a given team, provide an empty group list. Returns a 400 error if an IdP has not yet been configured, or if a team ID in the request body is not found or is not a UUID.

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

ID of the portal.

Request Body schema: application/json
Array of objects

The IdP groups to map to the given team.

Responses

Request samples

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

Response samples

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

Retrieve Identity Providers

Retrieves the identity providers available within the portal. This operation provides information about various identity providers for SAML or OIDC authentication integrations.

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

ID of the portal.

query Parameters
object

Filter identity providers returned in the response.

Responses

Response samples

Content type
application/json
[]

Create Identity Provider

Creates a new identity provider. This operation allows the creation of a new identity provider for authentication purposes.

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

ID of the portal.

Request Body schema: application/json

An object representing the configuration for creating a new identity provider. This configuration may pertain to either an OIDC or a SAML identity provider.

type
string (IdentityProviderType)
Enum: "oidc" "saml"

Specifies the type of identity provider.

login_path
string (Identity Provider Login Path Property)

The path used for initiating login requests with the identity provider.

OIDC Identity Provider Config (object) or SAML Identity Provider Config (object)

Responses

Request samples

Content type
application/json
Example
{
  • "type": "oidc",
  • "login_path": "the-oidc-konnect-org",
  • "config": {
    }
}

Response samples

Content type
application/json
Example
{
  • "id": "66da2d42-469d-48cd-9ff3-0db135dd82d8",
  • "type": "oidc",
  • "enabled": false,
  • "login_path": "the-oidc-konnect-org",
  • "config": {
    },
  • "created_at": "2022-02-07T17:46:57.52Z",
  • "updated_at": "2022-02-07T17:46:57.52Z"
}

Get Identity Provider

Retrieves the configuration of a single identity provider. This operation returns information about a specific identity provider's settings and authentication integration details.

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

ID of the portal.

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

ID of the identity provider.

Responses

Response samples

Content type
application/json
Example
{
  • "id": "66da2d42-469d-48cd-9ff3-0db135dd82d8",
  • "type": "oidc",
  • "enabled": false,
  • "login_path": "the-oidc-konnect-org",
  • "config": {
    },
  • "created_at": "2022-02-07T17:46:57.52Z",
  • "updated_at": "2022-02-07T17:46:57.52Z"
}

Update Identity Provider

Updates the configuration of an existing identity provider. This operation allows modifications to be made to an existing identity provider's configuration.

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

ID of the portal.

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

ID of the identity provider.

Request Body schema: application/json

An object representing the configuration for updating an identity provider. This configuration may pertain to either an OIDC or a SAML identity provider.

enabled
boolean (Identity Provider Enabled Property)
Default: false

Indicates whether the identity provider is enabled. Only one identity provider can be active at a time, such as SAML or OIDC.

login_path
string (Identity Provider Login Path Property)

The path used for initiating login requests with the identity provider.

OIDC Identity Provider Config (object) or SAML Identity Provider Config (object)

Responses

Request samples

Content type
application/json
Example
{
  • "enabled": true,
  • "login_path": "the-oidc-konnect-org",
  • "config": {
    }
}

Response samples

Content type
application/json
Example
{
  • "id": "66da2d42-469d-48cd-9ff3-0db135dd82d8",
  • "type": "oidc",
  • "enabled": false,
  • "login_path": "the-oidc-konnect-org",
  • "config": {
    },
  • "created_at": "2022-02-07T17:46:57.52Z",
  • "updated_at": "2022-02-07T17:46:57.52Z"
}

Delete Identity Provider

Deletes an existing identity provider configuration. This operation removes a specific identity provider from the portal.

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

ID of the portal.

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

ID of the identity provider.

Responses

Response samples

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

Portal Appearance

APIs related to Konnect Developer Portal Appearance Settings.

Get Appearance Configuration

Returns the current portal appearance configuration including any custom theme, colors, fonts, and image settings. Portals using the fully-customizable portal client may override or ignore these settings by disregarding them in the code.

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

ID of the portal.

Responses

Response samples

Content type
application/json
{
  • "theme_name": "custom",
  • "use_custom_fonts": true,
  • "custom_theme": {
    },
  • "custom_fonts": {
    },
  • "text": {
    },
  • "images": {
    }
}

Update Appearance Configuration

Updates the current appearance configuration for this portal including setting pre-defined or custom themes, fonts, colors, and images. Note that portals using the fully-customizable portal client may override or ignore these settings by disregarding them in the code.

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

ID of the portal.

Request Body schema: application/json

Update a portal's appearance settings

theme_name
string (PortalTheme)
Enum: "mint_rocket" "dark_mode" "custom"

Select a pre-existing default theme or specify 'custom' to use custom_theme variables.

object or null (AppearanceThemeVariables)

Groups of variables for configuring visual details of the portal user interface. Set theme_name to 'custom' to use custom values for theme variables.

object or null (NullableAppearanceFonts)

Font selections to render text in the portal user interface. Must set use_custom_fonts to true to enable using custom font values.

use_custom_fonts
boolean

If true, fonts in custom_fonts will be used over the theme's default fonts

object or null (NullableAppearanceTextVariables)

Values to display for customizable text in the portal user interface

object or null (AppearanceImages)

A collection of binary image data to customize images in the portal

Responses

Request samples

Content type
application/json
Example
{
  • "theme_name": "custom",
  • "use_custom_fonts": true,
  • "custom_theme": {
    },
  • "custom_fonts": {
    },
  • "text": {
    },
  • "images": {
    }
}

Response samples

Content type
application/json
{
  • "theme_name": "custom",
  • "use_custom_fonts": true,
  • "custom_theme": {
    },
  • "custom_fonts": {
    },
  • "text": {
    },
  • "images": {
    }
}

Get Portal Catalog Cover

Returns the portal catalog cover or returns the default

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

ID of the portal.

Responses

Response samples

Content type
data:image/jpg;base64,bmljZV9sb29raW5nX3BpY3R1cmU=

Get Default Appearance Configurations

Returns the built-in portal appearance configurations including pre-defined themes, colors, and font settings.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth

Responses

Response samples

Content type
application/json
{
  • "themes": {
    },
  • "fonts": {
    },
  • "text": {
    }
}

Portal Product Versions

Portal Product Versions hold metadata that describes how a Product Version is configured for a specific portal.

They contain:

  • Lifecyle and deprecation statuses
  • Application registration settings like auto approve or whether application registration is enabled
  • The authentication strategy that is enabled for Application Registration

List portal product versions

List portal product versions

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

ID of the portal.

query Parameters
sort
string

Sorts a collection of Portal Product Versions. Supported sort attributes are:

  • created_at
  • updated_at
  • publish_status
  • product_version_id
  • auth_strategy_ids
  • application_registration_enabled
  • auto_approve_registration
  • deprecated
object (PortalProductVersionFilters)

Filters a collection of Portal Product Versions.

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 portal product version

Create a portal product version

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

ID of the portal.

Request Body schema: application/json
publish_status
required
string (PortalProductVersionPublishStatus)
Enum: "published" "unpublished"

Publication status of the API product version on the portal

product_version_id
required
string <uuid> (UUID_RW)

Contains a unique identifier used by the API for this resource.

auth_strategy_ids
required
Array of strings <uuid> (AuthStrategyIDs) [ 0 .. 1 ] items

A list of authentication strategy IDs

application_registration_enabled
required
boolean (ApplicationRegistrationEnabled)

Whether the application registration on this portal for the api product version is enabled

auto_approve_registration
required
boolean (AutoApproveRegistration)

Whether the application registration auto approval on this portal for the api product version is enabled

deprecated
required
boolean (PortalProductVersionDeprecated)

Whether the api product version on the portal is deprecated

Responses

Request samples

Content type
application/json
{
  • "product_version_id": "33f8380e-7798-4566-99e3-2edf2b57d289",
  • "auth_strategy_ids": [
    ],
  • "publish_status": "published",
  • "application_registration_enabled": true,
  • "auto_approve_registration": true,
  • "deprecated": false
}

Response samples

Content type
application/json
{
  • "id": "22f8380e-7798-4566-99e3-2edf2b57d289",
  • "publish_status": "published",
  • "product_version_id": "33f8380e-7798-4566-99e3-2edf2b57d289",
  • "auth_strategies": [
    ],
  • "application_registration_enabled": true,
  • "auto_approve_registration": true,
  • "deprecated": false,
  • "created_at": "2023-01-01T00:00:00.000Z",
  • "updated_at": "2023-01-01T00:00:00.000Z"
}

Get a portal product version

Get a portal product version

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
productVersionId
required
string <uuid> (schemas-UUID)
Example: 5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

API product version identifier

portalId
required
string <uuid>
Example: f32d905a-ed33-46a3-a093-d8f536af9a8a

ID of the portal.

Responses

Response samples

Content type
application/json
{
  • "id": "22f8380e-7798-4566-99e3-2edf2b57d289",
  • "publish_status": "published",
  • "product_version_id": "33f8380e-7798-4566-99e3-2edf2b57d289",
  • "auth_strategies": [
    ],
  • "application_registration_enabled": true,
  • "auto_approve_registration": true,
  • "deprecated": false,
  • "created_at": "2023-01-01T00:00:00.000Z",
  • "updated_at": "2023-01-01T00:00:00.000Z"
}

Update a portal product version

Update a portal product version

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
productVersionId
required
string <uuid> (schemas-UUID)
Example: 5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

API product version identifier

portalId
required
string <uuid>
Example: f32d905a-ed33-46a3-a093-d8f536af9a8a

ID of the portal.

Request Body schema: application/json
publish_status
string (PortalProductVersionPublishStatus)
Enum: "published" "unpublished"

Publication status of the API product version on the portal

auth_strategy_ids
Array of strings <uuid> (AuthStrategyIDs) [ 0 .. 1 ] items

A list of authentication strategy IDs

application_registration_enabled
boolean (ApplicationRegistrationEnabled)

Whether the application registration on this portal for the api product version is enabled

auto_approve_registration
boolean (AutoApproveRegistration)

Whether the application registration auto approval on this portal for the api product version is enabled

deprecated
boolean (PortalProductVersionDeprecated)

Whether the api product version on the portal is deprecated

notify_developers
boolean (NotifyDevelopers)

Whether to notify developers who are affected by this change

Responses

Request samples

Content type
application/json
Example
{
  • "auto_approve_registration": false
}

Response samples

Content type
application/json
{
  • "id": "22f8380e-7798-4566-99e3-2edf2b57d289",
  • "publish_status": "published",
  • "product_version_id": "33f8380e-7798-4566-99e3-2edf2b57d289",
  • "auth_strategies": [
    ],
  • "application_registration_enabled": true,
  • "auto_approve_registration": true,
  • "deprecated": false,
  • "created_at": "2023-01-01T00:00:00.000Z",
  • "updated_at": "2023-01-01T00:00:00.000Z"
}

Replace a portal product version

Replace a portal product version

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
productVersionId
required
string <uuid> (schemas-UUID)
Example: 5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

API product version identifier

portalId
required
string <uuid>
Example: f32d905a-ed33-46a3-a093-d8f536af9a8a

ID of the portal.

Request Body schema: application/json
publish_status
required
string (PortalProductVersionPublishStatus)
Enum: "published" "unpublished"

Publication status of the API product version on the portal

auth_strategy_ids
required
Array of strings <uuid> (AuthStrategyIDs) [ 0 .. 1 ] items

A list of authentication strategy IDs

application_registration_enabled
required
boolean (ApplicationRegistrationEnabled)

Whether the application registration on this portal for the api product version is enabled

auto_approve_registration
required
boolean (AutoApproveRegistration)

Whether the application registration auto approval on this portal for the api product version is enabled

deprecated
required
boolean (PortalProductVersionDeprecated)

Whether the api product version on the portal is deprecated

notify_developers
boolean (NotifyDevelopers)

Whether to notify developers who are affected by this change

Responses

Request samples

Content type
application/json
{
  • "auth_strategy_ids": [
    ],
  • "publish_status": "published",
  • "application_registration_enabled": true,
  • "auto_approve_registration": true,
  • "deprecated": false
}

Response samples

Content type
application/json
{
  • "id": "22f8380e-7798-4566-99e3-2edf2b57d289",
  • "publish_status": "published",
  • "product_version_id": "33f8380e-7798-4566-99e3-2edf2b57d289",
  • "auth_strategies": [
    ],
  • "application_registration_enabled": true,
  • "auto_approve_registration": true,
  • "deprecated": false,
  • "created_at": "2023-01-01T00:00:00.000Z",
  • "updated_at": "2023-01-01T00:00:00.000Z"
}

Delete a portal product version

Delete a portal product version

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
productVersionId
required
string <uuid> (schemas-UUID)
Example: 5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

API product version identifier

portalId
required
string <uuid>
Example: f32d905a-ed33-46a3-a093-d8f536af9a8a

ID of the portal.

Responses

Response samples

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

Serverless Cloud Gateways

List Serverless cloud gateways

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

Returns an array of serverless cloud gateways objects.

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

labels
string
Example: labels=filter[labels][eq]=env:prod

Filter serverless cloud gateways in the response by associated labels.

Responses

Response samples

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

Create a new serverless cloud gateway

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

Create a new serverless cloud gateway

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
Request Body schema: application/json
required
object (Control plane)
cluster_cert
required
string

The cluster certificate (public key).

cluster_cert_key
required
string

The cluster certificate key (private key).

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
{
  • "control_plane": {
    },
  • "cluster_cert": "-----BEGIN CERTIFICATE----- MIICRDCCAa2gAwIBAgIBADANBgkqhkiG9w0BAQ0FADA/MQswCQYDVQQGEwJ1czEL MAkGA1UECAwCVFgxDTALBgNVBAoMBFRlc3QxFDASBgNVBAMMC2V4YW1wbGUuY29t MB4XDTI0MDQyNjA5NTA1OVoXDTI1MDQyNjA5NTA1OVowPzELMAkGA1UEBhMCdXMx CzAJBgNVBAgMAlRYMQ0wCwYDVQQKDARUZXN0MRQwEgYDVQQDDAtleGFtcGxlLmNv bTCBnzANBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEA8FaJZmPsthBT1XkTyqUJiuQV 4p4KaLpNMioNQtIdeGKFXelmZlVfW0bfLGBgFmkwo19KIzFtOlITUjb0Qqlub2Dn TIPoDs7rXA8aw6umJu73Z6647U3+alxNCpwTuYOY2CJQ+HWEIuOuwAdtQkndEp9r 7ZWA2xLatQKBYEvEmykCAwEAAaNQME4wHQYDVR0OBBYEFGUznNeZK74vlA4bqKHb 706tyMwcMB8GA1UdIwQYMBaAFGUznNeZK74vlA4bqKHb706tyMwcMAwGA1UdEwQF MAMBAf8wDQYJKoZIhvcNAQENBQADgYEARmnu/2vUcmJYLlg86MN0prXGC3CGXsem fDtPF4SBPxfchdG7HJKywTloIiCBKGEQALkCHiJcQJNcSHmzH3/Qk+SrOJNH01gt HsKA4SNFJZR5fCRpT6USCukyE2Wlr+PWPscrFCWbLXhK4Ql/t0oog1255B10HqKk 1qDkNrzCd/o= -----END CERTIFICATE-----\n",
  • "cluster_cert_key": "-----BEGIN PRIVATE KEY----- MIICeAIBADANBgkqhkiG9w0BAQEFAASCAmIwggJeAgEAAoGBAPBWiWZj7LYQU9V5 E8qlCYrkFeKeCmi6TTIqDULSHXhihV3pZmZVX1tG3yxgYBZpMKNfSiMxbTpSE1I2 9EKpbm9g50yD6A7O61wPGsOrpibu92euuO1N/mpcTQqcE7mDmNgiUPh1hCLjrsAH bUJJ3RKfa+2VgNsS2rUCgWBLxJspAgMBAAECgYEAvA7qqozL/1ZdUu/P1cQ36E86 9L03ZeVJXFRdVgj2eGqW8vob3z00RUb6gE3VQhQDNALvDwSw9G6eoblQfgz31Hju sb+j6bGOm2BqzYrx6rpcgme7k9ScV0tEbtiBNX0E/ToHvNywHtdOBvDocN2wh42Z 6bS9um51H+SXR036mgUCQQD4T7WrJHL97Hj8TtHnTw895xWKaGn94H7ZQa2lo1nk 7CQ4Oi8rFX5tDdyV7UU6fekBWuhpmIhSGJhyHD7UThBjAkEA98ef9ey2Qx+j+R8S tgpgJAF3LVNJJicEHCS/Vltgc84X/vidVAMa2+TYPxPrrUjxBr0STCeB5wZhvvsB D8cOAwJBAJ5JqaQPUx1dDe7Ai/vooO20Dj4xu0c0QYha3sfU7qwIgDo7lO/g/ruj 93a3TscvlkXf3oHZ0ySKOzual86ciMMCQQDGOLgaWHVy+4QFTzt70I8bHuUFqKRT VlEuZqN/ZXijDFQcES5jwFwjYE8zHy+ioEDaIDXcIJsGhA98Zndx9M+bAkA4IFdx 4YIDhuk1MJAYPqVQs5szEF/0BGymLNVYlIox48bZg+TH3uXwTVRVySxvpRa8dd3O 0gHs3EIV6GFUl7ev -----END PRIVATE KEY-----\n",
  • "labels": {
    }
}

Response samples

Content type
application/json
{
  • "control_plane": {
    },
  • "gateway_endpoint": "kong-518da50bf7euab123.kongcloud.dev",
  • "created_at": "2022-11-04T20:10:06.927Z",
  • "updated_at": "2022-11-04T20:10:06.927Z"
}

Get the serverless cloud gateway

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

Get the serverless cloud gateway

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

Id of the Serverless Cloud Gateway control plane

Responses

Response samples

Content type
application/json
{
  • "control_plane": {
    },
  • "gateway_endpoint": "kong-518da50bf7euab123.kongcloud.dev",
  • "created_at": "2022-11-04T20:10:06.927Z",
  • "updated_at": "2022-11-04T20:10:06.927Z"
}

Delete the serverless cloud gateway

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

Delete the serverless cloud gateway

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

Id of the Serverless Cloud Gateway control plane

Responses

Response samples

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

DP Nodes

DP Nodes

Fetch Expected Config Hash

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

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

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

Responses

Response samples

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

List Data Plane Node Records

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

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

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

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

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

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

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

Responses

Response samples

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

Fetch Data Plane Node Record

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

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

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

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

Node identifier

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

Number of resources to be returned.

tags
string
Example: tags=tag1,tag2

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

Responses

Response samples

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

Delete Data Plane Node Record

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

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

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

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

Node identifier

Responses

List End-of-Life Data Plane Node Records

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

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

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

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

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

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

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

Responses

Response samples

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

DP Certificates

DP Certificates

List DP Client Certificates

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

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

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

Responses

Response samples

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

Pin New DP Client Certificate

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

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

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

Request Body schema: application/json

Request body for creating a dp-client-certificate.

cert
required
string

JSON escaped string of the certificate.

Responses

Request samples

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

Response samples

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

Fetch DP Client Certificate

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

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

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

certificateId
required
string

Responses

Response samples

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

Delete DP Client Certificate

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

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

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

certificateId
required
string

Responses

Custom Plugin Schemas

Custom Plugin Schemas

List custom plugin schemas associated with a control plane

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

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

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

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

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

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

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

Responses

Response samples

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

Upload custom plugin schema

Upload a custom plugin schema associated with a control plane.

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

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

Request Body schema: application/json
lua_schema
required
string

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

Responses

Request samples

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

Response samples

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

Fetch custom plugin schema

Returns information about a custom plugin from a given name.

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

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

name
required
string
Example: myplugin

The custom plugin name

Responses

Response samples

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

Delete custom plugin schema

Delete an individual custom plugin schema.

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

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

name
required
string
Example: myplugin

The custom plugin name

Responses

Response samples

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

Create or update a custom plugin schema

Create or update an individual custom plugin schema.

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

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

name
required
string
Example: myplugin

The custom plugin name

Request Body schema: application/json
lua_schema
required
string

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

Responses

Request samples

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

Response samples

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

Config Stores

Config Stores

List all config stores for a control plane

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

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

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

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

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

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

Responses

Response samples

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

Create Config Store

Create a Config Store

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

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

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

Responses

Request samples

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

Response samples

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

Fetch Config Store

Returns a Config Store

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

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

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

Config Store identifier

Responses

Response samples

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

Update an individual Config Store

Updates a Config Store

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

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

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

Config Store identifier

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

Responses

Request samples

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

Response samples

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

Delete Config Store

Removes a config store

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

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

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

Config Store identifier

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

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

Responses

Response samples

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

Config Store Secrets

Config Store Secrets

Create Config Store Secret

Creates a secret for a Config Store.

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

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

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

Config Store identifier

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

Responses

Request samples

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

Response samples

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

List Config Store Secrets

Returns a collection of all secrets for a Config Store.

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

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

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

Config Store identifier

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

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

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

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

Responses

Response samples

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

Fetch Config Store Secret

Returns a secret for the Config Store.

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

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

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

Config Store identifier

key
required
string
Example: ConfigStoreSecretKey

Config Store Secret key

Responses

Response samples

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

Update Config Store Secret

Updates a secret for a Config Store.

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

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

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

Config Store identifier

key
required
string
Example: ConfigStoreSecretKey

Config Store Secret key

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

Responses

Request samples

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

Response samples

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

Delete Config Store Secret

Removes a secret from a Config Store.

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

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

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

Config Store identifier

key
required
string
Example: ConfigStoreSecretKey

Config Store Secret key

Responses

Response samples

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

CustomPlugins

List all CustomPlugins

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

List all CustomPlugins

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

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

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

Number of resources to be returned.

offset
string

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

tags
string
Example: tags=tag1,tag2

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

Responses

Response samples

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

Create a new CustomPlugin

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

Create a new CustomPlugin

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

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

Request Body schema: application/json

Description of the new CustomPlugin for creation

created_at
integer or null

Unix epoch when the resource was created.

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

Unix epoch when the resource was last updated.

Responses

Request samples

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

Response samples

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

Delete a CustomPlugin

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

Delete a CustomPlugin

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

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

CustomPluginId
required
string

ID of the CustomPlugin to lookup

Responses

Response samples

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

Fetch a CustomPlugin

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

Get a CustomPlugin using ID or name.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
CustomPluginId
required
string

ID of the CustomPlugin to lookup

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

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

Responses

Response samples

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

Upsert a CustomPlugin

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

Create or Update CustomPlugin using ID or name.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
CustomPluginId
required
string

ID of the CustomPlugin to lookup

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

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

Request Body schema: application/json

Description of the CustomPlugin

created_at
integer or null

Unix epoch when the resource was created.

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

Unix epoch when the resource was last updated.

Responses

Request samples

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

Response samples

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

Services

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

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

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

Services can be both tagged and filtered by tags.

List all Services

List all Services

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

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

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

Number of resources to be returned.

offset
string

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

tags
string
Example: tags=tag1,tag2

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

Responses

Response samples

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

Create a new Service

Create a new Service

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

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

Request Body schema: application/json

Description of the new Service for creation

ca_certificates
Array of strings or null

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

object or null

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

connect_timeout
integer or null
Default: 60000

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

created_at
integer or null

Unix epoch when the resource was created.

enabled
boolean or null
Default: true

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

host
required
string

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

id
string or null
name
string or null

The Service name.

path
string or null

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

port
integer or null
Default: 80

The upstream server port.

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

The protocol used to communicate with the upstream.

read_timeout
integer or null
Default: 60000

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

retries
integer or null
Default: 5

The number of retries to execute upon failure to proxy.

tags
Array of strings

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

tls_verify
boolean or null

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

tls_verify_depth
integer or null

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

updated_at
integer or null

Unix epoch when the resource was last updated.

url
string

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

write_timeout
integer or null
Default: 60000

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

Responses

Request samples

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

Response samples

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

Delete a Service

Delete a Service

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

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

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

ID of the Service to lookup

Responses

Response samples

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

Fetch a Service

Get a Service using ID or name.

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

ID of the Service to lookup

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

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

Responses

Response samples

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

Upsert a Service

Create or Update Service using ID or name.

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

ID of the Service to lookup

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

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

Request Body schema: application/json

Description of the Service

ca_certificates
Array of strings or null

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

object or null

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

connect_timeout
integer or null
Default: 60000

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

created_at
integer or null

Unix epoch when the resource was created.

enabled
boolean or null
Default: true

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

host
required
string

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

id
string or null
name
string or null

The Service name.

path
string or null

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

port
integer or null
Default: 80

The upstream server port.

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

The protocol used to communicate with the upstream.

read_timeout
integer or null
Default: 60000

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

retries
integer or null
Default: 5

The number of retries to execute upon failure to proxy.

tags
Array of strings

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

tls_verify
boolean or null

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

tls_verify_depth
integer or null

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

updated_at
integer or null

Unix epoch when the resource was last updated.

url
string

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

write_timeout
integer or null
Default: 60000

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

Responses

Request samples

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

Response samples

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

Routes

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

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

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

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

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

List all Routes

List all Routes

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

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

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

Number of resources to be returned.

offset
string

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

tags
string
Example: tags=tag1,tag2

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

Responses

Response samples

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

Create a new Route

Create a new Route

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

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

Request Body schema: application/json

Description of the new Route for creation

One of
created_at
integer or null

Unix epoch when the resource was created.

Array of objects or null

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

object or null

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

hosts
Array of strings or null

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

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

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

id
string or null
methods
Array of strings or null

A list of HTTP methods that match this Route.

name
string or null

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

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

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

paths
Array of strings or null

A list of paths that match this Route.

preserve_host
boolean or null
Default: false

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

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

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

regex_priority
integer or null
Default: 0

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

request_buffering
boolean or null
Default: true

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

response_buffering
boolean or null
Default: true

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

object or null

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

snis
Array of strings or null

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

Array of objects or null

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

strip_path
boolean or null
Default: true

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

tags
Array of strings

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

updated_at
integer or null

Unix epoch when the resource was last updated.

Responses

Request samples

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

Response samples

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

Delete a Route

Delete a Route

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

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

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

ID of the Route to lookup

Responses

Response samples

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

Fetch a Route

Get a Route using ID or name.

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

ID of the Route to lookup

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

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

Responses

Response samples

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

Upsert a Route

Create or Update Route using ID or name.

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

ID of the Route to lookup

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

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

Request Body schema: application/json

Description of the Route

One of
created_at
integer or null

Unix epoch when the resource was created.

Array of objects or null

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

object or null

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

hosts
Array of strings or null

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

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

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

id
string or null
methods
Array of strings or null

A list of HTTP methods that match this Route.

name
string or null

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

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

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

paths
Array of strings or null

A list of paths that match this Route.

preserve_host
boolean or null
Default: false

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

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

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

regex_priority
integer or null
Default: 0

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

request_buffering
boolean or null
Default: true

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

response_buffering
boolean or null
Default: true

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

object or null

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

snis
Array of strings or null

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

Array of objects or null

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

strip_path
boolean or null
Default: true

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

tags
Array of strings

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

updated_at
integer or null

Unix epoch when the resource was last updated.

Responses

Request samples

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

Response samples

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

List all Routes associated with a Service

List all Routes associated with a Service

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

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

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

ID of the Service to lookup

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

Number of resources to be returned.

offset
string

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

tags
string
Example: tags=tag1,tag2

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

Responses

Response samples

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

Create a new Route associated with a Service

Create a new Route associated with a Service

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

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

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

ID of the Service to lookup

Request Body schema: application/json

Description of new Route for creation

One of
created_at
integer or null

Unix epoch when the resource was created.

Array of objects or null

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

object or null

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

hosts
Array of strings or null

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

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

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

id
string or null
methods
Array of strings or null

A list of HTTP methods that match this Route.

name
string or null

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

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

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

paths
Array of strings or null

A list of paths that match this Route.

preserve_host
boolean or null
Default: false

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

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

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

regex_priority
integer or null
Default: 0

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

request_buffering
boolean or null
Default: true

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

response_buffering
boolean or null
Default: true

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

object or null

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

snis
Array of strings or null

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

Array of objects or null

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

strip_path
boolean or null
Default: true

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

tags
Array of strings

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

updated_at
integer or null

Unix epoch when the resource was last updated.

Responses

Request samples

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

Response samples

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

Delete a a Route associated with a Service

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

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

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

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

ID of the Service to lookup

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

ID of the Route to lookup

Responses

Fetch a Route associated with a Service

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

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

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

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

ID of the Service to lookup

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

ID of the Route to lookup

Responses

Response samples

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

Upsert a Route associated with a Service

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

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

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

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

ID of the Service to lookup

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

ID of the Route to lookup

Request Body schema: application/json

Description of the Route

One of
created_at
integer or null

Unix epoch when the resource was created.

Array of objects or null

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

object or null

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

hosts
Array of strings or null

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

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

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

id
string or null
methods
Array of strings or null

A list of HTTP methods that match this Route.

name
string or null

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

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

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

paths
Array of strings or null

A list of paths that match this Route.

preserve_host
boolean or null
Default: false

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

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

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

regex_priority
integer or null
Default: 0

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

request_buffering
boolean or null
Default: true

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

response_buffering
boolean or null
Default: true

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

object or null

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

snis
Array of strings or null

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

Array of objects or null

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

strip_path
boolean or null
Default: true

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

tags
Array of strings

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

updated_at
integer or null

Unix epoch when the resource was last updated.

Responses

Request samples

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

Response samples

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

Plugins

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

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

Plugins can be both tagged and filtered by tags.

List all Plugins associated with a Consumer Group

List all Plugins associated with a Consumer Group

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

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

ConsumerGroupId
required
string

ID of the Consumer Group to lookup

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

Number of resources to be returned.

offset
string

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

tags
string
Example: tags=tag1,tag2

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

Responses

Response samples

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

Create a new Plugin associated with a Consumer Group

Create a new Plugin associated with a Consumer Group

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

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

ConsumerGroupId
required
string

ID of the Consumer Group to lookup

Request Body schema: application/json

Description of new Plugin for creation

object or null

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

object or null

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

object or null
created_at
integer or null

Unix epoch when the resource was created.

enabled
boolean or null
Default: true

Whether the plugin is applied.

id
string or null
instance_name
string or null
name
required
string

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

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

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

object or null

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

object or null

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

tags
Array of strings

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

updated_at
integer or null

Unix epoch when the resource was last updated.

Responses

Request samples

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

Response samples

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

Delete a a Plugin associated with a Consumer Group

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

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

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

ConsumerGroupId
required
string

ID of the Consumer Group to lookup

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

ID of the Plugin to lookup

Responses

Fetch a Plugin associated with a Consumer Group

Get a Plugin associated with a Consumer Group using ID.

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

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

ConsumerGroupId
required
string

ID of the Consumer Group to lookup

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

ID of the Plugin to lookup

Responses

Response samples

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

Upsert a Plugin associated with a Consumer Group

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

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

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

ConsumerGroupId
required
string

ID of the Consumer Group to lookup

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

ID of the Plugin to lookup

Request Body schema: application/json

Description of the Plugin

object or null

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

object or null

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

object or null
created_at
integer or null

Unix epoch when the resource was created.

enabled
boolean or null
Default: true

Whether the plugin is applied.

id
string or null
instance_name
string or null
name
required
string

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

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

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

object or null

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

object or null

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

tags
Array of strings

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

updated_at
integer or null

Unix epoch when the resource was last updated.

Responses

Request samples

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

Response samples

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

List all Plugins associated with a Consumer

List all Plugins associated with a Consumer

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

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

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

Consumer ID for nested entities

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

Number of resources to be returned.

offset
string

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

tags
string
Example: tags=tag1,tag2

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

Responses

Response samples

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

Create a new Plugin associated with a Consumer

Create a new Plugin associated with a Consumer

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

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

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

Consumer ID for nested entities

Request Body schema: application/json

Description of new Plugin for creation

object or null

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

object or null

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

object or null
created_at
integer or null

Unix epoch when the resource was created.

enabled
boolean or null
Default: true

Whether the plugin is applied.

id
string or null
instance_name
string or null
name
required
string

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

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

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

object or null

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

object or null

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

tags
Array of strings

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

updated_at
integer or null

Unix epoch when the resource was last updated.

Responses

Request samples

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

Response samples

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

Delete a a Plugin associated with a Consumer

Delete a a Plugin associated with a Consumer using ID.

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

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

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

Consumer ID for nested entities

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

ID of the Plugin to lookup

Responses

Fetch a Plugin associated with a Consumer

Get a Plugin associated with a Consumer using ID.

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

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

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

Consumer ID for nested entities

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

ID of the Plugin to lookup

Responses

Response samples

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

Upsert a Plugin associated with a Consumer

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

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

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

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

Consumer ID for nested entities

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

ID of the Plugin to lookup

Request Body schema: application/json

Description of the Plugin

object or null

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

object or null

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

object or null
created_at
integer or null

Unix epoch when the resource was created.

enabled
boolean or null
Default: true

Whether the plugin is applied.

id
string or null
instance_name
string or null
name
required
string

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

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

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

object or null

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

object or null

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

tags
Array of strings

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

updated_at
integer or null

Unix epoch when the resource was last updated.

Responses

Request samples

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

Response samples

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

List all Plugins

List all Plugins

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

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

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

Number of resources to be returned.

offset
string

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

tags
string
Example: tags=tag1,tag2

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

Responses

Response samples

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

Create a new Plugin

Create a new Plugin

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

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

Request Body schema: application/json

Description of the new Plugin for creation

object or null

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

object or null

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

object or null
created_at
integer or null

Unix epoch when the resource was created.

enabled
boolean or null
Default: true

Whether the plugin is applied.

id
string or null
instance_name
string or null
name
required
string

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

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

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

object or null

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

object or null

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

tags
Array of strings

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

updated_at
integer or null

Unix epoch when the resource was last updated.

Responses

Request samples

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

Response samples

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

Delete a Plugin

Delete a Plugin

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

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

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

ID of the Plugin to lookup

Responses

Response samples

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

Fetch a Plugin

Get a Plugin using ID.

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

ID of the Plugin to lookup

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

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

Responses

Response samples

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

Upsert a Plugin

Create or Update Plugin using ID.

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

ID of the Plugin to lookup

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

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

Request Body schema: application/json

Description of the Plugin

object or null

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

object or null

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

object or null
created_at
integer or null

Unix epoch when the resource was created.

enabled
boolean or null
Default: true

Whether the plugin is applied.

id
string or null
instance_name
string or null
name
required
string

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

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

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

object or null

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

object or null

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

tags
Array of strings

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

updated_at
integer or null

Unix epoch when the resource was last updated.

Responses

Request samples

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

Response samples

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

List all Plugins associated with a Route

List all Plugins associated with a Route

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

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

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

ID of the Route to lookup

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

Number of resources to be returned.

offset
string

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

tags
string
Example: tags=tag1,tag2

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

Responses

Response samples

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

Create a new Plugin associated with a Route

Create a new Plugin associated with a Route

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

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

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

ID of the Route to lookup

Request Body schema: application/json

Description of new Plugin for creation

object or null

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

object or null

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

object or null
created_at
integer or null

Unix epoch when the resource was created.

enabled
boolean or null
Default: true

Whether the plugin is applied.

id
string or null
instance_name
string or null
name
required
string

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

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

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

object or null

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

object or null

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

tags
Array of strings

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

updated_at
integer or null

Unix epoch when the resource was last updated.

Responses

Request samples

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

Response samples

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

Delete a a Plugin associated with a Route

Delete a a Plugin associated with a Route using ID.

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

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

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

ID of the Route to lookup

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

ID of the Plugin to lookup

Responses

Fetch a Plugin associated with a Route

Get a Plugin associated with a Route using ID.

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

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

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

ID of the Route to lookup

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

ID of the Plugin to lookup

Responses

Response samples

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

Upsert a Plugin associated with a Route

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

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

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

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

ID of the Route to lookup

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

ID of the Plugin to lookup

Request Body schema: application/json

Description of the Plugin

object or null

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

object or null

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

object or null
created_at
integer or null

Unix epoch when the resource was created.

enabled
boolean or null
Default: true

Whether the plugin is applied.

id
string or null
instance_name
string or null
name
required
string

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

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

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

object or null

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

object or null

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

tags
Array of strings

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

updated_at
integer or null

Unix epoch when the resource was last updated.

Responses

Request samples

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

Response samples

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

Fetch plugin schema

Get the schema for a plugin

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
pluginName
required
string

The name of the plugin

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

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

Responses

Response samples

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

List all Plugins associated with a Service

List all Plugins associated with a Service

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

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

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

ID of the Service to lookup

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

Number of resources to be returned.

offset
string

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

tags
string
Example: tags=tag1,tag2

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

Responses

Response samples

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

Create a new Plugin associated with a Service

Create a new Plugin associated with a Service

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

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

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

ID of the Service to lookup

Request Body schema: application/json

Description of new Plugin for creation

object or null

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

object or null

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

object or null
created_at
integer or null

Unix epoch when the resource was created.

enabled
boolean or null
Default: true

Whether the plugin is applied.

id
string or null
instance_name
string or null
name
required
string

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

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

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

object or null

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

object or null

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

tags
Array of strings

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

updated_at
integer or null

Unix epoch when the resource was last updated.

Responses

Request samples

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

Response samples

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

Delete a a Plugin associated with a Service

Delete a a Plugin associated with a Service using ID.

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

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

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

ID of the Service to lookup

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

ID of the Plugin to lookup

Responses

Fetch a Plugin associated with a Service

Get a Plugin associated with a Service using ID.

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

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

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

ID of the Service to lookup

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

ID of the Plugin to lookup

Responses

Response samples

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

Upsert a Plugin associated with a Service

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

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

The UUID of your control plane. This variable is available in the Konnect manager.

ServiceId
required
string
Example: 7fca84d6-7d37-4a74-a7b0-93e576089a41

ID of the Service to lookup

PluginId
required
string
Example: 3473c251-5b6c-4f45-b1ff-7ede735a366d

ID of the Plugin to lookup

Request Body schema: application/json

Description of the Plugin

object or null

The configuration properties for the Plugin which can be found on the plugins documentation page in the Kong Hub.

object or null

If set, the plugin will activate only for requests where the specified has been authenticated. (Note that some plugins can not be restricted to consumers this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer.

object or null
created_at
integer or null

Unix epoch when the resource was created.

enabled
boolean or null
Default: true

Whether the plugin is applied.

id
string or null
instance_name
string or null
name
required
string

The name of the Plugin that's going to be added. Currently, the Plugin must be installed in every Kong instance separately.

object or null
Array of objects or null
protocols
Array of strings or null
Default: ["grpc","grpcs","http","https"]
Enum: "grpc" "grpcs" "http" "https" "tcp" "tls" "tls_passthrough" "udp" "ws" "wss"

A list of the request protocols that will trigger this plugin. The default value, as well as the possible values allowed on this field, may change depending on the plugin type. For example, plugins that only work in stream mode will only support "tcp" and "tls".

object or null

If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the Route being used.

object or null

If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.

tags
Array of strings

An optional set of strings associated with the Plugin for grouping and filtering.

updated_at
integer or null

Unix epoch when the resource was last updated.

Responses

Request samples

Content type
application/json
{
  • "config": {
    },
  • "enabled": true,
  • "id": "3fd1eea1-885a-4011-b986-289943ff8177",
  • "name": "key-auth",
  • "partials": [
    ],
  • "protocols": [
    ]
}

Response samples

Content type
application/json
{
  • "config": {
    },
  • "enabled": true,
  • "id": "3fd1eea1-885a-4011-b986-289943ff8177",
  • "name": "key-auth",
  • "partials": [
    ],
  • "protocols": [
    ]
}

Consumers

The consumer object represents a consumer - or a user - of a service. You can either rely on Kong Gateway as the primary datastore, or you can map the consumer list with your database to keep consistency between Kong Gateway and your existing primary datastore.

List all Consumers

List all Consumers

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

query Parameters
size
integer [ 1 .. 1000 ]
Default: 100

Number of resources to be returned.

offset
string

Offset from which to return the next set of resources. Use the value of the 'offset' field from the response of a list operation as input here to paginate through all the resources

tags
string
Example: tags=tag1,tag2

A list of tags to filter the list of resources on. Multiple tags can be concatenated using ',' to mean AND or using '/' to mean OR.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "next": "string",
  • "offset": "string"
}

Create a new Consumer

Create a new Consumer

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

Request Body schema: application/json

Description of the new Consumer for creation

username
required
string or null

The unique username of the Consumer. You must send either this field or custom_id with the request.

custom_id
required
string or null

Field for storing an existing unique ID for the Consumer - useful for mapping Kong with users in your existing database. You must send either this field or username with the request.

type
required
string
tags
required
Array of strings (Tags) unique
consumer_groups
required
Array of strings (ConsumerGroups) [ items unique ]

Responses

Request samples

Content type
application/json
{
  • "custom_id": "4200",
  • "id": "8a388226-80e8-4027-a486-25e4f7db5d21",
  • "tags": [
    ],
  • "username": "bob-the-builder"
}

Response samples

Content type
application/json
{
  • "custom_id": "4200",
  • "id": "8a388226-80e8-4027-a486-25e4f7db5d21",
  • "tags": [
    ],
  • "username": "bob-the-builder"
}

Delete a Consumer

Delete a Consumer

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

ConsumerId
required
string
Example: c1059869-6fa7-4329-a5f5-5946d14ca2c5

ID of the Consumer to lookup

Responses

Response samples

Content type
application/json
Example
{
  • "message": "Duplicate API key found",
  • "status": 401
}

Fetch a Consumer

Get a Consumer using ID or username.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
ConsumerId
required
string
Example: c1059869-6fa7-4329-a5f5-5946d14ca2c5

ID of the Consumer to lookup

controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

Responses

Response samples

Content type
application/json
{
  • "custom_id": "4200",
  • "id": "8a388226-80e8-4027-a486-25e4f7db5d21",
  • "tags": [
    ],
  • "username": "bob-the-builder"
}

Upsert a Consumer

Create or Update Consumer using ID or username.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
ConsumerId
required
string
Example: c1059869-6fa7-4329-a5f5-5946d14ca2c5

ID of the Consumer to lookup

controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

Request Body schema: application/json

Description of the Consumer

username
required
string or null

The unique username of the Consumer. You must send either this field or custom_id with the request.

custom_id
required
string or null

Field for storing an existing unique ID for the Consumer - useful for mapping Kong with users in your existing database. You must send either this field or username with the request.

type
required
string
tags
required
Array of strings (Tags) unique
consumer_groups
required
Array of strings (ConsumerGroups) [ items unique ]

Responses

Request samples

Content type
application/json
{
  • "custom_id": "4200",
  • "id": "8a388226-80e8-4027-a486-25e4f7db5d21",
  • "tags": [
    ],
  • "username": "bob-the-builder"
}

Response samples

Content type
application/json
{
  • "custom_id": "4200",
  • "id": "8a388226-80e8-4027-a486-25e4f7db5d21",
  • "tags": [
    ],
  • "username": "bob-the-builder"
}

Consumer Groups

Consumer groups enable the organization and categorization of consumers (users or applications) within an API ecosystem. By grouping consumers together, you eliminate the need to manage them individually, providing a scalable, efficient approach to managing configurations.

List all Consumer Groups

List all Consumer Groups

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

query Parameters
size
integer [ 1 .. 1000 ]
Default: 100

Number of resources to be returned.

offset
string

Offset from which to return the next set of resources. Use the value of the 'offset' field from the response of a list operation as input here to paginate through all the resources

tags
string
Example: tags=tag1,tag2

A list of tags to filter the list of resources on. Multiple tags can be concatenated using ',' to mean AND or using '/' to mean OR.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "next": "string",
  • "offset": "string"
}

Create a new Consumer Group

Create a new Consumer Group

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

Request Body schema: application/json

Description of the new Consumer Group for creation

created_at
integer or null

Unix epoch when the resource was created.

id
string or null
name
required
string
tags
Array of strings
updated_at
integer or null

Unix epoch when the resource was last updated.

Responses

Request samples

Content type
application/json
{
  • "created_at": 0,
  • "id": "string",
  • "name": "string",
  • "tags": [
    ],
  • "updated_at": 0
}

Response samples

Content type
application/json
{
  • "created_at": 0,
  • "id": "string",
  • "name": "string",
  • "tags": [
    ],
  • "updated_at": 0
}

Delete a Consumer Group

Delete a Consumer Group

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

ConsumerGroupId
required
string

ID of the Consumer Group to lookup

Responses

Response samples

Content type
application/json
Example
{
  • "message": "Duplicate API key found",
  • "status": 401
}

Fetch a Consumer Group

Get a Consumer Group using ID.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
ConsumerGroupId
required
string

ID of the Consumer Group to lookup

controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

Responses

Response samples

Content type
application/json
{
  • "consumer_group": {
    }
}

Upsert a Consumer Group

Create or Update Consumer Group using ID.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
ConsumerGroupId
required
string

ID of the Consumer Group to lookup

controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

Request Body schema: application/json

Description of the Consumer Group

created_at
integer or null

Unix epoch when the resource was created.

id
string or null
name
required
string
tags
Array of strings
updated_at
integer or null

Unix epoch when the resource was last updated.

Responses

Request samples

Content type
application/json
{
  • "created_at": 0,
  • "id": "string",
  • "name": "string",
  • "tags": [
    ],
  • "updated_at": 0
}

Response samples

Content type
application/json
{
  • "created_at": 0,
  • "id": "string",
  • "name": "string",
  • "tags": [
    ],
  • "updated_at": 0
}

Remove consumers from consumer group

Pre-release Endpoint This endpoint is currently in beta and is subject to change.

Removes all consumers from a consumer groups. This operation does not delete the consumer group.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
ConsumerGroupId
required
string
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

Responses

List all Consumers in a Consumer Group

List all consumers in a consumer group

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
ConsumerGroupId
required
string
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

query Parameters
size
integer [ 1 .. 1000 ]
Default: 100

Number of resources to be returned.

offset
string

Offset from which to return the next set of resources. Use the value of the 'offset' field from the response of a list operation as input here to paginate through all the resources

tags
string
Example: tags=tag1,tag2

A list of tags to filter the list of resources on. Multiple tags can be concatenated using ',' to mean AND or using '/' to mean OR.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "next": "string",
  • "offset": "string"
}

Add consumer to consumer group

Add a consumer to a consumer group

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
ConsumerGroupId
required
string
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

Request Body schema: application/json
consumer
string

Responses

Request samples

Content type
application/json
{
  • "consumer": "cf4c7e60-11db-49dd-b300-7c7e5f0f7e6b"
}

Response samples

Content type
application/json
{
  • "consumer_group": {
    },
  • "consumers": [
    ]
}

Remove consumer from consumer group

Remove a consumer from a consumer group

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
ConsumerGroupId
required
string
ConsumerId
required
string
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

Responses

Remove consumer from consumer group

Removes a consumer from all consumer groups. This operation does not delete the consumer group.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

ConsumerId
required
string
Example: c1059869-6fa7-4329-a5f5-5946d14ca2c5

ID of the Consumer to lookup

Responses

List all Consumer Groups a Consumer belongs to

List all Consumer Groups a Consumer belongs to

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

ConsumerId
required
string
Example: c1059869-6fa7-4329-a5f5-5946d14ca2c5

ID of the Consumer to lookup

query Parameters
size
integer [ 1 .. 1000 ]
Default: 100

Number of resources to be returned.

offset
string

Offset from which to return the next set of resources. Use the value of the 'offset' field from the response of a list operation as input here to paginate through all the resources

tags
string
Example: tags=tag1,tag2

A list of tags to filter the list of resources on. Multiple tags can be concatenated using ',' to mean AND or using '/' to mean OR.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "next": "string",
  • "offset": "string"
}

Add consumer to a specific consumer group

Add a consumer to a consumer group

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

ConsumerId
required
string
Example: c1059869-6fa7-4329-a5f5-5946d14ca2c5

ID of the Consumer to lookup

Request Body schema: application/json
group
string

Responses

Request samples

Content type
application/json
{
  • "group": "fedee695-2ae2-4e45-877a-776d9b2fc793"
}

Response samples

Content type
application/json
{
  • "consumer": {
    },
  • "consumer_groups": [
    ]
}

Remove consumer from consumer group

Removes a consumer from a consumer group. This operation does not delete the consumer group.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

ConsumerId
required
string
Example: c1059869-6fa7-4329-a5f5-5946d14ca2c5

ID of the Consumer to lookup

ConsumerGroupId
required
string

ID of the Consumer Group to lookup

Responses

Certificates

A certificate object represents a public certificate, and can be optionally paired with the corresponding private key. These objects are used by Kong Gateway to handle SSL/TLS termination for encrypted requests, or for use as a trusted CA store when validating peer certificate of client/service.

Certificates are optionally associated with SNI objects to tie a cert/key pair to one or more hostnames.

If intermediate certificates are required in addition to the main certificate, they should be concatenated together into one string.

List all Certificates

List all Certificates

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

query Parameters
size
integer [ 1 .. 1000 ]
Default: 100

Number of resources to be returned.

offset
string

Offset from which to return the next set of resources. Use the value of the 'offset' field from the response of a list operation as input here to paginate through all the resources

tags
string
Example: tags=tag1,tag2

A list of tags to filter the list of resources on. Multiple tags can be concatenated using ',' to mean AND or using '/' to mean OR.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "next": "string",
  • "offset": "string"
}

Create a new Certificate

Create a new Certificate

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

Request Body schema: application/json

Description of the new Certificate for creation

cert
required
string

PEM-encoded public certificate chain of the SSL key pair. This field is referenceable, which means it can be securely stored as a secret in a vault. References must follow a specific format.

cert_alt
string or null

PEM-encoded public certificate chain of the alternate SSL key pair. This should only be set if you have both RSA and ECDSA types of certificate available and would like Kong to prefer serving using ECDSA certs when client advertises support for it. This field is referenceable, which means it can be securely stored as a secret in a vault. References must follow a specific format.

created_at
integer or null

Unix epoch when the resource was created.

id
string or null
key
required
string

PEM-encoded private key of the SSL key pair. This field is referenceable, which means it can be securely stored as a secret in a vault. References must follow a specific format.

key_alt
string or null

PEM-encoded private key of the alternate SSL key pair. This should only be set if you have both RSA and ECDSA types of certificate available and would like Kong to prefer serving using ECDSA certs when client advertises support for it. This field is referenceable, which means it can be securely stored as a secret in a vault. References must follow a specific format.

snis
Array of strings or null
tags
Array of strings

An optional set of strings associated with the Certificate for grouping and filtering.

updated_at
integer or null

Unix epoch when the resource was last updated.

Responses

Request samples

Content type
application/json
{
  • "cert": "-----BEGIN CERTIFICATE-----\ncertificate-content\n-----END CERTIFICATE-----",
  • "id": "b2f34145-0343-41a4-9602-4c69dec2f269",
  • "key": "-----BEGIN PRIVATE KEY-----\nprivate-key-content\n-----END PRIVATE KEY-----"
}

Response samples

Content type
application/json
{
  • "cert": "-----BEGIN CERTIFICATE-----\ncertificate-content\n-----END CERTIFICATE-----",
  • "id": "b2f34145-0343-41a4-9602-4c69dec2f269",
  • "key": "-----BEGIN PRIVATE KEY-----\nprivate-key-content\n-----END PRIVATE KEY-----"
}

Delete a Certificate

Delete a Certificate

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

CertificateId
required
string
Example: ddf3cdaa-3329-4961-822a-ce6dbd38eff7

ID of the Certificate to lookup

Responses

Response samples

Content type
application/json
Example
{
  • "message": "Duplicate API key found",
  • "status": 401
}

Fetch a Certificate

Get a Certificate using ID.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
CertificateId
required
string
Example: ddf3cdaa-3329-4961-822a-ce6dbd38eff7

ID of the Certificate to lookup

controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

Responses

Response samples

Content type
application/json
{
  • "cert": "-----BEGIN CERTIFICATE-----\ncertificate-content\n-----END CERTIFICATE-----",
  • "id": "b2f34145-0343-41a4-9602-4c69dec2f269",
  • "key": "-----BEGIN PRIVATE KEY-----\nprivate-key-content\n-----END PRIVATE KEY-----"
}

Upsert a Certificate

Create or Update Certificate using ID.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
CertificateId
required
string
Example: ddf3cdaa-3329-4961-822a-ce6dbd38eff7

ID of the Certificate to lookup

controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

Request Body schema: application/json

Description of the Certificate

cert
required
string

PEM-encoded public certificate chain of the SSL key pair. This field is referenceable, which means it can be securely stored as a secret in a vault. References must follow a specific format.

cert_alt
string or null

PEM-encoded public certificate chain of the alternate SSL key pair. This should only be set if you have both RSA and ECDSA types of certificate available and would like Kong to prefer serving using ECDSA certs when client advertises support for it. This field is referenceable, which means it can be securely stored as a secret in a vault. References must follow a specific format.

created_at
integer or null

Unix epoch when the resource was created.

id
string or null
key
required
string

PEM-encoded private key of the SSL key pair. This field is referenceable, which means it can be securely stored as a secret in a vault. References must follow a specific format.

key_alt
string or null

PEM-encoded private key of the alternate SSL key pair. This should only be set if you have both RSA and ECDSA types of certificate available and would like Kong to prefer serving using ECDSA certs when client advertises support for it. This field is referenceable, which means it can be securely stored as a secret in a vault. References must follow a specific format.

snis
Array of strings or null
tags
Array of strings

An optional set of strings associated with the Certificate for grouping and filtering.

updated_at
integer or null

Unix epoch when the resource was last updated.

Responses

Request samples

Content type
application/json
{
  • "cert": "-----BEGIN CERTIFICATE-----\ncertificate-content\n-----END CERTIFICATE-----",
  • "id": "b2f34145-0343-41a4-9602-4c69dec2f269",
  • "key": "-----BEGIN PRIVATE KEY-----\nprivate-key-content\n-----END PRIVATE KEY-----"
}

Response samples

Content type
application/json
{
  • "cert": "-----BEGIN CERTIFICATE-----\ncertificate-content\n-----END CERTIFICATE-----",
  • "id": "b2f34145-0343-41a4-9602-4c69dec2f269",
  • "key": "-----BEGIN PRIVATE KEY-----\nprivate-key-content\n-----END PRIVATE KEY-----"
}

SNIs

An SNI object represents a many-to-one mapping of hostnames to a certificate.

A certificate object can have many hostnames associated with it. When Kong Gateway receives an SSL request, it uses the SNI field in the Client Hello to look up the certificate object based on the SNI associated with the certificate.

List all SNIs associated with a Certificate

List all SNIs associated with a Certificate

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

CertificateId
required
string
Example: ddf3cdaa-3329-4961-822a-ce6dbd38eff7

ID of the Certificate to lookup

query Parameters
size
integer [ 1 .. 1000 ]
Default: 100

Number of resources to be returned.

offset
string

Offset from which to return the next set of resources. Use the value of the 'offset' field from the response of a list operation as input here to paginate through all the resources

tags
string
Example: tags=tag1,tag2

A list of tags to filter the list of resources on. Multiple tags can be concatenated using ',' to mean AND or using '/' to mean OR.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "next": "string",
  • "offset": "string"
}

Create a new SNI associated with a Certificate

Create a new SNI associated with a Certificate

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

CertificateId
required
string
Example: ddf3cdaa-3329-4961-822a-ce6dbd38eff7

ID of the Certificate to lookup

Request Body schema: application/json

Description of new SNI for creation

object

The id (a UUID) of the certificate with which to associate the SNI hostname. The Certificate must have a valid private key associated with it to be used by the SNI object.

created_at
integer or null

Unix epoch when the resource was created.

id
string or null
name
required
string

The SNI name to associate with the given certificate.

tags
Array of strings

An optional set of strings associated with the SNIs for grouping and filtering.

updated_at
integer or null

Unix epoch when the resource was last updated.

Responses

Request samples

Content type
application/json
{
  • "id": "36c4566c-14cc-4132-9011-4139fcbbe50a",
  • "name": "some.example.org"
}

Response samples

Content type
application/json
{
  • "certificate": {
    },
  • "id": "36c4566c-14cc-4132-9011-4139fcbbe50a",
  • "name": "some.example.org"
}

Delete a an SNI associated with a Certificate

Delete a an SNI associated with a Certificate using ID or name.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

CertificateId
required
string
Example: ddf3cdaa-3329-4961-822a-ce6dbd38eff7

ID of the Certificate to lookup

SNIId
required
string
Example: 64c17a1a-b7d7-4a65-a5a4-42e4a7016e7f

ID of the SNI to lookup

Responses

Fetch an SNI associated with a Certificate

Get an SNI associated with a Certificate using ID or name.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

CertificateId
required
string
Example: ddf3cdaa-3329-4961-822a-ce6dbd38eff7

ID of the Certificate to lookup

SNIId
required
string
Example: 64c17a1a-b7d7-4a65-a5a4-42e4a7016e7f

ID of the SNI to lookup

Responses

Response samples

Content type
application/json
{
  • "certificate": {
    },
  • "id": "36c4566c-14cc-4132-9011-4139fcbbe50a",
  • "name": "some.example.org"
}

Upsert an SNI associated with a Certificate

Create or Update an SNI associated with a Certificate using ID or name.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

CertificateId
required
string
Example: ddf3cdaa-3329-4961-822a-ce6dbd38eff7

ID of the Certificate to lookup

SNIId
required
string
Example: 64c17a1a-b7d7-4a65-a5a4-42e4a7016e7f

ID of the SNI to lookup

Request Body schema: application/json

Description of the SNI

object

The id (a UUID) of the certificate with which to associate the SNI hostname. The Certificate must have a valid private key associated with it to be used by the SNI object.

created_at
integer or null

Unix epoch when the resource was created.

id
string or null
name
required
string

The SNI name to associate with the given certificate.

tags
Array of strings

An optional set of strings associated with the SNIs for grouping and filtering.

updated_at
integer or null

Unix epoch when the resource was last updated.

Responses

Request samples

Content type
application/json
{
  • "id": "36c4566c-14cc-4132-9011-4139fcbbe50a",
  • "name": "some.example.org"
}

Response samples

Content type
application/json
{
  • "certificate": {
    },
  • "id": "36c4566c-14cc-4132-9011-4139fcbbe50a",
  • "name": "some.example.org"
}

List all SNIs

List all SNIs

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

query Parameters
size
integer [ 1 .. 1000 ]
Default: 100

Number of resources to be returned.

offset
string

Offset from which to return the next set of resources. Use the value of the 'offset' field from the response of a list operation as input here to paginate through all the resources

tags
string
Example: tags=tag1,tag2

A list of tags to filter the list of resources on. Multiple tags can be concatenated using ',' to mean AND or using '/' to mean OR.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "next": "string",
  • "offset": "string"
}

Create a new SNI

Create a new SNI

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

Request Body schema: application/json

Description of the new SNI for creation

required
object

The id (a UUID) of the certificate with which to associate the SNI hostname. The Certificate must have a valid private key associated with it to be used by the SNI object.

created_at
integer or null

Unix epoch when the resource was created.

id
string or null
name
required
string

The SNI name to associate with the given certificate.

tags
Array of strings

An optional set of strings associated with the SNIs for grouping and filtering.

updated_at
integer or null

Unix epoch when the resource was last updated.

Responses

Request samples

Content type
application/json
{
  • "certificate": {
    },
  • "id": "36c4566c-14cc-4132-9011-4139fcbbe50a",
  • "name": "some.example.org"
}

Response samples

Content type
application/json
{
  • "certificate": {
    },
  • "id": "36c4566c-14cc-4132-9011-4139fcbbe50a",
  • "name": "some.example.org"
}

Delete an SNI

Delete an SNI

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

SNIId
required
string
Example: 64c17a1a-b7d7-4a65-a5a4-42e4a7016e7f

ID of the SNI to lookup

Responses

Response samples

Content type
application/json
Example
{
  • "message": "Duplicate API key found",
  • "status": 401
}

Fetch an SNI

Get an SNI using ID or name.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
SNIId
required
string
Example: 64c17a1a-b7d7-4a65-a5a4-42e4a7016e7f

ID of the SNI to lookup

controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

Responses

Response samples

Content type
application/json
{
  • "certificate": {
    },
  • "id": "36c4566c-14cc-4132-9011-4139fcbbe50a",
  • "name": "some.example.org"
}

Upsert a SNI

Create or Update SNI using ID or name.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
SNIId
required
string
Example: 64c17a1a-b7d7-4a65-a5a4-42e4a7016e7f

ID of the SNI to lookup

controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

Request Body schema: application/json

Description of the SNI

required
object

The id (a UUID) of the certificate with which to associate the SNI hostname. The Certificate must have a valid private key associated with it to be used by the SNI object.

created_at
integer or null

Unix epoch when the resource was created.

id
string or null
name
required
string

The SNI name to associate with the given certificate.

tags
Array of strings

An optional set of strings associated with the SNIs for grouping and filtering.

updated_at
integer or null

Unix epoch when the resource was last updated.

Responses

Request samples

Content type
application/json
{
  • "certificate": {
    },
  • "id": "36c4566c-14cc-4132-9011-4139fcbbe50a",
  • "name": "some.example.org"
}

Response samples

Content type
application/json
{
  • "certificate": {
    },
  • "id": "36c4566c-14cc-4132-9011-4139fcbbe50a",
  • "name": "some.example.org"
}

CA Certificates

A CA certificate object represents a trusted certificate authority. These objects are used by Kong Gateway to verify the validity of a client or server certificate.

List all CA Certificates

List all CA Certificates

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

query Parameters
size
integer [ 1 .. 1000 ]
Default: 100

Number of resources to be returned.

offset
string

Offset from which to return the next set of resources. Use the value of the 'offset' field from the response of a list operation as input here to paginate through all the resources

tags
string
Example: tags=tag1,tag2

A list of tags to filter the list of resources on. Multiple tags can be concatenated using ',' to mean AND or using '/' to mean OR.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "next": "string",
  • "offset": "string"
}

Create a new CA Certificate

Create a new CA Certificate

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

Request Body schema: application/json

Description of the new CA Certificate for creation

cert
required
string

PEM-encoded public certificate of the CA.

cert_digest
string or null

SHA256 hex digest of the public certificate. This field is read-only and it cannot be set by the caller, the value is automatically computed.

created_at
integer or null

Unix epoch when the resource was created.

id
string or null
tags
Array of strings

An optional set of strings associated with the Certificate for grouping and filtering.

updated_at
integer or null

Unix epoch when the resource was last updated.

Responses

Request samples

Content type
application/json
{
  • "cert": "-----BEGIN CERTIFICATE-----\ncertificate-content\n-----END CERTIFICATE-----",
  • "id": "b2f34145-0343-41a4-9602-4c69dec2f260"
}

Response samples

Content type
application/json
{
  • "cert": "-----BEGIN CERTIFICATE-----\ncertificate-content\n-----END CERTIFICATE-----",
  • "id": "b2f34145-0343-41a4-9602-4c69dec2f260"
}

Delete a CA Certificate

Delete a CA Certificate

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

CACertificateId
required
string
Example: 3c31f18a-f27a-4f9b-8cd4-bf841554612f

ID of the CA Certificate to lookup

Responses

Response samples

Content type
application/json
Example
{
  • "message": "Duplicate API key found",
  • "status": 401
}

Fetch a CA Certificate

Get a CA Certificate using ID.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
CACertificateId
required
string
Example: 3c31f18a-f27a-4f9b-8cd4-bf841554612f

ID of the CA Certificate to lookup

controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

Responses

Response samples

Content type
application/json
{
  • "cert": "-----BEGIN CERTIFICATE-----\ncertificate-content\n-----END CERTIFICATE-----",
  • "id": "b2f34145-0343-41a4-9602-4c69dec2f260"
}

Upsert a CA Certificate

Create or Update CA Certificate using ID.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
CACertificateId
required
string
Example: 3c31f18a-f27a-4f9b-8cd4-bf841554612f

ID of the CA Certificate to lookup

controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

Request Body schema: application/json

Description of the CA Certificate

cert
required
string

PEM-encoded public certificate of the CA.

cert_digest
string or null

SHA256 hex digest of the public certificate. This field is read-only and it cannot be set by the caller, the value is automatically computed.

created_at
integer or null

Unix epoch when the resource was created.

id
string or null
tags
Array of strings

An optional set of strings associated with the Certificate for grouping and filtering.

updated_at
integer or null

Unix epoch when the resource was last updated.

Responses

Request samples

Content type
application/json
{
  • "cert": "-----BEGIN CERTIFICATE-----\ncertificate-content\n-----END CERTIFICATE-----",
  • "id": "b2f34145-0343-41a4-9602-4c69dec2f260"
}

Response samples

Content type
application/json
{
  • "cert": "-----BEGIN CERTIFICATE-----\ncertificate-content\n-----END CERTIFICATE-----",
  • "id": "b2f34145-0343-41a4-9602-4c69dec2f260"
}

Upstreams

The upstream object represents a virtual hostname and can be used to load balance incoming requests over multiple services (targets).

An upstream also includes a health checker, which can enable and disable targets based on their ability or inability to serve requests. The configuration for the health checker is stored in the upstream object, and applies to all of its targets.

List all Upstreams

List all Upstreams

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

query Parameters
size
integer [ 1 .. 1000 ]
Default: 100

Number of resources to be returned.

offset
string

Offset from which to return the next set of resources. Use the value of the 'offset' field from the response of a list operation as input here to paginate through all the resources

tags
string
Example: tags=tag1,tag2

A list of tags to filter the list of resources on. Multiple tags can be concatenated using ',' to mean AND or using '/' to mean OR.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "next": "string",
  • "offset": "string"
}

Create a new Upstream

Create a new Upstream

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

Request Body schema: application/json

Description of the new Upstream for creation

algorithm
string or null
Default: "round-robin"
Enum: "consistent-hashing" "least-connections" "round-robin" "latency"

Which load balancing algorithm to use.

object or null

If set, the certificate to be used as client certificate while TLS handshaking to the upstream server.

created_at
integer or null

Unix epoch when the resource was created.

hash_fallback
string or null
Default: "none"
Enum: "none" "consumer" "ip" "header" "cookie" "path" "query_arg" "uri_capture"

What to use as hashing input if the primary hash_on does not return a hash (eg. header is missing, or no Consumer identified). Not available if hash_on is set to cookie.

hash_fallback_header
string or null

The header name to take the value from as hash input. Only required when hash_fallback is set to header.

hash_fallback_query_arg
string or null

The name of the query string argument to take the value from as hash input. Only required when hash_fallback is set to query_arg.

hash_fallback_uri_capture
string or null

The name of the route URI capture to take the value from as hash input. Only required when hash_fallback is set to uri_capture.

hash_on
string or null
Default: "none"
Enum: "none" "consumer" "ip" "header" "cookie" "path" "query_arg" "uri_capture"

What to use as hashing input. Using none results in a weighted-round-robin scheme with no hashing.

hash_on_cookie
string or null

The cookie name to take the value from as hash input. Only required when hash_on or hash_fallback is set to cookie. If the specified cookie is not in the request, Kong will generate a value and set the cookie in the response.

hash_on_cookie_path
string or null
Default: "/"

The cookie path to set in the response headers. Only required when hash_on or hash_fallback is set to cookie.

hash_on_header
string or null

The header name to take the value from as hash input. Only required when hash_on is set to header.

hash_on_query_arg
string or null

The name of the query string argument to take the value from as hash input. Only required when hash_on is set to query_arg.

hash_on_uri_capture
string or null

The name of the route URI capture to take the value from as hash input. Only required when hash_on is set to uri_capture.

object or null
host_header
string or null

The hostname to be used as Host header when proxying requests through Kong.

id
string or null
name
required
string

This is a hostname, which must be equal to the host of a Service.

slots
integer or null
Default: 10000

The number of slots in the load balancer algorithm. If algorithm is set to round-robin, this setting determines the maximum number of slots. If algorithm is set to consistent-hashing, this setting determines the actual number of slots in the algorithm. Accepts an integer in the range 10-65536.

tags
Array of strings

An optional set of strings associated with the Upstream for grouping and filtering.

updated_at
integer or null

Unix epoch when the resource was last updated.

use_srv_name
boolean or null
Default: false

If set, the balancer will use SRV hostname(if DNS Answer has SRV record) as the proxy upstream Host.

Responses

Request samples

Content type
application/json
{
  • "algorithm": "round-robin",
  • "hash_fallback": "none",
  • "hash_on": "none",
  • "hash_on_cookie_path": "/",
  • "healthchecks": {
    },
  • "id": "6eed5e9c-5398-4026-9a4c-d48f18a2431e",
  • "name": "api.example.internal",
  • "slots": 10000
}

Response samples

Content type
application/json
{
  • "algorithm": "round-robin",
  • "hash_fallback": "none",
  • "hash_on": "none",
  • "hash_on_cookie_path": "/",
  • "healthchecks": {
    },
  • "id": "6eed5e9c-5398-4026-9a4c-d48f18a2431e",
  • "name": "api.example.internal",
  • "slots": 10000
}

Delete an Upstream

Delete an Upstream

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

UpstreamId
required
string
Example: 426d620c-7058-4ae6-aacc-f85a3204a2c5

ID of the Upstream to lookup

Responses

Response samples

Content type
application/json
Example
{
  • "message": "Duplicate API key found",
  • "status": 401
}

Fetch an Upstream

Get an Upstream using ID or name.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
UpstreamId
required
string
Example: 426d620c-7058-4ae6-aacc-f85a3204a2c5

ID of the Upstream to lookup

controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

Responses

Response samples

Content type
application/json
{
  • "algorithm": "round-robin",
  • "hash_fallback": "none",
  • "hash_on": "none",
  • "hash_on_cookie_path": "/",
  • "healthchecks": {
    },
  • "id": "6eed5e9c-5398-4026-9a4c-d48f18a2431e",
  • "name": "api.example.internal",
  • "slots": 10000
}

Upsert a Upstream

Create or Update Upstream using ID or name.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
UpstreamId
required
string
Example: 426d620c-7058-4ae6-aacc-f85a3204a2c5

ID of the Upstream to lookup

controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

Request Body schema: application/json

Description of the Upstream

algorithm
string or null
Default: "round-robin"
Enum: "consistent-hashing" "least-connections" "round-robin" "latency"

Which load balancing algorithm to use.

object or null

If set, the certificate to be used as client certificate while TLS handshaking to the upstream server.

created_at
integer or null

Unix epoch when the resource was created.

hash_fallback
string or null
Default: "none"
Enum: "none" "consumer" "ip" "header" "cookie" "path" "query_arg" "uri_capture"

What to use as hashing input if the primary hash_on does not return a hash (eg. header is missing, or no Consumer identified). Not available if hash_on is set to cookie.

hash_fallback_header
string or null

The header name to take the value from as hash input. Only required when hash_fallback is set to header.

hash_fallback_query_arg
string or null

The name of the query string argument to take the value from as hash input. Only required when hash_fallback is set to query_arg.

hash_fallback_uri_capture
string or null

The name of the route URI capture to take the value from as hash input. Only required when hash_fallback is set to uri_capture.

hash_on
string or null
Default: "none"
Enum: "none" "consumer" "ip" "header" "cookie" "path" "query_arg" "uri_capture"

What to use as hashing input. Using none results in a weighted-round-robin scheme with no hashing.

hash_on_cookie
string or null

The cookie name to take the value from as hash input. Only required when hash_on or hash_fallback is set to cookie. If the specified cookie is not in the request, Kong will generate a value and set the cookie in the response.

hash_on_cookie_path
string or null
Default: "/"

The cookie path to set in the response headers. Only required when hash_on or hash_fallback is set to cookie.

hash_on_header
string or null

The header name to take the value from as hash input. Only required when hash_on is set to header.

hash_on_query_arg
string or null

The name of the query string argument to take the value from as hash input. Only required when hash_on is set to query_arg.

hash_on_uri_capture
string or null

The name of the route URI capture to take the value from as hash input. Only required when hash_on is set to uri_capture.

object or null
host_header
string or null

The hostname to be used as Host header when proxying requests through Kong.

id
string or null
name
required
string

This is a hostname, which must be equal to the host of a Service.

slots
integer or null
Default: 10000

The number of slots in the load balancer algorithm. If algorithm is set to round-robin, this setting determines the maximum number of slots. If algorithm is set to consistent-hashing, this setting determines the actual number of slots in the algorithm. Accepts an integer in the range 10-65536.

tags
Array of strings

An optional set of strings associated with the Upstream for grouping and filtering.

updated_at
integer or null

Unix epoch when the resource was last updated.

use_srv_name
boolean or null
Default: false

If set, the balancer will use SRV hostname(if DNS Answer has SRV record) as the proxy upstream Host.

Responses

Request samples

Content type
application/json
{
  • "algorithm": "round-robin",
  • "hash_fallback": "none",
  • "hash_on": "none",
  • "hash_on_cookie_path": "/",
  • "healthchecks": {
    },
  • "id": "6eed5e9c-5398-4026-9a4c-d48f18a2431e",
  • "name": "api.example.internal",
  • "slots": 10000
}

Response samples

Content type
application/json
{
  • "algorithm": "round-robin",
  • "hash_fallback": "none",
  • "hash_on": "none",
  • "hash_on_cookie_path": "/",
  • "healthchecks": {
    },
  • "id": "6eed5e9c-5398-4026-9a4c-d48f18a2431e",
  • "name": "api.example.internal",
  • "slots": 10000
}

Vaults

Vault objects are used to configure different vault connectors for managing secrets. Configuring a vault lets you reference secrets from other entities. This allows for a proper separation of secrets and configuration and prevents secret sprawl.

For example, you could store a certificate and a key in a vault, then reference them from a certificate entity. This way, the certificate and key are not stored in the entity directly and are more secure.

Secrets rotation can be managed using TTLs.

List all Vaults

List all Vaults

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

query Parameters
size
integer [ 1 .. 1000 ]
Default: 100

Number of resources to be returned.

offset
string

Offset from which to return the next set of resources. Use the value of the 'offset' field from the response of a list operation as input here to paginate through all the resources

tags
string
Example: tags=tag1,tag2

A list of tags to filter the list of resources on. Multiple tags can be concatenated using ',' to mean AND or using '/' to mean OR.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "next": "string",
  • "offset": "string"
}

Create a new Vault

Create a new Vault

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

Request Body schema: application/json

Description of the new Vault for creation

required
object

The configuration properties for the Vault which can be found on the vaults' documentation page.

created_at
integer or null

Unix epoch when the resource was created.

description
string or null

The description of the Vault entity.

id
string or null
name
required
string

The name of the Vault that's going to be added. Currently, the Vault implementation must be installed in every Kong instance.

prefix
required
string

The unique prefix (or identifier) for this Vault configuration. The prefix is used to load the right Vault configuration and implementation when referencing secrets with the other entities.

tags
Array of strings

An optional set of strings associated with the Vault for grouping and filtering.

updated_at
integer or null

Unix epoch when the resource was last updated.

Responses

Request samples

Content type
application/json
{
  • "config": {
    },
  • "description": "environment variable based vault",
  • "id": "2747d1e5-8246-4f65-a939-b392f1ee17f8",
  • "name": "env",
  • "prefix": "env",
  • "tags": [
    ]
}

Response samples

Content type
application/json
{
  • "config": {
    },
  • "description": "environment variable based vault",
  • "id": "2747d1e5-8246-4f65-a939-b392f1ee17f8",
  • "name": "env",
  • "prefix": "env",
  • "tags": [
    ]
}

Delete a Vault

Delete a Vault

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

VaultId
required
string
Example: 9d4d6d19-77c6-428e-a965-9bc9647633e9

ID of the Vault to lookup

Responses

Response samples

Content type
application/json
Example
{
  • "message": "Duplicate API key found",
  • "status": 401
}

Fetch a Vault

Get a Vault using ID or prefix.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
VaultId
required
string
Example: 9d4d6d19-77c6-428e-a965-9bc9647633e9

ID of the Vault to lookup

controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

Responses

Response samples

Content type
application/json
{
  • "config": {
    },
  • "description": "environment variable based vault",
  • "id": "2747d1e5-8246-4f65-a939-b392f1ee17f8",
  • "name": "env",
  • "prefix": "env",
  • "tags": [
    ]
}

Upsert a Vault

Create or Update Vault using ID or prefix.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
VaultId
required
string
Example: 9d4d6d19-77c6-428e-a965-9bc9647633e9

ID of the Vault to lookup

controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

Request Body schema: application/json

Description of the Vault

required
object

The configuration properties for the Vault which can be found on the vaults' documentation page.

created_at
integer or null

Unix epoch when the resource was created.

description
string or null

The description of the Vault entity.

id
string or null
name
required
string

The name of the Vault that's going to be added. Currently, the Vault implementation must be installed in every Kong instance.

prefix
required
string

The unique prefix (or identifier) for this Vault configuration. The prefix is used to load the right Vault configuration and implementation when referencing secrets with the other entities.

tags
Array of strings

An optional set of strings associated with the Vault for grouping and filtering.

updated_at
integer or null

Unix epoch when the resource was last updated.

Responses

Request samples

Content type
application/json
{
  • "config": {
    },
  • "description": "environment variable based vault",
  • "id": "2747d1e5-8246-4f65-a939-b392f1ee17f8",
  • "name": "env",
  • "prefix": "env",
  • "tags": [
    ]
}

Response samples

Content type
application/json
{
  • "config": {
    },
  • "description": "environment variable based vault",
  • "id": "2747d1e5-8246-4f65-a939-b392f1ee17f8",
  • "name": "env",
  • "prefix": "env",
  • "tags": [
    ]
}

Keys

A key object holds a representation of asymmetric keys in various formats. When Kong Gateway or a Kong plugin requires a specific public or private key to perform certain operations, it can use this entity.

List all Keys associated with a KeySet

List all Keys associated with a KeySet

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

KeySetId
required
string
Example: 6cc34248-50b4-4a81-9201-3bdf7a83f712

ID of the KeySet to lookup

query Parameters
size
integer [ 1 .. 1000 ]
Default: 100

Number of resources to be returned.

offset
string

Offset from which to return the next set of resources. Use the value of the 'offset' field from the response of a list operation as input here to paginate through all the resources

tags
string
Example: tags=tag1,tag2

A list of tags to filter the list of resources on. Multiple tags can be concatenated using ',' to mean AND or using '/' to mean OR.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "next": "string",
  • "offset": "string"
}

Create a new Key associated with a KeySet

Create a new Key associated with a KeySet

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

KeySetId
required
string
Example: 6cc34248-50b4-4a81-9201-3bdf7a83f712

ID of the KeySet to lookup

Request Body schema: application/json

Description of new Key for creation

created_at
integer or null

Unix epoch when the resource was created.

id
string or null
jwk
string or null

A JSON Web Key represented as a string.

kid
required
string

A unique identifier for a key.

name
string or null

The name to associate with the given keys.

object or null

A keypair in PEM format.

object or null

The id (an UUID) of the key-set with which to associate the key.

tags
Array of strings

An optional set of strings associated with the Key for grouping and filtering.

updated_at
integer or null

Unix epoch when the resource was last updated.

x5t
string or null

Responses

Request samples

Content type
application/json
{
  • "id": "d958f66b-8e99-44d2-b0b4-edd5bbf24658",
  • "jwk": "{\"alg\":\"RSA\", \"kid\": \"42\", ...}",
  • "kid": "42",
  • "name": "a-key",
  • "pem": {
    },
  • "set": {
    }
}

Response samples

Content type
application/json
{
  • "id": "d958f66b-8e99-44d2-b0b4-edd5bbf24658",
  • "jwk": "{\"alg\":\"RSA\", \"kid\": \"42\", ...}",
  • "kid": "42",
  • "name": "a-key",
  • "pem": {
    },
  • "set": {
    }
}

Delete a a Key associated with a KeySet

Delete a a Key associated with a KeySet using ID or name.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

KeySetId
required
string
Example: 6cc34248-50b4-4a81-9201-3bdf7a83f712

ID of the KeySet to lookup

KeyId
required
string
Example: bba22c06-a632-42be-a018-1b9ff357b5b9

ID of the Key to lookup

Responses

Fetch a Key associated with a KeySet

Get a Key associated with a KeySet using ID or name.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

KeySetId
required
string
Example: 6cc34248-50b4-4a81-9201-3bdf7a83f712

ID of the KeySet to lookup

KeyId
required
string
Example: bba22c06-a632-42be-a018-1b9ff357b5b9

ID of the Key to lookup

Responses

Response samples

Content type
application/json
{
  • "id": "d958f66b-8e99-44d2-b0b4-edd5bbf24658",
  • "jwk": "{\"alg\":\"RSA\", \"kid\": \"42\", ...}",
  • "kid": "42",
  • "name": "a-key",
  • "pem": {
    },
  • "set": {
    }
}

Upsert a Key associated with a KeySet

Create or Update a Key associated with a KeySet using ID or name.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

KeySetId
required
string
Example: 6cc34248-50b4-4a81-9201-3bdf7a83f712

ID of the KeySet to lookup

KeyId
required
string
Example: bba22c06-a632-42be-a018-1b9ff357b5b9

ID of the Key to lookup

Request Body schema: application/json

Description of the Key

created_at
integer or null

Unix epoch when the resource was created.

id
string or null
jwk
string or null

A JSON Web Key represented as a string.

kid
required
string

A unique identifier for a key.

name
string or null

The name to associate with the given keys.

object or null

A keypair in PEM format.

object or null

The id (an UUID) of the key-set with which to associate the key.

tags
Array of strings

An optional set of strings associated with the Key for grouping and filtering.

updated_at
integer or null

Unix epoch when the resource was last updated.

x5t
string or null

Responses

Request samples

Content type
application/json
{
  • "id": "d958f66b-8e99-44d2-b0b4-edd5bbf24658",
  • "jwk": "{\"alg\":\"RSA\", \"kid\": \"42\", ...}",
  • "kid": "42",
  • "name": "a-key",
  • "pem": {
    },
  • "set": {
    }
}

Response samples

Content type
application/json
{
  • "id": "d958f66b-8e99-44d2-b0b4-edd5bbf24658",
  • "jwk": "{\"alg\":\"RSA\", \"kid\": \"42\", ...}",
  • "kid": "42",
  • "name": "a-key",
  • "pem": {
    },
  • "set": {
    }
}

List all Keys

List all Keys

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

query Parameters
size
integer [ 1 .. 1000 ]
Default: 100

Number of resources to be returned.

offset
string

Offset from which to return the next set of resources. Use the value of the 'offset' field from the response of a list operation as input here to paginate through all the resources

tags
string
Example: tags=tag1,tag2

A list of tags to filter the list of resources on. Multiple tags can be concatenated using ',' to mean AND or using '/' to mean OR.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "next": "string",
  • "offset": "string"
}

Create a new Key

Create a new Key

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

Request Body schema: application/json

Description of the new Key for creation

created_at
integer or null

Unix epoch when the resource was created.

id
string or null
jwk
string or null

A JSON Web Key represented as a string.

kid
required
string

A unique identifier for a key.

name
string or null

The name to associate with the given keys.

object or null

A keypair in PEM format.

object or null

The id (an UUID) of the key-set with which to associate the key.

tags
Array of strings

An optional set of strings associated with the Key for grouping and filtering.

updated_at
integer or null

Unix epoch when the resource was last updated.

x5t
string or null

Responses

Request samples

Content type
application/json
{
  • "id": "d958f66b-8e99-44d2-b0b4-edd5bbf24658",
  • "jwk": "{\"alg\":\"RSA\", \"kid\": \"42\", ...}",
  • "kid": "42",
  • "name": "a-key",
  • "pem": {
    },
  • "set": {
    }
}

Response samples

Content type
application/json
{
  • "id": "d958f66b-8e99-44d2-b0b4-edd5bbf24658",
  • "jwk": "{\"alg\":\"RSA\", \"kid\": \"42\", ...}",
  • "kid": "42",
  • "name": "a-key",
  • "pem": {
    },
  • "set": {
    }
}

Delete a Key

Delete a Key

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

KeyId
required
string
Example: bba22c06-a632-42be-a018-1b9ff357b5b9

ID of the Key to lookup

Responses

Response samples

Content type
application/json
Example
{
  • "message": "Duplicate API key found",
  • "status": 401
}

Fetch a Key

Get a Key using ID or name.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
KeyId
required
string
Example: bba22c06-a632-42be-a018-1b9ff357b5b9

ID of the Key to lookup

controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

Responses

Response samples

Content type
application/json
{
  • "id": "d958f66b-8e99-44d2-b0b4-edd5bbf24658",
  • "jwk": "{\"alg\":\"RSA\", \"kid\": \"42\", ...}",
  • "kid": "42",
  • "name": "a-key",
  • "pem": {
    },
  • "set": {
    }
}

Upsert a Key

Create or Update Key using ID or name.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
KeyId
required
string
Example: bba22c06-a632-42be-a018-1b9ff357b5b9

ID of the Key to lookup

controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

Request Body schema: application/json

Description of the Key

created_at
integer or null

Unix epoch when the resource was created.

id
string or null
jwk
string or null

A JSON Web Key represented as a string.

kid
required
string

A unique identifier for a key.

name
string or null

The name to associate with the given keys.

object or null

A keypair in PEM format.

object or null

The id (an UUID) of the key-set with which to associate the key.

tags
Array of strings

An optional set of strings associated with the Key for grouping and filtering.

updated_at
integer or null

Unix epoch when the resource was last updated.

x5t
string or null

Responses

Request samples

Content type
application/json
{
  • "id": "d958f66b-8e99-44d2-b0b4-edd5bbf24658",
  • "jwk": "{\"alg\":\"RSA\", \"kid\": \"42\", ...}",
  • "kid": "42",
  • "name": "a-key",
  • "pem": {
    },
  • "set": {
    }
}

Response samples

Content type
application/json
{
  • "id": "d958f66b-8e99-44d2-b0b4-edd5bbf24658",
  • "jwk": "{\"alg\":\"RSA\", \"kid\": \"42\", ...}",
  • "kid": "42",
  • "name": "a-key",
  • "pem": {
    },
  • "set": {
    }
}

KeySets

A JSON Web key set. Key sets are the preferred way to expose keys to plugins because they tell the plugin where to look for keys or have a scoping mechanism to restrict plugins to specific keys.

List all KeySets

List all KeySets

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

query Parameters
size
integer [ 1 .. 1000 ]
Default: 100

Number of resources to be returned.

offset
string

Offset from which to return the next set of resources. Use the value of the 'offset' field from the response of a list operation as input here to paginate through all the resources

tags
string
Example: tags=tag1,tag2

A list of tags to filter the list of resources on. Multiple tags can be concatenated using ',' to mean AND or using '/' to mean OR.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "next": "string",
  • "offset": "string"
}

Create a new KeySet

Create a new KeySet

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

Request Body schema: application/json

Description of the new KeySet for creation

created_at
integer or null

Unix epoch when the resource was created.

id
string or null
name
string or null
tags
Array of strings
updated_at
integer or null

Unix epoch when the resource was last updated.

Responses

Request samples

Content type
application/json
{
  • "id": "b58c7d9d-e54f-444c-b24d-cdfc4159f61e",
  • "name": "example-key-set",
  • "tags": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "b58c7d9d-e54f-444c-b24d-cdfc4159f61e",
  • "name": "example-key-set",
  • "tags": [
    ]
}

Delete a KeySet

Delete a KeySet

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

KeySetId
required
string
Example: 6cc34248-50b4-4a81-9201-3bdf7a83f712

ID of the KeySet to lookup

Responses

Response samples

Content type
application/json
Example
{
  • "message": "Duplicate API key found",
  • "status": 401
}

Fetch a KeySet

Get a KeySet using ID or name.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
KeySetId
required
string
Example: 6cc34248-50b4-4a81-9201-3bdf7a83f712

ID of the KeySet to lookup

controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

Responses

Response samples

Content type
application/json
{
  • "id": "b58c7d9d-e54f-444c-b24d-cdfc4159f61e",
  • "name": "example-key-set",
  • "tags": [
    ]
}

Upsert a KeySet

Create or Update KeySet using ID or name.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
KeySetId
required
string
Example: 6cc34248-50b4-4a81-9201-3bdf7a83f712

ID of the KeySet to lookup

controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

Request Body schema: application/json

Description of the KeySet

created_at
integer or null

Unix epoch when the resource was created.

id
string or null
name
string or null
tags
Array of strings
updated_at
integer or null

Unix epoch when the resource was last updated.

Responses

Request samples

Content type
application/json
{
  • "id": "b58c7d9d-e54f-444c-b24d-cdfc4159f61e",
  • "name": "example-key-set",
  • "tags": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "b58c7d9d-e54f-444c-b24d-cdfc4159f61e",
  • "name": "example-key-set",
  • "tags": [
    ]
}

API-keys

List all API-keys associated with a Consumer

List all API-keys associated with a Consumer

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

ConsumerIdForNestedEntities
required
string
Example: f28acbfa-c866-4587-b688-0208ac24df21

Consumer ID for nested entities

query Parameters
size
integer [ 1 .. 1000 ]
Default: 100

Number of resources to be returned.

offset
string

Offset from which to return the next set of resources. Use the value of the 'offset' field from the response of a list operation as input here to paginate through all the resources

tags
string
Example: tags=tag1,tag2

A list of tags to filter the list of resources on. Multiple tags can be concatenated using ',' to mean AND or using '/' to mean OR.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "next": "string",
  • "offset": "string"
}

Create a new API-key associated with a Consumer

Create a new API-key associated with a Consumer

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

ConsumerIdForNestedEntities
required
string
Example: f28acbfa-c866-4587-b688-0208ac24df21

Consumer ID for nested entities

Request Body schema: application/json

Description of new API-key for creation

object or null
created_at
integer or null

Unix epoch when the resource was created.

id
string or null
key
required
string
tags
Array of strings

Responses

Request samples

Content type
application/json
{
  • "id": "b2f34145-0343-41a4-9602-4c69dec2f269",
  • "key": "IL1deIyHyQA40WpeLeA1bIUXuvTwlGjo"
}

Response samples

Content type
application/json
{
  • "consumer": {
    },
  • "id": "b2f34145-0343-41a4-9602-4c69dec2f269",
  • "key": "IL1deIyHyQA40WpeLeA1bIUXuvTwlGjo"
}

Delete a an API-key associated with a Consumer

Delete a an API-key associated with a Consumer using ID.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

ConsumerIdForNestedEntities
required
string
Example: f28acbfa-c866-4587-b688-0208ac24df21

Consumer ID for nested entities

KeyAuthId
required
string

ID of the API-key to lookup

Responses

Fetch an API-key associated with a Consumer

Get an API-key associated with a Consumer using ID.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

ConsumerIdForNestedEntities
required
string
Example: f28acbfa-c866-4587-b688-0208ac24df21

Consumer ID for nested entities

KeyAuthId
required
string

ID of the API-key to lookup

Responses

Response samples

Content type
application/json
{
  • "consumer": {
    },
  • "id": "b2f34145-0343-41a4-9602-4c69dec2f269",
  • "key": "IL1deIyHyQA40WpeLeA1bIUXuvTwlGjo"
}

Upsert an API-key associated with a Consumer

Create or Update an API-key associated with a Consumer using ID.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

ConsumerIdForNestedEntities
required
string
Example: f28acbfa-c866-4587-b688-0208ac24df21

Consumer ID for nested entities

KeyAuthId
required
string

ID of the API-key to lookup

Request Body schema: application/json

Description of the API-key

object or null
created_at
integer or null

Unix epoch when the resource was created.

id
string or null
key
required
string
tags
Array of strings

Responses

Request samples

Content type
application/json
{
  • "id": "b2f34145-0343-41a4-9602-4c69dec2f269",
  • "key": "IL1deIyHyQA40WpeLeA1bIUXuvTwlGjo"
}

Response samples

Content type
application/json
{
  • "consumer": {
    },
  • "id": "b2f34145-0343-41a4-9602-4c69dec2f269",
  • "key": "IL1deIyHyQA40WpeLeA1bIUXuvTwlGjo"
}

List all API-keys

List all API-keys

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

query Parameters
size
integer [ 1 .. 1000 ]
Default: 100

Number of resources to be returned.

offset
string

Offset from which to return the next set of resources. Use the value of the 'offset' field from the response of a list operation as input here to paginate through all the resources

tags
string
Example: tags=tag1,tag2

A list of tags to filter the list of resources on. Multiple tags can be concatenated using ',' to mean AND or using '/' to mean OR.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "next": "string",
  • "offset": "string"
}

Fetch an API-key

Get an API-key using ID.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
KeyAuthId
required
string

ID of the API-key to lookup

controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

Responses

Response samples

Content type
application/json
{
  • "consumer": {
    },
  • "id": "b2f34145-0343-41a4-9602-4c69dec2f269",
  • "key": "IL1deIyHyQA40WpeLeA1bIUXuvTwlGjo"
}

Basic-auth credentials

List all Basic-auth credentials

List all Basic-auth credentials

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

query Parameters
size
integer [ 1 .. 1000 ]
Default: 100

Number of resources to be returned.

offset
string

Offset from which to return the next set of resources. Use the value of the 'offset' field from the response of a list operation as input here to paginate through all the resources

tags
string
Example: tags=tag1,tag2

A list of tags to filter the list of resources on. Multiple tags can be concatenated using ',' to mean AND or using '/' to mean OR.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "next": "string",
  • "offset": "string"
}

Fetch a Basic-auth credential

Get a Basic-auth credential using ID.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
BasicAuthId
required
string
Example: 80db1b58-ca7c-4d21-b92a-64eb07725872

ID of the Basic-auth credential to lookup

controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

Responses

Response samples

Content type
application/json
{
  • "consumer": {
    },
  • "id": "b2f34145-0343-41a4-9602-4c69dec2f269",
  • "password": "hashedsoopersecretvalue",
  • "username": "darius"
}

List all Basic-auth credentials associated with a Consumer

List all Basic-auth credentials associated with a Consumer

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

ConsumerIdForNestedEntities
required
string
Example: f28acbfa-c866-4587-b688-0208ac24df21

Consumer ID for nested entities

query Parameters
size
integer [ 1 .. 1000 ]
Default: 100

Number of resources to be returned.

offset
string

Offset from which to return the next set of resources. Use the value of the 'offset' field from the response of a list operation as input here to paginate through all the resources

tags
string
Example: tags=tag1,tag2

A list of tags to filter the list of resources on. Multiple tags can be concatenated using ',' to mean AND or using '/' to mean OR.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "next": "string",
  • "offset": "string"
}

Create a new Basic-auth credential associated with a Consumer

Create a new Basic-auth credential associated with a Consumer

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

ConsumerIdForNestedEntities
required
string
Example: f28acbfa-c866-4587-b688-0208ac24df21

Consumer ID for nested entities

Request Body schema: application/json

Description of new Basic-auth credential for creation

object or null
created_at
integer or null

Unix epoch when the resource was created.

id
string or null
password
required
string
tags
Array of strings
username
required
string

Responses

Request samples

Content type
application/json
{
  • "id": "b2f34145-0343-41a4-9602-4c69dec2f269",
  • "password": "hashedsoopersecretvalue",
  • "username": "darius"
}

Response samples

Content type
application/json
{
  • "consumer": {
    },
  • "id": "b2f34145-0343-41a4-9602-4c69dec2f269",
  • "password": "hashedsoopersecretvalue",
  • "username": "darius"
}

Delete a a Basic-auth credential associated with a Consumer

Delete a a Basic-auth credential associated with a Consumer using ID.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

ConsumerIdForNestedEntities
required
string
Example: f28acbfa-c866-4587-b688-0208ac24df21

Consumer ID for nested entities

BasicAuthId
required
string
Example: 80db1b58-ca7c-4d21-b92a-64eb07725872

ID of the Basic-auth credential to lookup

Responses

Fetch a Basic-auth credential associated with a Consumer

Get a Basic-auth credential associated with a Consumer using ID.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

ConsumerIdForNestedEntities
required
string
Example: f28acbfa-c866-4587-b688-0208ac24df21

Consumer ID for nested entities

BasicAuthId
required
string
Example: 80db1b58-ca7c-4d21-b92a-64eb07725872

ID of the Basic-auth credential to lookup

Responses

Response samples

Content type
application/json
{
  • "consumer": {
    },
  • "id": "b2f34145-0343-41a4-9602-4c69dec2f269",
  • "password": "hashedsoopersecretvalue",
  • "username": "darius"
}

Upsert a Basic-auth credential associated with a Consumer

Create or Update a Basic-auth credential associated with a Consumer using ID.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

ConsumerIdForNestedEntities
required
string
Example: f28acbfa-c866-4587-b688-0208ac24df21

Consumer ID for nested entities

BasicAuthId
required
string
Example: 80db1b58-ca7c-4d21-b92a-64eb07725872

ID of the Basic-auth credential to lookup

Request Body schema: application/json

Description of the Basic-auth credential

object or null
created_at
integer or null

Unix epoch when the resource was created.

id
string or null
password
required
string
tags
Array of strings
username
required
string

Responses

Request samples

Content type
application/json
{
  • "id": "b2f34145-0343-41a4-9602-4c69dec2f269",
  • "password": "hashedsoopersecretvalue",
  • "username": "darius"
}

Response samples

Content type
application/json
{
  • "consumer": {
    },
  • "id": "b2f34145-0343-41a4-9602-4c69dec2f269",
  • "password": "hashedsoopersecretvalue",
  • "username": "darius"
}

JWTs

List all JWTs associated with a Consumer

List all JWTs associated with a Consumer

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

ConsumerIdForNestedEntities
required
string
Example: f28acbfa-c866-4587-b688-0208ac24df21

Consumer ID for nested entities

query Parameters
size
integer [ 1 .. 1000 ]
Default: 100

Number of resources to be returned.

offset
string

Offset from which to return the next set of resources. Use the value of the 'offset' field from the response of a list operation as input here to paginate through all the resources

tags
string
Example: tags=tag1,tag2

A list of tags to filter the list of resources on. Multiple tags can be concatenated using ',' to mean AND or using '/' to mean OR.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "next": "string",
  • "offset": "string"
}

Create a new JWT associated with a Consumer

Create a new JWT associated with a Consumer

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

ConsumerIdForNestedEntities
required
string
Example: f28acbfa-c866-4587-b688-0208ac24df21

Consumer ID for nested entities

Request Body schema: application/json

Description of new JWT for creation

algorithm
string or null
Default: "HS256"
Enum: "HS256" "HS384" "HS512" "RS256" "RS384" "RS512" "ES256" "ES384" "ES512" "PS256" "PS384" "PS512" "EdDSA"
object or null
created_at
integer or null

Unix epoch when the resource was created.

id
string or null
key
string or null
rsa_public_key
string or null
secret
string or null
tags
Array of strings

Responses

Request samples

Content type
application/json
{
  • "algorithm": "HS256",
  • "id": "75695322-e8a0-4109-aed4-5416b0308d85",
  • "key": "YJdmaDvVTJxtcWRCvkMikc8oELgAVNcz",
  • "secret": "C50k0bcahDhLNhLKSUBSR1OMiFGzNZ7X"
}

Response samples

Content type
application/json
{
  • "algorithm": "HS256",
  • "consumer": {
    },
  • "id": "75695322-e8a0-4109-aed4-5416b0308d85",
  • "key": "YJdmaDvVTJxtcWRCvkMikc8oELgAVNcz",
  • "secret": "C50k0bcahDhLNhLKSUBSR1OMiFGzNZ7X"
}

Delete a a JWT associated with a Consumer

Delete a a JWT associated with a Consumer using ID.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

ConsumerIdForNestedEntities
required
string
Example: f28acbfa-c866-4587-b688-0208ac24df21

Consumer ID for nested entities

JWTId
required
string
Example: 4a7f5faa-8c96-46d6-8214-c87573ef2ac4

ID of the JWT to lookup

Responses

Fetch a JWT associated with a Consumer

Get a JWT associated with a Consumer using ID.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

ConsumerIdForNestedEntities
required
string
Example: f28acbfa-c866-4587-b688-0208ac24df21

Consumer ID for nested entities

JWTId
required
string
Example: 4a7f5faa-8c96-46d6-8214-c87573ef2ac4

ID of the JWT to lookup

Responses

Response samples

Content type
application/json
{
  • "algorithm": "HS256",
  • "consumer": {
    },
  • "id": "75695322-e8a0-4109-aed4-5416b0308d85",
  • "key": "YJdmaDvVTJxtcWRCvkMikc8oELgAVNcz",
  • "secret": "C50k0bcahDhLNhLKSUBSR1OMiFGzNZ7X"
}

Upsert a JWT associated with a Consumer

Create or Update a JWT associated with a Consumer using ID.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

ConsumerIdForNestedEntities
required
string
Example: f28acbfa-c866-4587-b688-0208ac24df21

Consumer ID for nested entities

JWTId
required
string
Example: 4a7f5faa-8c96-46d6-8214-c87573ef2ac4

ID of the JWT to lookup

Request Body schema: application/json

Description of the JWT

algorithm
string or null
Default: "HS256"
Enum: "HS256" "HS384" "HS512" "RS256" "RS384" "RS512" "ES256" "ES384" "ES512" "PS256" "PS384" "PS512" "EdDSA"
object or null
created_at
integer or null

Unix epoch when the resource was created.

id
string or null
key
string or null
rsa_public_key
string or null
secret
string or null
tags
Array of strings

Responses

Request samples

Content type
application/json
{
  • "algorithm": "HS256",
  • "id": "75695322-e8a0-4109-aed4-5416b0308d85",
  • "key": "YJdmaDvVTJxtcWRCvkMikc8oELgAVNcz",
  • "secret": "C50k0bcahDhLNhLKSUBSR1OMiFGzNZ7X"
}

Response samples

Content type
application/json
{
  • "algorithm": "HS256",
  • "consumer": {
    },
  • "id": "75695322-e8a0-4109-aed4-5416b0308d85",
  • "key": "YJdmaDvVTJxtcWRCvkMikc8oELgAVNcz",
  • "secret": "C50k0bcahDhLNhLKSUBSR1OMiFGzNZ7X"
}

List all JWTs

List all JWTs

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

query Parameters
size
integer [ 1 .. 1000 ]
Default: 100

Number of resources to be returned.

offset
string

Offset from which to return the next set of resources. Use the value of the 'offset' field from the response of a list operation as input here to paginate through all the resources

tags
string
Example: tags=tag1,tag2

A list of tags to filter the list of resources on. Multiple tags can be concatenated using ',' to mean AND or using '/' to mean OR.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "next": "string",
  • "offset": "string"
}

Fetch a JWT

Get a JWT using ID.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
JWTId
required
string
Example: 4a7f5faa-8c96-46d6-8214-c87573ef2ac4

ID of the JWT to lookup

controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

Responses

Response samples

Content type
application/json
{
  • "algorithm": "HS256",
  • "consumer": {
    },
  • "id": "75695322-e8a0-4109-aed4-5416b0308d85",
  • "key": "YJdmaDvVTJxtcWRCvkMikc8oELgAVNcz",
  • "secret": "C50k0bcahDhLNhLKSUBSR1OMiFGzNZ7X"
}

HMAC-auth credentials

List all HMAC-auth credentials associated with a Consumer

List all HMAC-auth credentials associated with a Consumer

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

ConsumerIdForNestedEntities
required
string
Example: f28acbfa-c866-4587-b688-0208ac24df21

Consumer ID for nested entities

query Parameters
size
integer [ 1 .. 1000 ]
Default: 100

Number of resources to be returned.

offset
string

Offset from which to return the next set of resources. Use the value of the 'offset' field from the response of a list operation as input here to paginate through all the resources

tags
string
Example: tags=tag1,tag2

A list of tags to filter the list of resources on. Multiple tags can be concatenated using ',' to mean AND or using '/' to mean OR.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "next": "string",
  • "offset": "string"
}

Create a new HMAC-auth credential associated with a Consumer

Create a new HMAC-auth credential associated with a Consumer

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

ConsumerIdForNestedEntities
required
string
Example: f28acbfa-c866-4587-b688-0208ac24df21

Consumer ID for nested entities

Request Body schema: application/json

Description of new HMAC-auth credential for creation

object or null
created_at
integer or null

Unix epoch when the resource was created.

id
string or null
secret
string or null
tags
Array of strings
username
required
string

Responses

Request samples

Content type
application/json
{
  • "id": "75695322-e8a0-4109-aed4-5416b0308d85",
  • "secret": "wQazJ304DW5huJklHgUfjfiSyCyTAEDZ",
  • "username": "xerxes"
}

Response samples

Content type
application/json
{
  • "consumer": {
    },
  • "id": "75695322-e8a0-4109-aed4-5416b0308d85",
  • "secret": "wQazJ304DW5huJklHgUfjfiSyCyTAEDZ",
  • "username": "xerxes"
}

Delete a a HMAC-auth credential associated with a Consumer

Delete a a HMAC-auth credential associated with a Consumer using ID.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

ConsumerIdForNestedEntities
required
string
Example: f28acbfa-c866-4587-b688-0208ac24df21

Consumer ID for nested entities

HMACAuthId
required
string
Example: 70e7b00b-72f2-471b-a5ce-9c4171775360

ID of the HMAC-auth credential to lookup

Responses

Fetch a HMAC-auth credential associated with a Consumer

Get a HMAC-auth credential associated with a Consumer using ID.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

ConsumerIdForNestedEntities
required
string
Example: f28acbfa-c866-4587-b688-0208ac24df21

Consumer ID for nested entities

HMACAuthId
required
string
Example: 70e7b00b-72f2-471b-a5ce-9c4171775360

ID of the HMAC-auth credential to lookup

Responses

Response samples

Content type
application/json
{
  • "consumer": {
    },
  • "id": "75695322-e8a0-4109-aed4-5416b0308d85",
  • "secret": "wQazJ304DW5huJklHgUfjfiSyCyTAEDZ",
  • "username": "xerxes"
}

Upsert a HMAC-auth credential associated with a Consumer

Create or Update a HMAC-auth credential associated with a Consumer using ID.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

ConsumerIdForNestedEntities
required
string
Example: f28acbfa-c866-4587-b688-0208ac24df21

Consumer ID for nested entities

HMACAuthId
required
string
Example: 70e7b00b-72f2-471b-a5ce-9c4171775360

ID of the HMAC-auth credential to lookup

Request Body schema: application/json

Description of the HMAC-auth credential

object or null
created_at
integer or null

Unix epoch when the resource was created.

id
string or null
secret
string or null
tags
Array of strings
username
required
string

Responses

Request samples

Content type
application/json
{
  • "id": "75695322-e8a0-4109-aed4-5416b0308d85",
  • "secret": "wQazJ304DW5huJklHgUfjfiSyCyTAEDZ",
  • "username": "xerxes"
}

Response samples

Content type
application/json
{
  • "consumer": {
    },
  • "id": "75695322-e8a0-4109-aed4-5416b0308d85",
  • "secret": "wQazJ304DW5huJklHgUfjfiSyCyTAEDZ",
  • "username": "xerxes"
}

List all HMAC-auth credentials

List all HMAC-auth credentials

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

query Parameters
size
integer [ 1 .. 1000 ]
Default: 100

Number of resources to be returned.

offset
string

Offset from which to return the next set of resources. Use the value of the 'offset' field from the response of a list operation as input here to paginate through all the resources

tags
string
Example: tags=tag1,tag2

A list of tags to filter the list of resources on. Multiple tags can be concatenated using ',' to mean AND or using '/' to mean OR.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "next": "string",
  • "offset": "string"
}

Fetch a HMAC-auth credential

Get a HMAC-auth credential using ID.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
HMACAuthId
required
string
Example: 70e7b00b-72f2-471b-a5ce-9c4171775360

ID of the HMAC-auth credential to lookup

controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

Responses

Response samples

Content type
application/json
{
  • "consumer": {
    },
  • "id": "75695322-e8a0-4109-aed4-5416b0308d85",
  • "secret": "wQazJ304DW5huJklHgUfjfiSyCyTAEDZ",
  • "username": "xerxes"
}

MTLS-auth credentials

List all MTLS-auth credentials associated with a Consumer

List all MTLS-auth credentials associated with a Consumer

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

ConsumerIdForNestedEntities
required
string
Example: f28acbfa-c866-4587-b688-0208ac24df21

Consumer ID for nested entities

query Parameters
size
integer [ 1 .. 1000 ]
Default: 100

Number of resources to be returned.

offset
string

Offset from which to return the next set of resources. Use the value of the 'offset' field from the response of a list operation as input here to paginate through all the resources

tags
string
Example: tags=tag1,tag2

A list of tags to filter the list of resources on. Multiple tags can be concatenated using ',' to mean AND or using '/' to mean OR.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "next": "string",
  • "offset": "string"
}

Create a new MTLS-auth credential associated with a Consumer

Create a new MTLS-auth credential associated with a Consumer

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

ConsumerIdForNestedEntities
required
string
Example: f28acbfa-c866-4587-b688-0208ac24df21

Consumer ID for nested entities

Request Body schema: application/json

Description of new MTLS-auth credential for creation

object
object or null
created_at
integer or null

Unix epoch when the resource was created.

id
string or null
subject_name
required
string
tags
Array of strings

Responses

Request samples

Content type
application/json
{
  • "ca_certificate": {
    },
  • "id": "b2f34145-0343-41a4-9602-4c69dec2f269",
  • "subject_name": "CA_Subject_Name"
}

Response samples

Content type
application/json
{
  • "ca_certificate": {
    },
  • "consumer": {
    },
  • "id": "b2f34145-0343-41a4-9602-4c69dec2f269",
  • "subject_name": "CA_Subject_Name"
}

Delete a a MTLS-auth credential associated with a Consumer

Delete a a MTLS-auth credential associated with a Consumer using ID.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

ConsumerIdForNestedEntities
required
string
Example: f28acbfa-c866-4587-b688-0208ac24df21

Consumer ID for nested entities

MTLSAuthId
required
string

ID of the MTLS-auth credential to lookup

Responses

Fetch a MTLS-auth credential associated with a Consumer

Get a MTLS-auth credential associated with a Consumer using ID.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

ConsumerIdForNestedEntities
required
string
Example: f28acbfa-c866-4587-b688-0208ac24df21

Consumer ID for nested entities

MTLSAuthId
required
string

ID of the MTLS-auth credential to lookup

Responses

Response samples

Content type
application/json
{
  • "ca_certificate": {
    },
  • "consumer": {
    },
  • "id": "b2f34145-0343-41a4-9602-4c69dec2f269",
  • "subject_name": "CA_Subject_Name"
}

Upsert a MTLS-auth credential associated with a Consumer

Create or Update a MTLS-auth credential associated with a Consumer using ID.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

ConsumerIdForNestedEntities
required
string
Example: f28acbfa-c866-4587-b688-0208ac24df21

Consumer ID for nested entities

MTLSAuthId
required
string

ID of the MTLS-auth credential to lookup

Request Body schema: application/json

Description of the MTLS-auth credential

object
object or null
created_at
integer or null

Unix epoch when the resource was created.

id
string or null
subject_name
required
string
tags
Array of strings

Responses

Request samples

Content type
application/json
{
  • "ca_certificate": {
    },
  • "id": "b2f34145-0343-41a4-9602-4c69dec2f269",
  • "subject_name": "CA_Subject_Name"
}

Response samples

Content type
application/json
{
  • "ca_certificate": {
    },
  • "consumer": {
    },
  • "id": "b2f34145-0343-41a4-9602-4c69dec2f269",
  • "subject_name": "CA_Subject_Name"
}

List all MTLS-auth credentials

List all MTLS-auth credentials

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

query Parameters
size
integer [ 1 .. 1000 ]
Default: 100

Number of resources to be returned.

offset
string

Offset from which to return the next set of resources. Use the value of the 'offset' field from the response of a list operation as input here to paginate through all the resources

tags
string
Example: tags=tag1,tag2

A list of tags to filter the list of resources on. Multiple tags can be concatenated using ',' to mean AND or using '/' to mean OR.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "next": "string",
  • "offset": "string"
}

Fetch a MTLS-auth credential

Get a MTLS-auth credential using ID.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
MTLSAuthId
required
string

ID of the MTLS-auth credential to lookup

controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

Responses

Response samples

Content type
application/json
{
  • "ca_certificate": {
    },
  • "consumer": {
    },
  • "id": "b2f34145-0343-41a4-9602-4c69dec2f269",
  • "subject_name": "CA_Subject_Name"
}

ACLs

List all ACLs

List all ACLs

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

query Parameters
size
integer [ 1 .. 1000 ]
Default: 100

Number of resources to be returned.

offset
string

Offset from which to return the next set of resources. Use the value of the 'offset' field from the response of a list operation as input here to paginate through all the resources

tags
string
Example: tags=tag1,tag2

A list of tags to filter the list of resources on. Multiple tags can be concatenated using ',' to mean AND or using '/' to mean OR.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "next": "string",
  • "offset": "string"
}

Fetch an ACL

Get an ACL using ID.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
ACLId
required
string
Example: f28acbfa-c866-4587-b688-0208ac24df21

ID of the ACL to lookup

controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

Responses

Response samples

Content type
application/json
{
  • "consumer": {
    },
  • "group": "foo",
  • "id": "b1f34145-0343-41a4-9602-4c69dec2f269"
}

List all ACLs associated with a Consumer

List all ACLs associated with a Consumer

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

ConsumerIdForNestedEntities
required
string
Example: f28acbfa-c866-4587-b688-0208ac24df21

Consumer ID for nested entities

query Parameters
size
integer [ 1 .. 1000 ]
Default: 100

Number of resources to be returned.

offset
string

Offset from which to return the next set of resources. Use the value of the 'offset' field from the response of a list operation as input here to paginate through all the resources

tags
string
Example: tags=tag1,tag2

A list of tags to filter the list of resources on. Multiple tags can be concatenated using ',' to mean AND or using '/' to mean OR.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "next": "string",
  • "offset": "string"
}

Create a new ACL associated with a Consumer

Create a new ACL associated with a Consumer

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

ConsumerIdForNestedEntities
required
string
Example: f28acbfa-c866-4587-b688-0208ac24df21

Consumer ID for nested entities

Request Body schema: application/json

Description of new ACL for creation

object or null
created_at
integer or null

Unix epoch when the resource was created.

group
required
string
id
string or null
tags
Array of strings

Responses

Request samples

Content type
application/json
{
  • "group": "foo",
  • "id": "b1f34145-0343-41a4-9602-4c69dec2f269"
}

Response samples

Content type
application/json
{
  • "consumer": {
    },
  • "group": "foo",
  • "id": "b1f34145-0343-41a4-9602-4c69dec2f269"
}

Delete a an ACL associated with a Consumer

Delete a an ACL associated with a Consumer using ID.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

ConsumerIdForNestedEntities
required
string
Example: f28acbfa-c866-4587-b688-0208ac24df21

Consumer ID for nested entities

ACLId
required
string
Example: f28acbfa-c866-4587-b688-0208ac24df21

ID of the ACL to lookup

Responses

Fetch an ACL associated with a Consumer

Get an ACL associated with a Consumer using ID.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

ConsumerIdForNestedEntities
required
string
Example: f28acbfa-c866-4587-b688-0208ac24df21

Consumer ID for nested entities

ACLId
required
string
Example: f28acbfa-c866-4587-b688-0208ac24df21

ID of the ACL to lookup

Responses

Response samples

Content type
application/json
{
  • "consumer": {
    },
  • "group": "foo",
  • "id": "b1f34145-0343-41a4-9602-4c69dec2f269"
}

Upsert an ACL associated with a Consumer

Create or Update an ACL associated with a Consumer using ID.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

ConsumerIdForNestedEntities
required
string
Example: f28acbfa-c866-4587-b688-0208ac24df21

Consumer ID for nested entities

ACLId
required
string
Example: f28acbfa-c866-4587-b688-0208ac24df21

ID of the ACL to lookup

Request Body schema: application/json

Description of the ACL

object or null
created_at
integer or null

Unix epoch when the resource was created.

group
required
string
id
string or null
tags
Array of strings

Responses

Request samples

Content type
application/json
{
  • "group": "foo",
  • "id": "b1f34145-0343-41a4-9602-4c69dec2f269"
}

Response samples

Content type
application/json
{
  • "consumer": {
    },
  • "group": "foo",
  • "id": "b1f34145-0343-41a4-9602-4c69dec2f269"
}

Targets

List all Targets associated with an Upstream

List all Targets associated with an Upstream

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

UpstreamIdForTarget
required
string
Example: 5a078780-5d4c-4aae-984a-bdc6f52113d8

ID or target of the Target to lookup

query Parameters
size
integer [ 1 .. 1000 ]
Default: 100

Number of resources to be returned.

offset
string

Offset from which to return the next set of resources. Use the value of the 'offset' field from the response of a list operation as input here to paginate through all the resources

tags
string
Example: tags=tag1,tag2

A list of tags to filter the list of resources on. Multiple tags can be concatenated using ',' to mean AND or using '/' to mean OR.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "next": "string",
  • "offset": "string"
}

Create a new Target associated with an Upstream

Create a new Target associated with an Upstream

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

UpstreamIdForTarget
required
string
Example: 5a078780-5d4c-4aae-984a-bdc6f52113d8

ID or target of the Target to lookup

Request Body schema: application/json

Description of new Target for creation

created_at
number or null

Unix epoch when the resource was created.

id
string or null
tags
Array of strings

An optional set of strings associated with the Target for grouping and filtering.

target
string or null

The target address (ip or hostname) and port. If the hostname resolves to an SRV record, the port value will be overridden by the value from the DNS record.

updated_at
number or null

Unix epoch when the resource was last updated.

object or null
weight
integer or null
Default: 100

The weight this target gets within the upstream loadbalancer (0-65535). If the hostname resolves to an SRV record, the weight value will be overridden by the value from the DNS record.

Responses

Request samples

Content type
application/json
{
  • "id": "089292a7-ba3d-4d88-acf0-97b4b2e2621a",
  • "target": "203.0.113.42",
  • "weight": 100
}

Response samples

Content type
application/json
{
  • "id": "089292a7-ba3d-4d88-acf0-97b4b2e2621a",
  • "target": "203.0.113.42",
  • "upstream": {
    },
  • "weight": 100
}

Delete a a Target associated with an Upstream

Delete a a Target associated with an Upstream using ID or target.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

UpstreamIdForTarget
required
string
Example: 5a078780-5d4c-4aae-984a-bdc6f52113d8

ID or target of the Target to lookup

TargetId
required
string
Example: 5a078780-5d4c-4aae-984a-bdc6f52113d8

ID of the Target to lookup

Responses

Fetch a Target associated with an Upstream

Get a Target associated with an Upstream using ID or target.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

UpstreamIdForTarget
required
string
Example: 5a078780-5d4c-4aae-984a-bdc6f52113d8

ID or target of the Target to lookup

TargetId
required
string
Example: 5a078780-5d4c-4aae-984a-bdc6f52113d8

ID of the Target to lookup

Responses

Response samples

Content type
application/json
{
  • "id": "089292a7-ba3d-4d88-acf0-97b4b2e2621a",
  • "target": "203.0.113.42",
  • "upstream": {
    },
  • "weight": 100
}

Upsert a Target associated with an Upstream

Create or Update a Target associated with an Upstream using ID or target.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
controlPlaneId
required
string <uuid>
Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458

The UUID of your control plane. This variable is available in the Konnect manager.

UpstreamIdForTarget
required
string
Example: 5a078780-5d4c-4aae-984a-bdc6f52113d8

ID or target of the Target to lookup

TargetId
required
string
Example: 5a078780-5d4c-4aae-984a-bdc6f52113d8

ID of the Target to lookup

Request Body schema: application/json

Description of the Target

created_at
number or null

Unix epoch when the resource was created.

id
string or null
tags
Array of strings

An optional set of strings associated with the Target for grouping and filtering.

target
string or null

The target address (ip or hostname) and port. If the hostname resolves to an SRV record, the port value will be overridden by the value from the DNS record.

updated_at
number or null

Unix epoch when the resource was last updated.

object or null
weight
integer or null
Default: 100

The weight this target gets within the upstream loadbalancer (0-65535). If the hostname resolves to an SRV record, the weight value will be overridden by the value from the DNS record.

Responses

Request samples

Content type
application/json
{
  • "id": "089292a7-ba3d-4d88-acf0-97b4b2e2621a",
  • "target": "203.0.113.42",
  • "weight": 100
}

Response samples

Content type
application/json
{
  • "id": "089292a7-ba3d-4d88-acf0-97b4b2e2621a",
  • "target": "203.0.113.42",
  • "upstream": {
    },
  • "weight": 100
}

Portal Audit Logs

Update Portal Audit Log Replay Job

Updates a job to re-send audit logs to an portal's webhook.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
portalId
required
string <uuid>
Example: f32d905a-ed33-46a3-a093-d8f536af9a8a

ID of the portal.

Request Body schema: application/json

The request schema to replace a portal audit log replay job.

start_at
required
string <date-time>

The start of a date-time range in RFC3339 format e.g. 2017-07-21T17:32:28Z. Must be within the last 7 days.

end_at
required
string <date-time>

The end of a date-time range in RFC3339 format e.g. 2017-07-21T17:32:28Z. Must be within the last 7 days.

Responses

Request samples

Content type
application/json
{
  • "start_at": "2019-08-24T14:15:22Z",
  • "end_at": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "start_at": "2017-07-21T17:32:28Z",
  • "end_at": "2017-07-21T17:32:28Z",
  • "status": "unconfigured",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Get Portal Audit Log Replay Job

Returns the audit log replay job's configuration and status.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
portalId
required
string <uuid>
Example: f32d905a-ed33-46a3-a093-d8f536af9a8a

ID of the portal.

Responses

Response samples

Content type
application/json
{
  • "start_at": "2017-07-21T17:32:28Z",
  • "end_at": "2017-07-21T17:32:28Z",
  • "status": "unconfigured",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Update Portal Audit Log Webhook

Updates the configuration for a webhook to receive audit logs.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
portalId
required
string <uuid>
Example: f32d905a-ed33-46a3-a093-d8f536af9a8a

ID of the portal.

Request Body schema: application/json

The request schema to modify an portal audit log webhook.

enabled
boolean
Default: false

Indicates if the data should be sent to the configured destination.

audit_log_destination_id
string <uuid>

ID of the audit log destination.

Responses

Request samples

Content type
application/json
Example
{
  • "enabled": false
}

Response samples

Content type
application/json
{
  • "enabled": true,
  • "audit_log_destination_id": "9cb77dc2-ff99-4d47-84ab-7c5c1b3ef939"
}

Get Portal Audit Log Webhook

Returns configuration for the audit log webhook.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
portalId
required
string <uuid>
Example: f32d905a-ed33-46a3-a093-d8f536af9a8a

ID of the portal.

Responses

Response samples

Content type
application/json
{
  • "enabled": true,
  • "audit_log_destination_id": "9cb77dc2-ff99-4d47-84ab-7c5c1b3ef939"
}

Get Portal Audit Log Webhook Status

Returns status of the audit log webhook.

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessTokenserviceAccessTokenbearerAuth
path Parameters
portalId
required
string <uuid>
Example: f32d905a-ed33-46a3-a093-d8f536af9a8a

ID of the portal.

Responses

Response samples

Content type
application/json
{
  • "webhook_enabled": true,
  • "webhook_status": "inactive",
  • "last_attempt_at": "2023-03-21T09:29:14.52Z",
  • "last_response_code": 401,
  • "last_response_message": "Unauthorized"
}