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/
Request
This function fetches a domain's Delegation of Signing (DS) records.
Important:
When you disable the DNS role, the system disables this function.
Security
BasicAuth
- Mock server
https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/DNSSEC/fetch_ds_records
- A server running cPanel.
https://cpanel-server.tld:2083/execute/DNSSEC/fetch_ds_records
- CLI
- URL
- curl
- JavaScript
- Node.js
- Python
- Java
- Java8+Apache
- C#
- C#+Newtonsoft
- PHP
- Go
- Ruby
- R
uapi --output=jsonpretty \
--user=username \
DNSSEC \
fetch_ds_records \
domain='example.com'Response
application/json
{ "apiversion": 3, "func": "fetch_ds_records", "module": "DNSSEC", "result": { "data": { … }, "errors": null, "messages": null, "metadata": {}, "status": 1, "warnings": null } }
Request
This function imports a DNSSEC security key.
Important:
When you disable the DNS role, the system disables this function.
Security
BasicAuth
Query
The security key data that the pdnsutil utility's export-zone-key call returns.
Example: key_data=Private-key-format:%20v1.2%0AAlgorithm:%2013%20\(ECDSAP256SHA256\)%0APrivateKey:%20xCM281KtWE9oCsUX8fP1hDZ02/X7JCjp4QZA/DZjfX0=%0A%0A
- Mock server
https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/DNSSEC/import_zone_key
- A server running cPanel.
https://cpanel-server.tld:2083/execute/DNSSEC/import_zone_key
- CLI
- URL
- curl
- JavaScript
- Node.js
- Python
- Java
- Java8+Apache
- C#
- C#+Newtonsoft
- PHP
- Go
- Ruby
- R
uapi --output=jsonpretty \
--user=username \
DNSSEC \
import_zone_key \
domain='example.com' \
key_type='ksk' \
key_data=$'Private-key-format:%20v1.2%0AAlgorithm:%2013%20\\(ECDSAP256SHA256\\)%0APrivateKey:%20xCM281KtWE9oCsUX8fP1hDZ02/X7JCjp4QZA/DZjfX0=%0A%0A'Response
application/json
{ "apiversion": 3, "func": "import_zone_key", "module": "DNSSEC", "result": { "data": { … }, "errors": null, "messages": null, "metadata": {}, "status": 1, "warnings": null } }
Request
This function removes a DNSSEC security key.
Important:
When you disable the DNS role, the system disables this function.
Security
BasicAuth
- Mock server
https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/DNSSEC/remove_zone_key
- A server running cPanel.
https://cpanel-server.tld:2083/execute/DNSSEC/remove_zone_key
- CLI
- URL
- curl
- JavaScript
- Node.js
- Python
- Java
- Java8+Apache
- C#
- C#+Newtonsoft
- PHP
- Go
- Ruby
- R
uapi --output=jsonpretty \
--user=username \
DNSSEC \
remove_zone_key \
domain='example.com' \
key_id='1'Response
application/json
{ "apiversion": 3, "func": "remove_zone_key", "module": "DNSSEC", "result": { "data": { … }, "errors": null, "messages": null, "metadata": {}, "status": 1, "warnings": null } }