RCrclone
job

Run batch of commands

Changed on

Run a batch of rclone rc commands concurrently. An input can set _async to run in the background, and its entry in results is then a job ID. Inputs have no headers, so they can't use Prefer.

post/job/batch

Request

Headers

Prefer'respond-async'

Set to respond-async to run the call in the background. Rclone returns a 202 with a job ID right away, and job/status reports progress. This has the same effect as the _async param in rclone's docs, but _async alone returns a 200 instead of a 202.

Request body

_configobject

Config overrides for this call only.

_filterobject

Filter overrides for this call only.

_groupstring

Stats group for this call.

concurrencyinteger

Do this many commands concurrently. Defaults to --transfers if not set.

Response

Results of the batch job execution.

resultsobject[] required

One entry for each input, in order. Each is that command's result, its error, or a job ID if the input set _async.

Changes

  • 9abe65975575Revision changes
    • info

      api tag job added

  • 1d0b982bbbffRevision changes
    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • info

      added the non-success response with the status

    • info

      added the required property to the response with the status