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

Base URL
https://api.blaxel.ai/v0
Auth
- OAuth 2
  Authorization code/oauth/authorize
  Client credentials
  Token URL/oauth/token
  Scopescustomdomains:create
- or HTTP bearer
TypeScript
https://skmtc.dev/blaxel/apis/blaxel-control-plane/docs/customdomains/post.ts
A function with typed inputs. Its response is checked against the schema.

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"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.