UAPI accesses the cPanel interface's features. Use this API to access and modify cPanel account data and settings.
Download OpenAPI description
Overview
URL
WebPros International, LLC
License
Languages
Servers
Mock server
https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/
A server running cPanel.
https://{host}:{port}/execute/
Query Examples:
The domain to check.
Note:
To check multiple domains, duplicate or increment the parameter name. For example, to exclude three domains, you could:
- Use the
domainparameter multiple times. - Use the
domain,domain-1, anddomain-2parameters.
domain=domain=example.com&domain-1=example1.com&domain-2=example2.com
domain=domain=example.com&domain=example1.com&domain=example2.com
domain=example.com
- Mock server
https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/DNS/ensure_domains_reside_only_locally
- A server running cPanel.
https://cpanel-server.tld:2083/execute/DNS/ensure_domains_reside_only_locally
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
-u <username>:<password> \
'https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/DNS/ensure_domains_reside_only_locally?domain=example1.com'Response
application/json
{ "apiversion": 3, "func": "ensure_domains_reside_only_locally", "module": "DNS", "result": { "data": [ … ], "errors": null, "messages": null, "metadata": { … }, "status": 1, "warnings": null } }
Request
This function returns whether ALIAS and ANAME records are available and the value of the running PowerDNS (PDNS) resolver setting, if any exists. For more information, read our ALIAS documentation.
Security
BasicAuth
- Mock server
https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/DNS/is_alias_available
- A server running cPanel.
https://cpanel-server.tld:2083/execute/DNS/is_alias_available
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
-u <username>:<password> \
https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/DNS/is_alias_availableResponse
application/json
{ "apiversion": 3, "func": "is_alias_available", "module": "DNS", "result": { "data": { … }, "errors": null, "messages": null, "metadata": { … }, "status": 1, "warnings": null } }