Domain Management
Domain Contacts
- Domains Contacts
Name Server Groups
- Name Server Groups
DNZ Zones and Records
Email and Web Forwarding
- Email Forwarding
- Web Forwarding
SSL Certificates
- Private Keys
- SSL Certificates

API Access

Build custom apps using our JSON API

Configure API

Host Names - Domain Name API

Domain hosts describe nameservers available on the specified domain name.

Become a Reseller

Filter:

All
GET
POST
PUT
DELETE
DELETE
Chargeable *

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

GET/dom/host

Gets all domain hosts

Request Details

Response Details

Request Details

This command has no URL/Query String parameters

Response Details

200 Response

{
    "result" : [
        {
            "created_on" : "2023-06-02",
            "domain_uuid" : "a7ba3588-dbe0-4972-bfac-3da598607583",
            "host_name" : "ns1",
            "ip_addresses" : [
                "8.8.8.8",
                "8.8.4.4"
            ],
            "updated_on" : "2023-06-02",
            "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6"
        }
    ],
    "status_code" : 200,
    "status_message" : "OK"
}

GET/dom/host/{uuid}

Gets a specific domain hosts

Request Details

Response Details

Request Details

URL and Query String Parameters

Name
Type
Required

- uuid
- String
- True
The UUID of the domain host to be queried

Response Details

200 Response

{
    "result" : {
        "created_on" : "2023-06-02",
        "domain_uuid" : "a7ba3588-dbe0-4972-bfac-3da598607583",
        "host_name" : "ns1",
        "ip_addresses" : [
            "8.8.8.8",
            "8.8.4.4"
        ],
        "updated_on" : "2023-06-02",
        "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6"
    },
    "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/host

Creates a new host

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 this host name is applied to
- host_name
- String
- True
The name of this domains host name
- ip_addresses
- Array of String
- True
A list of IP addresses to apply to this host name

JSON all-fields example:

{
    "domain_uuid" : "a7ba3588-dbe0-4972-bfac-3da598607583",
    "host_name" : "ns1",
    "ip_addresses" : [
        "8.8.8.8",
        "8.8.4.4"
    ]
}

Response Details

201 Response

{
    "result" : {
        "created_on" : "2023-06-02",
        "domain_uuid" : "a7ba3588-dbe0-4972-bfac-3da598607583",
        "host_name" : "ns1",
        "ip_addresses" : [
            "8.8.8.8",
            "8.8.4.4"
        ],
        "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6"
    },
    "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/host/{uuid}

Updates the specified host

Request Details

Response Details

Request Details

URL and Query String Parameters

Name
Type
Required

- uuid
- String
- True
The UUID of the domain host to be updated

PUT body

Name
Type
Required

- domain_uuid
- String
- True
The UUID of the domain this host name is applied to
- host_name
- String
- True
The name of this domains host name
- ip_addresses
- Array of String
- True
A list of IP addresses to apply to this host name

JSON all-fields example:

{
    "domain_uuid" : "a7ba3588-dbe0-4972-bfac-3da598607583",
    "host_name" : "ns1",
    "ip_addresses" : [
        "8.8.8.8",
        "8.8.4.4"
    ]
}

Response Details

200 Response

{
    "result" : {
        "created_on" : "2023-06-02",
        "domain_uuid" : "a7ba3588-dbe0-4972-bfac-3da598607583",
        "host_name" : "ns1",
        "ip_addresses" : [
            "8.8.8.8",
            "8.8.4.4"
        ],
        "updated_on" : "2023-06-02",
        "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6"
    },
    "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/host/{uuid}

Deletes the specified host
Back to top

Request Details

Response Details
Request Details

URL and Query String Parameters
- Name
- Type
- Required
- uuid
  
  String
  
  True
  
  The UUID of the domain host 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"
}
```