Flow Runs

Update Flow Run

Updates a flow run.

patch/api/flow_runs/{id}

Path parameters

idstring uuid required

The flow run id

The flow run id

Headers

x-prefect-api-versionstring

Request body

namestring

The name of the flow run. Defaults to a random slug if not specified.

flow_versionstring

The version of the flow executed in this flow run.

parametersobject

Parameters for the flow run.

tagsstring[]

A list of tags on the flow run

infrastructure_pidstring

The id of the flow run as returned by an infrastructure block.

Example request

{
  "name": "my-flow-run",
  "flow_version": "1.0",
  "tags": [
    "tag-1",
    "tag-2"
  ]
}

Response

Successful Response

Changes