cPanel/UserTasks
cPanel module

UserTasks

2 functions, invoked through the cpanel_uapi tool.

scope cpanel:uapi
Call any function with cpanel_uapi(service_id, module="UserTasks", function, params). Live availability depends on the cPanel features JetHost has enabled on your account — call list_cpanel_operations to see what is active.

delete GET#

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.

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.

idstringRequired
The task's ID number.

Response — normalized as { ok, data, errors[], warnings[] }; data contains:

Payload varies by call.

retrieve GET#

Return task queue information

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.

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.

No parameters.

Response — normalized as { ok, data, errors[], warnings[] }; data is an array of:

actionstring
The task's action. * create Note: create is the only possible value.
One of: create
argsobject
An object containing one or more action- and subsystem-specific arguments, if any exist. For example, a task that returns an action value of create and a subsystem value of VersionControl will include the repository_root argument.
repository_rootstring
The absolute path to the repostiory's root directory.
idstring
The task's ID number.
subsystemstring
The subsystem that will handle the process. * VersionControl Note: VersionControl is the only possible value.
One of: VersionControl