Sign in
Custom Domains

Create Custom Domain

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

post/v2/cloud-gateways/custom-domains

Request body

control_plane_idstring uuid required
control_plane_geo'us' | 'eu' | 'au' required

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

domainstring required

Domain name of the custom domain.

Example request

{
  "control_plane_id": "0949471e-b759-45ba-87ab-ee63fb781388",
  "domain": "example.com"
}

Response

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

idstring uuid required
control_plane_idstring uuid required
control_plane_geo'us' | 'eu' | 'au' required

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

domainstring required

Domain name of the custom domain.

certificate_idstring uuid nullable

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.

sni_idstring uuid nullable

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.

state'created' | 'initializing' | 'ready' | 'terminating' | 'terminated' | 'error' required

State of the custom domain.

entity_versioninteger required

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

created_atstring date-time required

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

updated_atstring date-time required

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

Example response

{
  "id": "39ed3790-085d-4605-9627-f96d86aaf425",
  "control_plane_id": "0949471e-b759-45ba-87ab-ee63fb781388",
  "domain": "example.com",
  "certificate_id": "3b7cbeee-fbec-440e-a5ef-89e7dec3b9d0",
  "sni_id": "a8f11ea8-af09-4422-9735-5d4f8910aba1",
  "state_metadata": {
    "reported_status": "INVALID",
    "reason": "CNAME points to '_acme-challenge.<prefix>.gateways.konghq.tech.' instead of '_acme-challenge.<prefix>.acme.gateways.konghq.tech.'\n"
  },
  "entity_version": 1,
  "created_at": "2022-11-04T20:10:06.927Z",
  "updated_at": "2022-11-04T20:10:06.927Z"
}

Changes