DNS

DNS Zones

List DNS Zones

This is not account scoped and will return ALL dns zones this user has access to.

GET /api/dns_zones

Returned Params

• dns_zone: Array
  • id: String
  • name: String
  • dnssec: Boolean
  • dnssec_data: Object (nil if dnssec = false)
  • created_at: DateTime
  • updated_at: DateTime
  • account: Object
    • id: String
    • name: String

---

View a Zone

GET /api/dns_zones/:id

Returned Params

• dns_zone: Object
  • id: String
  • name: String
  • dnssec: Boolean
  • dnssec_data: Object (nil if dnssec = false)
    • Enabled: Boolean
    • DsRecord: String
    • Digest: String
    • DigestType: String
    • Algorithm: Integer
    • PublicKey: String
    • KeyTag: Integer
    • Flags: Integer
    • DsConfigured: Boolean
  • created_at: DateTime
  • updated_at: DateTime
  • account: Object
    • id: String
    • name: String
  • records: Array
    • id: String
    • record_type: Integer
    • ttle: Integer
    • value: String
    • name: String
    • priority: Integer
    • port: Integer
    • flags: String
    • record_tag: String
    • site: Object | If a pull zone (record_type == 7)
      • id: String
      • name: String
      • created_at: DateTime
      • updated_at: DateTime
      • primary_domain: String
      • location: String
      • package: String
    • created_at: DateTime
    • updated_at: DateTime
  • nameservers: Array

---

Enable / Disable dnssec

PATCH /api/dns_zones/:id

Params

• dns_zone: Object
  • dnssec: Boolean

Returns the same as show.

---

Create a DNS Zone

POST /api/dns_zones

Params

• dns_zone: Object
  • name: String
  • account_id: String

Returns the same as show.

---

Delete Zone

DELETE /api/dns_zones/:id

Returns 201

DNS Records

List all records

Also returned when viewing a zone

GET /api/dns_zones/:zone_id/records

Returned Params

• dns_records: Array
  • id: String
  • record_type: Integer
  • ttl: Integer
  • value: String
  • name: String
  • priority: Integer
  • weight: Integer
  • port: Integer
  • flags: String
  • record_type: Integer
  • comment: String
  • site: Object | If a pull zone (record_type == 7)
    • id: String
    • name: String
    • created_at: DateTime
    • updated_at: DateTime
    • primary_domain: String
    • location: String
    • package: String
  • created_at: DateTime
  • updated_at: DateTime

View Record

GET /api/dns_zones/:zone_id/records/:id

Returned Params

• dns_record: Object
  • id: String
  • record_type: Integer
  • ttl: Integer
  • value: String
  • name: String
  • priority: Integer
  • weight: Integer
  • port: Integer
  • flags: String
  • record_type: Integer
  • comment: String
  • site: Object | If a pull zone (record_type == 7)
    • id: String
    • name: String
    • created_at: DateTime
    • updated_at: DateTime
    • primary_domain: String
    • location: String
    • package: String
  • created_at: DateTime
  • updated_at: DateTime

Update Record

PATCH /api/dns_zones/{zone_id}/records/{id}

Params

• dns_record: Object
  • record_type: Integer
  • ttl: Integer
  • value: String
  • name: String
  • priority: Integer
  • weight: Integer
  • port: Integer
  • flags: Integer
  • record_tag: String
  • comment: String

Create Records

POST /api/dns_zones/{zone_id}/records

Params

• dns_record: Object
  • record_type: Integer
  • ttl: Integer
  • value: String
  • name: String
  • priority: Integer
  • weight: Integer
  • port: Integer
  • flags: Integer
  • record_tag: String
  • comment: String

Delete Zone

DELETE /api/dns_zones/{zone_id}/records/{id}