WHM API.
Download OpenAPI description
Overview
URL
WebPros International, LLC
License
Languages
Servers
Mock server
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/
A server running WHM.
https://{host}:{port}/json-api/
Query Examples:
The domain for which to check the DKIM records.
Note:
To check multiple domains, duplicate or increment the parameter name. For example, domain-1, domain-2, and domain-3 parameters.
domain=domain-1=example.com&domain-2=example.com&domain-3=example3.com
domain=domain=example.com&domain=example2.com&domain=example3.com
domain=example.com
- Mock server
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/validate_current_dkims
- A server running WHM.
https://whm-server.tld:2087/json-api/validate_current_dkims
- 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/whm.openapi/validate_current_dkims?domain=string'Response
application/json
{ "data": { "payload": [ … ] }, "metadata": { "command": "validate_current_dkims", "reason": "OK", "result": 1, "version": 1 } }
Query Examples:
The domain for which to check the DMARC record.
Note:
To check multiple domains, duplicate or increment the parameter name. For example, domain-1, domain-2, and domain-3 parameters.
If you do not include this argument, the system will validate DMARC records for all domains on the server.
domain=domain-1=example.com&domain-2=example.com&domain-3=example3.com
domain=domain=example.com&domain=example2.com&domain=example3.com
domain=domain=example.com
- Mock server
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/validate_current_dmarcs
- A server running WHM.
https://whm-server.tld:2087/json-api/validate_current_dmarcs
- 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/whm.openapi/validate_current_dmarcs?domain=string'Response
application/json
{ "data": { "payload": [ … ] }, "metadata": { "command": "validate_current_dmarcs", "reason": "OK", "result": 1, "version": 1 } }
Request
This function validates the pointer records (PTR) for IPv4 and IPv6 addresses an account's domains send mail from. It retrieves the PTR records for each IP address and determines which of the domain's IP addresses send mail. It then validates the PTR records for each IP address and validates the A (IPv4) or AAAA (IPv6) records pointing to each domain. This function also ensures that at least one of that domain's A or AAAA records points back to the IP address.
Security
BasicAuth
Query Examples:
The domain for which to validate the PTR records.
Note:
To check multiple domains, duplicate or increment the parameter name. For example, use the domain-1, domain-2, and domain-3 parameters.
domain=domain-1=example.com domain-2=example2.com domain-3=example3.com
domain=domain=example.com&domain=example2.com&domain=example3.com
domain=example.com
- Mock server
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/validate_current_ptrs
- A server running WHM.
https://whm-server.tld:2087/json-api/validate_current_ptrs
- 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/whm.openapi/validate_current_ptrs?domain=string'Response
application/json
{ "data": { "payload": [ … ] }, "metadata": { "command": "validate_current_ptrs", "reason": "OK", "result": 1, "version": 1 } }