v1

latestOpenAPI 3.0.32026-07-22194221292.5 KB

customdomains

Create custom domain

Creates a new custom domain for preview deployments. After creation, you must configure DNS records and verify domain ownership before it becomes active.

post/customdomains

Request body

Example request

{
  "metadata": {
    "displayName": "Preview Domain",
    "name": "preview.example.com"
  },
  "spec": {
    "domainType": "applications",
    "fallbackPreviewId": "my-fallback-preview",
    "region": "us-pdx-1",
    "status": "verified"
  }
}

Response

successful operation

Example response

{
  "metadata": {
    "displayName": "Preview Domain",
    "name": "preview.example.com"
  },
  "spec": {
    "domainType": "applications",
    "fallbackPreviewId": "my-fallback-preview",
    "region": "us-pdx-1",
    "status": "verified"
  }
}