v1

latestOpenAPI 3.1.0MIT2026-07-1799111346.8 KB

Set option values

Sets temporary option overrides for the running process by supplying key/value pairs grouped under option block names. Provide one or more query parameters whose names match the blocks you want to modify (for example main, rc, http). Each block parameter carries an object of option overrides.

post/options/set

Query parameters

dlnaobject

Overrides for the dlna option block.

filterobject

Overrides for the filter option block.

ftpobject

Overrides for the ftp option block.

mainobject

Overrides for the main option block.

httpobject

Overrides for the http option block.

logobject

Overrides for the log option block.

mountobject

Overrides for the mount option block.

nfsobject

Overrides for the nfs option block.

proxyobject

Overrides for the proxy option block.

rcobject

Overrides for the rc option block.

resticobject

Overrides for the restic option block.

s3object

Overrides for the s3 option block.

sftpobject

Overrides for the sftp option block.

vfsobject

Overrides for the vfs option block.

webdavobject

Overrides for the webdav option block.

_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