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 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
- 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/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 } }
Request
This function configures the domain to use Next Secure Record 3 (NSEC3) semantics.
Important:
When you disable the DNS role, the system disables this function.
Security
BasicAuth
Query
The domain on which to enable NSEC3 semantics.
Example: domain=example.com
The number of times that the system re-executes the first resource record hash operation.
Example: nsec3_iterations=7
Whether NSEC3 will operate in Narrow mode 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.
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.
Enum01
Example: nsec3_opt_out=0
The salt value that PowerDNS uses in the hashes. 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.
Example: nsec3_salt=1A2B3C4D5E6F
- Mock server
https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/DNSSEC/set_nsec3
- A server running cPanel.
https://cpanel-server.tld:2083/execute/DNSSEC/set_nsec3
- 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/set_nsec3?domain=example.com&nsec3_iterations=7&nsec3_narrow=1&nsec3_opt_out=0&nsec3_salt=1A2B3C4D5E6F'Response
application/json
{ "apiversion": 3, "func": "set_nsec3", "module": "DNSSEC", "result": { "data": { … }, "errors": null, "messages": null, "metadata": {}, "status": 1, "warnings": null } }
Request
This function configures the domain to use Next Secure Record (NSEC) semantics instead of Next Secure Record 3 (NSEC3) semantics.
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/unset_nsec3
- A server running cPanel.
https://cpanel-server.tld:2083/execute/DNSSEC/unset_nsec3
- 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/unset_nsec3?domain=example.com'Response
application/json
{ "apiversion": 3, "func": "unset_nsec3", "module": "DNSSEC", "result": { "data": { … }, "errors": null, "messages": null, "metadata": {}, "status": 1, "warnings": null } }