RecordSet Model

Table of Contents

RecordSet ATTRIBUTES

field type description
zoneId string the id of the zone to which this recordset belongs
name string The name of the RecordSet
type string Type of DNS record, supported records are currently: A, AAAA, CNAME, PTR, MX, NS, SOA, SRV, TXT, SSHFP, and SPF. Unsupported types will be given the type UNKNOWN
ttl long the TTL in seconds for the recordset
status string Active - RecordSet is added is created and ready for use, Inactive - RecordSet effects are not applied, Pending - RecordSet is queued for creation, PendingUpdate - RecordSet is queued for update, PendingDelete - RecordSet is queued for delete
created date-time the timestamp GMT when the recordset was created
updated date-time the timestamp GMT when the recordset was last updated
records Array of RecordData Array of record data, a single RecordSet can have multiple DNS records as long as they are all the same type
id string the id of the recordset. This is important as you will use it for other recordset operations
account string DEPRECATED The account that created the RecordSet

RecordSet EXAMPLE

{
    "type": "A",
    "zoneId": "8f8f649f-998e-4428-a029-b4ba5f5bd4ca",
    "name": "foo",
    "ttl": 38400,
    "status": "Active",
    "created": "2017-02-22T21:34:35Z",
    "records": [
        {
            "address": "1.1.1.1"
        },
        {
            "address": "2.2.2.2"
        },
        {
            "address": "3.3.3.3"
        }
    ],
    "id": "8306cce4-e16a-4579-9b19-4af46dc75853",
    "account": "b34f8d18-646f-4843-a80a-7c0d58a22bf5"
}

RECORD DATA INFORMATION

Current supported record types are: A, AAAA, CNAME, PTR, MX, NS, SOA, SRV, TXT, SSHFP, and SPF. Each individual record encodes its data in a record data object, in which each record type has different required attributes

NS and SOA records are currently read-only and cannot be created, updated or deleted

record type attribute type
A address string

   
AAAA address string

   
CNAME cname string

   
MX preference integer
MX exchange string

   
NS nsdname string

   
PTR ptrdname string

   
SOA mname string
SOA rname string
SOA serial long
SOA refresh long
SOA retry long
SOA expire long
SOA minimum long

   
SPF text string

   
SRV priority integer
SRV weight integer
SRV port integer
SRV target string

   
SSHFP algorithm integer
SSHFP type integer
SSHFP fingerprint string

   
TXT text string

RECORD DATA EXAMPLE

Each record is a map that must include all attributes for the data type, the records are stored in the records field of the RecordSet. The records must be an array of at least one record map. All records in the records array must be of the type stored in the typ field of the RecordSet

Use the @ symbol to point to the zone origin

CNAME records cannot point to the zone origin, thus the RecordSet name cannot be @ nor the zone origin

Individual SSHFP record:

{
    "type": "SSHFP",
    "zoneId": "8f8f649f-998e-4428-a029-b4ba5f5bd4ca",
    "name": "foo",
    "ttl": 38400,
    "status": "Active",
    "created": "2017-02-22T21:34:35Z",
    "records": [
        {
            "algorithm": 1,
            "type": 3,
            "fingerprint": "560c7d19d5da9a3a5c7c19992d1fbde15d8dad31"
        }
    ],
    "id": "8306cce4-e16a-4579-9b19-4af46dc75853",
    "account": "b34f8d18-646f-4843-a80a-7c0d58a22bf5"
}

Multiple SSHFP records:

{
    "type": "SSHFP",
    "zoneId": "8f8f649f-998e-4428-a029-b4ba5f5bd4ca",
    "name": "foo",
    "ttl": 38400,
    "status": "Active",
    "created": "2017-02-22T21:34:35Z",
    "records": [
        {
          "algorithm": 1,
          "type": 2,
          "fingerprint": "560c7d19d5da9a3a5c7c19992d1fbde15d8dad31"
        },
        {
          "algorithm": 3,
          "type": 1,
          "fingerprint": "160c7d19d5da9a3a5c7c19992d1fbde15d8dad31"
        },
        {
          "algorithm": 4,
          "type": 1,
          "fingerprint": "260c7d19d5da9a3a5c7c19992d1fbde15d8dad31"
        }
    ],
    "id": "8306cce4-e16a-4579-9b19-4af46dc75853",
    "account": "b34f8d18-646f-4843-a80a-7c0d58a22bf5"
}