Scan for common DNS records on your domain and automatically add them to your zone. Useful if you haven't updated your nameservers yet.
/zones/{zone_identifier}/dns_records/scan
post
DNS Records for a Zone
dns-records-for-a-zone-scan-dns-records
{
"business": true,
"enterprise": true,
"free": true,
"pro": true
}{
"enum": [
"#dns_records:edit"
]
}[
{
"in": "path",
"name": "zone_identifier",
"required": true,
"schema": {
"description": "Identifier",
"example": "023e105f4ecef8ad9ca31a8372d0c353",
"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": {
"anyOf": [
{
"type": "object"
},
{
"type": "string"
}
]
}
}
}
],
"type": "object"
},
{
"properties": {
"result": {
"properties": {
"recs_added": {
"description": "Number of DNS records added.",
"example": 5,
"type": "number"
},
"total_records_parsed": {
"description": "Total number of DNS records parsed.",
"example": 5,
"type": "number"
}
},
"type": "object"
},
"timing": {
"properties": {
"end_time": {
"description": "When the file parsing ended.",
"example": "2014-03-01T12:20:01Z",
"format": "date-time",
"type": "string"
},
"process_time": {
"description": "Processing time of the file in seconds.",
"example": 1,
"type": "number"
},
"start_time": {
"description": "When the file parsing started.",
"example": "2014-03-01T12:20:00Z",
"format": "date-time",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
]
}
}
},
"description": "Scan DNS 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": {
"anyOf": [
{
"type": "object"
},
{
"type": "string"
}
]
}
}
}
],
"type": "object"
},
{
"properties": {
"result": {
"properties": {
"recs_added": {
"description": "Number of DNS records added.",
"example": 5,
"type": "number"
},
"total_records_parsed": {
"description": "Total number of DNS records parsed.",
"example": 5,
"type": "number"
}
},
"type": "object"
},
"timing": {
"properties": {
"end_time": {
"description": "When the file parsing ended.",
"example": "2014-03-01T12:20:01Z",
"format": "date-time",
"type": "string"
},
"process_time": {
"description": "Processing time of the file in seconds.",
"example": 1,
"type": "number"
},
"start_time": {
"description": "When the file parsing started.",
"example": "2014-03-01T12:20:00Z",
"format": "date-time",
"type": "string"
}
},
"type": "object"
}
},
"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": "Scan DNS Records response failure"
}
}[
{
"api_email": [],
"api_key": []
}
]