API Reference

Dennis API

Resources & Endpoints

List zone records

Lists all the records for a given zone.

GET
https://dennis.localhost/api/v1/zones/{zone}/records

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

Arguments

The following arguments are supported for this endpoint.

Name Type Default Value

zone Required

Zone Lookup None

name

Filter records by name)

 String None

type

Filter records by type

 Record types None

query

Filter records by their name or content (partial matching)

 String None

exclude_managed

Exclude returning any records that are managed by Dennis

 Boolean None

tags

Filter records to include all records with any of the given tags

 String Array None

Potential Errors

The following errors may occur during this request.

Details HTTP status

zone_not_found

No zone could be found using the given arguments

 404 Not Found

Returned Object

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

{
    records: [ Record {
        id: Integer
        name: String?
        external_reference: String?
        type: Record types
        full_name: String
        ttl: Integer?
        priority: Integer?
        managed: Boolean
        created_at: Unix Timestamp
        updated_at: Unix Timestamp
        raw_content: String
        display_content: String
        content: RecordContentAttributes {
            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?
            }
            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?
            }
            IPS: RecordContentAttributesForIPS? {
                ip_addresses: String?
            }
        }
    } ]
}