Update Peer

PUT

https://api.cloudflare.com/client/v4/accounts/{account_identifier}/secondary_dns/peers/{identifier}

Last modified:2022-12-16 13:48:34

Modify Peer.

Request

Path Params

identifier

string

required

account_identifier

string

required

Body Params application/json

required

Example:

23ff594956f20c2a721606e94745a8aa

string

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

optional

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

Example:

false

name

string

required

The name of the peer.

Example:

my-peer-1

port

number

optional

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

Example:

tsig_id

string

optional

TSIG authentication will be used for zone transfer if configured.

Example:

69cd1e104af3e6ed3cb344f263fd0d5a

Example

{
    "id": "23ff594956f20c2a721606e94745a8aa",
    "ip": "192.0.2.53",
    "ixfr_enable": false,
    "name": "my-peer-1",
    "port": 53,
    "tsig_id": "69cd1e104af3e6ed3cb344f263fd0d5a"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PUT 'https://api.cloudflare.com/client/v4/accounts//secondary_dns/peers/' \
--header 'Content-Type: application/json' \
--data-raw '{
    "id": "23ff594956f20c2a721606e94745a8aa",
    "ip": "192.0.2.53",
    "ixfr_enable": false,
    "name": "my-peer-1",
    "port": 53,
    "tsig_id": "69cd1e104af3e6ed3cb344f263fd0d5a"
}'

Responses

🟢200Update Peer response

application/json

Body

allOf {2}

optional

object (api-response-single)

optional

errors

array [object {2}]

messages

required

Example:

[]

messages

array [object {2}]

messages

required

Example:

[]

result

required

success

enum<boolean>

required

Whether the API call was successful

Allowed value:

true

Example:

true

object

optional

result

object (peer)

optional

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
}

🟢200Update Peer response failure

Modified at 2022-12-16 13:48:34

Peer Details

Delete Primary Zone Configuration