List domains

List domains handled by Registrar.

application/json

Body

result

required

Any of

allOf {2}

array[object (domains) {12}]

allOf {2}

One of

array[object (domains) {12}]

object

available

boolean

schemas-available

optional

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

Example:

false

can_register

boolean

can_register

optional

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

Example:

false

created_at

string <date-time>

components-schemas-created_at

optional

Shows time of creation.

Example:

2018-08-28T17:26:26Z

current_registrar

string

current_registrar

optional

Shows name of current registrar.

Example:

Cloudflare

expires_at

string <date-time>

expires_at

optional

Shows when domain name registration expires.

Example:

2019-08-28T23:59:59Z

string

schemas-domain_identifier

read-onlyoptional

Domain identifier.

<= 32 characters

Example:

ea95132c15732412d22c1476fa83f27a

locked

boolean

locked

optional

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

Example:

false

registrant_contact

object

registrant_contact

optional

Shows contact information for domain registrant.

registry_statuses

string

registry_statuses

optional

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

Example:

ok,serverTransferProhibited

supported_tld

boolean

supported_tld

optional

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

Example:

true

transfer_in

object

transfer_in

optional

Statuses for domain transfers into Cloudflare Registrar.

updated_at

string <date-time>

domains_components-schemas-updated_at

optional

Last updated.

Example:

2018-08-28T17:26:26Z

errors

array [object {2}]

messages

required

Example:

[]

code

integer

required

>= 1000

message

string

required

messages

array [object {2}]

messages

required

Example:

[]

code

integer

required

>= 1000

message

string

required

success

enum<boolean>

required

Whether the API call was successful

Allowed value:

true

Example:

true

result_info

object

result_info

optional

count

number

optional

Total number of results for the requested service

Example:

page

number

optional

Current page within paginated list of results

Example:

per_page

number

optional

Number of results per page of results

Example:

total_count

number

optional

Total results available without any search parameters

Example:

2000

Example

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

Request

Request samples

Responses