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/
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 } }
Request
This function parses a given DNS zone.
Important:
Most DNS zones contain only 7-bit ASCII. However, it is possible for DNS zones to contain any binary sequence. An application that decodes this function's base64 output must be able to handle cases where the decoded octets do not match any specific character encoding.
Security
BasicAuth
- Mock server
https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/DNS/parse_zone
- A server running cPanel.
https://cpanel-server.tld:2083/execute/DNS/parse_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/parse_zone?zone=example.com'Response
application/json
{ "apiversion": 3, "func": "parse_zone", "module": "DNS", "result": { "data": [ … ], "errors": null, "messages": null, "metadata": { … }, "status": 1, "warnings": null } }
Query
The IPv4 address to use as the replacement in the zone files.
Example: dest_ip=192.0.2.1
The domain to perform the zone file updates on.
Note:
To update multiple domains, increment or duplicate the parameter name. For example, domain-0, domain-1, and domain-2.
domain=example.com domain-1=example1.com domain-2=example2.com
domain=example.com domain=example1.com domain=example2.com
domain=example.com
The IPv4 address to use as the replacement for FTP records in the zone files.
If this parameter is not provided, then the system will use the dest_ip value.
Example: ftp_ip=192.0.2.1
The IPv4 address to replace in the zone files. The detected source IPv4 address is one of:
- If there is an A record for the root of the zone and the IP address is not a loopback address, then the system will use its address.
- If there are any A records in the zone whose addresses are not loopback addresses, then the system will use the address of the first such A record in the zone file.
- If no A records exist in the zone or all A records have loopback addresses, then the system will not update the zone file.
If you do not call this parameter, the system will automatically detect the IP addresses in the zone files.
Example: source_ip=192.0.2.0
- Mock server
https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/DNS/swap_ip_in_zones
- A server running cPanel.
https://cpanel-server.tld:2083/execute/DNS/swap_ip_in_zones
- 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/swap_ip_in_zones?dest_ip=192.0.2.1&domain=example.com&ftp_ip=192.0.2.1&source_ip=192.0.2.0'Response
application/json
{ "apiversion": 3, "func": "swap_ip_in_zones", "module": "DNS", "result": { "data": [ … ], "errors": null, "messages": null, "metadata": {}, "status": 1, "warnings": null } }