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 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 } }
Request
This function enables DNSSEC on the domain.
Note:
- After you enable DNSSEC on the domain, you must add the DNS 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 Examples:
The domain on which to enable DNSSEC.
Note:
To enable DNSSEC on multiple domains, increment the parameter name. For example: domain-0, domain-1, domain-2.
domain=domain-0=example0.com&domain-1=example1.com&domain-2=example2.com
domain=example.com
Whether to activate the newly-created key.
1— Activate the key.0— Do not activate the key.
Default 1
Enum01
Example: active=1
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.
Default 8
Example: algo_num=8
The manner in which the system creates the security key.
simple— Use a single key for both KSK and ZSK. Use this value when thealgo_nomparameter is greater than8.classic— Use separate keys for KSK and ZSK. Use this value when thealgo_nomparameter is equal to or less than8.
Default "classic"
Enum"simple""classic"
Example: key_setup=classic
The number of times that the system rehashes the first resource record hash operation.
A non-negative integer less than 501.
Prior to cPanel version 132, this defaulted to 7.
Default 0
Example: nsec3_iterations=7
Whether NSEC3 will operate in Narrow or Inclusive mode.
In Narrow mode, PowerDNS sends out white lies about the next secure record. Rather than query the resource record in the database, PowerDNS sends the hash plus 1 as the next secure record.
1— Narrow mode.0— Inclusive mode.
Default 1
Enum01
Example: nsec3_narrow=1
Whether the system will create records for all delegations.
1— Create records for all delegations.0— Create records only for secure delegations.
Note:
Only select 1 if you must create records for all delegations.
Default 0
Enum01
Example: nsec3_opt_out=0
A hexadecimal string that the system appends to the domain name before it applies the hash function to the name. For more information about the salt value, read the RFC 5155 documentation.
Beginning with cPanel version 132, this parameter also accepts the literal value - to indicate that no salt should be used.
If you do not declare a value, the system defaults to no salt. Prior to cPanel version 132, if you did not declare a value, the system defaulted to a random 64-bit value.
Default "-"
Example: nsec3_salt=1A2B3C4D5E6F
Whether the domain will use Next Secure Record (NSEC) or NSEC3 semantics.
1— Use NSEC3 semantics.0— Use NSEC semantics.
Note:
If you use NSEC semantics (0), the system ignores the other NSEC3 options.
Default 1
Enum01
Example: use_nsec3=1
- Mock server
https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/DNSSEC/enable_dnssec
- A server running cPanel.
https://cpanel-server.tld:2083/execute/DNSSEC/enable_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/enable_dnssec?domain=string&active=1&algo_num=8&key_setup=classic&nsec3_iterations=7&nsec3_narrow=1&nsec3_opt_out=0&nsec3_salt=1A2B3C4D5E6F&use_nsec3=1'Response
application/json
{ "apiversion": 3, "func": "enable_dnssec", "module": "DNSSEC", "result": { "data": { … }, "errors": null, "messages": null, "metadata": {}, "status": 1, "warnings": null } }