Skip to main content
PATCH
/
task_runs
/
{id}
Update Task Run
curl --request PATCH \
  --url https://api.example.com/task_runs/{id} \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>"
}
'
{
  "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 task run id

Body

application/json

Data used by the Prefect REST API to update a task run

​
name
string
Example:

"my-task-run"

Response

Successful Response