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 information regarding HTTPS records support. HTTPS records are defined in RFC 9460 and provide service parameters for HTTPS endpoints. For more information, read our HTTPS record documentation.
Security
BasicAuth
- Mock server
https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/DNS/is_https_available
- A server running cPanel.
https://cpanel-server.tld:2083/execute/DNS/is_https_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_https_availableResponse
application/json
{ "apiversion": 3, "func": "is_https_available", "module": "DNS", "result": { "data": { … }, "errors": null, "messages": null, "metadata": { … }, "status": 1, "warnings": null } }
- Mock server
https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/DNS/lookup
- A server running cPanel.
https://cpanel-server.tld:2083/execute/DNS/lookup
- 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/lookup?domain=example.com'Response
application/json
{ "apiversion": 3, "func": "lookup", "module": "DNS", "result": { "data": [ … ], "errors": null, "messages": null, "metadata": { … }, "status": 1, "warnings": null } }
Query Examples:
The current serial number in the DNS zone’s SOA (Start of Authority) record. If this value does not match the zone’s current state, the request fails.
Example: serial=202001010100
The records to add to the zone. Each item must be a serialized JSON object that contains:
dname— The record’s name.ttl— The record’s TTL (Time-To-Live) value.record_type— The record’s type. For example,AorTXT.data— An array of strings. The format and number of the strings depend on therecord_typevalue.
An A record.
A TXT record.
The records to edit in the zone. Each item must be a serialized JSON object that contains:
line_index— The line number in the DNS zone where the record starts. This is a 0-based index, so to edit the first line in the file use the0value. To edit the second line, give1, and so forth.dname— The record’s name.ttl— The record’s TTL (Time-To-Live) value.record_type— The record’s new type. For example,AorTXT.data— An array of strings. The format and number of the strings depend on therecord_typevalue.
Example: edit='{"line_index": 9, "dname":"example", "ttl":14400, "record_type":"TXT", "data":["string1", "string2"]}'
- Mock server
https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/DNS/mass_edit_zone
- A server running cPanel.
https://cpanel-server.tld:2083/execute/DNS/mass_edit_zone
- 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/mass_edit_zone?serial=202001010100&zone=example.com&add=string&edit=%27{%22line_index%22%3A+9%2C+%22dname%22%3A%22example%22%2C+%22ttl%22%3A14400%2C+%22record_type%22%3A%22TXT%22%2C+%22data%22%3A%5B%22string1%22%2C+%22string2%22%5D}%27&remove=22'Response
application/json
{ "apiversion": 3, "func": "mass_edit_zone", "module": "DNS", "result": { "data": { … }, "errors": null, "messages": null, "metadata": { … }, "status": 1, "warnings": null } }