---
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)

---

[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)