API Reference

Pages

Projects

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Domains

Get domains

GET/accounts/{account_id}/pages/projects/{project_name}/domains

Get domain

GET/accounts/{account_id}/pages/projects/{project_name}/domains/{domain_name}

Add domain

POST/accounts/{account_id}/pages/projects/{project_name}/domains

Patch domain

PATCH/accounts/{account_id}/pages/projects/{project_name}/domains/{domain_name}

Delete domain

DELETE/accounts/{account_id}/pages/projects/{project_name}/domains/{domain_name}

ModelsExpand Collapse

DomainListResponse { id, certificate_authority, created_on, 6 more }

id: string

certificate_authority: "google" or "lets_encrypt"

One of the following:

"google"

"lets_encrypt"

created_on: string

domain_id: string

name: string

The domain name.

status: "initializing" or "pending" or "active" or 3 more

One of the following:

"initializing"

"pending"

"active"

"deactivated"

"blocked"

"error"

validation_data: { method, status, error_message, 2 more }

method: "http" or "txt"

One of the following:

"http"

"txt"

status: "initializing" or "pending" or "active" or 2 more

One of the following:

"initializing"

"pending"

"active"

"deactivated"

"error"

error_message: optional string

txt_name: optional string

txt_value: optional string

verification_data: { status, error_message }

status: "pending" or "active" or "deactivated" or 2 more

One of the following:

"pending"

"active"

"deactivated"

"blocked"

"error"

error_message: optional string

zone_tag: string

DomainGetResponse { id, certificate_authority, created_on, 6 more }

id: string

certificate_authority: "google" or "lets_encrypt"

One of the following:

"google"

"lets_encrypt"

created_on: string

domain_id: string

name: string

The domain name.

status: "initializing" or "pending" or "active" or 3 more

One of the following:

"initializing"

"pending"

"active"

"deactivated"

"blocked"

"error"

validation_data: { method, status, error_message, 2 more }

method: "http" or "txt"

One of the following:

"http"

"txt"

status: "initializing" or "pending" or "active" or 2 more

One of the following:

"initializing"

"pending"

"active"

"deactivated"

"error"

error_message: optional string

txt_name: optional string

txt_value: optional string

verification_data: { status, error_message }

status: "pending" or "active" or "deactivated" or 2 more

One of the following:

"pending"

"active"

"deactivated"

"blocked"

"error"

error_message: optional string

zone_tag: string

DomainCreateResponse { id, certificate_authority, created_on, 6 more }

id: string

certificate_authority: "google" or "lets_encrypt"

One of the following:

"google"

"lets_encrypt"

created_on: string

domain_id: string

name: string

The domain name.

status: "initializing" or "pending" or "active" or 3 more

One of the following:

"initializing"

"pending"

"active"

"deactivated"

"blocked"

"error"

validation_data: { method, status, error_message, 2 more }

method: "http" or "txt"

One of the following:

"http"

"txt"

status: "initializing" or "pending" or "active" or 2 more

One of the following:

"initializing"

"pending"

"active"

"deactivated"

"error"

error_message: optional string

txt_name: optional string

txt_value: optional string

verification_data: { status, error_message }

status: "pending" or "active" or "deactivated" or 2 more

One of the following:

"pending"

"active"

"deactivated"

"blocked"

"error"

error_message: optional string

zone_tag: string

DomainEditResponse { id, certificate_authority, created_on, 6 more }

id: string

certificate_authority: "google" or "lets_encrypt"

One of the following:

"google"

"lets_encrypt"

created_on: string

domain_id: string

name: string

The domain name.

status: "initializing" or "pending" or "active" or 3 more

One of the following:

"initializing"

"pending"

"active"

"deactivated"

"blocked"

"error"

validation_data: { method, status, error_message, 2 more }

method: "http" or "txt"

One of the following:

"http"

"txt"

status: "initializing" or "pending" or "active" or 2 more

One of the following:

"initializing"

"pending"

"active"

"deactivated"

"error"

error_message: optional string

txt_name: optional string

txt_value: optional string

verification_data: { status, error_message }

status: "pending" or "active" or "deactivated" or 2 more

One of the following:

"pending"

"active"

"deactivated"

"blocked"

"error"

error_message: optional string

zone_tag: string

DomainDeleteResponse = unknown