options

Describe options

Changed on

Returns metadata for options, including help text and defaults, grouped by block.

post/options/info

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.

blocksstring

Optional comma-separated list of option block names to describe.

Response

Metadata describing available options, organised by block.

Changes