Set custom domain

Attach a custom hostname on a managed Vee3 domain to a hosted static website.

← All Pages endpoints · Capability overview

POST/v1/pages/{page_id}/custom-domain

https://api.vee3.io/v1/pages/{page_id}/custom-domain

50 tokens

Attach a custom hostname on a managed Vee3 domain to a hosted static website.

Authorization

Send your API key in the Authorization header:

Authorization: Bearer YOUR_API_KEY

MCP

The same capability is available as an MCP tool on Vee3 hosted MCP.

Tool name

pages.set_custom_domain

Parameters2 fields

page_idstringRequired

Page id to attach the custom domain to.

custom_domainstringRequired

Hostname to attach, such as www.example.com or example.com. Must be on a domain this Vee3 account already manages. At most 253 characters.

max length 253

Response11 fields

page_idstring

Unique identifier for the page.

namestring

Display name for the page, if set.

slugstring

Page slug.

statusstring

Current page status.

urlstring

Public HTTPS URL for the page. Uses the custom domain when one is attached.

hostnamestring

Preview hostname ({slug}.vee3.site). Always present, including when a custom domain is attached.

custom_domainstring

Custom hostname attached to the page, if any.

messagestring

Note that DNS and TLS can take several minutes to become available, and sometimes up to about 30 minutes.

created_atstring

When the page was created.

updated_atstring

When the page record was last updated.

last_deployed_atstring

When files were last deployed to the page.

HTTP errors: unauthorized, validation_error, insufficient_tokens, payment_required, page_not_found, page_custom_domain_not_managed, page_custom_domain_taken, page_custom_domain_not_allowed, dns_not_using_namecheap

Example request

Python

import requests

url = "https://api.vee3.io/v1/pages/{page_id}/custom-domain"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
}
payload = {
    "page_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "custom_domain": "www.example.com"
}

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

Example responses1 example

200Page details after attaching a custom domain.

custom_domain_attached.json

{
  "page_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "name": "Docs",
  "slug": "docs",
  "status": "active",
  "url": "https://www.example.com",
  "hostname": "docs.vee3.site",
  "custom_domain": "www.example.com",
  "created_at": "2026-08-11T12:00:00.000Z",
  "updated_at": "2026-08-31T14:40:00.000Z",
  "last_deployed_at": "2026-08-11T12:05:00.000Z",
  "message": "The custom domain is attached. DNS and TLS can take several minutes to become available, and sometimes up to about 30 minutes."
}