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/
Request
This function retrieves the license holder's support-related information.
Note:
- This function is not available through the command line. You must call it as a request body.
- To use this function, you must set up a cPanelID token in your current session. For more information, read our cPanelID documentation.
Security
BasicAuth
- Mock server
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/ticket_get_support_info
- A server running WHM.
https://whm-server.tld:2087/json-api/ticket_get_support_info
- 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/ticket_get_support_infoResponse
application/json
{ "data": { "arch": "x86_64", "arch_supported": 1, "company_id": 7, "company_name": "Example, L.L.C.", "distro": "centos enterprise 6.8", "distro_supported": 1, "gets_direct_support": 0, "has_company_info": 0, "has_compatibility_info": 1, "hostname": "server.example.com", "ip": "192.168.0.1", "logo_url": "http://example.com/assets/ourlogo.png", "pub_support_contact": "http://documentation.example.com/", "pub_tech_contact": "https://support.example.com/", "tech_contact_email": "support@example.com" }, "metadata": { "command": "ticket_get_support_info", "reason": "OK", "result": 1, "version": 1 } }
Request
This function lists all active and open support tickets from the cPanel Customer Portal.
Note:
This function is not available through the command line. You must call it as a request body.
Security
BasicAuth
- Mock server
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/ticket_list
- A server running WHM.
https://whm-server.tld:2087/json-api/ticket_list
- 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/ticket_list?server_num=2&ticket_id=999999999&ssh_username=username'Response
application/json
{ "data": { "auths": [ … ], "non_fatals": [] }, "metadata": { "command": "ticket_list", "reason": "OK", "result": 1, "version": 1 } }
Request
This function records a user's acceptance of the Technical Support Agreement (TSA). The cPanel Customer Portal stores each record with the user's login, the date and time, and the TSA's version.
Note:
This function is not available through the command line. You must call it as a request body.
Security
BasicAuth
- Mock server
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/ticket_update_service_agreement_approval
- A server running WHM.
https://whm-server.tld:2087/json-api/ticket_update_service_agreement_approval
- 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/ticket_update_service_agreement_approval?version=2020-04.v01.TSUPPORT'Response
application/json
{ "metadata": { "command": "ticket_update_service_agreement_approval", "reason": "OK", "result": 1, "version": 1 } }