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

Create custom domain

cURL

curl --request POST \
  --url https://api.blaxel.ai/v0/customdomains \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "metadata": {
    "displayName": "Preview Domain",
    "labels": {},
    "name": "preview.example.com",
    "workspace": "<string>"
  },
  "spec": {
    "cnameRecords": "<string>",
    "region": "us-pdx-1",
    "txtRecords": {}
  }
}
'

200

{
  "metadata": {
    "createdAt": "<string>",
    "updatedAt": "<string>",
    "createdBy": "<string>",
    "updatedBy": "<string>",
    "displayName": "Preview Domain",
    "labels": {},
    "name": "preview.example.com",
    "workspace": "<string>"
  },
  "spec": {
    "cnameRecords": "<string>",
    "lastVerifiedAt": "<string>",
    "region": "us-pdx-1",
    "status": "verified",
    "txtRecords": {},
    "verificationError": "<string>"
  }
}

Authorizations

OAuth2ApiKeyAuth

Authorization · string · header · required

OAuth2 authentication with JWT tokens

Body

application/json

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

Show child attributes

spec · object · required

Custom domain specification

Show child attributes

Response

200 - application/json

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

Show child attributes

spec · object · required

Custom domain specification

Show child attributes