Skip to main content
POST
Share a custom domain

Authorizations

Authorization
string
header
required

OAuth2 authentication with JWT tokens

Path Parameters

domainName
string
required

Name of the custom domain

Body

application/json
targetWorkspace
string
required

Name of the workspace to share the domain with, or "account" to share with every workspace of the account.

Response

successful operation

Custom domain for preview deployments The custom domain represents a base domain (e.g., example.com) that will be used to serve preview deployments. Each preview will be accessible at a subdomain: .preview. (e.g., abc123.preview.example.com)

metadata
object
required

Custom domain metadata

spec
object
required

Custom domain specification

Last modified on July 14, 2026