/accounts/{identifier}/custom_ns/verify
post
Account-Level Custom Nameservers
account-level-custom-nameservers-verify-account-custom-nameserver-glue-records
{
"business": true,
"enterprise": true,
"free": false,
"pro": false
}{
"enum": [
"#organization:edit"
]
}[
{
"in": "path",
"name": "identifier",
"required": true,
"schema": {
"description": "Account identifier tag.",
"example": "372e67954025e0ba6aaa6d586b9e0b59",
"maxLength": 32,
"readOnly": true,
"type": "string"
}
}
]{
"content": {
"application/json": {}
},
"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": {
"items": {},
"nullable": true,
"type": "array"
},
"result_info": {
"properties": {
"count": {
"description": "Total number of results for the requested service",
"example": 1,
"type": "number"
},
"page": {
"description": "Current page within paginated list of results",
"example": 1,
"type": "number"
},
"per_page": {
"description": "Number of results per page of results",
"example": 20,
"type": "number"
},
"total_count": {
"description": "Total results available without any search parameters",
"example": 2000,
"type": "number"
}
},
"type": "object"
}
}
}
],
"type": "object"
},
{
"properties": {
"result": {
"items": {
"description": "A single account custom nameserver.",
"properties": {
"dns_records": {
"description": "A and AAAA records associated with the nameserver.",
"items": {
"properties": {
"type": {
"description": "DNS record type.",
"enum": [
"A",
"AAAA"
],
"example": "A",
"type": "string"
},
"value": {
"description": "DNS record contents (an IPv4 or IPv6 address).",
"example": "1.1.1.1",
"type": "string"
}
}
},
"type": "array"
},
"ns_name": {
"description": "The FQDN of the name server.",
"example": "ns1.example.com",
"format": "hostname",
"type": "string"
},
"ns_set": {
"default": 1,
"description": "The number of the set that this name server belongs to.",
"example": 1,
"maximum": 5,
"minimum": 1,
"type": "number"
},
"status": {
"deprecated": true,
"description": "Verification status of the nameserver.",
"enum": [
"moved",
"pending",
"verified"
],
"example": "verified",
"type": "string"
},
"zone_tag": {
"description": "Identifier",
"example": "023e105f4ecef8ad9ca31a8372d0c353",
"maxLength": 32,
"readOnly": true,
"type": "string"
}
},
"required": [
"dns_records",
"ns_name",
"status",
"zone_tag"
],
"title": "Custom NS"
},
"type": "array"
}
},
"type": "object"
}
]
}
}
},
"description": "Verify Account Custom Nameserver Glue Records 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": {
"items": {},
"nullable": true,
"type": "array"
},
"result_info": {
"properties": {
"count": {
"description": "Total number of results for the requested service",
"example": 1,
"type": "number"
},
"page": {
"description": "Current page within paginated list of results",
"example": 1,
"type": "number"
},
"per_page": {
"description": "Number of results per page of results",
"example": 20,
"type": "number"
},
"total_count": {
"description": "Total results available without any search parameters",
"example": 2000,
"type": "number"
}
},
"type": "object"
}
}
}
],
"type": "object"
},
{
"properties": {
"result": {
"items": {
"description": "A single account custom nameserver.",
"properties": {
"dns_records": {
"description": "A and AAAA records associated with the nameserver.",
"items": {
"properties": {
"type": {
"description": "DNS record type.",
"enum": [
"A",
"AAAA"
],
"example": "A",
"type": "string"
},
"value": {
"description": "DNS record contents (an IPv4 or IPv6 address).",
"example": "1.1.1.1",
"type": "string"
}
}
},
"type": "array"
},
"ns_name": {
"description": "The FQDN of the name server.",
"example": "ns1.example.com",
"format": "hostname",
"type": "string"
},
"ns_set": {
"default": 1,
"description": "The number of the set that this name server belongs to.",
"example": 1,
"maximum": 5,
"minimum": 1,
"type": "number"
},
"status": {
"deprecated": true,
"description": "Verification status of the nameserver.",
"enum": [
"moved",
"pending",
"verified"
],
"example": "verified",
"type": "string"
},
"zone_tag": {
"description": "Identifier",
"example": "023e105f4ecef8ad9ca31a8372d0c353",
"maxLength": 32,
"readOnly": true,
"type": "string"
}
},
"required": [
"dns_records",
"ns_name",
"status",
"zone_tag"
],
"title": "Custom NS"
},
"type": "array"
}
},
"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": "Verify Account Custom Nameserver Glue Records response failure"
}
}[
{
"api_email": [],
"api_key": []
}
]