Skip to main content
PATCH
/
flow_runs
/
{id}
Update Flow Run
curl --request PATCH \
  --url https://api.example.com/flow_runs/{id} \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "flow_version": "<string>",
  "parameters": {},
  "empirical_policy": {
    "max_retries": 0,
    "retry_delay_seconds": 0,
    "retries": 123,
    "retry_delay": 123,
    "pause_keys": [
      "<string>"
    ],
    "resuming": false
  },
  "tags": [
    "<string>"
  ],
  "infrastructure_pid": "<string>",
  "job_variables": {}
}
'
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.prefect.io/llms.txt

Use this file to discover all available pages before exploring further.

Headers

​
x-prefect-api-version
string

Path Parameters

​
id
string<uuid>
required

The flow run id

Body

application/json

Data used by the Prefect REST API to update a flow run.

​
name
string | null
​
flow_version
string | null
​
parameters
Parameters · object
​
empirical_policy
FlowRunPolicy · object

Defines of how a flow run should retry.

​
tags
string[]
​
infrastructure_pid
string | null
​
job_variables
Job Variables · object

Response

Successful Response