API Help

The HTTP API provides the full functionality of the ClouDNS web control panel by simple HTTP calls. The responses can be returned in XML and JSON format. HTTP API can be used for an integration with custom billing and control panel systems. The HTTP API is used for the WHMCS provisioning module which is a great example of what you can do with the ClouDNS HTTP API and your custom system.

API Structure and Documentation

This page serves as the starting point for the ClouDNS HTTP API. In the navigation menu, you will find detailed documentation for every API endpoint and topic, including:

Each section comes with complete usage instructions, required parameters, request and response examples, supported methods (GET/POST), and error handling guidance.

Supported Request Methods and Data Types

The API supports both the GET and POST HTTP methods for all endpoints. You can use either method when sending requests.

All parameters are passed as strings, but they represent different data types depending on the context. Here's a quick overview:

  • Boolean: true or false (e.g., ?active=true)
  • Integer: Whole numbers (e.g., ?zone_id=12345)
  • Float: Decimal numbers (e.g., ?price=12.99)
  • String: Text values (e.g., ?domain=example.com)
  • Array: Multiple values using the same key (e.g., ?domain[]=a.com&domain[]=b.com)

Response Formats

The API supports two formats for all responses:

  • JSON – Lightweight, easy to use in web and server-side applications.
  • XML – Ideal for legacy systems or more structured data integrations.

Use .json or .xml at the end of the endpoint URL to specify the desired format.

Example:

  • JSON: https://api.cloudns.net/login/login.json
  • XML: https://api.cloudns.net/login/login.xml

Rate Limiting

To ensure consistent performance and reliability, API usage is limited per IP address as follows:

  • 20 requests per second
  • 600 requests per minute
  • 36,000 requests per hour

If your application requires higher limits, you can contact our technical support team via live chat or ticket.

Authentication

All API calls require authentication parameters. Depending on your setup, you may use either:

  • auth-id and auth-password for API users, or
  • sub-auth-id or sub-auth-user with auth-password for sub-users

For detailed authentication instructions, visit the Access and Authentication section of the documentation.

Getting Started

To begin using the API:

  1. Obtain your authentication credentials
  2. Choose your preferred response format (JSON or XML)
  3. Explore endpoint-specific documentation

You’ll be able to:

  • Test login credentials
  • Retrieve your current IP
  • Check account balances
  • Manage domains, DNS zones, SSL certs, monitoring checks, and more

 Request Parameters

Each API request includes a list of parameters, some of which are marked as Required and others as Optional.

  • Required parameters must always be provided for the request to function.
  • Optional parameters may be necessary depending on the context of the request.
    For example, when creating a SMTP monitoring check, the port parameter is optional in general, but it becomes necessary in this specific case. On the other hand, it is not used at all when creating a PING check.

The documentation for each endpoint clearly indicates which parameters are required or optional based on the operation.

Ready to Implement

With the fundamentals covered, you're ready to explore the available endpoints and begin implementing the functionality that fits your use case. The detailed documentation for each method will guide you through every step of the process.


Last modified: 2025-03-27
Cookies help us deliver our services. By using our services, you agree to our use of cookies. Learn more