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": {
    "createdAt": "<string>",
    "updatedAt": "<string>",
    "createdBy": "<string>",
    "updatedBy": "<string>",
    "displayName": "<string>",
    "labels": {},
    "name": "<string>",
    "workspace": "<string>"
  },
  "spec": {
    "cnameTarget": "<string>",
    "lastVerifiedAt": "<string>",
    "status": "<string>",
    "txtRecords": {},
    "verificationError": "<string>"
  }
}'
{
  "metadata": {
    "createdAt": "<string>",
    "updatedAt": "<string>",
    "createdBy": "<string>",
    "updatedBy": "<string>",
    "displayName": "<string>",
    "labels": {},
    "name": "<string>",
    "workspace": "<string>"
  },
  "spec": {
    "cnameTarget": "<string>",
    "lastVerifiedAt": "<string>",
    "status": "<string>",
    "txtRecords": {},
    "verificationError": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

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-id>.preview.<base-domain> (e.g., abc123.preview.example.com)

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-id>.preview.<base-domain> (e.g., abc123.preview.example.com)