Yay.com loading

Loading

  • My Shopping Cart (0) £0.00

  • Register

DNZ Zones and Records

API Access

Build custom apps using our JSON API

FREE
Get your free API Key

DNS Records

Create and update records on DNS zones managed by this account

Get your free API Key

Filter:

  • All
  • GET
  • POST
  • PUT
  • DELETE
  • DELETE
  • Chargeable *

* You will be charged every time this command is run.

  • GET/dom/dns-zone/{zone_uuid}/records

    Gets all DNS records for the provided DNS zone

    Back to top

    Request Details

    Response Details

    Request Details

    URL and Query String Parameters

    • Name

    • Type

    • Required

      • zone_uuid

      • String

      • True

      The UUID of the DNS Zone who's records are to be queried

    Response Details

    200 Response

    {
        "result" : [
            {
                "record_name" : "www.example.com",
                "record_type" : "CNAME",
                "record_content" : "example.com",
                "ttl" : 14400,
                "priority" : 10,
                "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6",
                "created_on" : "2017-12-14",
                "updated_on" : "2017-12-14"
            }
        ],
        "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"
    }
  • GET/dom/dns-zone/{zone_uuid}/records/{uuid}

    Gets a specific DNS record for the provided DNS zone

    Back to top

    Request Details

    Response Details

    Request Details

    URL and Query String Parameters

    • Name

    • Type

    • Required

      • zone_uuid

      • String

      • True

      The UUID of the DNS Zone who's records are to be queried

      • uuid

      • String

      • True

      The UUID of the DNS record to query

    Response Details

    200 Response

    {
        "result" : {
            "record_name" : "www.example.com",
            "record_type" : "CNAME",
            "record_content" : "example.com",
            "ttl" : 14400,
            "priority" : 10,
            "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6",
            "created_on" : "2017-12-14",
            "updated_on" : "2017-12-14"
        },
        "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/{zone_uuid}/records

    Creates a new DNS record for the provided DNS zone

    Back to top

    Request Details

    Response Details

    Request Details

    URL and Query String Parameters

    • Name

    • Type

    • Required

      • zone_uuid

      • String

      • True

      The UUID of the DNS Zone to create a record for

    POST body

    • Name

    • Type

    • Required

      • 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:

    {
        "record_name" : "www.example.com",
        "record_type" : "CNAME",
        "record_content" : "example.com",
        "ttl" : 14400,
        "priority" : 10
    }

    Response Details

    201 Response

    {
        "result" : {
            "record_name" : "www.example.com",
            "record_type" : "CNAME",
            "record_content" : "example.com",
            "ttl" : 14400,
            "priority" : 10,
            "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6",
            "created_on" : "2017-12-14"
        },
        "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/{zone_uuid}/records/{uuid}

    Updates the specified DNS record

    Back to top

    Request Details

    Response Details

    Request Details

    URL and Query String Parameters

    • Name

    • Type

    • Required

      • zone_uuid

      • String

      • True

      The UUID of the DNS Zone to the record belongs to

      • uuid

      • String

      • True

      The UUID of the DNS record to be updated

    PUT body

    • Name

    • Type

    • Required

      • 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:

    {
        "record_name" : "www.example.com",
        "record_type" : "CNAME",
        "record_content" : "example.com",
        "ttl" : 14400,
        "priority" : 10
    }

    Response Details

    200 Response

    {
        "result" : {
            "record_name" : "www.example.com",
            "record_type" : "CNAME",
            "record_content" : "example.com",
            "ttl" : 14400,
            "priority" : 10,
            "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6",
            "created_on" : "2017-12-14",
            "updated_on" : "2017-12-14"
        },
        "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"
    }
  • DELETE/dom/dns-zone/{zone_uuid}/records/{uuid}

    Deletes the specified DNS record

    Back to top

    Request Details

    Response Details

    Request Details

    URL and Query String Parameters

    • Name

    • Type

    • Required

      • zone_uuid

      • String

      • True

      The UUID of the DNS Zone to the record belongs to

      • uuid

      • String

      • True

      The UUID of the DNS record to be deleted

    Response Details

    204 Response

    {
        "result" : {},
        "status_code" : 204,
        "status_message" : "No Content"
    }

    400 Response

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

    404 Response

    {
        "result" : {},
        "status_code" : 404,
        "status_message" : "Not Found"
    }
View Desktop Site