Sign in
Custom Domains

Create a custom domain for a project

post/projects/{project_id}/custom-domains

Request

  • Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/projects/{project_id}/custom-domains
  • Auth: HTTP bearer

Path parameters

project_idinteger required

Project ID

Request body

branchstring nullable
domainstring required
environment_idinteger required
redirect_tostring nullable
service_namestring nullable

Docker Compose service name this domain routes to (only for docker-compose projects)

status_codeinteger nullable

Response

Custom domain created successfully

branchstring nullable
created_atinteger required
domainstring required
domain_idinteger nullable
expiration_timeinteger nullable
idinteger required
last_renewedinteger nullable
messagestring nullable
project_idinteger required
redirect_tostring nullable
service_namestring nullable

Docker Compose service name this domain routes to

statusstring required
status_codeinteger nullable
updated_atinteger required

Changes

No recorded changes to this operation across all 50 revisions of this API.