---
title: "Start serve instance"
method: POST
path: "/serve/start"
---

# Start serve instance

`POST /serve/start`

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

## Query parameters

- `type` string
- `fs` string
- `addr` string
- `params` object
- `_config` string
- `_filter` string
- `_group` string
- `_async` boolean

## Headers

- `Prefer` 'respond-async'

## Request body

- ServeStartRequest
  - `type` string — Type of server to start (e.g. `http`, `webdav`, `ftp`, `sftp`).
  - `fs` string — Remote path that will be served.
  - `addr` string — Address and port to bind the server to, such as `:5572` or `localhost:8080`.
  - `_config` string — JSON encoded config overrides applied for this call only.
  - `_filter` string — JSON encoded filter overrides applied for this call only.
  - `_group` string — Assign the request to a custom stats group.
  - `_async` boolean — Run the command asynchronously. Returns a job id immediately.

## Response `200`

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

- object
  - `addr` string, required — Address and port the server is listening on.
  - `id` string, required — Identifier to pass to `serve/stop`.

## 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** `638e349833a9` — 1 info
  - added the required property `executeId` to the response with the `202` status
- **2026-07-12** `fdf1b1fc77fe` — 1 breaking
  - removed the required property `executeId` from the response with the `202` status
- **2026-07-12** `842fb2d927ae` — 1 info
  - added the required property `executeId` to the response with the `202` status
- **2026-06-05** `2849bf2803ce` — 2 info
  - added the new optional `header` request parameter `Prefer`
  - added the success response with the status `202`
- **2026-04-11** `86281b9ee38c` — 1 warning, 6 info
  - removed the request property `params`
  - the `query` request parameter `addr` became optional
  - the `query` request parameter `fs` became optional
  - the `query` request parameter `type` became optional
  - …3 more

[Full history](https://skmtc.dev/rclone/apis/rclone-rc-api/changes/serve/start/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)