--- 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[], required - `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` union, required - boolean - number - `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[], required - `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` union, required - boolean - number - `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[], required - `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` union, required - boolean - number - `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[], required - `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` union, required - boolean - number - `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[], required - `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` union, required - boolean - number - `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[], required - `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` union, required - boolean - number - `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[], required - `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` union, required - boolean - number - `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[], required - `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` union, required - boolean - number - `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[], required - `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` union, required - boolean - number - `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[], required - `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` union, required - boolean - number - `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[], required - `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` union, required - boolean - number - `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[], required - `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` union, required - boolean - number - `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[], required - `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` union, required - boolean - number - `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[], required - `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` union, required - boolean - number - `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[], required - `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` union, required - boolean - number - `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) --- [API](https://skmtc.net/rclone/apis/rclone-rc-api.md) · [All operations](https://skmtc.net/rclone/apis/rclone-rc-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/rclone/rclone-rc-api/versions/2849bf2803ce/schema)