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/
Request
This function deletes a process from the user task queue.
Each cPanel account uses a separate user task queue in order to ensure that processes for one user do not impede another user on the server.
- For example, the Git Version Control interface (cPanel >> Home >> Files >> Git Version Control) uses the user task queue to clone repositories (via the
VersionControl::createfunction). - For more information, read our Task Queue Monitor documentation.
Security
BasicAuth
- Mock server
https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/UserTasks/delete
- A server running cPanel.
https://cpanel-server.tld:2083/execute/UserTasks/delete
- CLI
- URL
- curl
- JavaScript
- Node.js
- Python
- Java
- Java8+Apache
- C#
- C#+Newtonsoft
- PHP
- Go
- Ruby
- R
uapi --output=jsonpretty --user=username UserTasks delete id='00000000\/5a9ec8dd4c345d'Response
application/json
{ "apiversion": 3, "func": "delete", "module": "UserTasks", "result": { "data": null, "errors": null, "messages": null, "metadata": {}, "status": 1, "warnings": null } }
Request
This function retrieves a cPanel account's user task queue information.
Each cPanel account uses a separate user task queue in order to ensure that processes for one user do not impede another user on the server.
- For example, the Git Version Control interface (cPanel >> Home >> Files >> Git Version Control) uses the user task queue to clone repositories (via the
VersionControl::createfunction). - For more information, read our Task Queue Monitor documentation.
Security
BasicAuth
- Mock server
https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/UserTasks/retrieve
- A server running cPanel.
https://cpanel-server.tld:2083/execute/UserTasks/retrieve
- CLI
- URL
- curl
- JavaScript
- Node.js
- Python
- Java
- Java8+Apache
- C#
- C#+Newtonsoft
- PHP
- Go
- Ruby
- R
uapi --output=jsonpretty \
--user=username \
UserTasks \
retrieveResponse
application/json
{ "apiversion": 3, "func": "retrieve", "module": "UserTasks", "result": { "data": [ … ], "errors": null, "messages": null, "metadata": { … }, "status": 1, "warnings": null } }