Yay.com loading

Loading

  • My Shopping Cart (0) £0.00

  • Register

Name Server Groups

API Access

Build custom apps using our JSON API

FREE
Get your free API Key

Name Server Groups

Create and manage groups of Nameservers for use with domain names.

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/name-server-group

    Gets all active name server groups 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" : [
            {
                "group_name" : "Default Name Servers",
                "is_default" : true,
                "name_servers" : [
                    "ns1.example.com",
                    "ns2.example.com"
                ],
                "domains_using" : 10,
                "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6",
                "created_on" : "2017-12-14",
                "updated_on" : "2017-12-14"
            }
        ],
        "status_code" : 200,
        "status_message" : "OK"
    }
  • GET/dom/name-server-group/default

    Gets the default name server group for an account

    Back to top

    Request Details

    Response Details

    Request Details

    This command has no URL/Query String parameters

    Response Details

    200 Response

    {
        "result" : {
            "group_name" : "Default Name Servers",
            "is_default" : true,
            "name_servers" : [
                "ns1.example.com",
                "ns2.example.com"
            ],
            "domains_using" : 10,
            "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6",
            "created_on" : "2017-12-14",
            "updated_on" : "2017-12-14"
        },
        "status_code" : 200,
        "status_message" : "OK"
    }

    404 Response

    {
        "result" : {},
        "status_code" : 404,
        "status_message" : "Not Found"
    }
  • GET/dom/name-server-group/{uuid}

    Gets a specific name server group for 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 name server group to be quiered

    Response Details

    200 Response

    {
        "result" : {
            "group_name" : "Default Name Servers",
            "is_default" : true,
            "name_servers" : [
                "ns1.example.com",
                "ns2.example.com"
            ],
            "domains_using" : 10,
            "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6",
            "created_on" : "2017-12-14",
            "updated_on" : "2017-12-14"
        },
        "status_code" : 200,
        "status_message" : "OK"
    }

    404 Response

    {
        "result" : {},
        "status_code" : 404,
        "status_message" : "Not Found"
    }
  • POST/dom/name-server-group

    Creates a new name server group

    Back to top

    Request Details

    Response Details

    Request Details

    This command has no URL/Query String parameters

    POST body

    • Name

    • Type

    • Required

      • group_name

      • String

      • True

      The nickname for this Name Server Group

      • is_default

      • boolean

      • False

      Indicates that this is the default Name Server Group to be used for new domains

      • name_servers

      • Array of String

      • True

      The list of name servers that make up this group

    JSON all-fields example:

    {
        "group_name" : "Default Name Servers",
        "is_default" : true,
        "name_servers" : [
            "ns1.example.com",
            "ns2.example.com"
        ]
    }

    Response Details

    201 Response

    {
        "result" : {
            "group_name" : "Default Name Servers",
            "is_default" : true,
            "name_servers" : [
                "ns1.example.com",
                "ns2.example.com"
            ],
            "domains_using" : 10,
            "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6",
            "created_on" : "2017-12-14"
        },
        "status_code" : 201,
        "status_message" : "Created"
    }
  • PUT/dom/name-server-group/{uuid}

    Updates the specified name server group

    Back to top

    Request Details

    Response Details

    Request Details

    URL and Query String Parameters

    • Name

    • Type

    • Required

      • uuid

      • String

      • True

      The UUID of the name server group to be updated

    PUT body

    • Name

    • Type

    • Required

      • group_name

      • String

      • True

      The nickname for this Name Server Group

      • is_default

      • boolean

      • False

      Indicates that this is the default Name Server Group to be used for new domains

      • name_servers

      • Array of String

      • True

      The list of name servers that make up this group

    JSON all-fields example:

    {
        "group_name" : "Default Name Servers",
        "is_default" : true,
        "name_servers" : [
            "ns1.example.com",
            "ns2.example.com"
        ]
    }

    Response Details

    200 Response

    {
        "result" : {
            "group_name" : "Default Name Servers",
            "is_default" : true,
            "name_servers" : [
                "ns1.example.com",
                "ns2.example.com"
            ],
            "domains_using" : 10,
            "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6",
            "created_on" : "2017-12-14",
            "updated_on" : "2017-12-14"
        },
        "status_code" : 200,
        "status_message" : "OK"
    }

    404 Response

    {
        "result" : {},
        "status_code" : 404,
        "status_message" : "Not Found"
    }
  • DELETE/dom/name-server-group/{uuid}

    Deletes the specified name server group

    Back to top

    Request Details

    Response Details

    Request Details

    URL and Query String Parameters

    • Name

    • Type

    • Required

      • uuid

      • String

      • True

      The UUID of the name server group be deleted

    Response Details

    204 Response

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

    404 Response

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