v1

latestOpenAPI 3.1.0MIT2026-07-1799111346.8 KB

Run an rclone command

Executes a standard rclone CLI command remotely and streams or returns its output.

post/core/command

Query parameters

commandstring

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

argstring[]

Optional positional arguments for the command. Repeat to supply multiple values.

optstring

Optional command options encoded as a JSON string.

returnTypestring

Controls how output is returned; accepts COMBINED_OUTPUT, STREAM, STREAM_ONLY_STDOUT, or STREAM_ONLY_STDERR.

_groupstring

Assign the request to a custom stats group.

_asyncboolean

Run the command asynchronously. Returns a job id immediately.

Headers

Prefer'respond-async'

Set to "respond-async" with _async=true to receive HTTP 202 instead of 200.

Request body

commandstring

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

argstring[]

Optional positional arguments for the command. Repeat to supply multiple values.

optstring

Optional command options encoded as a JSON string.

returnTypestring

Controls how output is returned; accepts COMBINED_OUTPUT, STREAM, STREAM_ONLY_STDOUT, or STREAM_ONLY_STDERR.

_groupstring

Assign the request to a custom stats group.

_asyncboolean

Run the command asynchronously. Returns a job id immediately.

Response

Outcome of a command executed with core/command, including streamed result.

errorboolean required
resultstring nullable
returnTypestring nullable