3.0.0OAS 3.0

Konnect API for managing cloud-gateways infrastructure.

API Base URL
  • Server 1:https://global.api.konghq.com/v3

    Base URL for the global region

Security
konnectAccessToken (http)

The Konnect access token is meant to be used by the Konnect dashboard and the decK CLI authenticate with.

personalAccessToken (http)

The personal access token is meant to be used as an alternative to basic-auth when accessing Konnect via APIs.
You can generate a Personal Access Token (PAT) from the personal access token page in the Konnect dashboard.
The PAT token must be passed in the header of a request, for example:
curl -X GET 'https://global.api.konghq.com/v2/users/' --header 'Authorization: Bearer kpat_xgfT...'

systemAccountAccessToken (http)

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

Additional Information
Contact Kong

Custom Domains

List Custom Domains

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

get
https://global.api.konghq.com/v3/cloud-gateways/custom-domains

Query Parameters

filterobject

Filters supported for custom domains on the global API.

* Additional properties are NOT allowed.
Show Child Parameters
page[size]integer

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

Example:10

page[number]integer

Determines which page of the entities to retrieve.

Example:1

Response

application/json

A paginated list for a collection of custom domains.

ListGlobalCustomDomainsResponse

metaobjectrequired

returns the pagination information

Show Child Parameters
dataOne Of
array[object]required

Object containing information about a custom domain for a control-plane.

Dedicated Custom Domainobject
Show Child Parameters
get/cloud-gateways/custom-domains
 
application/json

Create Custom Domain

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

post
https://global.api.konghq.com/v3/cloud-gateways/custom-domains

Body

application/json

CreateCustomDomainRequest

Request schema for creating a custom domain in the global API.

* Additional properties are NOT allowed.
kindstringrequired

Allowed values:dedicated.v0serverless.v0serverless.v1

control_plane_idstring(uuid)required

Example:0949471e-b759-45ba-87ab-ee63fb781388

control_plane_geostringrequired

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

Allowed values:useuaumeinsg

domainstringrequired

Domain name of the custom domain.

Example:example.com

Response

application/json

Response format for creating a custom domain for a control-plane in the global API.

Custom Domain

Custom Domainobject

Object containing information about a custom domain for a control-plane.

One Of
idstring(uuid)requiredread-only

Example:39ed3790-085d-4605-9627-f96d86aaf425

kindstringrequired

Allowed values:dedicated.v0

control_plane_idstring(uuid)required

Example:0949471e-b759-45ba-87ab-ee63fb781388

control_plane_geostringrequired

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

Allowed values:useuaumeinsg

domainstringrequired

Domain name of the custom domain.

Example:example.com

certificate_idstring | null(uuid)read-only

Certificate ID for the certificate representing this domain and stored on data-planes for this
control-plane. Can be retrieved via the control-planes API for this custom domain’s control-plane.

Example:3b7cbeee-fbec-440e-a5ef-89e7dec3b9d0

sni_idstring | null(uuid)read-only

Server Name Indication ID for this domain and stored on data-planes for this control-plane. Can be retrieved
via the control-planes API for this custom domain’s control-plane.

Example:a8f11ea8-af09-4422-9735-5d4f8910aba1

statestringrequiredread-only

State of the custom domain.

Allowed values:createdinitializingreadyterminatingterminatederror

state_metadataobjectrequiredread-only

Metadata describing the backing state of the custom domain and why it may be in an erroneous state.

* Additional properties are NOT allowed.
Show Child Parameters
entity_versionintegerrequiredread-only

Monotonically-increasing version count of the custom domain, to indicate the order of updates to the custom
domain.

Example:1

created_atstring(date-time)requiredread-only

An RFC-3339 timestamp representation of custom domain creation date.

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

updated_atstring(date-time)requiredread-only

An RFC-3339 timestamp representation of custom domain update date.

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

post/cloud-gateways/custom-domains

Body

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

Get Custom Domain

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

get
https://global.api.konghq.com/v3/cloud-gateways/custom-domains/{customDomainId}

Path Parameters

customDomainIdstring(uuid)requiredread-only

ID of the custom domain to operate on.

Example:39ed3790-085d-4605-9627-f96d86aaf425

Response

application/json

Response format for retrieving a custom domain for a control-plane.

Custom Domain

Custom Domainobject

Object containing information about a custom domain for a control-plane.

One Of
idstring(uuid)requiredread-only

Example:39ed3790-085d-4605-9627-f96d86aaf425

kindstringrequired

Allowed values:dedicated.v0

control_plane_idstring(uuid)required

Example:0949471e-b759-45ba-87ab-ee63fb781388

control_plane_geostringrequired

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

Allowed values:useuaumeinsg

domainstringrequired

Domain name of the custom domain.

Example:example.com

certificate_idstring | null(uuid)read-only

Certificate ID for the certificate representing this domain and stored on data-planes for this
control-plane. Can be retrieved via the control-planes API for this custom domain’s control-plane.

Example:3b7cbeee-fbec-440e-a5ef-89e7dec3b9d0

sni_idstring | null(uuid)read-only

Server Name Indication ID for this domain and stored on data-planes for this control-plane. Can be retrieved
via the control-planes API for this custom domain’s control-plane.

Example:a8f11ea8-af09-4422-9735-5d4f8910aba1

statestringrequiredread-only

State of the custom domain.

Allowed values:createdinitializingreadyterminatingterminatederror

state_metadataobjectrequiredread-only

Metadata describing the backing state of the custom domain and why it may be in an erroneous state.

* Additional properties are NOT allowed.
Show Child Parameters
entity_versionintegerrequiredread-only

Monotonically-increasing version count of the custom domain, to indicate the order of updates to the custom
domain.

Example:1

created_atstring(date-time)requiredread-only

An RFC-3339 timestamp representation of custom domain creation date.

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

updated_atstring(date-time)requiredread-only

An RFC-3339 timestamp representation of custom domain update date.

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

get/cloud-gateways/custom-domains/{customDomainId}
 
application/json