Skip to main content
PUT
/
customdomains
/
{domainName}
Update custom domain
curl --request PUT \
  --url https://api.blaxel.ai/v0/customdomains/{domainName} \
  --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": {}
  }
}
'
{
  "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

​
Authorization
string
header
required

OAuth2 authentication with JWT tokens

Path Parameters

​
domainName
string
required

Name of the custom domain

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

​
spec
object
required

Custom domain specification

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

​
spec
object
required

Custom domain specification

Last modified on June 3, 2026