List custom domains

Returns all custom domains configured in the workspace. Custom domains allow serving preview deployments under your own domain (e.g., preview.yourdomain.com).

GET /customdomains

List custom domains

cURL

curl --request GET \
  --url https://api.blaxel.ai/v0/customdomains \
  --header 'Authorization: Bearer <token>'

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

Response

200 - application/json

successful operation

metadata · object · required

Custom domain metadata

Show child attributes

spec · object · required

Custom domain specification

Show child attributes