RCrclone
core

Run an rclone command

Changed on

Executes a standard rclone CLI command remotely and streams or returns its output. Don't combine the STREAM return types with Prefer: respond-async, because the 202 is sent before the command runs.

post/core/command

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.

commandstring

Name of the rclone command to execute, for example ls or lsf.

argstring[]

Arguments passed to the command.

optobject

Flags passed to the command.

returnType'COMBINED_OUTPUT' | 'STREAM' | 'STREAM_ONLY_STDOUT' | 'STREAM_ONLY_STDERR'

Response

Outcome of a command run with core/command. With the default returnType this is JSON. The STREAM return types write the output to the body as plain text.

errorboolean required
resultstring nullable

Changes

  • 9abe65975575Revision changes
    • info

      api tag core added

  • 1d0b982bbbffRevision changes
    • warning

      removed the optional property from the response with the status

    • info

      added the media type text/plain for the response with the status

    • info

      added the non-success response with the status