Custom Domain Name
stringDomain name of the custom domain.
Custom Domain
objectObject containing information about a custom domain for a control-plane.
Example:39ed3790-085d-4605-9627-f96d86aaf425
Example:0949471e-b759-45ba-87ab-ee63fb781388
Set of control-plane geos supported for deploying cloud-gateways configurations.
Allowed values:useuaumeinsg
Domain name of the custom domain.
Example:example.com
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
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
State of the custom domain.
Allowed values:createdinitializingreadyterminatingterminatederror
Metadata describing the backing state of the custom domain and why it may be in an erroneous state.
Show Child Parameters
Monotonically-increasing version count of the custom domain, to indicate the order of updates to the custom
domain.
Example:1
An RFC-3339 timestamp representation of custom domain creation date.
Example:2022-11-04T20:10:06.927Z
An RFC-3339 timestamp representation of custom domain update date.
Example:2022-11-04T20:10:06.927Z
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
Custom Domain Online Property Status
stringSet of available statuses for the online properties of a custom domain.
Allowed values:verifiedunverified
Custom Domain Online Status
objectSet of available statuses for the online properties of a custom domain.
Allowed values:verifiedunverified
Set of available statuses for the online properties of a custom domain.
Allowed values:verifiedunverified
CreateConfigurationRequest
objectRequest schema for creating a configuration.
Example:0949471e-b759-45ba-87ab-ee63fb781388
Set of control-plane geos supported for deploying cloud-gateways configurations.
Allowed values:useuaumeinsg
Supported gateway version. For serverless.v1 kind of cloud gateways, this field should be omitted.
Example:3.2
Object that describes where to deploy a data-plane group, along with how many instances.
Show Child Parameters
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
Type of API access data-plane groups will support for a configuration.
Allowed values:privatepublicprivate+public
Default:private+public
Example:private+public