cPanel/Batch
cPanel module

Batch

1 functions, invoked through the cpanel_uapi tool.

Run multiple UAPI calls in one request via command-N params; always mutating; enumerate constituent calls first

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

strict GET mutating#

Run multiple UAPI functions in order

This function combines calls for multiple UAPI functions and performs them in order.

Note:

  • If a function call in the list fails, the Batch::strict function does not run further function calls in the list.
  • Due to the potential length of calls of this function, we recommend that you use the HTTP POST method for extremely long batch commands.

JetHost note: each command parameter is one JSON-encoded [module, function, params] triple; submit several by indexing the parameter name command-0, command-1, command-2, … (unindexed command is fine for a single call). Worked example — two calls run in order:

  • command-0 = ["Email","list_pops",{}]
  • command-1 = ["DNS","parse_zone",{"zone":"example.com"}]

Batch::strict is always treated as mutating regardless of which constituent calls are read-only, so enumerate every constituent [module, function, params] call to the user before running the batch — the caller cannot see inside the JSON-encoded command values otherwise.

commandmixedRequired
A UAPI function call, encoded as a JSON array with two or three items: The UAPI module. The UAPI function. A JSON object containing the parameters to pass to this function. You can omit this value if you do not pass any parameters to the function. To submit multiple commands, duplicate the parameter name, or index all parameter names and increment the index for each one. When using the cPanel LiveAPI PHP Library, you must increment the parameter name when you submit the arguments in an associative array. For example: use command-0, command-1, and command-2. When using the cPanel LiveAPI Perl Library, you must increment the parameter name when you submit the arguments in a hash. For example: use command-0, command-1, and command-2. You do not need to add an index to command parameters for query string calls of this function.

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

dataobject
The data returned by an individual UAPI call invoked through this Batch::strict call.
errorsarray<string>
List of errors if the API failed.
messagesarray<string>
List of messages generated by the API.
metadataany
statusinteger
- 1 - Success - 0 - Failed: Check the errors field for more details.
One of: 0 1
warningsarray<string>
List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running an API.