api.dns.record

/dns/domain/(name)/record

api.dns.record.views.dns_record_list(*args, **kwargs)

List (GET) all DNS records which belong to a DNS domain. Delete (DELETE) specified DNS records that belong to a DNS domain.

GET /dns/domain/(name)/record
DC-bound?:
  • ✓ - domain.dc_bound=true
  • ✗ - domain.dc_bound=false
Permissions:
Asynchronous?:
Parameters:
  • name (string) – required - Domain name
  • data.full (boolean) – Return list of objects with all record details (default: false)
  • data.order_by (string) – Available fields for sorting: id, name, type, ttl, disabled, changed (default: id)
Status Codes:
DELETE /dns/domain/(name)/record
DC-bound?:
  • ✓ - domain.dc_bound=true
  • ✗ - domain.dc_bound=false
Permissions:
Asynchronous?:
Parameters:
  • name (string) – required - Domain name
  • data.records (array) – required List of DNS record ids to be deleted
Status Codes:

/dns/domain/(name)/record/(record_id)

api.dns.record.views.dns_record(*args, **kwargs)

Show (GET), create (POST, update (PUT) or delete (DELETE) a DNS record.

GET /dns/domain/(name)/record/(record_id)
DC-bound?:
  • ✓ - domain.dc_bound=true
  • ✗ - domain.dc_bound=false
Permissions:
Asynchronous?:
Parameters:
  • name (string) – required - Domain name
  • record_id (integer) – required - DNS record ID
Status Codes:
POST /dns/domain/(name)/record
DC-bound?:
  • ✓ - domain.dc_bound=true
  • ✗ - domain.dc_bound=false
Permissions:
Asynchronous?:
Parameters:
  • name (string) – required - Domain name
  • data.name (string) – required - The name of the DNS record - the full URI the DNS server should pick up on
  • data.type (string) – required - DNS record type (one of: A, AAAA, CERT, CNAME, HINFO, KEY, LOC, MX, NAPTR, NS, PTR, RP, SOA, SPF, SSHFP, SRV, TLSA, TXT)
  • data.content (string) – required - DNS record content - the answer of the DNS query
  • data.ttl (integer) – How long (seconds) the DNS client is allowed to remember this record (default: 3600)
  • data.prio (integer) – Priority used by some record types (default: 0)
  • data.disabled (boolean) – If set to true, this record is hidden from DNS clients (default: false)
Status Codes:
PUT /dns/domain/(name)/record/(record_id)
DC-bound?:
  • ✓ - domain.dc_bound=true
  • ✗ - domain.dc_bound=false
Permissions:
Asynchronous?:
Parameters:
  • name (string) – required - Domain name
  • record_id (integer) – required - DNS record ID
  • data.name (string) – The name of the DNS record - the full URI the DNS server should pick up on
  • data.type (string) – DNS record type (one of: A, AAAA, CERT, CNAME, HINFO, KEY, LOC, MX, NAPTR, NS, PTR, RP, SOA, SPF, SSHFP, SRV, TLSA, TXT)
  • data.content (string) – DNS record content - the answer of the DNS query
  • data.ttl (integer) – How long (seconds) the DNS client is allowed to remember this record
  • data.prio (integer) – Priority used by some record types
  • data.disabled (boolean) – If set to true, this record is hidden from DNS clients
Status Codes:
DELETE /dns/domain/(name)/record/(record_id)
DC-bound?:
  • ✓ - domain.dc_bound=true
  • ✗ - domain.dc_bound=false
Permissions:
Asynchronous?:
Parameters:
  • name (string) – required - Domain name
  • record_id (integer) – required - DNS record ID
Status Codes: