Domains

Custom domains can be used to give your deployments a unique URL.

List an organization's domains

GET/v1/organizations/{organizationId}/domains

Get a list of domains associated with an organization. Links to the first, last, next, and previous pages of results are found in the Link header of the response.

Parameters

Name	Type	Description
page	integer
limit	integer
organizationId (required)	string (uuid)	Organization ID

Responses

Success (200)

Response Type

application/json

Response Properties

Name	Type	Description
id	string (uuid)	The ID of the domain.
organizationId	string (uuid)	The ID of the organization that the domain is associated with.
domain	string	The domain value.
token	string
isValidated	boolean	Whether the domain's ownership is validated or not.
certificates	array	TLS certificates for the domain.
provisioningStatus	undefined
projectId	string (uuid)	The ID of the project that the domain is associated with. If the domain is not associated with any project, this field is omitted.
createdAt	string (date-time)
updatedAt	string (date-time)
dnsRecords	array	These records are used to verify the ownership of the domain.

Invalid Request (400)

Response Type

application/json

Response Properties

Name	Type	Description
code	string	The error code
message	string	The error message

Unauthorized (401)

Response Type

application/json

Response Properties

Name	Type	Description
code	string	The error code
message	string	The error message

Not Found (404)

Response Type

application/json

Response Properties

Name	Type	Description
code	string	The error code
message	string	The error message

Add a domain to an organization

POST/v1/organizations/{organizationId}/domains

Add a new domain to the specified organization. Before use, added domain needs to be verified, and TLS certificates for the domain need to be provisioned.

Parameters

Name	Type	Description
organizationId (required)	string (uuid)	Organization ID

Request Body (JSON)

Name	Type	Description
domain	string

Responses

Success (200)

Response Type

application/json

Response Properties

Name	Type	Description
id	string (uuid)	The ID of the domain.
organizationId	string (uuid)	The ID of the organization that the domain is associated with.
domain	string	The domain value.
token	string
isValidated	boolean	Whether the domain's ownership is validated or not.
certificates	array	TLS certificates for the domain.
provisioningStatus	undefined
projectId	string (uuid)	The ID of the project that the domain is associated with. If the domain is not associated with any project, this field is omitted.
createdAt	string (date-time)
updatedAt	string (date-time)
dnsRecords	array	These records are used to verify the ownership of the domain.

Invalid Request (400)

Response Type

application/json

Response Properties

Name	Type	Description
code	string	The error code
message	string	The error message

Unauthorized (401)

Response Type

application/json

Response Properties

Name	Type	Description
code	string	The error code
message	string	The error message

Not Found (404)

Response Type

application/json

Response Properties

Name	Type	Description
code	string	The error code
message	string	The error message

Get a domain by ID

GET/v1/domains/{domainId}

Get metadata about a domain by the given ID.

Parameters

Name	Type	Description
domainId (required)	string (uuid)	Domain ID

Responses

Success (200)

Response Type

application/json

Response Properties

Name	Type	Description
id	string (uuid)	The ID of the domain.
organizationId	string (uuid)	The ID of the organization that the domain is associated with.
domain	string	The domain value.
token	string
isValidated	boolean	Whether the domain's ownership is validated or not.
certificates	array	TLS certificates for the domain.
provisioningStatus	undefined
projectId	string (uuid)	The ID of the project that the domain is associated with. If the domain is not associated with any project, this field is omitted.
createdAt	string (date-time)
updatedAt	string (date-time)
dnsRecords	array	These records are used to verify the ownership of the domain.

Invalid Request (400)

Response Type

application/json

Response Properties

Name	Type	Description
code	string	The error code
message	string	The error message

Unauthorized (401)

Response Type

application/json

Response Properties

Name	Type	Description
code	string	The error code
message	string	The error message

Not Found (404)

Response Type

application/json

Response Properties

Name	Type	Description
code	string	The error code
message	string	The error message

Associate a domain with a deployment

PATCH/v1/domains/{domainId}

With this API endpoint, you can associate or disassociate a domain with a deployment. Domain association is required in order to serve the deployment on the domain.

Parameters

Name	Type	Description
domainId (required)	string (uuid)	Domain ID

Request Body (JSON)

Name	Type	Description
deploymentId (nullable)	object

Responses

Success (200)

Empty response body

Invalid Request (400)

Response Type

application/json

Response Properties

Name	Type	Description
code	string	The error code
message	string	The error message

Unauthorized (401)

Response Type

application/json

Response Properties

Name	Type	Description
code	string	The error code
message	string	The error message

Not Found (404)

Response Type

application/json

Response Properties

Name	Type	Description
code	string	The error code
message	string	The error message

Delete a domain

DELETE/v1/domains/{domainId}

Delete a domain by the given ID.

Parameters

Name	Type	Description
domainId (required)	string (uuid)	Domain ID

Responses

Success (200)

Empty response body

Invalid Request (400)

Response Type

application/json

Response Properties

Name	Type	Description
code	string	The error code
message	string	The error message

Unauthorized (401)

Response Type

application/json

Response Properties

Name	Type	Description
code	string	The error code
message	string	The error message

Not Found (404)

Response Type

application/json

Response Properties

Name	Type	Description
code	string	The error code
message	string	The error message

Verify a domain

POST/v1/domains/{domainId}/verify

This API endpoint triggers the ownership verification of a domain. It should be called after necessary DNS records are properly set up.

Parameters

Name	Type	Description
domainId (required)	string (uuid)	Domain ID

Responses

Success (200)

Empty response body

Invalid Request (400)

Response Type

application/json

Response Properties

Name	Type	Description
code	string	The error code
message	string	The error message

Unauthorized (401)

Response Type

application/json

Response Properties

Name	Type	Description
code	string	The error code
message	string	The error message

Not Found (404)

Response Type

application/json

Response Properties

Name	Type	Description
code	string	The error code
message	string	The error message

Upload TLS certificate for a domain

POST/v1/domains/{domainId}/certificates

Upload TLS certificates for your domain.

Parameters

Name	Type	Description
domainId (required)	string (uuid)	Domain ID

Request Body (JSON)

Name	Type	Description
privateKey	string	The PEM encoded private key for the TLS certificate
certificateChain	string	The PRM encoded certificate chain for the TLS certificate

Responses

Success (200)

Empty response body

Invalid Request (400)

Response Type

application/json

Response Properties

Name	Type	Description
code	string	The error code
message	string	The error message

Unauthorized (401)

Response Type

application/json

Response Properties

Name	Type	Description
code	string	The error code
message	string	The error message

Not Found (404)

Response Type

application/json

Response Properties

Name	Type	Description
code	string	The error code
message	string	The error message

Provision TLS certificates for a domain

POST/v1/domains/{domainId}/certificates/provision

Provision TLS certificates for your domain.

Parameters

Name	Type	Description
domainId (required)	string (uuid)	Domain ID

Responses

Success (200)

Empty response body

Invalid Request (400)

Response Type

application/json

Response Properties

Name	Type	Description
code	string	The error code
message	string	The error message

Unauthorized (401)

Response Type

application/json

Response Properties

Name	Type	Description
code	string	The error code
message	string	The error message

Not Found (404)

Response Type

application/json

Response Properties

Name	Type	Description
code	string	The error code
message	string	The error message