List Peers

List Peers.

application/json

Body

result

required

Any of

allOf {2}

array[object (peer) {6}]

allOf {2}

One of

array[object (peer) {6}]

object

peer_components-schemas-identifier

required

Example:

23ff594956f20c2a721606e94745a8aa

string

Cloudflare Client API_ip

optional

IPv4/IPv6 address of primary or secondary nameserver, depending on what zone this peer is linked to. For primary zones this IP defines the IP of the secondary nameserver Cloudflare will NOTIFY upon zone changes. For secondary zones this IP defines the IP of the primary nameserver Cloudflare will send AXFR/IXFR requests to.

Example:

192.0.2.53

ixfr_enable

boolean

ixfr_enable

optional

Enable IXFR transfer protocol, default is AXFR. Only applicable to secondary zones.

Example:

false

name

string

peer_components-schemas-name

required

The name of the peer.

Example:

my-peer-1

port

number

port

optional

DNS port of primary or secondary nameserver, depending on what zone this peer is linked to.

Example:

tsig_id

string

tsig_id

optional

TSIG authentication will be used for zone transfer if configured.

Example:

69cd1e104af3e6ed3cb344f263fd0d5a

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": [
        {
            "id": "23ff594956f20c2a721606e94745a8aa",
            "ip": "192.0.2.53",
            "ixfr_enable": false,
            "name": "my-peer-1",
            "port": 53,
            "tsig_id": "69cd1e104af3e6ed3cb344f263fd0d5a"
        }
    ],
    "success": true,
    "result_info": {
        "count": 1,
        "page": 1,
        "per_page": 20,
        "total_count": 2000
    }
}

Request

Request samples

Responses