PRprefecthq
Flow Runs

Set Flow Run State

Changed on

Set a flow run state, invoking any orchestration rules.

post/api/flow_runs/{id}/set_state

Request

  • The document declares no server URL.
  • Auth
    none declared

Path parameters

idstring uuid required

The flow run id

Headers

x-prefect-api-versionstring

Request body

forceboolean

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

Response

Successful Response

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

Enumerates return statuses for setting run states.

Example response

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

Changes

  • 93ae2b3f2efdRevision changes
    • breaking

      added to the // request property allOf list

    • breaking

      added to the // request property allOf list

    • breaking

      the request property // became required

    • breaking

      removed the enum value CANCELLED of the request property //

    • breaking

      removed the enum value CANCELLING of the request property //

    • breaking

      removed the enum value COMPLETED of the request property //

    • breaking

      removed the enum value CRASHED of the request property //

    • breaking

      removed the enum value FAILED of the request property //

    • breaking

      removed the enum value PAUSED of the request property //

    • breaking

      removed the enum value PENDING of the request property //

    • breaking

      removed the enum value RUNNING of the request property //

    • breaking

      removed the enum value SCHEDULED of the request property //

    • breaking

      the // request property type changed from object to no type

    • breaking

      the // request property type changed from string to no type

    • warning

      removed the request property ///

    • warning

      removed the request property ///

    • warning

      removed the request property ///

    • warning

      removed the request property ///

    • warning

      removed the request property ///

    • warning

      removed the request property ///

    • warning

      removed the request property ///

    • warning

      removed the request property ///

    • warning

      removed the request property ///

    • warning

      removed the request property ///

    • warning

      removed the request property ///

    • warning

      removed the request property ///

    • warning

      removed the request property ///

    • warning

      removed the request property ///

    • warning

      removed the request property ///