Custom Domain

object

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

idstring(uuid)requiredread-only

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

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(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(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

kindstring

Pre-release Feature
This feature is currently in beta and is subject to change.

Kind of the custom domain based on Cloud Gateway deployment.

Allowed values:dedicated.v0serverless.v1

Default:dedicated.v0

Example

Custom Domain Online Property Status

string

Set of available statuses for the online properties of a custom domain.

Allowed values:verifiedunverified

Custom Domain Online Status

object
* Additional properties are NOT allowed.
cnamestringrequiredread-only

Set of available statuses for the online properties of a custom domain.

Allowed values:verifiedunverified

sslstringrequiredread-only

Set of available statuses for the online properties of a custom domain.

Allowed values:verifiedunverified

Example

CreateConfigurationRequest

object

Request schema for creating a configuration.

* Additional properties are NOT allowed.
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

versionstring

Supported gateway version. For serverless.v1 kind of cloud gateways, this field should be omitted.

Example:3.2

dataplane_groupsarray[object](set)required

Object that describes where to deploy a data-plane group, along with how many instances.

* Additional properties are NOT allowed.
Show Child Parameters
kindstring

Pre-release Feature
This feature is currently in beta and is subject to change.

Kind of the Cloud Gateway deployment. If serverless.v1 is specified, the following fields
should be omitted (will be ignored if provided): autoscale, cloud_gateway_network_id, version.

Allowed values:dedicated.v0serverless.v1

Default:dedicated.v0

api_accessstring

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

Allowed values:privatepublicprivate+public

Default:private+public

Example:private+public

Example

CreateCustomDomainRequest

object

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

* Additional properties are NOT allowed.
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

kindstring

Pre-release Feature
This feature is currently in beta and is subject to change.

Kind of the custom domain based on Cloud Gateway deployment.

Allowed values:dedicated.v0serverless.v1

Default:dedicated.v0

Example