v1

latestOpenAPI 3.0.2cPanel License2026-08-06657427.1 MB

UserTasks

SSE Task Management

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.

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/retrieve

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": "retrieve",
  "module": "UserTasks",
  "result": {
    "data": [
      {
        "action": "create",
        "args": {},
        "id": "00000000\\/5a9ec8dd4c345d",
        "subsystem": "VersionControl"
      },
      {
        "action": "create",
        "args": {
          "repository_root": "/home/user/public_html/example"
        },
        "id": "00000000/h39dnn27suc13l",
        "subsystem": "VersionControl"
      }
    ],
    "metadata": {
      "transformed": 1
    },
    "status": 1
  }
}