Skip to content

DNS Zones

List all zones

GET /api/zones

OAuth authorization required: dns_read

Schema
  • zones: Array
    • id: Integer
    • name: String
    • created_at: DateTime
    • updated_at: DateTime

View zone

GET /api/zones/{id}

OAuth authorization required: dns_read

Schema
  • zone:
    • id: Integer
    • name: String
    • records: Object
      • A: Array
      • ...
    • created_at: DateTime
    • updated_at: DateTime
Example 
{
  "zone": {
    "id": 2,
    "name": "mytestdomain.net",
    "created_at": "2019-08-26T17:22:39.333Z",
    "updated_at": "2019-08-26T17:22:39.333Z",
    "records": {
      "A": [],
      "AAAA": [],
      "CAA": [],
      "CNAME": [],
      "DS": [],
      "HINFO": [],
      "MX": [],
      "NAPTR": [],
      "NS": [
        {
          "ttl": 86400,
          "zone_id": "mytestdomain.net",
          "type": "NS",
          "name": "mytestdomain.net",
          "hostname": "ns1.auto-dns.com"
        },
        {
          "ttl": 86400,
          "zone_id": "mytestdomain.net",
          "type": "NS",
          "name": "mytestdomain.net",
          "hostname": "ns2.auto-dns.com"
        },
        {
          "ttl": 86400,
          "zone_id": "mytestdomain.net",
          "type": "NS",
          "name": "mytestdomain.net",
          "hostname": "ns3.autodns.nl"
        },
        {
          "ttl": 86400,
          "zone_id": "mytestdomain.net",
          "type": "NS",
          "name": "mytestdomain.net",
          "hostname": "ns4.autodns.nl"
        }
      ],
      "PTR": [],
      "SRV": [],
      "SOA": [
        {
          "ttl": 86400,
          "zone_id": "mytestdomain.net",
          "type": "SOA",
          "refresh": 43200,
          "retry": 7200,
          "expire": 1209600,
          "email": "dns@usr.cloud",
          "default": 86400
        }
      ],
      "SSHFP": [],
      "TLSA": [],
      "TXT": []
    }
  }
}

List All Collaborators

GET /api/zones/{zone-id}/collaborators

Schema
  • collaborations: Array
    • id: Integer
    • collaborator: Object
      • id: Integer
      • email: String
      • full_name: String

View Collaborator

GET /api/zones/{zone-id}/collaborators/{id}

Schema
  • collaboration: Object
    • id: Integer
    • zone: Object
      • id: Integer
      • name: String
  • collaborator: Object
    • id: Integer
    • email: String
    • full_name: String
  • resource_owner: Object
    • id: Integer
    • email: String
    • full_name: String

Create Collaborator Request

POST /api/zones/{zone-id}/collaborators

Schema
  • collaborator: Object
    • user_email: String

Remove Collaborator

DELETE /api/zones/{zone-id}/collaborators/{id}