Domains

List domains

GET/accounts/{account_id}/registrar/domains

Get domain

GET/accounts/{account_id}/registrar/domains/{domain_name}

Update domain

PUT/accounts/{account_id}/registrar/domains/{domain_name}

ModelsExpand Collapse

Domain = object { id, available, can_register, 9 more }

id: optional string

Domain identifier.

maxLength32

available: optional boolean

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

can_register: optional boolean

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

created_at: optional string

Shows time of creation.

formatdate-time

current_registrar: optional string

Shows name of current registrar.

expires_at: optional string

Shows when domain name registration expires.

formatdate-time

locked: optional boolean

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

registrant_contact: optional object { address, city, country, 10 more }

Shows contact information for domain registrant.

address: string

Address.

city: string

City.

country: string

The country in which the user lives.

maxLength30

first_name: string

User's first name

maxLength60

last_name: string

User's last name

maxLength60

organization: string

Name of organization.

phone: string

User's telephone number

maxLength20

state: string

State.

zip: string

The zipcode or postal code where the user lives.

maxLength20

id: optional string

Contact Identifier.

maxLength32

address2: optional string

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

email: optional string

The contact email address of the user.

maxLength90

fax: optional string

Contact fax number.

registry_statuses: optional string

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

supported_tld: optional boolean

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

transfer_in: optional object { accept_foa, approve_transfer, can_cancel_transfer, 3 more }

Statuses for domain transfers into Cloudflare Registrar.

accept_foa: optional "needed" or "ok"

Form of authorization has been accepted by the registrant.

One of the following:

"needed"

"ok"

approve_transfer: optional "needed" or "ok" or "pending" or 3 more

Shows transfer status with the registry.

One of the following:

"needed"

"ok"

"pending"

"trying"

"rejected"

"unknown"

can_cancel_transfer: optional boolean

Indicates if cancellation is still possible.

disable_privacy: optional "needed" or "ok" or "unknown"

Privacy guards are disabled at the foreign registrar.

One of the following:

"needed"

"ok"

"unknown"

enter_auth_code: optional "needed" or "ok" or "pending" or 2 more

Auth code has been entered and verified.

One of the following:

"needed"

"ok"

"pending"

"trying"

"rejected"

unlock_domain: optional "needed" or "ok" or "pending" or 2 more

Domain is unlocked at the foreign registrar.

One of the following:

"needed"

"ok"

"pending"

"trying"

"unknown"

updated_at: optional string

Last updated.

formatdate-time

DomainGetResponse = unknown

DomainUpdateResponse = unknown