--- title: "Describe options" method: POST path: "/options/info" --- # Describe options `POST /options/info` Returns metadata for options, including help text and defaults, grouped by block. ## Query parameters - `blocks` string - `_group` string - `_async` boolean ## Headers - `Prefer` 'respond-async' ## Request body - OptionsInfoRequest - `blocks` string — Optional comma-separated list of option block names to describe. - `_group` string — Assign the request to a custom stats group. - `_async` boolean — Run the command asynchronously. Returns a job id immediately. ## Response `200` Metadata describing available options, organised by block. - object - `dlna` OptionsInfoOption[] - `Name` string, required - `FieldName` string, required - `Help` string, required - `Default` union, required — Default value for this option. - string[] - boolean - number - string - object - `Value` boolean, required - `Valid` boolean, required - `Value` unknown, required - `Hide` integer, required - `Required` boolean, required - `IsPassword` boolean, required - `NoPrefix` boolean, required - `Advanced` boolean, required - `Exclusive` boolean, required - `Sensitive` boolean, required - `DefaultStr` string, required - `ValueStr` string, required - `Type` string, required - `Groups` string - `ShortOpt` string - `Examples` OptionsInfoOptionExample[] - `Value` string, required - `Help` string, required - `filter` OptionsInfoOption[] - `Name` string, required - `FieldName` string, required - `Help` string, required - `Default` union, required — Default value for this option. - string[] - boolean - number - string - object - `Value` boolean, required - `Valid` boolean, required - `Value` unknown, required - `Hide` integer, required - `Required` boolean, required - `IsPassword` boolean, required - `NoPrefix` boolean, required - `Advanced` boolean, required - `Exclusive` boolean, required - `Sensitive` boolean, required - `DefaultStr` string, required - `ValueStr` string, required - `Type` string, required - `Groups` string - `ShortOpt` string - `Examples` OptionsInfoOptionExample[] - `Value` string, required - `Help` string, required - `ftp` OptionsInfoOption[] - `Name` string, required - `FieldName` string, required - `Help` string, required - `Default` union, required — Default value for this option. - string[] - boolean - number - string - object - `Value` boolean, required - `Valid` boolean, required - `Value` unknown, required - `Hide` integer, required - `Required` boolean, required - `IsPassword` boolean, required - `NoPrefix` boolean, required - `Advanced` boolean, required - `Exclusive` boolean, required - `Sensitive` boolean, required - `DefaultStr` string, required - `ValueStr` string, required - `Type` string, required - `Groups` string - `ShortOpt` string - `Examples` OptionsInfoOptionExample[] - `Value` string, required - `Help` string, required - `http` OptionsInfoOption[] - `Name` string, required - `FieldName` string, required - `Help` string, required - `Default` union, required — Default value for this option. - string[] - boolean - number - string - object - `Value` boolean, required - `Valid` boolean, required - `Value` unknown, required - `Hide` integer, required - `Required` boolean, required - `IsPassword` boolean, required - `NoPrefix` boolean, required - `Advanced` boolean, required - `Exclusive` boolean, required - `Sensitive` boolean, required - `DefaultStr` string, required - `ValueStr` string, required - `Type` string, required - `Groups` string - `ShortOpt` string - `Examples` OptionsInfoOptionExample[] - `Value` string, required - `Help` string, required - `log` OptionsInfoOption[] - `Name` string, required - `FieldName` string, required - `Help` string, required - `Default` union, required — Default value for this option. - string[] - boolean - number - string - object - `Value` boolean, required - `Valid` boolean, required - `Value` unknown, required - `Hide` integer, required - `Required` boolean, required - `IsPassword` boolean, required - `NoPrefix` boolean, required - `Advanced` boolean, required - `Exclusive` boolean, required - `Sensitive` boolean, required - `DefaultStr` string, required - `ValueStr` string, required - `Type` string, required - `Groups` string - `ShortOpt` string - `Examples` OptionsInfoOptionExample[] - `Value` string, required - `Help` string, required - `main` OptionsInfoOption[] - `Name` string, required - `FieldName` string, required - `Help` string, required - `Default` union, required — Default value for this option. - string[] - boolean - number - string - object - `Value` boolean, required - `Valid` boolean, required - `Value` unknown, required - `Hide` integer, required - `Required` boolean, required - `IsPassword` boolean, required - `NoPrefix` boolean, required - `Advanced` boolean, required - `Exclusive` boolean, required - `Sensitive` boolean, required - `DefaultStr` string, required - `ValueStr` string, required - `Type` string, required - `Groups` string - `ShortOpt` string - `Examples` OptionsInfoOptionExample[] - `Value` string, required - `Help` string, required - `mount` OptionsInfoOption[] - `Name` string, required - `FieldName` string, required - `Help` string, required - `Default` union, required — Default value for this option. - string[] - boolean - number - string - object - `Value` boolean, required - `Valid` boolean, required - `Value` unknown, required - `Hide` integer, required - `Required` boolean, required - `IsPassword` boolean, required - `NoPrefix` boolean, required - `Advanced` boolean, required - `Exclusive` boolean, required - `Sensitive` boolean, required - `DefaultStr` string, required - `ValueStr` string, required - `Type` string, required - `Groups` string - `ShortOpt` string - `Examples` OptionsInfoOptionExample[] - `Value` string, required - `Help` string, required - `nfs` OptionsInfoOption[] - `Name` string, required - `FieldName` string, required - `Help` string, required - `Default` union, required — Default value for this option. - string[] - boolean - number - string - object - `Value` boolean, required - `Valid` boolean, required - `Value` unknown, required - `Hide` integer, required - `Required` boolean, required - `IsPassword` boolean, required - `NoPrefix` boolean, required - `Advanced` boolean, required - `Exclusive` boolean, required - `Sensitive` boolean, required - `DefaultStr` string, required - `ValueStr` string, required - `Type` string, required - `Groups` string - `ShortOpt` string - `Examples` OptionsInfoOptionExample[] - `Value` string, required - `Help` string, required - `proxy` OptionsInfoOption[] - `Name` string, required - `FieldName` string, required - `Help` string, required - `Default` union, required — Default value for this option. - string[] - boolean - number - string - object - `Value` boolean, required - `Valid` boolean, required - `Value` unknown, required - `Hide` integer, required - `Required` boolean, required - `IsPassword` boolean, required - `NoPrefix` boolean, required - `Advanced` boolean, required - `Exclusive` boolean, required - `Sensitive` boolean, required - `DefaultStr` string, required - `ValueStr` string, required - `Type` string, required - `Groups` string - `ShortOpt` string - `Examples` OptionsInfoOptionExample[] - `Value` string, required - `Help` string, required - `rc` OptionsInfoOption[] - `Name` string, required - `FieldName` string, required - `Help` string, required - `Default` union, required — Default value for this option. - string[] - boolean - number - string - object - `Value` boolean, required - `Valid` boolean, required - `Value` unknown, required - `Hide` integer, required - `Required` boolean, required - `IsPassword` boolean, required - `NoPrefix` boolean, required - `Advanced` boolean, required - `Exclusive` boolean, required - `Sensitive` boolean, required - `DefaultStr` string, required - `ValueStr` string, required - `Type` string, required - `Groups` string - `ShortOpt` string - `Examples` OptionsInfoOptionExample[] - `Value` string, required - `Help` string, required - `restic` OptionsInfoOption[] - `Name` string, required - `FieldName` string, required - `Help` string, required - `Default` union, required — Default value for this option. - string[] - boolean - number - string - object - `Value` boolean, required - `Valid` boolean, required - `Value` unknown, required - `Hide` integer, required - `Required` boolean, required - `IsPassword` boolean, required - `NoPrefix` boolean, required - `Advanced` boolean, required - `Exclusive` boolean, required - `Sensitive` boolean, required - `DefaultStr` string, required - `ValueStr` string, required - `Type` string, required - `Groups` string - `ShortOpt` string - `Examples` OptionsInfoOptionExample[] - `Value` string, required - `Help` string, required - `s3` OptionsInfoOption[] - `Name` string, required - `FieldName` string, required - `Help` string, required - `Default` union, required — Default value for this option. - string[] - boolean - number - string - object - `Value` boolean, required - `Valid` boolean, required - `Value` unknown, required - `Hide` integer, required - `Required` boolean, required - `IsPassword` boolean, required - `NoPrefix` boolean, required - `Advanced` boolean, required - `Exclusive` boolean, required - `Sensitive` boolean, required - `DefaultStr` string, required - `ValueStr` string, required - `Type` string, required - `Groups` string - `ShortOpt` string - `Examples` OptionsInfoOptionExample[] - `Value` string, required - `Help` string, required - `sftp` OptionsInfoOption[] - `Name` string, required - `FieldName` string, required - `Help` string, required - `Default` union, required — Default value for this option. - string[] - boolean - number - string - object - `Value` boolean, required - `Valid` boolean, required - `Value` unknown, required - `Hide` integer, required - `Required` boolean, required - `IsPassword` boolean, required - `NoPrefix` boolean, required - `Advanced` boolean, required - `Exclusive` boolean, required - `Sensitive` boolean, required - `DefaultStr` string, required - `ValueStr` string, required - `Type` string, required - `Groups` string - `ShortOpt` string - `Examples` OptionsInfoOptionExample[] - `Value` string, required - `Help` string, required - `vfs` OptionsInfoOption[] - `Name` string, required - `FieldName` string, required - `Help` string, required - `Default` union, required — Default value for this option. - string[] - boolean - number - string - object - `Value` boolean, required - `Valid` boolean, required - `Value` unknown, required - `Hide` integer, required - `Required` boolean, required - `IsPassword` boolean, required - `NoPrefix` boolean, required - `Advanced` boolean, required - `Exclusive` boolean, required - `Sensitive` boolean, required - `DefaultStr` string, required - `ValueStr` string, required - `Type` string, required - `Groups` string - `ShortOpt` string - `Examples` OptionsInfoOptionExample[] - `Value` string, required - `Help` string, required - `webdav` OptionsInfoOption[] - `Name` string, required - `FieldName` string, required - `Help` string, required - `Default` union, required — Default value for this option. - string[] - boolean - number - string - object - `Value` boolean, required - `Valid` boolean, required - `Value` unknown, required - `Hide` integer, required - `Required` boolean, required - `IsPassword` boolean, required - `NoPrefix` boolean, required - `Advanced` boolean, required - `Exclusive` boolean, required - `Sensitive` boolean, required - `DefaultStr` string, required - `ValueStr` string, required - `Type` string, required - `Groups` string - `ShortOpt` string - `Examples` OptionsInfoOptionExample[] - `Value` string, required - `Help` string, required ## Other responses - `202` — Request accepted for async processing. Poll /job/status with the returned jobid. - `4XX` — Any error response (HTTP 4xx/5xx) - `5XX` — Any error response (HTTP 4xx/5xx) ## Changes - **2026-08-19** `adc0c129da4f` — 15 breaking, 16 info - the response property `dlna` became optional for the status `200` - the response property `filter` became optional for the status `200` - the response property `ftp` became optional for the status `200` - the response property `http` became optional for the status `200` - …27 more - **2026-08-19** `638e349833a9` — 1 info - added the required property `executeId` to the response with the `202` status - **2026-07-12** `adb8ad5fe035` — 31 info - added `subschema #1, subschema #2, subschema #3` to the `additionalProperties/items/Value` response property `anyOf` list for the response status `200` - added `subschema #1, subschema #2, subschema #3` to the `dlna/items/Value` response property `anyOf` list for the response status `200` - added `subschema #1, subschema #2, subschema #3` to the `filter/items/Value` response property `anyOf` list for the response status `200` - added `subschema #1, subschema #2, subschema #3` to the `ftp/items/Value` response property `anyOf` list for the response status `200` - …27 more - **2026-07-12** `86429c26cace` — 15 breaking, 16 info - the response property `dlna` became optional for the status `200` - the response property `filter` became optional for the status `200` - the response property `ftp` became optional for the status `200` - the response property `http` became optional for the status `200` - …27 more - …earlier changes not shown [Full history](https://skmtc.dev/rclone/apis/rclone-rc-api/changes/options/info/post.md) --- [API](https://skmtc.dev/rclone/apis/rclone-rc-api.md) · [All operations](https://skmtc.dev/rclone/apis/rclone-rc-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/rclone/rclone-rc-api/revisions/adc0c129da4f/schema)