Skip to content
Cloudflare API
Start here
API Reference
Pages
Projects

Domains

List Pages custom domains
pages.projects.domains.list(strproject_name, DomainListParams**kwargs) -> SyncSinglePage[DomainListResponse]
GET/accounts/{account_id}/pages/projects/{project_name}/domains
Get a Pages custom domain
pages.projects.domains.get(strdomain_name, DomainGetParams**kwargs) -> DomainGetResponse
GET/accounts/{account_id}/pages/projects/{project_name}/domains/{domain_name}
Add a Pages custom domain
pages.projects.domains.create(strproject_name, DomainCreateParams**kwargs) -> DomainCreateResponse
POST/accounts/{account_id}/pages/projects/{project_name}/domains
Retry custom domain validation
pages.projects.domains.edit(strdomain_name, DomainEditParams**kwargs) -> DomainEditResponse
PATCH/accounts/{account_id}/pages/projects/{project_name}/domains/{domain_name}
Delete a Pages custom domain
pages.projects.domains.delete(strdomain_name, DomainDeleteParams**kwargs) -> object
DELETE/accounts/{account_id}/pages/projects/{project_name}/domains/{domain_name}
ModelsExpand Collapse
class DomainListResponse: …
id: str
certificate_authority: Literal["google", "lets_encrypt"]
One of the following:
"google"
"lets_encrypt"
created_on: str
domain_id: str
name: str

Fully qualified domain name for the Pages project, such as example.com.

status: Literal["initializing", "pending", "active", 3 more]
One of the following:
"initializing"
"pending"
"active"
"deactivated"
"blocked"
"error"
validation_data: ValidationData
method: Literal["http", "txt"]
One of the following:
"http"
"txt"
status: Literal["initializing", "pending", "active", 2 more]
One of the following:
"initializing"
"pending"
"active"
"deactivated"
"error"
error_message: Optional[str]
txt_name: Optional[str]
txt_value: Optional[str]
verification_data: VerificationData
status: Literal["pending", "active", "deactivated", 2 more]
One of the following:
"pending"
"active"
"deactivated"
"blocked"
"error"
error_message: Optional[str]
zone_tag: str
class DomainGetResponse: …
id: str
certificate_authority: Literal["google", "lets_encrypt"]
One of the following:
"google"
"lets_encrypt"
created_on: str
domain_id: str
name: str

Fully qualified domain name for the Pages project, such as example.com.

status: Literal["initializing", "pending", "active", 3 more]
One of the following:
"initializing"
"pending"
"active"
"deactivated"
"blocked"
"error"
validation_data: ValidationData
method: Literal["http", "txt"]
One of the following:
"http"
"txt"
status: Literal["initializing", "pending", "active", 2 more]
One of the following:
"initializing"
"pending"
"active"
"deactivated"
"error"
error_message: Optional[str]
txt_name: Optional[str]
txt_value: Optional[str]
verification_data: VerificationData
status: Literal["pending", "active", "deactivated", 2 more]
One of the following:
"pending"
"active"
"deactivated"
"blocked"
"error"
error_message: Optional[str]
zone_tag: str
class DomainCreateResponse: …
id: str
certificate_authority: Literal["google", "lets_encrypt"]
One of the following:
"google"
"lets_encrypt"
created_on: str
domain_id: str
name: str

Fully qualified domain name for the Pages project, such as example.com.

status: Literal["initializing", "pending", "active", 3 more]
One of the following:
"initializing"
"pending"
"active"
"deactivated"
"blocked"
"error"
validation_data: ValidationData
method: Literal["http", "txt"]
One of the following:
"http"
"txt"
status: Literal["initializing", "pending", "active", 2 more]
One of the following:
"initializing"
"pending"
"active"
"deactivated"
"error"
error_message: Optional[str]
txt_name: Optional[str]
txt_value: Optional[str]
verification_data: VerificationData
status: Literal["pending", "active", "deactivated", 2 more]
One of the following:
"pending"
"active"
"deactivated"
"blocked"
"error"
error_message: Optional[str]
zone_tag: str
class DomainEditResponse: …
id: str
certificate_authority: Literal["google", "lets_encrypt"]
One of the following:
"google"
"lets_encrypt"
created_on: str
domain_id: str
name: str

Fully qualified domain name for the Pages project, such as example.com.

status: Literal["initializing", "pending", "active", 3 more]
One of the following:
"initializing"
"pending"
"active"
"deactivated"
"blocked"
"error"
validation_data: ValidationData
method: Literal["http", "txt"]
One of the following:
"http"
"txt"
status: Literal["initializing", "pending", "active", 2 more]
One of the following:
"initializing"
"pending"
"active"
"deactivated"
"error"
error_message: Optional[str]
txt_name: Optional[str]
txt_value: Optional[str]
verification_data: VerificationData
status: Literal["pending", "active", "deactivated", 2 more]
One of the following:
"pending"
"active"
"deactivated"
"blocked"
"error"
error_message: Optional[str]
zone_tag: str