Skip to content
Cloudflare API
Start here
API Reference
Registrar

Domains

List domains
registrar.domains.list(DomainListParams**kwargs) -> SyncSinglePage[Domain]
GET/accounts/{account_id}/registrar/domains
Get domain
registrar.domains.get(strdomain_name, DomainGetParams**kwargs) -> object
GET/accounts/{account_id}/registrar/domains/{domain_name}
Update domain
registrar.domains.update(strdomain_name, DomainUpdateParams**kwargs) -> object
PUT/accounts/{account_id}/registrar/domains/{domain_name}
ModelsExpand Collapse
class Domain: …
id: Optional[str]

Domain identifier.

maxLength32
available: Optional[bool]

Shows if a domain is available for transferring into Cloudflare Registrar.

can_register: Optional[bool]

Indicates if the domain can be registered as a new domain.

created_at: Optional[datetime]

Shows time of creation.

formatdate-time
current_registrar: Optional[str]

Shows name of current registrar.

expires_at: Optional[datetime]

Shows when domain name registration expires.

formatdate-time
locked: Optional[bool]

Shows whether a registrar lock is in place for a domain.

registrant_contact: Optional[RegistrantContact]

Shows contact information for domain registrant.

address: str

Address.

city: str

City.

country: Optional[str]

The country in which the user lives.

maxLength30
first_name: Optional[str]

User's first name

maxLength60
last_name: Optional[str]

User's last name

maxLength60
organization: str

Name of organization.

phone: Optional[str]

User's telephone number

maxLength20
state: str

State.

zip: Optional[str]

The zipcode or postal code where the user lives.

maxLength20
id: Optional[str]

Contact Identifier.

maxLength32
address2: Optional[str]

Optional address line for unit, floor, suite, etc.

email: Optional[str]

The contact email address of the user.

maxLength90
fax: Optional[str]

Contact fax number.

registry_statuses: Optional[str]

A comma-separated list of registry status codes. A full list of status codes can be found at EPP Status Codes.

supported_tld: Optional[bool]

Whether a particular TLD is currently supported by Cloudflare Registrar. Refer to TLD Policies for a list of supported TLDs.

transfer_in: Optional[TransferIn]

Statuses for domain transfers into Cloudflare Registrar.

accept_foa: Optional[Literal["needed", "ok"]]

Form of authorization has been accepted by the registrant.

One of the following:
"needed"
"ok"
approve_transfer: Optional[Literal["needed", "ok", "pending", 3 more]]

Shows transfer status with the registry.

One of the following:
"needed"
"ok"
"pending"
"trying"
"rejected"
"unknown"
can_cancel_transfer: Optional[bool]

Indicates if cancellation is still possible.

disable_privacy: Optional[Literal["needed", "ok", "unknown"]]

Privacy guards are disabled at the foreign registrar.

One of the following:
"needed"
"ok"
"unknown"
enter_auth_code: Optional[Literal["needed", "ok", "pending", 2 more]]

Auth code has been entered and verified.

One of the following:
"needed"
"ok"
"pending"
"trying"
"rejected"
unlock_domain: Optional[Literal["needed", "ok", "pending", 2 more]]

Domain is unlocked at the foreign registrar.

One of the following:
"needed"
"ok"
"pending"
"trying"
"unknown"
updated_at: Optional[datetime]

Last updated.

formatdate-time