Set Task Run State - Prefect

APIs & SDK

Overview
Python SDK Overview
REST API
- REST API overview
- Cloud API
- Server API
  - Server API Overview
  - Root
  - Flows
  - Flow Runs
  - Task Runs
    - POST
      Create Task Run
    - GET
      Read Task Run
    - DEL
      Delete Task Run
    - PATCH
      Update Task Run
    - POST
      Count Task Runs
    - POST
      Task Run History
    - POST
      Read Task Runs
    - POST
      Set Task Run State
    - POST
      Read Dashboard Task Run Counts
    - POST
      Read Task Run Counts By State
  - Flow Run States
  - Task Run States
  - Flow Run Notification Policies
  - Deployments
  - SavedSearches
  - Logs
  - Concurrency Limits
  - Concurrency Limits V2
  - Block types
  - Block documents
  - Work Pools
  - Task Workers
  - Work Queues
  - Artifacts
  - Block schemas
  - Block capabilities
  - Collections
  - Variables
  - GET
    Create Csrf Token
  - Events
  - Automations
  - UI
  - Admin

POST

/

api

/

task_runs

/

{id}

/

set_state

Headers

x-prefect-api-version

string

Path Parameters

id

string

required

The task run id

Body

application/json

state

object

required

The intended state.

force

boolean

default: false

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

Response

200 - application/json

A container for the output of state orchestration.

state

object | null

required

Represents the state of a run.

status

enum<string>

required

Enumerates return statuses for setting run states.

Available options:

ACCEPT,

REJECT,

ABORT,

WAIT

details

object

required

Details associated with an ACCEPT state transition.

Was this page helpful?

Read Task Runs Read Dashboard Task Run Counts