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.

SecurityBasicAuth

Request

query Parameters

required

string

The task's ID number.

Example: id=00000000\/5a9ec8dd4c345d

Responses

200

HTTP Request was successful.

Response Schema: application/json

apiversion	integer The version of the API.
func	string The name of the method called.
module	string The name of the module called.
	object

get/UserTasks/delete

Request samples

CLI
URL
LiveAPI Perl
LiveAPI PHP

uapi --output=jsonpretty --user=username UserTasks delete id='00000000\/5a9ec8dd4c345d'

Response samples

application/json

{"apiversion": 3,
"func": "delete",
"module": "UserTasks",
"result": {"data": null,
"errors": null,
"messages": null,
"metadata": { },
"status": 1,
"warnings": null
}
}