API Reference

Registrar

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Domains

List domains

Deprecated

client.Registrar.Domains.List(ctx, query) (*SinglePage[Domain], error)

GET/accounts/{account_id}/registrar/domains

Get domain

Deprecated

client.Registrar.Domains.Get(ctx, domainName, query) (*DomainGetResponse, error)

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

Update domain

Deprecated

client.Registrar.Domains.Update(ctx, domainName, params) (*DomainUpdateResponse, error)

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

ModelsExpand Collapse

type Domain struct{…}

ID stringOptional

Domain identifier.

maxLength32

Available boolOptional

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

CanRegister boolOptional

Indicates eligibility to register the domain as a new domain.

CreatedAt TimeOptional

Shows time of creation.

formatdate-time

CurrentRegistrar stringOptional

Shows name of current registrar.

ExpiresAt TimeOptional

Shows when domain name registration expires.

formatdate-time

Locked boolOptional

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

RegistrantContact DomainRegistrantContactOptional

Shows contact information for domain registrant.

Address string

Address.

City string

City.

Country string

The country in which the user lives.

maxLength30

FirstName string

User’s first name.

maxLength60

LastName 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 stringOptional

Contact Identifier.

maxLength32

Address2 stringOptional

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

Email stringOptional

The contact email address of the user.

maxLength90

Fax stringOptional

Contact fax number.

RegistryStatuses stringOptional

A comma-separated list of registry status codes. Refer to EPP Status Codes for the full list.

SupportedTLD boolOptional

Indicates whether Cloudflare Registrar currently supports a particular TLD. Refer to TLD Policies for a list of supported TLDs.

TransferIn DomainTransferInOptional

Statuses for domain transfers into Cloudflare Registrar.

AcceptFoa DomainTransferInAcceptFoaOptional

Status of the registrant authorization step.

One of the following:

const DomainTransferInAcceptFoaNeeded DomainTransferInAcceptFoa = "needed"

const DomainTransferInAcceptFoaOk DomainTransferInAcceptFoa = "ok"

ApproveTransfer DomainTransferInApproveTransferOptional

Status of the registry transfer-approval step.

One of the following:

const DomainTransferInApproveTransferNeeded DomainTransferInApproveTransfer = "needed"

const DomainTransferInApproveTransferOk DomainTransferInApproveTransfer = "ok"

const DomainTransferInApproveTransferPending DomainTransferInApproveTransfer = "pending"

const DomainTransferInApproveTransferTrying DomainTransferInApproveTransfer = "trying"

const DomainTransferInApproveTransferRejected DomainTransferInApproveTransfer = "rejected"

const DomainTransferInApproveTransferUnknown DomainTransferInApproveTransfer = "unknown"

CanCancelTransfer boolOptional

Indicates if cancellation is still possible.

DisablePrivacy DomainTransferInDisablePrivacyOptional

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

One of the following:

const DomainTransferInDisablePrivacyNeeded DomainTransferInDisablePrivacy = "needed"

const DomainTransferInDisablePrivacyOk DomainTransferInDisablePrivacy = "ok"

const DomainTransferInDisablePrivacyUnknown DomainTransferInDisablePrivacy = "unknown"

EnterAuthCode DomainTransferInEnterAuthCodeOptional

Status of the auth-code entry and verification step.

One of the following:

const DomainTransferInEnterAuthCodeNeeded DomainTransferInEnterAuthCode = "needed"

const DomainTransferInEnterAuthCodeOk DomainTransferInEnterAuthCode = "ok"

const DomainTransferInEnterAuthCodePending DomainTransferInEnterAuthCode = "pending"

const DomainTransferInEnterAuthCodeTrying DomainTransferInEnterAuthCode = "trying"

const DomainTransferInEnterAuthCodeRejected DomainTransferInEnterAuthCode = "rejected"

UnlockDomain DomainTransferInUnlockDomainOptional

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

One of the following:

const DomainTransferInUnlockDomainNeeded DomainTransferInUnlockDomain = "needed"

const DomainTransferInUnlockDomainOk DomainTransferInUnlockDomain = "ok"

const DomainTransferInUnlockDomainPending DomainTransferInUnlockDomain = "pending"

const DomainTransferInUnlockDomainTrying DomainTransferInUnlockDomain = "trying"

const DomainTransferInUnlockDomainUnknown DomainTransferInUnlockDomain = "unknown"

UpdatedAt TimeOptional

Last updated.

formatdate-time