Flow

Update a flow

PATCH
/flows/{flow}

Partially updates a flow. Accepts a multipart upload with an optional metadata part and an optional bundle tarball part. Only the fields present are modified; omitted fields retain their current values. Uploading a new bundle starts a deploy, which the flow shows as its latestDeploy: the flow keeps its current bundle, and its function index, until the new one is indexed, then swaps both in, so existing schedules keep running against the updated file. A deploy that fails leaves them unchanged; a newer one supersedes it. Metadata changes apply at once, except actions sent with a bundle: they are the bundle's, and go live with it.

BearerAuth
headerAuthorizationBearer <JWT>

Admin token, API token issued via /api-tokens, or an OIDC JWT access token issued by the configured OIDC provider.

flow*string
Formatuuid
multipart/form-data
  1. body
metadata?

Partial update of mutable flow fields. Only the fields present in the request body are updated; omitted fields retain their current values.

bundle?unknown

Optional replacement flow tarball (.tar.gz).

Response Body

The updated flow; with a bundle, its latestDeploy is the new deploy.

application/json
  1. response
name*string

Unique resource name.

displayName*string

Human-readable name.

description*string

Free-text description of what the flow does.

path?string

Object-store key for the flow tarball. Absent while the flow has no bundle.

createTime*string

Time at which the flow was created.

Formatdate-time
public*boolean

Whether the flow is publicly visible.

actions?array<>

Actions used by the flow.

latestDeploy?

A deploy of a flow: of a bundle, which is indexed before it goes live, or of a new flow without one.

Example Request
curl -X PATCH 'https://example.com/api/hub/flows/497f6eca-6276-4993-bfeb-53cbbbba6f08'
Example Response
{  "name": "flows/550e8400-e29b-41d4-a716-446655440000",  "displayName": "Data Ingestion Pipeline",  "description": "Pulls CSV files from S3, transforms them, and loads into Postgres.",  "path": "flows/550e8400-e29b-41d4-a716-446655440000/bundle-1760000000000000000.tar.gz",  "createTime": "2026-03-20T14:30:00Z",  "public": false,  "actions": [    {      "name": "string",      "integration": "string",      "scopes": [        "string"      ]    }  ],  "latestDeploy": {    "name": "deploys/0190f5a2-7c3e-7b1a-9d4e-2f6a8b0c1d3e",    "flow": "flows/550e8400-e29b-41d4-a716-446655440000",    "state": "PENDING",    "error": {      "reason": "INVALID_BUNDLE",      "message": "Syntax error in src/index.ts: Variable declaration expected.",      "fluxCode": "parse",      "file": "src/index.ts",      "range": {}    },    "createTime": "2019-08-24T14:15:22Z",    "updateTime": "2019-08-24T14:15:22Z"  }}