List DNS records

Return a list of all DNS records in a zone.


If successful, this endpoint will return a 200 OK status.


One of the following scopes are required to use this endpoint.


The following arguments are supported for this endpoint.

Name Type Default Value

dns_zone Required

DNS Zone Lookup None

Potential Errors

The following errors may occur during this request.

Details HTTP status


No DNS zone was found matching any of the criteria provided in the arguments

404 Not Found


The authenticated identity is not permitted to perform this action

403 Forbidden

Returned Object

When the request is successful, you can expect an object matching the specification below to be returned.

    dns_records: [ DNSRecord {
        id: String
        name: String?
        full_name: String
        ttl: Integer?
        type: DNS record types
        priority: Integer?
        content: String
        content_attributes: DNSRecordContentAttributes {
            A: RecordContentAttributesForA? {
                ip_address: String?
            AAAA: RecordContentAttributesForAAAA? {
                ip_address: String?
            ALIAS: RecordContentAttributesForALIAS? {
                hostname: String?
            CAA: RecordContentAttributesForCAA? {
                flag: String?
                tag: String?
                value: String?
            CNAME: RecordContentAttributesForCNAME? {
                hostname: String?
            IPS: RecordContentAttributesForIPS? {
                ip_addresses: String?
            MX: RecordContentAttributesForMX? {
                hostname: String?
            NS: RecordContentAttributesForNS? {
                hostname: String?
            PTR: RecordContentAttributesForPTR? {
                hostname: String?
            SOA: RecordContentAttributesForSOA? {
            SRV: RecordContentAttributesForSRV? {
                weight: String?
                port: String?
                target: String?
            SSHFP: RecordContentAttributesForSSHFP? {
                algorithm: String?
                fingerprint_type: String?
                fingerprint: String?
            TXT: RecordContentAttributesForTXT? {
                content: String?
            VirtualMachine: RecordContentAttributesForVirtualMachine? {
                virtual_machine: String?
    } ]