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.

SecurityBasicAuth

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

Request samples

CLI
URL
LiveAPI Perl
LiveAPI PHP

uapi --output=jsonpretty \
  --user=username \
  UserTasks \
  retrieve

Response samples

application/json

{"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"
}
],
"errors": null,
"messages": null,
"metadata": {"transformed": 1
},
"status": 1,
"warnings": null
}
}