APIs & SDK
- Overview
- Python SDK Overview
- REST API
- REST API overview
- Cloud API
- Server API
- Server API Overview
- Root
- Flows
- Flow Runs
- Task Runs
- 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
- GETCreate Csrf Token
- Events
- Automations
- UI
- Admin
Get Scheduled Flow Runs
Load scheduled runs for a worker
Headers
Path Parameters
The work pool name
Body
The names of work pool queues
The maximum time to look for scheduled flow runs
The minimum time to look for scheduled flow runs
Defaults to PREFECT_API_DEFAULT_LIMIT if not provided.
Response
An ORM representation of flow run data.
The id of the flow being run.
The name of the flow run. Defaults to a random slug if not specified.
The id of the flow run's current state.
The id of the deployment associated with this flow run, if available.
The version of the deployment associated with this flow run.
The work queue that handled this flow run.
The version of the flow executed in this flow run.
Parameters for the flow run.
An optional idempotency key for the flow run. Used to ensure the same flow run is not created multiple times.
Additional context for the flow run.
Defines of how a flow run should retry.
The maximum number of retries. Field is not used. Please use retries instead.
The delay between retries. Field is not used. Please use retry_delay instead.
The number of retries.
The delay time between retries, in seconds.
Tracks pauses this run has observed.
Indicates if this run is resuming from a pause.
The type of retry this run is undergoing.
in_process, reschedule A list of tags on the flow run
A dictionary of key-value labels. Values can be strings, numbers, or booleans.
If the flow run is a subflow, the id of the 'dummy' task in the parent flow used to track subflow state.
The type of the current flow run state.
SCHEDULED, PENDING, RUNNING, COMPLETED, FAILED, CANCELLED, CRASHED, PAUSED, CANCELLING The name of the current flow run state.
The number of times the flow run was executed.
The flow run's expected start time.
The next time the flow run is scheduled to start.
The actual start time.
The actual end time.
Total run time. If the flow run was executed multiple times, the time of each run will be summed.
A real-time estimate of the total run time.
The difference between actual and expected start time.
Whether or not the flow run was automatically scheduled.
The block document defining infrastructure to use this flow run.
The id of the flow run as returned by an infrastructure block.
The id of the run's work pool queue.
The current state of the flow run.
Enumeration of state types.
SCHEDULED, PENDING, RUNNING, COMPLETED, FAILED, CANCELLED, CRASHED, PAUSED, CANCELLING Data associated with the state, e.g. a result. Content must be storable as JSON.
Variables used as overrides in the base job template
Was this page helpful?