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 generates a DNSSEC zone key for a domain.
Note:
- After you enable DNSSEC on the domain, you must add the DS records to your registrar.
- You cannot modify the DNSSEC security key. To make any changes, you must disable (and delete) and re-create the DNSSEC security key.
Important:
When you disable the DNS role, the system disables this function.
Security
BasicAuth
Query
The algorithm that the system uses to generate the security key.
5— RSA/SHA-16— DSA-NSEC3-SHA17— RSASHA1-NSEC3-SHA18— RSA/SHA-25610— RSA/SHA-51213— ECDSA Curve P-256 with SHA-25614— ECDSA Curve P-384 with SHA-384
Note:
We recommend that you use 'ECDSA Curve P-256 with SHA-256' if your registrar supports it.
Enum5678101314
Example: algo_num=8
Whether to activate the newly-created key.
1— Activate the key.0— Do not activate the key.
Default 1
Enum01
Example: active=1
The key's size, in bits.
Note:
For the following algo_num and key_type parameters, the key_size defaults to the following values:
5— ksk2048zsk10246— ksk2048zsk10247— ksk2048zsk10248— ksk2048zsk102410— ksk2048zsk102413— ksk256zsk25614— ksk384zsk384
Example: key_size=2048
- Mock server
https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/DNSSEC/add_zone_key
- A server running cPanel.
https://cpanel-server.tld:2083/execute/DNSSEC/add_zone_key
- 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/DNSSEC/add_zone_key?algo_num=8&domain=example.com&key_type=ksk&active=1&key_size=2048'Response
application/json
{ "apiversion": 3, "func": "add_zone_key", "module": "DNSSEC", "result": { "data": { … }, "errors": null, "messages": null, "metadata": {}, "status": 1, "warnings": null } }
Request
This function deactivates 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/deactivate_zone_key
- A server running cPanel.
https://cpanel-server.tld:2083/execute/DNSSEC/deactivate_zone_key
- 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/DNSSEC/deactivate_zone_key?domain=example.com&key_id=1'Response
application/json
{ "apiversion": 3, "func": "deactivate_zone_key", "module": "DNSSEC", "result": { "data": { … }, "errors": null, "messages": null, "metadata": {}, "status": 1, "warnings": null } }
Request
This function disables DNSSEC on the domain.
Warning:
- This action is irreversible. If you disable DNSSEC on the domain, you will lose the associated keys. You can only retrieve the previous state with a full backup.
- If you disable DNSSEC, you must remove the DNS records at the registrar.
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/disable_dnssec
- A server running cPanel.
https://cpanel-server.tld:2083/execute/DNSSEC/disable_dnssec
- 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/DNSSEC/disable_dnssec?domain=string'Response
application/json
{ "apiversion": 3, "func": "disable_dnssec", "module": "DNSSEC", "result": { "data": { … }, "errors": null, "messages": null, "metadata": {}, "status": 1, "warnings": null } }