---
title: "change the status of a flow"
method: PATCH
path: "/v1/flows/{flow-id}"
tags: ["flows"]
---

# change the status of a flow

`PATCH /v1/flows/{flow-id}`

## Request body

- PatchStatus — encodes the intended status to switch to
  - `status` 'running' | 'paused', required — Valid statusses flows and connectors can be switched to

## Response `200`

The new status of the flow after applying the patch

- Flow — Information on a deployed flow
  - `alias` string, required — Alias of the flow
  - `status` 'initializing' | 'running' | 'paused' | 'draining' | 'stopped' | 'failed', required — runtime status of a flow or connector instance
  - `connectors` string[], required — aliases of connectors in the flow

## Other responses

- `400` — Error during patch operation, due to invalid status transition.
- `404` — The flow 'flow-id' wasnt found. It is thus not deployed in the runtime.

## Changes

> 5 revisions in range; 1 could not be searched.

- **2022-02-23** `0456ca3a6da1` — 1 info
  - endpoint added
- **2020-02-11** `2b3f4037582e` — 1 breaking
  - api path removed without deprecation

[Change history](https://skmtc.dev/tremor-rs/apis/tremor-api/changes/v1/flows/:flow-id/patch.md)

---

[API](https://skmtc.dev/tremor-rs/apis/tremor-api.md) · [All operations](https://skmtc.dev/tremor-rs/apis/tremor-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/tremor-rs/tremor-api/revisions/b73c19450409/schema)