Get All Records (API) | Dyn Help Center

Retrieving a list of zone records using the API requires specific syntax depending on whether you are using REST or SOAP. Use this table to find the syntax for your command.

Understanding How The API Works »

REST Syntax

Click to view all REST Resources

AllRecord/ GET — Retrieves a list of all record resources for the specified node and zone combination as well as all records from any object below that point on the zone hierarchy.

HTTP Action — GET

URIs

Retrieves all records from the zone — https://api.dynect.net/REST/AllRecord/<zone>

Retrieves all records from the node — https://api.dynect.net/REST/AllRecord/<zone>/<FQDN>/

Arguments:

No Arguments.

Response:

array — Individual record resources.

SOAP Syntax

Click to view all SOAP Commands

GetAllRecords — Retrieves a list of record resources for all records of any type at the specified node point or beneath the named node.

Arguments:

string token — Required. The session identifier.
string zone — Required. Zone name of the records to retrieve.
string FQDN — Fully Qualified Domain Name of the records to retrieve. If specified, the records returned are limited to records found at or beneath this node.

Response — Click for More Info

hash data
- array A_records Click for More Info
  - string fqdn — Fully qualified domain name of a node in the zone.
  - hash rdata — RData defining the record.
    - string address — IPv4 Address.
  - string record_id — A numeric identifier for the record.
  - string record_type — The RRType of the record.
  - string ttl — TTL for the record.
  - string zone — Name of the zone.

array AAAA_records Click for More Info
- string fqdn — Fully qualified domain name of a node in the zone.
- hash rdata — RData defining the record.
  - string address — IPv6 Address.
- string record_id — A numeric identifier for the record.
- string record_type — The RRType of the record.
- string ttl — TTL for the record.
- string zone — Name of the zone.

array CERT_records Click for More Info
- string fqdn — Fully qualified domain name of a node in the zone.
- hash rdata — RData defining the record.
  - string format — Certificate type.
  - string tag — Key tag, as per DNSSEC types.
  - string algorithm — Algorithm, as per DNSSEC types
  - string certificate — Base-64 encoded certificate data.
- string record_id — A numeric identifier for the record.
- string record_type — The RRType of the record.
- string ttl — TTL for the record.
- string zone — Name of the zone.

array CNAME_records Click for More Info
- string fqdn — Fully qualified domain name of a node in the zone.
- hash rdata — RData defining the record.
  - string cname — Hostname
- string record_id — A numeric identifier for the record.
- string record_type — The RRType of the record.
- string ttl — TTL for the record.
- string zone — Name of the zone.

array DHCID_records Click for More Info
- string fqdn — Fully qualified domain name of a node in the zone.
- hash rdata — RData defining the record.
  - string digest — Base-64 encoded digest of DHCP data.
- string record_id — A numeric identifier for the record.
- string record_type — The RRType of the record.
- string ttl — TTL for the record.
- string zone — Name of the zone.

array DNAME_records Click for More Info
- string fqdn — Fully qualified domain name of a node in the zone.
- hash rdata — RData defining the record.
  - string dname — Target hostname
- string record_id — A numeric identifier for the record.
- string record_type — The RRType of the record.
- string ttl — TTL for the record.
- string zone — Name of the zone.

array DNSKEY_records Click for More Info
- string fqdn — Fully qualified domain name of a node in the zone.
- hash rdata — RData defining the record.
  - string algorithm
  - string flags
  - string protocol
  - string public_key
- string record_id — A numeric identifier for the record.
- string record_type — The RRType of the record.
- string ttl — TTL for the record.
- string zone — Name of the zone.

array DS_records Click for More Info
- string fqdn — Fully qualified domain name of a node in the zone.
- hash rdata — RData defining the record.
  - string algorithm
  - string digest
  - string digtype
  - string keytag
- string record_id — A numeric identifier for the record.
- string record_type — The RRType of the record.
- string ttl — TTL for the record.
- string zone — Name of the zone.

array IPSECKEY_records Click for More Info
- string fqdn — Fully qualified domain name of a node in the zone.
- hash rdata — RData defining the record.
  - string precedence — Precedence among other IPSECKEY records here.
  - string gatetype — Type of gateway field: 1 = IPv4 address; 2 = IPv6 address; 3 = Hostname.
  - string algorithm — Algorithm for public_key field.
  - string gateway — The IPSec gateway.
  - string public_key — Base-64 encoded public key data.
- string record_id — A numeric identifier for the record.
- string record_type — The RRType of the record.
- string ttl — TTL for the record.
- string zone — Name of the zone.

array KEY_records Click for More Info
- string fqdn — Fully qualified domain name of a node in the zone.
- hash rdata — RData defining the record.
  - string algorithm
  - string flags
  - string protocol
  - string public_key
- string record_id — A numeric identifier for the record.
- string record_type — The RRType of the record.
- string ttl — TTL for the record.
- string zone — Name of the zone.

array KX_records Click for More Info
- string fqdn — Fully qualified domain name of a node in the zone.
- hash rdata — RData defining the record.
  - string exchange
  - string preference
- string record_id — A numeric identifier for the record.
- string record_type — The RRType of the record.
- string ttl — TTL for the record.
- string zone — Name of the zone.

