NuNames REST API Documentation

Before you begin

NuNames uses a REST API. You can use any programming language that works with HTTP request to implement our API, as long as you set the X-APIKEY header in your HTTP requests.

Please refer to these important documents before you begin:

Last but not least, our API URL is: https://backoffice.hostcontrol.com/api/v1

Happy coding!

Available Methods

Customers

Resource Description
GET customer Returns a list of customers, matching an optional email address.
POST customer Creates a new customer.
GET customer/[customer_id] Returns a specified customer.
PUT customer/[customer_id] Update the setting 'is_receiving_support_notifications' for a customer via this command.

Contacts

Resource Description
GET contact Returns a list of contacts, matching an optional customer id.
GET contact/[contact_id] Returns a specified contact.
PUT contact/[contact_id] Updates a specified contact.

Domains

Resource Description
GET domain Returns a list of domains.
POST domain Registers a new domain.
POST domain order Creates a new order.
GET domain/[domain_name] Returns a specified domain name.
PUT domain/[domain_name] Updates the auto renew state for this domain.
DELETE domain/[domain_name] Sets the renew state for this domain to false.
GET domain/[domain_name]/auth-code Returns the auth code for a specified domain name.
POST domain/[domain_name]/renew Manually renew a domain.
POST domain/[domain_name]/transfer Transfer a domain to another registrar
GET domain/[domain_name]/name-server Returns a list of nameservers for the given domain name.
POST domain/[domain_name]/name-server Adds up to five nameservers to the specified domain name.
GET domain/[domain_name]/zone Returns a zone for the specific domain name.
POST domain/[domain_name]/zone Sets zone records for the specified domain name.
POST domain-is Checks the availability of a domain.
GET domain-prices Returns a list of prices (in cents) for the domains.
GET domain-transfer Returns a list of transfers, matching an optional customer id.
POST domain-transfer Start a transfer for a specified domain and customer.
GET domain-transfer/[domain_transfer_id] Returns the status of a specified domain transfer.
PUT domain-transfer/[domain_transfer_id] Updates the auth code for a specific domain transfer.
DELETE domain-transfer/[domain_transfer_id] Cancels (and deletes) a current transfer.
POST domain-transfer/[domain_transfer_id]/approve Approves a specified transfer.

Labels

Resource Description
GET label Returns properties for the label.

Orders

Resource Description
GET order Returns a list of orders.
POST order Creates a new order.
GET order/[order_id] Returns a specified order.
POST hosting order Creates a new hosting order for slimsite and email plans.
POST hosting change order Change hosting order for slimsite and email plans.
POST hosting renew order Renew hosting order for slimsite and email plans.
POST open xchange order Creates open xchange order.
GET open xchange license order Returns a list of open xchange license orders.
GET open xchange plan order Returns a list of open xchange plan orders.
GET hosting plan order Returns a list of hosting plan orders.
GET custom product plan order Returns a list of custom product plan orders.
POST custom product order Creates a new custom product.
POST renew custom product order Renew the custom product order.
POST swap open xchange license Swap the current existing license with new license.

OX users

Resource Description
GET ox-user Returns a list of OX users
POST ox-user Creates an OX user
GET ox-user/[username] Returns the specified OX user
DELETE ox-user/[username] Deletes the specified OX user
GET ox-user/[username]/access Provisions the specified OX user