Skip to main content
POST
Add a custom domain to a deployment. Automatically provisions an SSL certificate via Let’s Encrypt.

Path Parameters

string
required
The deployment ID (e.g., dep_abc123xyz)

Request Body

string
required
The custom domain hostname (e.g., api.example.com)

Response

string
The configured hostname
boolean
Whether the domain is fully configured
string
Certificate status: pending, issued, failed
array
DNS records to configure at your registrar
string
URL to check domain status
The deployment must be in ready state before adding a custom domain.
1

Add the domain

Call this endpoint to register the domain
2

Configure DNS

Add the CNAME record at your domain registrar
3

Wait for certificate

Certificate is issued automatically after DNS propagates (usually 1-5 minutes)