api.dns.domain

/dns/domain

api.dns.domain.views.dns_domain_list(*args, **kwargs)

List (GET) all DNS domains.

GET /dns/domain
DC-bound?:
Permissions:
Asynchronous?:
Parameters:
  • data.full (boolean) – Return list of objects with all domain details (default: false)
  • data.extended (boolean) – Return list of objects with extended domain details (default: false)
  • data.order_by (string) – Available fields for sorting: name, created (default: name)
Status Codes:

/dns/domain/(name)

api.dns.domain.views.dns_domain(*args, **kwargs)

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

GET /dns/domain/(name)
DC-bound?:
  • ✓ - dc_bound=true
  • ✗ - dc_bound=false
Permissions:
Asynchronous?:
Parameters:
  • name (string) – required - Domain name
  • data.extended (boolean) – Display extended domain details (default: false)
Status Codes:
POST /dns/domain/(name)
DC-bound?:
  • ✓ - dc_bound=true
  • ✗ - dc_bound=false
Permissions:
Asynchronous?:
Parameters:
  • name (string) – required - Domain name
  • data.access (integer) – Access type (1 - Public, 3 - Private) (default: 3)
  • data.owner (string) – User that owns the domain (default: logged in user)
  • data.type (string) – PowerDNS domain type which determines how records are replicated. One of MASTER, NATIVE. When set to MASTER, PowerDNS will send NOTIFY messages after zone changes to all hosts specified in NS record for given domain. When set to NATIVE, PowerDNS will use only internal database replication between master DNS server and slave DNS servers. (default: MASTER)
  • data.tsig_keys (string) – Comma separated list of TSIG keys that will be allowed to do zone transfer query for this domain. Format: “key-type:key-name:secret,key-type:key-name2:secret2”; Example: “hmac-sha256:mykey:aabbcc..”. (default: empty)
  • data.desc (string) – Domain description
  • data.dc_bound (boolean) – Whether the domain is bound to a datacenter (requires SuperAdmin permission) (default: true)
  • data.dc (string) – Name of the datacenter the domain will be attached to (required if DC-bound)
Status Codes:
PUT /dns/domain/(name)
DC-bound?:
  • ✓ - dc_bound=true
  • ✗ - dc_bound=false
Permissions:
Asynchronous?:
Parameters:
  • name (string) – required - Domain name
  • data.access (integer) – Access type (1 - Public, 3 - Private)
  • data.type (string) – PowerDNS domain type which determines how records are replicated. One of MASTER, NATIVE. When set to MASTER, PowerDNS will send NOTIFY messages after zone changes to all hosts specified in NS record for given domain. When set to NATIVE, PowerDNS will use only internal database replication between master DNS server and slave DNS servers. (default: MASTER)
  • data.owner (string) – User that owns the domain
  • data.tsig_keys (string) – Comma separated list of TSIG keys that will be allowed to do zone transfer query for this domain. Format: “key-type:key-name:secret,key-type:key-name2:secret2”; Example: “hmac-sha256:mykey:aabbcc..”. (default: empty)
  • data.desc (string) – Domain description
  • data.dc_bound (boolean) – Whether the domain is bound to a datacenter (requires SuperAdmin permission)
Status Codes:
DELETE /dns/domain/(name)
DC-bound?:
  • ✓ - dc_bound=true
  • ✗ - dc_bound=false
Permissions:
Asynchronous?:
Parameters:
  • name (string) – required - Domain name
Status Codes: