Skip to content
Cloudflare API
Start here
API Reference
Registrar

Domains

List domains
client.registrar.domains.list(DomainListParams { account_id } params, RequestOptionsoptions?): SinglePage<Domain { id, available, can_register, 9 more } >
GET/accounts/{account_id}/registrar/domains
Get domain
client.registrar.domains.get(stringdomainName, DomainGetParams { account_id } params, RequestOptionsoptions?): DomainGetResponse | null
GET/accounts/{account_id}/registrar/domains/{domain_name}
Update domain
client.registrar.domains.update(stringdomainName, DomainUpdateParams { account_id, auto_renew, locked, privacy } params, RequestOptionsoptions?): DomainUpdateResponse | null
PUT/accounts/{account_id}/registrar/domains/{domain_name}
ModelsExpand Collapse
Domain { id, available, can_register, 9 more }
id?: string

Domain identifier.

maxLength32
available?: boolean

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

can_register?: boolean

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

created_at?: string

Shows time of creation.

formatdate-time
current_registrar?: string

Shows name of current registrar.

expires_at?: string

Shows when domain name registration expires.

formatdate-time
locked?: boolean

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

registrant_contact?: RegistrantContact { address, city, country, 10 more }

Shows contact information for domain registrant.

address: string

Address.

city: string

City.

country: string | null

The country in which the user lives.

maxLength30
first_name: string | null

User's first name

maxLength60
last_name: string | null

User's last name

maxLength60
organization: string

Name of organization.

phone: string | null

User's telephone number

maxLength20
state: string

State.

zip: string | null

The zipcode or postal code where the user lives.

maxLength20
id?: string

Contact Identifier.

maxLength32
address2?: string

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

email?: string

The contact email address of the user.

maxLength90
fax?: string

Contact fax number.

registry_statuses?: string

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

supported_tld?: boolean

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

transfer_in?: TransferIn { accept_foa, approve_transfer, can_cancel_transfer, 3 more }

Statuses for domain transfers into Cloudflare Registrar.

accept_foa?: "needed" | "ok"

Form of authorization has been accepted by the registrant.

One of the following:
"needed"
"ok"
approve_transfer?: "needed" | "ok" | "pending" | 3 more

Shows transfer status with the registry.

One of the following:
"needed"
"ok"
"pending"
"trying"
"rejected"
"unknown"
can_cancel_transfer?: boolean

Indicates if cancellation is still possible.

disable_privacy?: "needed" | "ok" | "unknown"

Privacy guards are disabled at the foreign registrar.

One of the following:
"needed"
"ok"
"unknown"
enter_auth_code?: "needed" | "ok" | "pending" | 2 more

Auth code has been entered and verified.

One of the following:
"needed"
"ok"
"pending"
"trying"
"rejected"
unlock_domain?: "needed" | "ok" | "pending" | 2 more

Domain is unlocked at the foreign registrar.

One of the following:
"needed"
"ok"
"pending"
"trying"
"unknown"
updated_at?: string

Last updated.

formatdate-time
DomainGetResponse = unknown
DomainUpdateResponse = unknown