Leveraging the Domain Name PHP Module, we have developed a live API with robust error handling that can be easily integrated into various programming languages.

Getting Started

You can use the API by deploying it on your server or by utilizing our hosted application.

  1. Create an Account
    First, create an account on the Domain Name API. This will provide you with the necessary credentials to access the API.

  2. Credentials
    After registering, use your username and password as your API credentials. These will be required for authentication and API interactions.

Deploying on Your Server

Minimum Requirements

  • PHP 8.1 or higher
  • PHP SOAPClient extension must be enabled

Setting Up Your Development Environment

Begin by cloning the open-source code and deploying it:

Clone the repository to your local environment or server to integrate the API into your application. You can find the repository on our GitHub.

After cloning the source code, run the API on your local server. To test the live API, use the following endpoint: http://localhost/ or https://domainName.com. Make sure to authenticate with the username and password you used during signup.

Expected Response

If everything is set up correctly, you should see the following response when making a GET request to your base URL:

{
	"message": "Domain Name API is active"
}

Configuration

To use your own nameservers, navigate to the /DomainNameAPI directory and update the default nameserver in the RegisterWithContactInfo function.

Using DotHost Domain API

Don’t have your own server? No problem!
You can utilize our fully built Domain Name API for your needs.

Please refer to our Domain Name API Reference for further details.

API Rate Limit

The API has a rate limit to ensure fair usage and prevent system overload:

  • Maximum Requests: 1000 requests
  • Time Window: 10-minute window

Be sure to stay within the rate limit to avoid disruptions. If the limit is exceeded, you may receive a 429 Too Many Requests error.

Note: For optimal performance and stability, consider implementing error handling and request throttling in your application.

Propagation

It may take some time for child nameservers to be updated, registered, or deleted.

When a domain is registered, it can take some time to fully propagate across the internet.