DnsRecord

DnsRecord
DnsRecord
JSON Example
{
    "algorithm": "string",
    "cname": {
        "cname": "string"
    },
    "delegated": false,
    "description": "string",
    "fqdn": [
        "string"
    ],
    "ip6_address": [
        {
            "ip6_address": {
                "addr": "string",
                "type": "string"
            }
        }
    ],
    "ip_address": [
        {
            "ip_address": {
                "addr": "string",
                "type": "string"
            }
        }
    ],
    "metadata": "string",
    "mx_records": [
        {
            "host": "string",
            "priority": 0
        }
    ],
    "ns": [
        {
            "ip6_address": {
                "addr": "string",
                "type": "string"
            },
            "ip_address": {
                "addr": "string",
                "type": "string"
            },
            "nsname": "string"
        }
    ],
    "num_records_in_response": 0,
    "service_locator": [
        {
            "port": 0,
            "priority": 0,
            "target": "string",
            "weight": 0
        }
    ],
    "ttl": 0,
    "txt_records": [
        {
            "text_str": "string"
        }
    ],
    "type": "string",
    "wildcard_match": false
}
string
algorithm
Optional
Constraints: default: DNS_RECORD_RESPONSE_ROUND_ROBIN

Specifies the algorithm to pick the IP address(es) to be returned, when multiple entries are configured. This does not apply if num_records_in_response is 0. Default is round-robin. Enum options - DNS_RECORD_RESPONSE_ROUND_ROBIN, DNS_RECORD_RESPONSE_CONSISTENT_HASH. Field introduced in 17.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

cname
Optional

cname

boolean
delegated
Optional

Configured FQDNs are delegated domains (i.e. they represent a zone cut). Field introduced in 17.1.2. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string
description
Optional

Details of DNS record. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

array of string
fqdn
Optional

Fully Qualified Domain Name. Minimum of 1 items required. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

ip6_address
Optional

IPv6 address in AAAA record. Field introduced in 18.1.1. Maximum of 4 items allowed. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

array of DnsARdata
ip_address
Optional

IP address in A record. Maximum of 4 items allowed. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string
metadata
Optional

Internal metadata for the DNS record. Field introduced in 18.2.5. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

array of DnsMxRdata
mx_records
Optional

MX record. Field introduced in 18.2.9, 20.1.1. Maximum of 4 items allowed. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

array of DnsNsRdata
ns
Optional

Name Server information in NS record. Field introduced in 17.1.1. Maximum of 13 items allowed. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

integer As uint32 As uint32
num_records_in_response
Optional

Specifies the number of records returned by the DNS service. Enter 0 to return all records. Default is 0. Allowed values are 0-20. Special values are 0- Return all records. Field introduced in 17.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

service_locator
Optional

Service locator info in SRV record. Maximum of 4 items allowed. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

integer As uint32 As uint32
ttl
Optional

Time To Live for this DNS record. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

txt_records
Optional

Text record. Field introduced in 18.2.9, 20.1.1. Maximum of 4 items allowed. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string
type
Required

DNS record type. Enum options - DNS_RECORD_OTHER, DNS_RECORD_A, DNS_RECORD_NS, DNS_RECORD_CNAME, DNS_RECORD_SOA, DNS_RECORD_PTR, DNS_RECORD_HINFO, DNS_RECORD_MX, DNS_RECORD_TXT, DNS_RECORD_RP, DNS_RECORD_DNSKEY, DNS_RECORD_AAAA, DNS_RECORD_SRV, DNS_RECORD_OPT, DNS_RECORD_RRSIG, DNS_RECORD_AXFR, DNS_RECORD_ANY. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

boolean
wildcard_match
Optional

Enable wild-card match of fqdn if an exact match is not found in the DNS table, the longest match is chosen by wild-carding the fqdn in the DNS request. Default is false. Field introduced in 17.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.