---
title: Domains
---

[Skip to content](#%5Ftop) 

[API Reference](https://developers.cloudflare.com/api/typescript)

[Registrar](https://developers.cloudflare.com/api/typescript/resources/registrar)

Copy Markdown

Open in **Claude**

Open in **ChatGPT**

Open in **Cursor**

---

**Copy Markdown**

**View as Markdown**

# Domains

##### [List domains](https://developers.cloudflare.com/api/typescript/resources/registrar/subresources/domains/methods/list)

Deprecated

client.registrar.domains.list(DomainListParams { account\_id } params, RequestOptionsoptions?): SinglePage<[Domain](https://developers.cloudflare.com/api/typescript/resources/registrar#%28resource%29%20registrar.domains%20%3E%20%28model%29%20domain%20%3E%20%28schema%29) { id, available, can\_register, 9 more } \>

GET/accounts/{account\_id}/registrar/domains

##### [Get domain](https://developers.cloudflare.com/api/typescript/resources/registrar/subresources/domains/methods/get)

Deprecated

client.registrar.domains.get(stringdomainName, DomainGetParams { account\_id } params, RequestOptionsoptions?): [DomainGetResponse](https://developers.cloudflare.com/api/typescript/resources/registrar#%28resource%29%20registrar.domains%20%3E%20%28model%29%20domain%5Fget%5Fresponse%20%3E%20%28schema%29) | null

GET/accounts/{account\_id}/registrar/domains/{domain\_name}

##### [Update domain](https://developers.cloudflare.com/api/typescript/resources/registrar/subresources/domains/methods/update)

Deprecated

client.registrar.domains.update(stringdomainName, DomainUpdateParams { account\_id, auto\_renew, locked, privacy } params, RequestOptionsoptions?): [DomainUpdateResponse](https://developers.cloudflare.com/api/typescript/resources/registrar#%28resource%29%20registrar.domains%20%3E%20%28model%29%20domain%5Fupdate%5Fresponse%20%3E%20%28schema%29) | 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 eligibility to register the domain 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. Refer to [EPP Status Codes](https://www.icann.org/resources/pages/epp-status-codes-2014-06-16-en) for the full list.

supported\_tld?: boolean

Indicates whether Cloudflare Registrar currently supports a particular TLD. Refer to [TLD Policies](https://www.cloudflare.com/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"

Status of the registrant authorization step.

One of the following:

"needed"

"ok"

approve\_transfer?: "needed" | "ok" | "pending" | 3 more

Status of the registry transfer-approval step.

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"

Status of the privacy-guard disabling step at the foreign registrar.

One of the following:

"needed"

"ok"

"unknown"

enter\_auth\_code?: "needed" | "ok" | "pending" | 2 more

Status of the auth-code entry and verification step.

One of the following:

"needed"

"ok"

"pending"

"trying"

"rejected"

unlock\_domain?: "needed" | "ok" | "pending" | 2 more

Status of the domain-unlock step at the foreign registrar.

One of the following:

"needed"

"ok"

"pending"

"trying"

"unknown"

updated\_at?: string

Last updated.

formatdate-time

DomainGetResponse \= unknown

DomainUpdateResponse \= unknown