RCrclone
serve

Start serve instance

Changed on

Launches a new rclone serve endpoint (http, webdav, ftp, etc.) with the provided parameters. It also takes the options of the chosen server type, using the option names from options/info. Rclone rejects any other key.

post/serve/start

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.

typestring required

Type of server to start (e.g. http, webdav, ftp, sftp).

addrstring

Address and port to bind the server to, such as :5572 or localhost:8080.

Response

Confirmation of a newly started server, including ID and bound address.

addrstring required

Address and port the server is listening on.

idstring required

Identifier to pass to serve/stop.

Changes