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/
- Mock server
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/ticket_create_stub_ticket
- A server running WHM.
https://whm-server.tld:2087/json-api/ticket_create_stub_ticket
- 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_create_stub_ticketResponse
application/json
{ "data": { "secure_id": "rofh411bv8", "ticket_id": 7648492 }, "metadata": { "command": "ticket_create_stub_ticket", "reason": "OK", "result": 1, "version": 1 } }
Request
This function retrieves the WebPros International, LLC Technical Support Agreement text and metadata about the user's agreement status from the cPanel Customer Portal.
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_agreement
- A server running WHM.
https://whm-server.tld:2087/json-api/ticket_get_support_agreement
- 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_agreementResponse
application/json
{ "data": { "accepted": 0, "accepted_date": 1566000000, "accepted_date_human": "8/17/19", "body": "<p>IMPORTANT: THIS TECHNICAL SUPPORT AGREEMENT ... at the end of AGREEMENT", "create_date": 1564790400, "create_date_human": "8/3/19", "download_url": "https://www.cpanel.net/legal/techagreement_download.cgi", "title": "Technical Support Agreement", "version": "2019-04.v01.TSUPPORT", "view_url": "http://cpanel.com/technical-support-agreements.html" }, "metadata": { "command": "ticket_get_support_agreement", "reason": "OK", "result": 1, "version": 1 } }
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 } }