v1

latestOpenAPI 3.1.0MIT2026-07-1799111346.8 KB

Start serve instance

Launches a new rclone serve endpoint (http, webdav, ftp, etc.) with the provided parameters.

post/serve/start

Query parameters

typestring

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

fsstring

Remote path that will be served.

addrstring

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

paramsobject

Additional arbitrary parameters allowed.

_configstring

JSON encoded config overrides applied for this call only.

_filterstring

JSON encoded filter overrides applied for this call only.

_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

typestring

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

fsstring

Remote path that will be served.

addrstring

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

_configstring

JSON encoded config overrides applied for this call only.

_filterstring

JSON encoded filter overrides applied for this call only.

_groupstring

Assign the request to a custom stats group.

_asyncboolean

Run the command asynchronously. Returns a job id immediately.

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.