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/
- Mock server
https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/Market/get_providers_list
- A server running cPanel.
https://cpanel-server.tld:2083/execute/Market/get_providers_list
- CLI
- URL
- curl
- JavaScript
- Node.js
- Python
- Java
- Java8+Apache
- C#
- C#+Newtonsoft
- PHP
- Go
- Ruby
- R
uapi --output=jsonpretty \
--user=username \
Market \
get_providers_listResponse
application/json
{ "apiversion": 3, "func": "get_providers_list", "module": "Market", "result": { "data": [ … ], "errors": null, "messages": null, "metadata": { … }, "status": 1, "warnings": null } }
Query Examples:
The ID of the ordered item.
Note:
To set the status for multiple items, duplicate or increment the parameter name. For example, to change the status for three certificates, use the order_item_id parameter multiple times or use the order_item_id-1, order_item_id-2, and order_item_id-3 parameters.
order_item_id=order_item_id-1=12345&order_item_id-2=12346&order_item_id-3=12347
order_item_id=order_item_id=12345&order_item_id=12346&order_item_id=12347
order_item_id=12345
- Mock server
https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/Market/set_status_of_pending_queue_items
- A server running cPanel.
https://cpanel-server.tld:2083/execute/Market/set_status_of_pending_queue_items
- CLI
- URL
- curl
- JavaScript
- Node.js
- Python
- Java
- Java8+Apache
- C#
- C#+Newtonsoft
- PHP
- Go
- Ruby
- R
uapi --output=jsonpretty \
--user=username \
Market \
set_status_of_pending_queue_items \
provider='cPStore' \
order_item_id='12345' \
status='confirmed'Response
application/json
{ "apiversion": 3, "func": "set_status_of_pending_queue_items", "module": "Market", "result": { "data": { … }, "errors": [ … ], "messages": null, "metadata": {}, "status": 0, "warnings": null } }
- Mock server
https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/Market/set_url_after_checkout
- A server running cPanel.
https://cpanel-server.tld:2083/execute/Market/set_url_after_checkout
- CLI
- URL
- curl
- JavaScript
- Node.js
- Python
- Java
- Java8+Apache
- C#
- C#+Newtonsoft
- PHP
- Go
- Ruby
- R
uapi --output=jsonpretty \
--user=username \
Market \
set_url_after_checkout \
provider='cPStore' \
access_token='725431a1-d5bc-11e5-a28b-8b0e09a93f05' \
order_id='123456' \
url_after_checkout='http://checkout.example.com'Response
application/json
{ "apiversion": 3, "func": "set_url_after_checkout", "module": "Market", "result": { "data": { … }, "errors": null, "messages": null, "metadata": {}, "status": 1, "warnings": null } }