array LOC_records Click for More Info
- string fqdn — Fully qualified domain name of a node in the zone.
- hash rdata — RData defining the record.
  - string altitude
  - string horiz_pre
  - string latitude
  - string longitude
  - string size
  - string version
  - string vert_pre
- string record_id — A numeric identifier for the record.
- string record_type — The RRType of the record.
- string ttl — TTL for the record.
- string zone — Name of the zone.

array MX_records Click for More Info
- string FQDN — Fully qualified domain name of a node in the zone.
- hash rdata — RData defining the record
  - string exchange
  - string preference
- string record_id — A numeric identifier for the record.
- string record_type — The RRType of the record.
- string ttl — TTL for the record.
- string zone — Name of the zone.

array NAPTR_records Click for More Info
- string FQDN — Fully qualified domain name of a node in the zone.
- hash rdata — RData defining the record.
  - string order — Ordering of NAPTR records here.
  - string preference — Precedence among other NAPTR records here.
  - string flags — Application-specific flags.
  - string services — Service parameters specific to application.
  - string regexp — A substitution expression.
  - string replacement — A replacement hostname.
- string record_id — A numeric identifier for the record.
- string record_type — The RRType of the record.
- string ttl — TTL for the record.
- string zone — Name of the zone.

array NS_records Click for More Info
- string FQDN — Fully qualified domain name of a node in the zone.
- hash rdata — RData defining the record.
  - string nsdname
- string record_id — A numeric identifier for the record.
- string record_type — The RRType of the record.
- string ttl — TTL for the record.
- string zone — Name of the zone.

array NSAP_records Click for More Info
- string FQDN — Fully qualified domain name of a node in the zone.
- hash rdata — RData defining the record.
  - string nsap — Hex-encoded NSAP identifier.
- string record_id — A numeric identifier for the record.
- string record_type — The RRType of the record.
- string ttl — TTL for the record.
- string zone — Name of the zone.

array PTR_records Click for More Info
- string FQDN — Fully qualified domain name of a node in the zone.
- hash rdata — RData defining the record
  - string ptrdname
- string record_id — A numeric identifier for the record.
- string record_type — The RRType of the record.
- string ttl — TTL for the record.
- string zone — Name of the zone.

array PX_records Click for More Info
- string FQDN — Fully qualified domain name of a node in the zone.
- hash rdata — RData defining the record.
  - string preference — numeric preference.
  - string map822 — mail hostname.
  - string mapx400 — X.400 address mapping.
- string record_id — A numeric identifier for the record.
- string record_type — The RRType of the record.
- string ttl — TTL for the record.
- string zone — Name of the zone.

array RP_records Click for More Info
- string FQDN — Fully qualified domain name of a node in the zone.
- hash rdata — RData defining the record
  - string mbox
  - string txtdname
- string record_id — A numeric identifier for the record.
- string record_type — The RRType of the record.
- string ttl — TTL for the record.
- string zone — Name of the zone

array SSHFP_records Click for More Info
- string FQDN — Fully qualified domain name of a node in the zone.
- hash rdata — RData defining the record.
  - string algorithm — algorithm for SSH key.
  - string fptype — type of fingerprint hash.
  - string fingerprint — hex-encoded fingerprint.
- string record_id — A numeric identifier for the record.
- string record_type — The RRType of the record.
- string ttl — TTL for the record.
- string zone — Name of the zone.

array SOA_records Click for More Info
- string FQDN — Fully qualified domain name of a node in the zone.
- hash rdata — RData defining the record.
  - string expire
  - string minimum
  - string mname
  - string refresh
  - string retry
  - string rname
  - string serial
- string record_id — A numeric identifier for the record.
- string record_type — The RRType of the record.
- string serial_style — The style of the zone’s serial.
  Valid values:
  increment – Serials are incremented by 1 on every change
  epoch – Serials will be the UNIX timestamp at the time of the publish
  day – Serials will be in the form of YYYYMMDDxx where xx is incremented by one for each change during that particular day.
  minute – Serials will be in the form of YYMMDDHHMM.
- string ttl — TTL for the record.
- string zone — Name of the zone.

array SPF_records Click for More Info
- string FQDN — Fully qualified domain name of a node in the zone.
- hash rdata — RData defining the record.
  - string txtdata
- string record_id — A numeric identifier for the record.
- string record_type — The RRType of the record.
- string ttl — TTL for the record.
- string zone — Name of the zone

array SRV_records Click for More Info
- string fqdn — Fully qualified domain name of a node in the zone.
- hash rdata — RData defining the record.
  - string port
  - string priority
  - string target
  - string weight
- string record_id — A numeric identifier for the record.
- string record_type — The RRType of the record.
- string ttl — TTL for the record.
- string zone — Name of the zone.

array TXT_records Click for More Info
- string FQDN — Fully qualified domain name of a node in the zone.
- hash rdata — RData defining the record.
  - string txtdata
- string record_id — A numeric identifier for the record.
- string record_type — The RRType of the record.
- string ttl — TTL for the record.
- string zone — Name of the zone.

Example Request — Click for More Info

{
	'token' => 'asdlkfjasl23j4879afa',
	'zone' => 'example.com',
}

DNS API Knowledge Base