Prefect UI API
The UI API from Prefect — 10 operation(s) for ui.
OpenAPI Specification
openapi: 3.1.0
info:
title: Prefect Cloud Account Billing UI API
description: Prefect Cloud REST API documentation.
version: 0.8.4
tags:
- name: UI
paths:
/api/accounts/{account_id}/workspaces/{workspace_id}/ui/flows/count-deployments:
post:
tags:
- UI
summary: Count Deployments By Flow
description: 'Get deployment counts by flow id.
Required workspace scopes: `see_flows`'
operationId: count_deployments_by_flow_api_accounts__account_id__workspaces__workspace_id__ui_flows_count_deployments_post
parameters:
- name: account_id
in: path
required: true
schema:
type: string
format: uuid
title: Account Id
- name: workspace_id
in: path
required: true
schema:
type: string
format: uuid
title: Workspace Id
- name: x-prefect-api-version
in: header
required: false
schema:
type: string
title: X-Prefect-Api-Version
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/Body_count_deployments_by_flow_api_accounts__account_id__workspaces__workspace_id__ui_flows_count_deployments_post'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
type: object
additionalProperties:
type: integer
propertyNames:
format: uuid
title: Response Count Deployments By Flow Api Accounts Account Id Workspaces Workspace Id Ui Flows Count Deployments Post
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/accounts/{account_id}/workspaces/{workspace_id}/ui/flows/next-runs:
post:
tags:
- UI
summary: Next Runs By Flow
description: 'Get the next flow run by flow id.
Required workspace scopes: `see_flows`'
operationId: next_runs_by_flow_api_accounts__account_id__workspaces__workspace_id__ui_flows_next_runs_post
parameters:
- name: workspace_id
in: path
required: true
schema:
type: string
format: uuid
title: Workspace Id
- name: account_id
in: path
required: true
schema:
type: string
format: uuid
title: Account Id
- name: x-prefect-api-version
in: header
required: false
schema:
type: string
title: X-Prefect-Api-Version
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/Body_next_runs_by_flow_api_accounts__account_id__workspaces__workspace_id__ui_flows_next_runs_post'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
type: object
additionalProperties:
anyOf:
- $ref: '#/components/schemas/SimpleNextFlowRun'
- type: 'null'
propertyNames:
format: uuid
title: Response Next Runs By Flow Api Accounts Account Id Workspaces Workspace Id Ui Flows Next Runs Post
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/accounts/{account_id}/workspaces/{workspace_id}/ui/flow_runs/history:
post:
tags:
- UI
summary: Read Flow Run History
description: '
Required workspace scopes: `see_flows`'
operationId: read_flow_run_history_api_accounts__account_id__workspaces__workspace_id__ui_flow_runs_history_post
parameters:
- name: account_id
in: path
required: true
schema:
type: string
format: uuid
title: Account Id
- name: workspace_id
in: path
required: true
schema:
type: string
format: uuid
title: Workspace Id
- name: x-prefect-api-version
in: header
required: false
schema:
type: string
title: X-Prefect-Api-Version
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Body_read_flow_run_history_api_accounts__account_id__workspaces__workspace_id__ui_flow_runs_history_post'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/SimpleFlowRun'
title: Response Read Flow Run History Api Accounts Account Id Workspaces Workspace Id Ui Flow Runs History Post
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/accounts/{account_id}/workspaces/{workspace_id}/ui/flow_runs/history-v2:
post:
tags:
- UI
summary: Read Flow Run History V2
description: '
Required workspace scopes: `see_flows`'
operationId: read_flow_run_history_v2_api_accounts__account_id__workspaces__workspace_id__ui_flow_runs_history_v2_post
parameters:
- name: account_id
in: path
required: true
schema:
type: string
format: uuid
title: Account Id
- name: workspace_id
in: path
required: true
schema:
type: string
format: uuid
title: Workspace Id
- name: x-prefect-api-version
in: header
required: false
schema:
type: string
title: X-Prefect-Api-Version
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Body_read_flow_run_history_v2_api_accounts__account_id__workspaces__workspace_id__ui_flow_runs_history_v2_post'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/FlowRunHistoryResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/accounts/{account_id}/workspaces/{workspace_id}/ui/flow_runs/count-task-runs:
post:
tags:
- UI
summary: Count Task Runs By Flow Run
description: 'Get task run counts by flow run id.
Required workspace scopes: `see_flows`'
operationId: count_task_runs_by_flow_run_api_accounts__account_id__workspaces__workspace_id__ui_flow_runs_count_task_runs_post
parameters:
- name: workspace_id
in: path
required: true
schema:
type: string
format: uuid
title: Workspace Id
- name: account_id
in: path
required: true
schema:
type: string
format: uuid
title: Account Id
- name: x-prefect-api-version
in: header
required: false
schema:
type: string
title: X-Prefect-Api-Version
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/Body_count_task_runs_by_flow_run_api_accounts__account_id__workspaces__workspace_id__ui_flow_runs_count_task_runs_post'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
type: object
additionalProperties:
type: integer
propertyNames:
format: uuid
title: Response Count Task Runs By Flow Run Api Accounts Account Id Workspaces Workspace Id Ui Flow Runs Count Task Runs Post
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/accounts/{account_id}/workspaces/{workspace_id}/ui/task_runs/dashboard/counts:
post:
tags:
- UI
summary: Read Dashboard Task Run Counts
description: '
Required workspace scopes: `see_flows`'
operationId: read_dashboard_task_run_counts_api_accounts__account_id__workspaces__workspace_id__ui_task_runs_dashboard_counts_post
parameters:
- name: account_id
in: path
required: true
schema:
type: string
format: uuid
title: Account Id
- name: workspace_id
in: path
required: true
schema:
type: string
format: uuid
title: Workspace Id
- name: x-prefect-api-version
in: header
required: false
schema:
type: string
title: X-Prefect-Api-Version
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/Body_read_dashboard_task_run_counts_api_accounts__account_id__workspaces__workspace_id__ui_task_runs_dashboard_counts_post'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/DashboardTaskRunCount'
title: Response Read Dashboard Task Run Counts Api Accounts Account Id Workspaces Workspace Id Ui Task Runs Dashboard Counts Post
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/accounts/{account_id}/workspaces/{workspace_id}/ui/task_runs/count:
post:
tags:
- UI
summary: Read Task Run Counts By State
description: '
Required workspace scopes: `see_flows`'
operationId: read_task_run_counts_by_state_api_accounts__account_id__workspaces__workspace_id__ui_task_runs_count_post
parameters:
- name: account_id
in: path
required: true
schema:
type: string
format: uuid
title: Account Id
- name: workspace_id
in: path
required: true
schema:
type: string
format: uuid
title: Workspace Id
- name: x-prefect-api-version
in: header
required: false
schema:
type: string
title: X-Prefect-Api-Version
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Body_read_task_run_counts_by_state_api_accounts__account_id__workspaces__workspace_id__ui_task_runs_count_post'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/CountByState'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/accounts/{account_id}/workspaces/{workspace_id}/ui/schemas/validate:
post:
tags:
- UI
summary: Validate Obj
operationId: validate_obj_api_accounts__account_id__workspaces__workspace_id__ui_schemas_validate_post
parameters:
- name: account_id
in: path
required: true
schema:
type: string
format: uuid
title: Account Id
- name: workspace_id
in: path
required: true
schema:
type: string
format: uuid
title: Workspace Id
- name: x-prefect-api-version
in: header
required: false
schema:
type: string
title: X-Prefect-Api-Version
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/Body_validate_obj_api_accounts__account_id__workspaces__workspace_id__ui_schemas_validate_post'
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/accounts/{account_id}/workspaces/{workspace_id}/ui/schemas/validate_schema:
post:
tags:
- UI
summary: Validate Schema
operationId: validate_schema_api_accounts__account_id__workspaces__workspace_id__ui_schemas_validate_schema_post
parameters:
- name: account_id
in: path
required: true
schema:
type: string
format: uuid
title: Account Id
- name: workspace_id
in: path
required: true
schema:
type: string
format: uuid
title: Workspace Id
- name: x-prefect-api-version
in: header
required: false
schema:
type: string
title: X-Prefect-Api-Version
requestBody:
required: true
content:
application/json:
schema:
type: object
additionalProperties: true
title: Schema
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/accounts/{account_id}/workspaces/{workspace_id}/ui/work_pools/count-flow-runs:
post:
tags:
- UI
summary: Count Flow Runs By Work Pool
description: 'Get flow run counts grouped by work pool id.
Returns a mapping of work_pool_id to the number of flow runs matching the
optional filter. Work pools with no matching runs are included with a count
of zero.
Required workspace scopes: `see_flows`'
operationId: count_flow_runs_by_work_pool_api_accounts__account_id__workspaces__workspace_id__ui_work_pools_count_flow_runs_post
parameters:
- name: workspace_id
in: path
required: true
schema:
type: string
format: uuid
title: Workspace Id
- name: account_id
in: path
required: true
schema:
type: string
format: uuid
title: Account Id
- name: x-prefect-api-version
in: header
required: false
schema:
type: string
title: X-Prefect-Api-Version
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/Body_count_flow_runs_by_work_pool_api_accounts__account_id__workspaces__workspace_id__ui_work_pools_count_flow_runs_post'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
type: object
additionalProperties:
type: integer
propertyNames:
format: uuid
title: Response Count Flow Runs By Work Pool Api Accounts Account Id Workspaces Workspace Id Ui Work Pools Count Flow Runs Post
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
components:
schemas:
FlowRunFilterNextScheduledStartTime:
properties:
before_:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Before
description: Only include flow runs with a next_scheduled_start_time or before this time
after_:
anyOf:
- type: string
format: date-time
- type: 'null'
title: After
description: Only include flow runs with a next_scheduled_start_time at or after this time
additionalProperties: false
type: object
title: FlowRunFilterNextScheduledStartTime
description: Filter by `FlowRun.next_scheduled_start_time`.
WorkPoolFilterType:
properties:
any_:
anyOf:
- items:
type: string
type: array
- type: 'null'
title: Any
description: A list of work pool types to include
additionalProperties: false
type: object
title: WorkPoolFilterType
description: Filter by `WorkPool.type`.
DeploymentFilterCreatedBy:
properties:
operator:
$ref: '#/components/schemas/prefect_cloud__orion__schemas__filters__Operator'
description: Operator for combining filter criteria. Defaults to 'and_'.
default: and_
id_:
anyOf:
- items:
type: string
format: uuid
type: array
- type: 'null'
title: Id
description: A list of creator IDs to include
type_:
anyOf:
- items:
type: string
type: array
- type: 'null'
title: Type
description: A list of creator types to include
is_null_:
anyOf:
- type: boolean
- type: 'null'
title: Is Null
description: If true, only include deployments without a creator
additionalProperties: false
type: object
title: DeploymentFilterCreatedBy
description: Filter by `Deployment.created_by`.
FlowRunFilterParentTaskRunId:
properties:
operator:
$ref: '#/components/schemas/prefect_cloud__orion__schemas__filters__Operator'
description: Operator for combining filter criteria. Defaults to 'and_'.
default: and_
any_:
anyOf:
- items:
type: string
format: uuid
type: array
- type: 'null'
title: Any
description: A list of flow run parent_task_run_ids to include
is_null_:
anyOf:
- type: boolean
- type: 'null'
title: Is Null
description: If true, only include flow runs without parent_task_run_id
additionalProperties: false
type: object
title: FlowRunFilterParentTaskRunId
description: Filter by `FlowRun.parent_task_run_id`.
DeploymentFilterName:
properties:
any_:
anyOf:
- items:
type: string
type: array
- type: 'null'
title: Any
description: A list of deployment names to include
examples:
- - my-deployment-1
- my-deployment-2
like_:
anyOf:
- type: string
- type: 'null'
title: Like
description: A case-insensitive partial match. For example, passing 'marvin' will match 'marvin', 'sad-Marvin', and 'marvin-robot'.
examples:
- marvin
additionalProperties: false
type: object
title: DeploymentFilterName
description: Filter by `Deployment.name`.
SimpleFlowRun:
properties:
id:
type: string
format: uuid
title: Id
description: The flow run id.
state_type:
$ref: '#/components/schemas/StateType'
description: The state type.
timestamp:
type: string
format: date-time
title: Timestamp
description: The start time of the run, or the expected start time if it hasn't run yet.
duration:
type: number
title: Duration
description: The total run time of the run.
lateness:
type: number
title: Lateness
description: The delay between the expected and actual start time.
type: object
required:
- id
- state_type
- timestamp
- duration
- lateness
title: SimpleFlowRun
DeploymentFilter:
properties:
operator:
$ref: '#/components/schemas/prefect_cloud__orion__schemas__filters__Operator'
description: Operator for combining filter criteria. Defaults to 'and_'.
default: and_
id:
anyOf:
- $ref: '#/components/schemas/DeploymentFilterId'
- type: 'null'
description: Filter criteria for `Deployment.id`
branch:
anyOf:
- $ref: '#/components/schemas/DeploymentFilterBranch'
- type: 'null'
description: Filter criteria for `Deployment.branch`
base:
anyOf:
- $ref: '#/components/schemas/DeploymentFilterBase'
- type: 'null'
description: Filter criteria for `Deployment.base`
root:
anyOf:
- $ref: '#/components/schemas/DeploymentFilterRoot'
- type: 'null'
description: Filter criteria for `Deployment.root`
name:
anyOf:
- $ref: '#/components/schemas/DeploymentFilterName'
- type: 'null'
description: Filter criteria for `Deployment.name`
is_schedule_active:
anyOf:
- $ref: '#/components/schemas/DeploymentFilterIsScheduleActive'
- type: 'null'
description: Filter criteria for `Deployment.is_schedule_active`
paused:
anyOf:
- $ref: '#/components/schemas/DeploymentFilterPaused'
- type: 'null'
description: Filter criteria for `Deployment.paused`
tags:
anyOf:
- $ref: '#/components/schemas/DeploymentFilterTags'
- type: 'null'
description: Filter criteria for `Deployment.tags`
work_queue_name:
anyOf:
- $ref: '#/components/schemas/DeploymentFilterWorkQueueName'
- type: 'null'
description: Filter criteria for `Deployment.work_queue_name`
concurrency_limit:
anyOf:
- $ref: '#/components/schemas/DeploymentFilterConcurrencyLimit'
- type: 'null'
description: 'DEPRECATED: Prefer `Deployment.concurrency_limit_id` over `Deployment.concurrency_limit`. If provided, will be ignored for backwards-compatibility. Will be removed after December 2024.'
deprecated: true
work_queue_id:
anyOf:
- $ref: '#/components/schemas/DeploymentFilterWorkQueueId'
- type: 'null'
description: Filter criteria for `Deployment.work_queue_id`
status:
anyOf:
- $ref: '#/components/schemas/DeploymentFilterStatus'
- type: 'null'
description: Filter criteria for `Deployment.status`
flow_or_deployment_name:
anyOf:
- $ref: '#/components/schemas/DeploymentOrFlowNameFilter'
- type: 'null'
description: Filter criteria for `Deployment.name` or `Flow.name`
flow_id:
anyOf:
- $ref: '#/components/schemas/DeploymentFilterFlowId'
- type: 'null'
description: Filter criteria for `Deployment.flow_id`
created_by:
anyOf:
- $ref: '#/components/schemas/DeploymentFilterCreatedBy'
- type: 'null'
description: Filter criteria for `Deployment.created_by`
updated_by:
anyOf:
- $ref: '#/components/schemas/DeploymentFilterUpdatedBy'
- type: 'null'
description: Filter criteria for `Deployment.updated_by`
additionalProperties: false
type: object
title: DeploymentFilter
description: Filter for deployments. Only deployments matching all criteria will be returned.
DeploymentFilterBase:
properties:
operator:
$ref: '#/components/schemas/prefect_cloud__orion__schemas__filters__Operator'
description: Operator for combining filter criteria. Defaults to 'and_'.
default: and_
any_:
anyOf:
- items:
type: string
type: array
- type: 'null'
title: Any
description: A list of deployments that have a base to include
examples:
- - deployment1
- deployment2
additionalProperties: false
type: object
title: DeploymentFilterBase
description: Filter by `Deployment.base`.
FlowRunFilterStateName:
properties:
any_:
anyOf:
- items:
type: string
type: array
- type: 'null'
title: Any
description: A list of flow run state names to include
not_any_:
anyOf:
- items:
type: string
type: array
- type: 'null'
title: Not Any
description: A list of flow run state names to exclude
additionalProperties: false
type: object
title: FlowRunFilterStateName
TaskRunFilterStartTime:
properties:
before_:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Before
description: Only include task runs starting at or before this time
after_:
anyOf:
- type: string
format: date-time
- type: 'null'
title: After
description: Only include task runs starting at or after this time
is_null_:
anyOf:
- type: boolean
- type: 'null'
title: Is Null
description: If true, only return task runs without a start time
additionalProperties: false
type: object
title: TaskRunFilterStartTime
description: Filter by `TaskRun.start_time`.
FlowRunFilterTags:
properties:
operator:
$ref: '#/components/schemas/prefect_cloud__orion__schemas__filters__Operator'
description: Operator for combining filter criteria. Defaults to 'and_'.
default: and_
all_:
anyOf:
- items:
type: string
type: array
- type: 'null'
title: All
description: A list of tags. Flow runs will be returned only if their tags are a superset of the list
examples:
- - tag-1
- tag-2
any_:
anyOf:
- items:
type: string
type: array
- type: 'null'
title: Any
description: A list of tags. Flow runs will be returned if their tags contain any of the tags in the list
examples:
- - tag-1
- tag-2
is_null_:
anyOf:
- type: boolean
- type: 'null'
title: Is Null
description: If true, only include flow runs without tags
additionalProperties: false
type: object
title: FlowRunFilterTags
description: Filter by `FlowRun.tags`.
DeploymentFilterConcurrencyLimit:
properties:
ge_:
anyOf:
- type: integer
- type: 'null'
title: Ge
description: Only include deployments with a concurrency limit greater than or equal to this value
le_:
anyOf:
- type: integer
- type: 'null'
title: Le
description: Only include deployments with a concurrency limit less than or equal to this value
is_null_:
anyOf:
- type: boolean
- type: 'null'
title: Is Null
description: If true, only include deployments without a concurrency limit
additionalProperties: false
type: object
title: DeploymentFilterConcurrencyLimit
description: 'DEPRECATED: Prefer `Deployment.concurrency_limit_id` over `Deployment.concurrency_limit`.'
WorkQueueFilterCreatedBy:
properties:
operator:
$ref: '#/components/schemas/prefect_cloud__orion__schemas__filters__Operator'
description: Operator for combining filter criteria. Defaults to 'and_'.
default: and_
id_:
anyOf:
- items:
type: string
format: uuid
type: array
- type: 'null'
title: Id
description: A list of creator IDs to include
type_:
anyOf:
- items:
type: string
type: array
- type: 'null'
title: Type
description: A list of creator types to include
is_null_:
anyOf:
- type: boolean
- type: 'null'
title: Is Null
description: If true, only include work queues without a creator
additionalProperties: false
type: object
title: WorkQueueFilterCreatedBy
description: Filter by `WorkQueue.created_by`.
TaskRunFilterExpectedStartTime:
properties:
before_:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Before
description: Only include task runs expected to start at or before this time
after_:
anyOf:
- type: string
format: date-time
- type: 'null'
title: After
description: Only include task runs expected to start at or after this time
additionalProperties: false
type: object
title: TaskRunFilterExpectedStartTime
description: Filter by `TaskRun.expected_start_time`.
WorkPoolFilterCreatedBy:
properties:
operator:
$ref: '#/components/schemas/prefect_cloud__orion__schemas__filters__Operator'
description: Operator for combining filter criteria. Defaults to 'and_'.
default: and_
id_:
anyOf:
- items:
type: string
format: uuid
type: array
- type: 'null'
title: Id
description: A list of creator IDs to include
type_:
anyOf:
- items:
type: string
type: array
- type: 'null'
title: Type
description: A list of creator types to include
is_null_:
anyOf:
- type: boolean
- type: 'null'
title: Is Null
description: If true, only include work pools without a creator
additionalProperties: false
type: object
title: WorkPoolFilterCreatedBy
description: Filter by `WorkPool.created_by`.
FlowRunFilterStateType:
properties:
any_:
anyOf:
- items:
$ref: '#/components/schemas/StateType'
type: array
- type: 'null'
title: Any
description: A list of flow run state types to include
not_any_:
anyOf:
- items:
$ref: '#/components/schemas/StateType'
type: array
- type: 'null'
title: Not Any
description: A list of flow run state types to exclude
additionalProperties: false
type: object
title: FlowRunFilterStateType
description: Filter by `FlowRun.state_type`.
CountByState:
properties:
COMPLETED:
type: integer
title: Completed
default: 0
PENDING:
type: integer
title: Pending
default: 0
RUNNING:
type: integer
title: Running
default: 0
FAILED:
type: integer
title: Failed
default: 0
CANCELLED:
type: integer
# --- truncated at 32 KB (88 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/prefect/refs/heads/main/openapi/prefect-ui-api-openapi.yml