List domains

GET/accounts/{account_id}/registrar/domains

Lists domains handled by Registrar.

Security

API Token

The preferred authorization scheme for interacting with the Cloudflare API. Create a token.

Example:Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY

API Email + API Key

The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.

Example:X-Auth-Email: user@example.com

The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.

Example:X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194

Path ParametersExpand Collapse

account_id: string

Identifier.

maxLength32

ReturnsExpand Collapse

errors: array of object { code, message, source }

code: number

minimum1000

message: string

source: optional object { pointer }

Location of the invalid value that caused the error.

pointer: string

JSON Pointer to the invalid or missing request value.

messages: array of object { code, message, source }

code: number

minimum1000

message: string

source: optional object { pointer }

Location of the invalid value that caused the error.

pointer: string

JSON Pointer to the invalid or missing request value.

result: array of Domain { 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 eligibility to register the domain 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. Refer to EPP Status Codes for the full list.

supported_tld: optional boolean

Indicates whether Cloudflare Registrar currently supports a particular TLD. 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"

Status of the registrant authorization step.

One of the following:

"needed"

"ok"

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

Status of the registry transfer-approval step.

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"

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

One of the following:

"needed"

"ok"

"unknown"

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

Status of the auth-code entry and verification step.

One of the following:

"needed"

"ok"

"pending"

"trying"

"rejected"

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

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

One of the following:

"needed"

"ok"

"pending"

"trying"

"unknown"

updated_at: optional string

Last updated.

formatdate-time

success: true

Whether the API call was successful.

result_info: optional object { count, page, per_page, total_count }

count: optional number

Total number of results for the requested service.

page: optional number

Current page within paginated list of results.

per_page: optional number

Number of results per page of results.

total_count: optional number

Total results available without any search parameters.

List domains

curl https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/registrar/domains \
    -H "Authorization: Bearer $CLOUDFLARE_API_TOKEN"

{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "result": [
    {
      "id": "ea95132c15732412d22c1476fa83f27a",
      "available": false,
      "can_register": false,
      "created_at": "2018-08-28T17:26:26Z",
      "current_registrar": "Cloudflare",
      "expires_at": "2019-08-28T23:59:59Z",
      "locked": false,
      "registrant_contact": {
        "address": "123 Sesame St.",
        "city": "Austin",
        "country": "US",
        "first_name": "John",
        "last_name": "Appleseed",
        "organization": "Cloudflare, Inc.",
        "phone": "+1 123-123-1234",
        "state": "TX",
        "zip": "12345",
        "id": "ea95132c15732412d22c1476fa83f27a",
        "address2": "Suite 430",
        "email": "user@example.com",
        "fax": "123-867-5309"
      },
      "registry_statuses": "ok,serverTransferProhibited",
      "supported_tld": true,
      "transfer_in": {
        "accept_foa": "needed",
        "approve_transfer": "unknown",
        "can_cancel_transfer": true,
        "disable_privacy": "ok",
        "enter_auth_code": "needed",
        "unlock_domain": "ok"
      },
      "updated_at": "2018-08-28T17:26:26Z"
    }
  ],
  "success": true,
  "result_info": {
    "count": 1,
    "page": 1,
    "per_page": 20,
    "total_count": 2000
  }
}

Returns Examples

{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "result": [
    {
      "id": "ea95132c15732412d22c1476fa83f27a",
      "available": false,
      "can_register": false,
      "created_at": "2018-08-28T17:26:26Z",
      "current_registrar": "Cloudflare",
      "expires_at": "2019-08-28T23:59:59Z",
      "locked": false,
      "registrant_contact": {
        "address": "123 Sesame St.",
        "city": "Austin",
        "country": "US",
        "first_name": "John",
        "last_name": "Appleseed",
        "organization": "Cloudflare, Inc.",
        "phone": "+1 123-123-1234",
        "state": "TX",
        "zip": "12345",
        "id": "ea95132c15732412d22c1476fa83f27a",
        "address2": "Suite 430",
        "email": "user@example.com",
        "fax": "123-867-5309"
      },
      "registry_statuses": "ok,serverTransferProhibited",
      "supported_tld": true,
      "transfer_in": {
        "accept_foa": "needed",
        "approve_transfer": "unknown",
        "can_cancel_transfer": true,
        "disable_privacy": "ok",
        "enter_auth_code": "needed",
        "unlock_domain": "ok"
      },
      "updated_at": "2018-08-28T17:26:26Z"
    }
  ],
  "success": true,
  "result_info": {
    "count": 1,
    "page": 1,
    "per_page": 20,
    "total_count": 2000
  }
}