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>",
    "fallbackPreviewId": "my-fallback-preview",
    "region": "us-pdx-1",
    "subjectAlternativeNames": [
      {}
    ],
    "txtRecords": {}
  }
}
'

import requests

url = "https://api.blaxel.ai/v0/customdomains"

payload = {
    "metadata": {
        "displayName": "Preview Domain",
        "labels": {},
        "name": "preview.example.com",
        "workspace": "<string>"
    },
    "spec": {
        "cnameRecords": "<string>",
        "fallbackPreviewId": "my-fallback-preview",
        "region": "us-pdx-1",
        "subjectAlternativeNames": [{}],
        "txtRecords": {}
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    metadata: {
      displayName: 'Preview Domain',
      labels: {},
      name: 'preview.example.com',
      workspace: '<string>'
    },
    spec: {
      cnameRecords: '<string>',
      fallbackPreviewId: 'my-fallback-preview',
      region: 'us-pdx-1',
      subjectAlternativeNames: [{}],
      txtRecords: {}
    }
  })
};

fetch('https://api.blaxel.ai/v0/customdomains', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.blaxel.ai/v0/customdomains",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'metadata' => [
        'displayName' => 'Preview Domain',
        'labels' => [
                
        ],
        'name' => 'preview.example.com',
        'workspace' => '<string>'
    ],
    'spec' => [
        'cnameRecords' => '<string>',
        'fallbackPreviewId' => 'my-fallback-preview',
        'region' => 'us-pdx-1',
        'subjectAlternativeNames' => [
                [
                                
                ]
        ],
        'txtRecords' => [
                
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.blaxel.ai/v0/customdomains"

	payload := strings.NewReader("{\n  \"metadata\": {\n    \"displayName\": \"Preview Domain\",\n    \"labels\": {},\n    \"name\": \"preview.example.com\",\n    \"workspace\": \"<string>\"\n  },\n  \"spec\": {\n    \"cnameRecords\": \"<string>\",\n    \"fallbackPreviewId\": \"my-fallback-preview\",\n    \"region\": \"us-pdx-1\",\n    \"subjectAlternativeNames\": [\n      {}\n    ],\n    \"txtRecords\": {}\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.blaxel.ai/v0/customdomains")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"metadata\": {\n    \"displayName\": \"Preview Domain\",\n    \"labels\": {},\n    \"name\": \"preview.example.com\",\n    \"workspace\": \"<string>\"\n  },\n  \"spec\": {\n    \"cnameRecords\": \"<string>\",\n    \"fallbackPreviewId\": \"my-fallback-preview\",\n    \"region\": \"us-pdx-1\",\n    \"subjectAlternativeNames\": [\n      {}\n    ],\n    \"txtRecords\": {}\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.blaxel.ai/v0/customdomains")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"metadata\": {\n    \"displayName\": \"Preview Domain\",\n    \"labels\": {},\n    \"name\": \"preview.example.com\",\n    \"workspace\": \"<string>\"\n  },\n  \"spec\": {\n    \"cnameRecords\": \"<string>\",\n    \"fallbackPreviewId\": \"my-fallback-preview\",\n    \"region\": \"us-pdx-1\",\n    \"subjectAlternativeNames\": [\n      {}\n    ],\n    \"txtRecords\": {}\n  }\n}"

response = http.request(request)
puts response.read_body

200

{
  "metadata": {
    "createdAt": "<string>",
    "updatedAt": "<string>",
    "createdBy": "<string>",
    "updatedBy": "<string>",
    "displayName": "Preview Domain",
    "labels": {},
    "name": "preview.example.com",
    "workspace": "<string>"
  },
  "spec": {
    "cnameRecords": "<string>",
    "fallbackPreviewId": "my-fallback-preview",
    "lastVerifiedAt": "<string>",
    "region": "us-pdx-1",
    "status": "verified",
    "subjectAlternativeNames": [
      {}
    ],
    "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