ClouDNS
ClouDNS API credentials setup: create a paid-plan API sub-user for scoped DNS access, or a main API user when the connection must also change registered-domain nameservers and DS records.
On this page
ClouDNS API credentials permissions
- Credential type
- API user ID or sub-user and password
- Preview access
- API sub-user → Read
- Apply access
- API sub-user → Read and Write
- API endpoint
- DNSMigrator uses the provider's fixed API endpoint.
Additional access
DNSControl id
{
"TYPE": "CLOUDNS"
}Create credentials
Create a paid-plan API sub-user for scoped DNS access, or a main API user when the connection must also change registered-domain nameservers and DS records.
Access you'll grant
API sub-user → Read
API sub-user → Read and Write
Before you start
- A paid ClouDNS plan; Free DNS does not include HTTP API access.
- Access to API & Resellers and the DNS zones or registered domains you want to connect.
Setup steps
0 of 6 done
Open API & Resellers
Sign in to ClouDNS and open API & Resellers. For DNS-only access, find API Sub-Users and select Add new sub-user.
Configure the DNS sub-user
Set a username and password, choose limits large enough for the delegated zones and records, and set access to Read for preview or Read and Write for apply. In the IP field, enter
our egress IPso only DNSMigrator can use it.Preview accessReadApply accessRead and WriteWhitelisted IPour egress IPDelegate the DNS zones
Delegate every DNS zone this connection needs to the sub-user. A sub-user can authenticate successfully while still returning no zones if none were delegated.
Use a main API user for registrar cutover
If DNSMigrator must change nameservers or DS records for domains registered at ClouDNS, use API Users → Add new user instead. Set its IP address to
our egress IP, choose a password, save it, and copy the generated auth ID.Match the API user type
Choose API user (auth-id) for the main numeric ID, API sub-user (sub-auth-id) for a numeric sub-user ID, or API sub-user by name (sub-auth-user) for its username.
Main API userauth-idNumeric sub-usersub-auth-idNamed sub-usersub-auth-userPaste the ID and password
Enter the numeric ID or sub-user name in Auth ID or sub-user name, enter the password you set in API password, then check access.
Troubleshooting
Invalid authentication
Match API user type to the identifier: numeric main ID uses auth-id, numeric sub-user ID uses sub-auth-id, and a username uses sub-auth-user. Then re-enter the matching password.
The source IP is not allowed
Set the API user's IP field to our egress IP. If you entered another address when creating it, update the user or create a replacement.
The sub-user sees no zones
Delegate each DNS zone to the sub-user and make sure its zone and record limits are not exhausted.
Registrar domains are unavailable
Use a main API user with auth-id. ClouDNS documents DNS-zone delegation to sub-users, but not delegation of registered-domain management.
Official documentation
- ClouDNS API access and authentication
- ClouDNS add API sub-user
- ClouDNS sub-user access level
- ClouDNS modify domain nameservers
Guide checked against the official documentation on .
Credential fields
| Field | Requirement | Where to find it |
|---|---|---|
| API user typeauthType | Required | Select auth-id for a main API user, sub-auth-id for a numeric API sub-user ID, or sub-auth-user for an API sub-user username. |
| Auth ID or sub-user nameauthId | Required | The generated numeric auth ID/sub-auth ID shown in the users table, or the exact sub-auth-user username when that type is selected. |
| API passwordpassword | Required | The password you set when creating the API user or sub-user; ClouDNS does not generate it. |
Capabilities
- Create zones
- Yes
- List zones
- Yes
- DNSSEC
- Managed through the API
- Minimum TTL
- 60 seconds
- Apex CNAME
- No
- Read only
- No
Record types
- A
- AAAA
- CNAME
- MX
- TXT
- NS
- SRV
- CAA
- PTR
- ALIAS
- DNAME
- TLSA
- SSHFP
- DS
- NAPTR
- SPF
ClouDNS-only types
- CLOUDNS_WR
These records need translation or review when you move to another provider.
Caveats
- TTLs must be one of ClouDNS's fixed values (60, 300, 900, 1800, 3600, 21600 … 2592000); other TTLs are rounded up.
- Web redirects (CLOUDNS_WR) are ClouDNS-only and are written as plain 301 redirects without frame options.
- The API is rate limited to about 20 requests per second per IP, so large zones apply record by record and take a while.
Troubleshooting
- Invalid authentication
- Match API user type to the identifier: numeric main ID uses auth-id, numeric sub-user ID uses sub-auth-id, and a username uses sub-auth-user. Then re-enter the matching password.
- The source IP is not allowed
- Set the API user's IP field to {egressIp}. If you entered another address when creating it, update the user or create a replacement.
- The sub-user sees no zones
- Delegate each DNS zone to the sub-user and make sure its zone and record limits are not exhausted.
- Registrar domains are unavailable
- Use a main API user with auth-id. ClouDNS documents DNS-zone delegation to sub-users, but not delegation of registered-domain management.