API Reference

Onyx Core API

Resources & Endpoints

List records for a DNS Domain

Returns a full list of DNS Domain records.

GET
https://portal.onyx.io/api/v2/dns_domains/{dns_domain}/records

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

Arguments

The following arguments are supported for this endpoint.

Name Type Default Value

dns_domain Required

DNS Domain Lookup None

Potential Errors

The following errors may occur during this request.

Details HTTP status

dns_domain_not_found

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

 404 Not Found

Returned Object

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

{
    dns_domain_records: [ DNSDomainRecord {
        id: Integer?
        name: String?
        full_name: String?
        ttl: Integer?
        data: String?
        form_data: [ DNSDomainRecordFormData {
            ip: String?
            name: String?
            host: String?
            priority: String?
            data: String?
            weight: String?
            port: String?
            target: String?
        } ]
        type: [ DNSDomainRecordType {
            class: String?
            name: String?
            color: String?
        } ]
    } ]
}