Yay.com loading

Loading

Call us on (888) YAY-8747

0

Login to Yay.com

Did you know we also sell domains?

Add domain registration to your VoIP service and manage your business in one location, anytime!

  • $13.19 / year

    .club

  • $26.19 / year

    .co

  • $9.79 / year

    .com

  • $11.99 / year

    .net

  • $8.59 / year

    .us

  • $1.19 / year

    .xyz

View all domain pricing

DNZ Zones and Records

API Access

Build custom apps using our JSON API

1st month FREE
Become a Reseller

DNS Templates

Create and manage DNS templates for use with domain names.

Become a Reseller

Filter:

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

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

  • GET/dom/dns-template

    Gets all DNS templates 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" : [
            {
                "name" : "Default NS Records",
                "is_default" : false,
                "records" : [],
                "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6",
                "created_on" : "2019-01-19",
                "updated_on" : "2019-01-19"
            }
        ],
        "status_code" : 200,
        "status_message" : "OK"
    }
  • GET/dom/dns-template/default

    Gets the default DNS template 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" : [
            {
                "name" : "Default NS Records",
                "is_default" : false,
                "records" : [],
                "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6",
                "created_on" : "2019-01-19",
                "updated_on" : "2019-01-19"
            }
        ],
        "status_code" : 200,
        "status_message" : "OK"
    }

    404 Response

    {
        "result" : {},
        "status_code" : 404,
        "status_message" : "Not Found"
    }
  • GET/dom/dns-template/{uuid}

    Gets a specific DNS template 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 template to be queried

    Response Details

    200 Response

    {
        "result" : {
            "name" : "Default NS Records",
            "is_default" : false,
            "records" : [],
            "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6",
            "created_on" : "2019-01-19",
            "updated_on" : "2019-01-19"
        },
        "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-template

    Creates a new DNS template

    Back to top

    Request Details

    Response Details

    Request Details

    This command has no URL/Query String parameters

    POST body

    • Name

    • Type

    • Required

      • is_default

      • boolean

      • True

      The default template will be assigned to new domains and transfers where applicable

      • name

      • String

      • True

      The name for this DNS template

      • records

      • Array of DnsTemplateRecord

      • True

      The list of DNS records to apply to the domain when using this template

    DnsTemplateRecord

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

    {
        "name" : "Default NS Records",
        "is_default" : false,
        "records" : []
    }

    Response Details

    201 Response

    {
        "result" : {
            "name" : "Default NS Records",
            "is_default" : false,
            "records" : [],
            "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6",
            "created_on" : "2019-01-19"
        },
        "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"
    }
  • POST/dom/dns-template/{uuid}

    Deletes the specified DNS template

    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 template 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"
    }
  • PUT/dom/dns-template/{uuid}

    Update an existing DNS template

    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 template to be updated

    PUT body

    • Name

    • Type

    • Required

      • is_default

      • boolean

      • True

      The default template will be assigned to new domains and transfers where applicable

      • name

      • String

      • True

      The name for this DNS template

      • records

      • Array of DnsTemplateRecord

      • True

      The list of DNS records to apply to the domain when using this template

    DnsTemplateRecord

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

    {
        "name" : "Default NS Records",
        "is_default" : false,
        "records" : []
    }

    Response Details

    200 Response

    {
        "result" : {
            "name" : "Default NS Records",
            "is_default" : false,
            "records" : [],
            "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6",
            "created_on" : "2019-01-19",
            "updated_on" : "2019-01-19"
        },
        "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"
    }