A container is provided with an automatically generated domain through which it is accessible.
Alternatively, custom domains can be assigned to containers in order to facilitate their use.
List all custom domains the caller can access (read permission).
By default, the custom domains listed are ordered by creation date in ascending order. This can be modified via the order_by field.
Additional parameters can be set in the query to filter the output, such as organization_id, project_id, namespace_id, or container_id.
path Parameters
regionThe region you want to target
query Parameters
pagepage_sizeorder_byorganization_idproject_idnamespace_idcontainer_idList all custom domains the caller can access (read permission). › Responses
total_countCreate a new custom domain for the container with the specified ID.
path Parameters
regionThe region you want to target
Create a new custom domain for the container with the specified ID. › Request Body
container_idUnique ID of the container the domain will be assigned to.
hostnameDomain assigned to the container.
tagsA list of arbitrary tags associated with the domain.
Create a new custom domain for the container with the specified ID. › Responses
idDomain unique ID. (UUID format)
container_idUnique ID of the container the domain is assigned to. (UUID format)
hostnameDomain assigned to the container.
statusDomain status.
error_messageDomain last error message.
created_atDomain creation date. (RFC 3339 format)
updated_atDomain last update date. (RFC 3339 format)
tagsA list of arbitrary tags associated with the domain.
Get the custom domain associated with the specified ID.
path Parameters
regionThe region you want to target
domain_idGet the custom domain associated with the specified ID. › Responses
idDomain unique ID. (UUID format)
container_idUnique ID of the container the domain is assigned to. (UUID format)
hostnameDomain assigned to the container.
statusDomain status.
error_messageDomain last error message.
created_atDomain creation date. (RFC 3339 format)
updated_atDomain last update date. (RFC 3339 format)
tagsA list of arbitrary tags associated with the domain.
Delete the custom domain associated with the specified ID.
path Parameters
regionThe region you want to target
domain_idUUID of the domain to delete.
Delete the custom domain associated with the specified ID. › Responses
idDomain unique ID. (UUID format)
container_idUnique ID of the container the domain is assigned to. (UUID format)
hostnameDomain assigned to the container.
statusDomain status.
error_messageDomain last error message.
created_atDomain creation date. (RFC 3339 format)
updated_atDomain last update date. (RFC 3339 format)
tagsA list of arbitrary tags associated with the domain.
Update the domain associated with the specified ID.
Only fields present in the request are updated; others are left untouched.
path Parameters
regionThe region you want to target
domain_idUUID of the domain to update.
Update the domain associated with the specified ID. › Request Body
tagsA list of arbitrary tags associated with the domain.
Update the domain associated with the specified ID. › Responses
idDomain unique ID. (UUID format)
container_idUnique ID of the container the domain is assigned to. (UUID format)
hostnameDomain assigned to the container.
statusDomain status.
error_messageDomain last error message.
created_atDomain creation date. (RFC 3339 format)
updated_atDomain last update date. (RFC 3339 format)
tagsA list of arbitrary tags associated with the domain.