v1

latestOpenAPI 3.0.2cPanel License2026-08-06657427.1 MB
UserTasks
SSE Task Management

Remove item from task queue

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::create function).
  • For more information, read our Task Queue Monitor documentation.
get/UserTasks/delete

Query parameters

idstring required
Example:00000000\/5a9ec8dd4c345d

The task's ID number.

Response

HTTP Request was successful.

apiversioninteger

The version of the API.

funcstring

The name of the method called.

modulestring

The name of the module called.

Example response

{
  "apiversion": 3,
  "func": "delete",
  "module": "UserTasks",
  "result": {
    "status": 1
  }
}