Custom Domains
List Custom Domains
Returns a paginated collection of custom domains across control-planes for an organization (restricted by
permitted control-plane reads).
Query Parameters
Filters supported for custom domains on the global API.
Show Child Parameters
The maximum number of items to include per page. The last page of a collection may include fewer items.
Example:10
Determines which page of the entities to retrieve.
Example:1
Response
application/json
Response
A paginated list for a collection of custom domains.
ListGlobalCustomDomainsResponse
returns the pagination information
Show Child Parameters
One OfObject containing information about a custom domain for a control-plane.
Show Child Parameters
Authentication
Query Parameters
Create Custom Domain
Creates a new custom domain for a control-plane (restricted by permitted control-plane write
action).
Body
application/json
Body
CreateCustomDomainRequest
Request schema for creating a custom domain in the global API.
Allowed values:dedicated.v0serverless.v0serverless.v1
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
Response
application/json
Response
Response format for creating a custom domain for a control-plane in the global API.
Custom Domain
Object containing information about a custom domain for a control-plane.
One OfExample:39ed3790-085d-4605-9627-f96d86aaf425
Allowed values:dedicated.v0
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
Authentication
Body
Get Custom Domain
Retrieves a custom domain by ID (restricted by permitted control-plane reads).
Path Parameters
ID of the custom domain to operate on.
Example:39ed3790-085d-4605-9627-f96d86aaf425
Response
application/json
Response
Response format for retrieving a custom domain for a control-plane.
Custom Domain
Object containing information about a custom domain for a control-plane.
One OfExample:39ed3790-085d-4605-9627-f96d86aaf425
Allowed values:dedicated.v0
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
Authentication
Path Parameters
Delete Custom Domain
Deletes a custom domain by ID (restricted by permitted control-plane reads).
Path Parameters
ID of the custom domain to operate on.
Example:39ed3790-085d-4605-9627-f96d86aaf425
Response
Response
No Content