DNS Zones - Domain Name API

Create and manage DNS zones

• GET/dom/dns-zone

  Gets all DNS zones on an account

  Back to top

  Request Details

  Response Details

  Request Details

  This command has no URL/Query String parameters

  Response Details

  200 Response

  {
      "result" : [
          {
              "created_on" : "2023-02-07",
              "domain_uuid" : "79526302-8144-41f2-9ca2-777db5686e40",
              "record" : [],
              "updated_on" : "2023-02-07",
              "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6",
              "zone_name" : ""
          }
      ],
      "status_code" : 200,
      "status_message" : "OK"
  }

• GET/dom/dns-zone/{uuid}

  Gets a specific DNS zones on an account

  Back to top

  Request Details

  Response Details

  Request Details

  URL and Query String Parameters

  • Name

  • Type

  • Required

  • • uuid

    • String

    • True

    The UUID of the DNS zone to query

  Response Details

  200 Response

  {
      "result" : {
          "created_on" : "2023-02-07",
          "domain_uuid" : "79526302-8144-41f2-9ca2-777db5686e40",
          "record" : [],
          "updated_on" : "2023-02-07",
          "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6",
          "zone_name" : ""
      },
      "status_code" : 200,
      "status_message" : "OK"
  }

  400 Response

  {
      "result" : {},
      "status_code" : 400,
      "status_message" : "Bad Request"
  }

  404 Response

  {
      "result" : {},
      "status_code" : 404,
      "status_message" : "Not Found"
  }

• POST/dom/dns-zone

  Creates a new DNS zone

  Back to top

  Request Details

  Response Details

  Request Details

  This command has no URL/Query String parameters

  POST body

  • Name

  • Type

  • Required

  • • domain_uuid

    • String

    • True

    The UUID of the Domain to apply this DNZ zone to

  • • record

    • Array of DomainDNSRecord

    • True

    The list of DNS records in this zone

  DomainDNSRecord

  • • priority

    • Integer

    • True

    The priority for this record, only applicable for SRV and MX records

  • • record_content

    • String

    • True

    The value for this DNS record, an IP address fo A records or a string for others

  • • record_name

    • String

    • True

    The complete hostname for this DNS record

  • • record_type

    • String

    • True

    The type of DNS record, one of (A, AAAA, CNAME, TXT, MX, SRV)

  • • ttl

    • Integer

    • True

    The TTL for this record in seconds (min = 3600, max = 2419200)

  JSON all-fields example:

  {
      "domain_uuid" : "79526302-8144-41f2-9ca2-777db5686e40",
      "record" : []
  }

  Response Details

  201 Response

  {
      "result" : {
          "created_on" : "2023-02-07",
          "domain_uuid" : "79526302-8144-41f2-9ca2-777db5686e40",
          "record" : [],
          "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6",
          "zone_name" : ""
      },
      "status_code" : 201,
      "status_message" : "Created"
  }

  400 Response

  {
      "result" : {},
      "status_code" : 400,
      "status_message" : "Bad Request"
  }

  404 Response

  {
      "result" : {},
      "status_code" : 404,
      "status_message" : "Not Found"
  }

• PUT/dom/dns-zone/{uuid}

  Updates a DNS zone

  Back to top

  Request Details

  Response Details

  Request Details

  URL and Query String Parameters

  • Name

  • Type

  • Required

  • • uuid

    • String

    • True

    The UUID of the DNS zone to be updated

  PUT body

  • Name

  • Type

  • Required

  • • domain_uuid

    • String

    • True

    The UUID of the Domain to apply this DNZ zone to

  • • record

    • Array of DomainDNSRecord

    • True

    The list of DNS records in this zone

  DomainDNSRecord

  • • priority

    • Integer

    • True

    The priority for this record, only applicable for SRV and MX records

  • • record_content

    • String

    • True

    The value for this DNS record, an IP address fo A records or a string for others

  • • record_name

    • String

    • True

    The complete hostname for this DNS record

  • • record_type

    • String

    • True

    The type of DNS record, one of (A, AAAA, CNAME, TXT, MX, SRV)

  • • ttl

    • Integer

    • True

    The TTL for this record in seconds (min = 3600, max = 2419200)

  JSON all-fields example:

  {
      "domain_uuid" : "79526302-8144-41f2-9ca2-777db5686e40",
      "record" : []
  }

  Response Details

  405 Response

  {
      "result" : {},
      "status_code" : 405,
      "status_message" : "Not Implemented"
  }

• PATCH/dom/dns-zone/{uuid}

  Increments the SoA serial number for a DNS zone

  Back to top

  Request Details

  Response Details

  Request Details

  URL and Query String Parameters

  • Name

  • Type

  • Required

  • • uuid

    • String

    • True

    The UUID of the DNS zone to be updated

  Response Details

  200 Response

  {
      "result" : {},
      "status_code" : 200,
      "status_message" : "OK"
  }

  400 Response

  {
      "result" : {},
      "status_code" : 400,
      "status_message" : "Bad Request"
  }

  404 Response

  {
      "result" : {},
      "status_code" : 404,
      "status_message" : "Not Found"
  }