v50

latestOpenAPI 3.1.0raw.githubusercontent.com2025-01-16170291390.7 KB

Task Runs

Set Task Run State

Set a task run state, invoking any orchestration rules.

post/api/task_runs/{id}/set_state

idstring uuid required

The task run id

x-prefect-api-versionstring

forceboolean

If false, orchestration rules will be applied that may alter or prevent the state transition. If True, orchestration rules are not applied.

Successful Response

status'ACCEPT' | 'REJECT' | 'ABORT' | 'WAIT' required

Enumerates return statuses for setting run states.

{
  "state": {
    "message": "Run started"
  }
}