Create Peer.
/accounts/{account_identifier}/secondary_dns/peers
post
Secondary DNS (Peer)
secondary-dns-(-peer)-create-peer
{
"business": false,
"enterprise": true,
"free": false,
"pro": false
}{
"enum": [
"#dns_records:edit",
"#organization:read"
]
}[
{
"in": "path",
"name": "account_identifier",
"required": true,
"schema": {
"example": "01a7362d577a6c3019a474fd6f485823",
"readOnly": true
}
}
]{
"content": {
"application/json": {
"schema": {
"required": [
"name"
]
}
}
},
"required": true
}{
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"allOf": [
{
"properties": {
"errors": {
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
},
"messages": {
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
},
"result": {
"anyOf": [
{
"type": "object"
},
{
"items": {},
"type": "array"
},
{
"type": "string"
}
]
},
"success": {
"description": "Whether the API call was successful",
"enum": [
true
],
"example": true,
"type": "boolean"
}
},
"required": [
"success",
"errors",
"messages",
"result"
],
"type": "object"
},
{
"properties": {
"result": {
"anyOf": [
{
"type": "object"
},
{
"type": "string"
}
]
}
}
}
],
"type": "object"
},
{
"properties": {
"result": {
"properties": {
"id": {
"example": "23ff594956f20c2a721606e94745a8aa",
"readOnly": true
},
"ip": {
"description": "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",
"type": "string"
},
"ixfr_enable": {
"description": "Enable IXFR transfer protocol, default is AXFR. Only applicable to secondary zones.",
"example": false,
"type": "boolean"
},
"name": {
"description": "The name of the peer.",
"example": "my-peer-1",
"type": "string"
},
"port": {
"description": "DNS port of primary or secondary nameserver, depending on what zone this peer is linked to.",
"example": 53,
"type": "number"
},
"tsig_id": {
"description": "TSIG authentication will be used for zone transfer if configured.",
"example": "69cd1e104af3e6ed3cb344f263fd0d5a",
"type": "string"
}
},
"required": [
"id",
"name"
],
"type": "object"
}
}
}
]
}
}
},
"description": "Create Peer response"
},
"4XX": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"allOf": [
{
"allOf": [
{
"properties": {
"errors": {
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
},
"messages": {
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
},
"result": {
"anyOf": [
{
"type": "object"
},
{
"items": {},
"type": "array"
},
{
"type": "string"
}
]
},
"success": {
"description": "Whether the API call was successful",
"enum": [
true
],
"example": true,
"type": "boolean"
}
},
"required": [
"success",
"errors",
"messages",
"result"
],
"type": "object"
},
{
"properties": {
"result": {
"anyOf": [
{
"type": "object"
},
{
"type": "string"
}
]
}
}
}
],
"type": "object"
},
{
"properties": {
"result": {
"properties": {
"id": {
"example": "23ff594956f20c2a721606e94745a8aa",
"readOnly": true
},
"ip": {
"description": "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",
"type": "string"
},
"ixfr_enable": {
"description": "Enable IXFR transfer protocol, default is AXFR. Only applicable to secondary zones.",
"example": false,
"type": "boolean"
},
"name": {
"description": "The name of the peer.",
"example": "my-peer-1",
"type": "string"
},
"port": {
"description": "DNS port of primary or secondary nameserver, depending on what zone this peer is linked to.",
"example": 53,
"type": "number"
},
"tsig_id": {
"description": "TSIG authentication will be used for zone transfer if configured.",
"example": "69cd1e104af3e6ed3cb344f263fd0d5a",
"type": "string"
}
},
"required": [
"id",
"name"
],
"type": "object"
}
}
}
]
},
{
"properties": {
"errors": {
"allOf": [
{
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
}
],
"example": [
{
"code": 7003,
"message": "No route for the URI"
}
],
"minLength": 1
},
"messages": {
"allOf": [
{
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
}
],
"example": []
},
"result": {
"enum": [
null
],
"nullable": true,
"type": "object"
},
"success": {
"description": "Whether the API call was successful",
"enum": [
false
],
"example": false,
"type": "boolean"
}
},
"required": [
"success",
"errors",
"messages",
"result"
],
"type": "object"
}
]
}
}
},
"description": "Create Peer response failure"
}
}[
{
"api_email": [],
"api_key": []
}
]