API docs by Redocly

Konnect Cloud Gateways (3.0.0)

Download OpenAPI specification:Download

URL: https://cloud.konghq.com

Konnect API for managing cloud-gateways infrastructure.

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:
konnectAccessTokenpersonalAccessTokensystemAccountAccessToken
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 write action).

Authorizations:
konnectAccessTokenpersonalAccessTokensystemAccountAccessToken
Request Body schema: application/json
kind
required
string
Enum: "dedicated.v0" "serverless.v0"
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
{
  • "kind": "dedicated.v0",
  • "control_plane_id": "0949471e-b759-45ba-87ab-ee63fb781388",
  • "control_plane_geo": "us",
  • "domain": "example.com"
}

Response samples

Content type
application/json
Example
{
  • "id": "39ed3790-085d-4605-9627-f96d86aaf425",
  • "kind": "dedicated.v0",
  • "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:
konnectAccessTokenpersonalAccessTokensystemAccountAccessToken
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
Example
{
  • "id": "39ed3790-085d-4605-9627-f96d86aaf425",
  • "kind": "dedicated.v0",
  • "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:
konnectAccessTokenpersonalAccessTokensystemAccountAccessToken
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:
konnectAccessTokenpersonalAccessTokensystemAccountAccessToken
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"
}