schultesdev/prefect-go
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
a04489ddf54150535f7507bc63d84bf2ad167a16
prefect-go/openapi.json

29948 lines
870 KiB
JSON
Raw Blame History

{
"openapi": "3.1.0",
"info": {
"title": "Prefect Prefect REST API",
"version": "3.6.19",
"x-logo": {
"url": "static/prefect-logo-mark-gradient.png"
}
},
"paths": {
"/health": {
"get": {
"tags": [
"Root"
],
"summary": "Health Check",
"operationId": "health_check_health_get",
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "boolean",
"title": "Response Health Check Health Get"
}
}
}
}
}
}
},
"/version": {
"get": {
"tags": [
"Root"
],
"summary": "Server Version",
"operationId": "server_version_version_get",
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "string",
"title": "Response Server Version Version Get"
}
}
}
}
}
}
},
"/flows/": {
"post": {
"tags": [
"Flows"
],
"summary": "Create Flow",
"description": "Creates a new flow from the provided schema. If a flow with the\nsame name already exists, the existing flow is returned.\n\nFor more information, see https://docs.prefect.io/v3/concepts/flows.",
"operationId": "create_flow_flows__post",
"parameters": [
{
"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/FlowCreate"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Flow"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/flows/{id}": {
"patch": {
"tags": [
"Flows"
],
"summary": "Update Flow",
"description": "Updates a flow.",
"operationId": "update_flow_flows__id__patch",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"description": "The flow id",
"title": "Id"
},
"description": "The flow 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/FlowUpdate"
}
}
}
},
"responses": {
"204": {
"description": "Successful Response"
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"get": {
"tags": [
"Flows"
],
"summary": "Read Flow",
"description": "Get a flow by id.",
"operationId": "read_flow_flows__id__get",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"description": "The flow id",
"title": "Id"
},
"description": "The flow id"
},
{
"name": "x-prefect-api-version",
"in": "header",
"required": false,
"schema": {
"type": "string",
"title": "X-Prefect-Api-Version"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Flow"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"delete": {
"tags": [
"Flows"
],
"summary": "Delete Flow",
"description": "Delete a flow by id.",
"operationId": "delete_flow_flows__id__delete",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"description": "The flow id",
"title": "Id"
},
"description": "The flow id"
},
{
"name": "x-prefect-api-version",
"in": "header",
"required": false,
"schema": {
"type": "string",
"title": "X-Prefect-Api-Version"
}
}
],
"responses": {
"204": {
"description": "Successful Response"
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/flows/count": {
"post": {
"tags": [
"Flows"
],
"summary": "Count Flows",
"description": "Count flows.",
"operationId": "count_flows_flows_count_post",
"parameters": [
{
"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_count_flows_flows_count_post"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "integer",
"title": "Response Count Flows Flows Count Post"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/flows/name/{name}": {
"get": {
"tags": [
"Flows"
],
"summary": "Read Flow By Name",
"description": "Get a flow by name.",
"operationId": "read_flow_by_name_flows_name__name__get",
"parameters": [
{
"name": "name",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "The name of the flow",
"title": "Name"
},
"description": "The name of the flow"
},
{
"name": "x-prefect-api-version",
"in": "header",
"required": false,
"schema": {
"type": "string",
"title": "X-Prefect-Api-Version"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Flow"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/flows/filter": {
"post": {
"tags": [
"Flows"
],
"summary": "Read Flows",
"description": "Query for flows.",
"operationId": "read_flows_flows_filter_post",
"parameters": [
{
"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_flows_flows_filter_post"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Flow"
},
"title": "Response Read Flows Flows Filter Post"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/flows/bulk_delete": {
"post": {
"tags": [
"Flows"
],
"summary": "Bulk Delete Flows",
"description": "Bulk delete flows matching the specified filter criteria.\n\nThis also deletes all associated deployments.\n\nReturns the IDs of flows that were deleted.",
"operationId": "bulk_delete_flows_flows_bulk_delete_post",
"parameters": [
{
"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_bulk_delete_flows_flows_bulk_delete_post"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FlowBulkDeleteResponse"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/flows/paginate": {
"post": {
"tags": [
"Flows"
],
"summary": "Paginate Flows",
"description": "Pagination query for flows.",
"operationId": "paginate_flows_flows_paginate_post",
"parameters": [
{
"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_paginate_flows_flows_paginate_post"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FlowPaginationResponse"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/flow_runs/": {
"post": {
"tags": [
"Flow Runs"
],
"summary": "Create Flow Run",
"description": "Create a flow run. If a flow run with the same flow_id and\nidempotency key already exists, the existing flow run will be returned.\n\nIf no state is provided, the flow run will be created in a PENDING state.\n\nFor more information, see https://docs.prefect.io/v3/concepts/flows.",
"operationId": "create_flow_run_flow_runs__post",
"parameters": [
{
"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/FlowRunCreate"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FlowRunResponse"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/flow_runs/{id}": {
"patch": {
"tags": [
"Flow Runs"
],
"summary": "Update Flow Run",
"description": "Updates a flow run.",
"operationId": "update_flow_run_flow_runs__id__patch",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"description": "The flow run id",
"title": "Id"
},
"description": "The flow run 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/FlowRunUpdate"
}
}
}
},
"responses": {
"204": {
"description": "Successful Response"
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"get": {
"tags": [
"Flow Runs"
],
"summary": "Read Flow Run",
"description": "Get a flow run by id.",
"operationId": "read_flow_run_flow_runs__id__get",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"description": "The flow run id",
"title": "Id"
},
"description": "The flow run id"
},
{
"name": "x-prefect-api-version",
"in": "header",
"required": false,
"schema": {
"type": "string",
"title": "X-Prefect-Api-Version"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FlowRunResponse"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"delete": {
"tags": [
"Flow Runs"
],
"summary": "Delete Flow Run",
"description": "Delete a flow run by id.",
"operationId": "delete_flow_run_flow_runs__id__delete",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"description": "The flow run id",
"title": "Id"
},
"description": "The flow run id"
},
{
"name": "x-prefect-api-version",
"in": "header",
"required": false,
"schema": {
"type": "string",
"title": "X-Prefect-Api-Version"
}
}
],
"responses": {
"204": {
"description": "Successful Response"
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/flow_runs/count": {
"post": {
"tags": [
"Flow Runs"
],
"summary": "Count Flow Runs",
"description": "Query for flow runs.",
"operationId": "count_flow_runs_flow_runs_count_post",
"parameters": [
{
"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_count_flow_runs_flow_runs_count_post"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "integer",
"title": "Response Count Flow Runs Flow Runs Count Post"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/flow_runs/lateness": {
"post": {
"tags": [
"Flow Runs"
],
"summary": "Average Flow Run Lateness",
"description": "Query for average flow-run lateness in seconds.",
"operationId": "average_flow_run_lateness_flow_runs_lateness_post",
"parameters": [
{
"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_average_flow_run_lateness_flow_runs_lateness_post"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Response Average Flow Run Lateness Flow Runs Lateness Post"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/flow_runs/history": {
"post": {
"tags": [
"Flow Runs"
],
"summary": "Flow Run History",
"description": "Query for flow run history data across a given range and interval.",
"operationId": "flow_run_history_flow_runs_history_post",
"parameters": [
{
"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_flow_run_history_flow_runs_history_post"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/HistoryResponse"
},
"title": "Response Flow Run History Flow Runs History Post"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/flow_runs/{id}/graph": {
"get": {
"tags": [
"Flow Runs",
"Flow Run Graph"
],
"summary": "Read Flow Run Graph V1",
"description": "Get a task run dependency map for a given flow run.",
"operationId": "read_flow_run_graph_v1_flow_runs__id__graph_get",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"description": "The flow run id",
"title": "Id"
},
"description": "The flow run id"
},
{
"name": "x-prefect-api-version",
"in": "header",
"required": false,
"schema": {
"type": "string",
"title": "X-Prefect-Api-Version"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DependencyResult"
},
"title": "Response Read Flow Run Graph V1 Flow Runs Id Graph Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/flow_runs/{id}/graph-v2": {
"get": {
"tags": [
"Flow Runs",
"Flow Run Graph"
],
"summary": "Read Flow Run Graph V2",
"description": "Get a graph of the tasks and subflow runs for the given flow run",
"operationId": "read_flow_run_graph_v2_flow_runs__id__graph_v2_get",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"description": "The flow run id",
"title": "Id"
},
"description": "The flow run id"
},
{
"name": "since",
"in": "query",
"required": false,
"schema": {
"type": "string",
"format": "date-time",
"description": "Only include runs that start or end after this time.",
"default": "0001-01-01T00:00:00+00:00",
"title": "Since"
},
"description": "Only include runs that start or end after this time."
},
{
"name": "x-prefect-api-version",
"in": "header",
"required": false,
"schema": {
"type": "string",
"title": "X-Prefect-Api-Version"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Graph"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/flow_runs/{id}/resume": {
"post": {
"tags": [
"Flow Runs"
],
"summary": "Resume Flow Run",
"description": "Resume a paused flow run.",
"operationId": "resume_flow_run_flow_runs__id__resume_post",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"description": "The flow run id",
"title": "Id"
},
"description": "The flow run 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_resume_flow_run_flow_runs__id__resume_post"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrchestrationResult"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/flow_runs/filter": {
"post": {
"tags": [
"Flow Runs"
],
"summary": "Read Flow Runs",
"description": "Query for flow runs.",
"operationId": "read_flow_runs_flow_runs_filter_post",
"parameters": [
{
"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_runs_flow_runs_filter_post"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FlowRunResponse"
},
"title": "Response Read Flow Runs Flow Runs Filter Post"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/flow_runs/bulk_delete": {
"post": {
"tags": [
"Flow Runs"
],
"summary": "Bulk Delete Flow Runs",
"description": "Bulk delete flow runs matching the specified filter criteria.\n\nReturns the IDs of flow runs that were deleted.",
"operationId": "bulk_delete_flow_runs_flow_runs_bulk_delete_post",
"parameters": [
{
"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_bulk_delete_flow_runs_flow_runs_bulk_delete_post"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FlowRunBulkDeleteResponse"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/flow_runs/bulk_set_state": {
"post": {
"tags": [
"Flow Runs"
],
"summary": "Bulk Set Flow Run State",
"description": "Bulk set state for flow runs matching the specified filter criteria.\n\nReturns the orchestration results for each flow run.",
"operationId": "bulk_set_flow_run_state_flow_runs_bulk_set_state_post",
"parameters": [
{
"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_bulk_set_flow_run_state_flow_runs_bulk_set_state_post"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FlowRunBulkSetStateResponse"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/flow_runs/{id}/set_state": {
"post": {
"tags": [
"Flow Runs"
],
"summary": "Set Flow Run State",
"description": "Set a flow run state, invoking any orchestration rules.",
"operationId": "set_flow_run_state_flow_runs__id__set_state_post",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"description": "The flow run id",
"title": "Id"
},
"description": "The flow run 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_set_flow_run_state_flow_runs__id__set_state_post"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrchestrationResult"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/flow_runs/{id}/input": {
"post": {
"tags": [
"Flow Runs"
],
"summary": "Create Flow Run Input",
"description": "Create a key/value input for a flow run.",
"operationId": "create_flow_run_input_flow_runs__id__input_post",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"description": "The flow run id",
"title": "Id"
},
"description": "The flow run 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_create_flow_run_input_flow_runs__id__input_post"
}
}
}
},
"responses": {
"201": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/flow_runs/{id}/input/filter": {
"post": {
"tags": [
"Flow Runs"
],
"summary": "Filter Flow Run Input",
"description": "Filter flow run inputs by key prefix",
"operationId": "filter_flow_run_input_flow_runs__id__input_filter_post",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"description": "The flow run id",
"title": "Id"
},
"description": "The flow run 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_filter_flow_run_input_flow_runs__id__input_filter_post"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FlowRunInput"
},
"title": "Response Filter Flow Run Input Flow Runs Id Input Filter Post"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/flow_runs/{id}/input/{key}": {
"get": {
"tags": [
"Flow Runs"
],
"summary": "Read Flow Run Input",
"description": "Create a value from a flow run input",
"operationId": "read_flow_run_input_flow_runs__id__input__key__get",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"description": "The flow run id",
"title": "Id"
},
"description": "The flow run id"
},
{
"name": "key",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "The input key",
"title": "Key"
},
"description": "The input key"
},
{
"name": "x-prefect-api-version",
"in": "header",
"required": false,
"schema": {
"type": "string",
"title": "X-Prefect-Api-Version"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"delete": {
"tags": [
"Flow Runs"
],
"summary": "Delete Flow Run Input",
"description": "Delete a flow run input",
"operationId": "delete_flow_run_input_flow_runs__id__input__key__delete",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"description": "The flow run id",
"title": "Id"
},
"description": "The flow run id"
},
{
"name": "key",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "The input key",
"title": "Key"
},
"description": "The input key"
},
{
"name": "x-prefect-api-version",
"in": "header",
"required": false,
"schema": {
"type": "string",
"title": "X-Prefect-Api-Version"
}
}
],
"responses": {
"204": {
"description": "Successful Response"
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/flow_runs/paginate": {
"post": {
"tags": [
"Flow Runs"
],
"summary": "Paginate Flow Runs",
"description": "Pagination query for flow runs.",
"operationId": "paginate_flow_runs_flow_runs_paginate_post",
"parameters": [
{
"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_paginate_flow_runs_flow_runs_paginate_post"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FlowRunPaginationResponse"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/flow_runs/{id}/logs/download": {
"get": {
"tags": [
"Flow Runs"
],
"summary": "Download Logs",
"description": "Download all flow run logs as a CSV file, collecting all logs until there are no more logs to retrieve.",
"operationId": "download_logs_flow_runs__id__logs_download_get",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"description": "The flow run id",
"title": "Id"
},
"description": "The flow run id"
},
{
"name": "x-prefect-api-version",
"in": "header",
"required": false,
"schema": {
"type": "string",
"title": "X-Prefect-Api-Version"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/flow_runs/{id}/labels": {
"patch": {
"tags": [
"Flow Runs"
],
"summary": "Update Flow Run Labels",
"description": "Update the labels of a flow run.",
"operationId": "update_flow_run_labels_flow_runs__id__labels_patch",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"description": "The flow run id",
"title": "Id"
},
"description": "The flow run 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,
"description": "The labels to update",
"title": "Labels"
}
}
}
},
"responses": {
"204": {
"description": "Successful Response"
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/task_runs/": {
"post": {
"tags": [
"Task Runs"
],
"summary": "Create Task Run",
"description": "Create a task run. If a task run with the same flow_run_id,\ntask_key, and dynamic_key already exists, the existing task\nrun will be returned.\n\nIf no state is provided, the task run will be created in a PENDING state.\n\nFor more information, see https://docs.prefect.io/v3/concepts/tasks.",
"operationId": "create_task_run_task_runs__post",
"parameters": [
{
"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/TaskRunCreate"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TaskRun"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/task_runs/{id}": {
"patch": {
"tags": [
"Task Runs"
],
"summary": "Update Task Run",
"description": "Updates a task run.",
"operationId": "update_task_run_task_runs__id__patch",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"description": "The task run id",
"title": "Id"
},
"description": "The task run 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/TaskRunUpdate"
}
}
}
},
"responses": {
"204": {
"description": "Successful Response"
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"get": {
"tags": [
"Task Runs"
],
"summary": "Read Task Run",
"description": "Get a task run by id.",
"operationId": "read_task_run_task_runs__id__get",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"description": "The task run id",
"title": "Id"
},
"description": "The task run id"
},
{
"name": "x-prefect-api-version",
"in": "header",
"required": false,
"schema": {
"type": "string",
"title": "X-Prefect-Api-Version"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TaskRun"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"delete": {
"tags": [
"Task Runs"
],
"summary": "Delete Task Run",
"description": "Delete a task run by id.",
"operationId": "delete_task_run_task_runs__id__delete",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"description": "The task run id",
"title": "Id"
},
"description": "The task run id"
},
{
"name": "x-prefect-api-version",
"in": "header",
"required": false,
"schema": {
"type": "string",
"title": "X-Prefect-Api-Version"
}
}
],
"responses": {
"204": {
"description": "Successful Response"
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/task_runs/count": {
"post": {
"tags": [
"Task Runs"
],
"summary": "Count Task Runs",
"description": "Count task runs.",
"operationId": "count_task_runs_task_runs_count_post",
"parameters": [
{
"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_count_task_runs_task_runs_count_post"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "integer",
"title": "Response Count Task Runs Task Runs Count Post"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/task_runs/history": {
"post": {
"tags": [
"Task Runs"
],
"summary": "Task Run History",
"description": "Query for task run history data across a given range and interval.",
"operationId": "task_run_history_task_runs_history_post",
"parameters": [
{
"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_task_run_history_task_runs_history_post"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/HistoryResponse"
},
"title": "Response Task Run History Task Runs History Post"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/task_runs/filter": {
"post": {
"tags": [
"Task Runs"
],
"summary": "Read Task Runs",
"description": "Query for task runs.",
"operationId": "read_task_runs_task_runs_filter_post",
"parameters": [
{
"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_runs_task_runs_filter_post"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TaskRun"
},
"title": "Response Read Task Runs Task Runs Filter Post"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/task_runs/paginate": {
"post": {
"tags": [
"Task Runs"
],
"summary": "Paginate Task Runs",
"description": "Pagination query for task runs.",
"operationId": "paginate_task_runs_task_runs_paginate_post",
"parameters": [
{
"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_paginate_task_runs_task_runs_paginate_post"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TaskRunPaginationResponse"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/task_runs/{id}/set_state": {
"post": {
"tags": [
"Task Runs"
],
"summary": "Set Task Run State",
"description": "Set a task run state, invoking any orchestration rules.",
"operationId": "set_task_run_state_task_runs__id__set_state_post",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"description": "The task run id",
"title": "Id"
},
"description": "The task run 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_set_task_run_state_task_runs__id__set_state_post"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrchestrationResult"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/flow_run_states/{id}": {
"get": {
"tags": [
"Flow Run States"
],
"summary": "Read Flow Run State",
"description": "Get a flow run state by id.\n\nFor more information, see https://docs.prefect.io/v3/concepts/flows#final-state-determination.",
"operationId": "read_flow_run_state_flow_run_states__id__get",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"description": "The flow run state id",
"title": "Id"
},
"description": "The flow run state id"
},
{
"name": "x-prefect-api-version",
"in": "header",
"required": false,
"schema": {
"type": "string",
"title": "X-Prefect-Api-Version"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/State"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/flow_run_states/": {
"get": {
"tags": [
"Flow Run States"
],
"summary": "Read Flow Run States",
"description": "Get states associated with a flow run.",
"operationId": "read_flow_run_states_flow_run_states__get",
"parameters": [
{
"name": "flow_run_id",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"title": "Flow Run Id"
}
},
{
"name": "x-prefect-api-version",
"in": "header",
"required": false,
"schema": {
"type": "string",
"title": "X-Prefect-Api-Version"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/State"
},
"title": "Response Read Flow Run States Flow Run States Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/task_run_states/{id}": {
"get": {
"tags": [
"Task Run States"
],
"summary": "Read Task Run State",
"description": "Get a task run state by id.\n\nFor more information, see https://docs.prefect.io/v3/concepts/tasks.",
"operationId": "read_task_run_state_task_run_states__id__get",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"description": "The task run state id",
"title": "Id"
},
"description": "The task run state id"
},
{
"name": "x-prefect-api-version",
"in": "header",
"required": false,
"schema": {
"type": "string",
"title": "X-Prefect-Api-Version"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/State"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/task_run_states/": {
"get": {
"tags": [
"Task Run States"
],
"summary": "Read Task Run States",
"description": "Get states associated with a task run.",
"operationId": "read_task_run_states_task_run_states__get",
"parameters": [
{
"name": "task_run_id",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"title": "Task Run Id"
}
},
{
"name": "x-prefect-api-version",
"in": "header",
"required": false,
"schema": {
"type": "string",
"title": "X-Prefect-Api-Version"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/State"
},
"title": "Response Read Task Run States Task Run States Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/deployments/": {
"post": {
"tags": [
"Deployments"
],
"summary": "Create Deployment",
"description": "Creates a new deployment from the provided schema. If a deployment with\nthe same name and flow_id already exists, the deployment is updated.\n\nIf the deployment has an active schedule, flow runs will be scheduled.\nWhen upserting, any scheduled runs from the existing deployment will be deleted.\n\nFor more information, see https://docs.prefect.io/v3/concepts/deployments.",
"operationId": "create_deployment_deployments__post",
"parameters": [
{
"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/DeploymentCreate"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeploymentResponse"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/deployments/{id}": {
"patch": {
"tags": [
"Deployments"
],
"summary": "Update Deployment",
"operationId": "update_deployment_deployments__id__patch",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"description": "The deployment id",
"title": "Id"
},
"description": "The deployment 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/DeploymentUpdate"
}
}
}
},
"responses": {
"204": {
"description": "Successful Response"
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"get": {
"tags": [
"Deployments"
],
"summary": "Read Deployment",
"description": "Get a deployment by id.",
"operationId": "read_deployment_deployments__id__get",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"description": "The deployment id",
"title": "Id"
},
"description": "The deployment id"
},
{
"name": "x-prefect-api-version",
"in": "header",
"required": false,
"schema": {
"type": "string",
"title": "X-Prefect-Api-Version"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeploymentResponse"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"delete": {
"tags": [
"Deployments"
],
"summary": "Delete Deployment",
"description": "Delete a deployment by id.",
"operationId": "delete_deployment_deployments__id__delete",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"description": "The deployment id",
"title": "Id"
},
"description": "The deployment id"
},
{
"name": "x-prefect-api-version",
"in": "header",
"required": false,
"schema": {
"type": "string",
"title": "X-Prefect-Api-Version"
}
}
],
"responses": {
"204": {
"description": "Successful Response"
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/deployments/name/{flow_name}/{deployment_name}": {
"get": {
"tags": [
"Deployments"
],
"summary": "Read Deployment By Name",
"description": "Get a deployment using the name of the flow and the deployment.",
"operationId": "read_deployment_by_name_deployments_name__flow_name___deployment_name__get",
"parameters": [
{
"name": "flow_name",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "The name of the flow",
"title": "Flow Name"
},
"description": "The name of the flow"
},
{
"name": "deployment_name",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "The name of the deployment",
"title": "Deployment Name"
},
"description": "The name of the deployment"
},
{
"name": "x-prefect-api-version",
"in": "header",
"required": false,
"schema": {
"type": "string",
"title": "X-Prefect-Api-Version"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeploymentResponse"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/deployments/filter": {
"post": {
"tags": [
"Deployments"
],
"summary": "Read Deployments",
"description": "Query for deployments.",
"operationId": "read_deployments_deployments_filter_post",
"parameters": [
{
"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_deployments_deployments_filter_post"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DeploymentResponse"
},
"title": "Response Read Deployments Deployments Filter Post"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/deployments/paginate": {
"post": {
"tags": [
"Deployments"
],
"summary": "Paginate Deployments",
"description": "Pagination query for flow runs.",
"operationId": "paginate_deployments_deployments_paginate_post",
"parameters": [
{
"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_paginate_deployments_deployments_paginate_post"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeploymentPaginationResponse"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/deployments/get_scheduled_flow_runs": {
"post": {
"tags": [
"Deployments"
],
"summary": "Get Scheduled Flow Runs For Deployments",
"description": "Get scheduled runs for a set of deployments. Used by a runner to poll for work.",
"operationId": "get_scheduled_flow_runs_for_deployments_deployments_get_scheduled_flow_runs_post",
"parameters": [
{
"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_get_scheduled_flow_runs_for_deployments_deployments_get_scheduled_flow_runs_post"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FlowRunResponse"
},
"title": "Response Get Scheduled Flow Runs For Deployments Deployments Get Scheduled Flow Runs Post"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/deployments/count": {
"post": {
"tags": [
"Deployments"
],
"summary": "Count Deployments",
"description": "Count deployments.",
"operationId": "count_deployments_deployments_count_post",
"parameters": [
{
"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_count_deployments_deployments_count_post"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "integer",
"title": "Response Count Deployments Deployments Count Post"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/deployments/bulk_delete": {
"post": {
"tags": [
"Deployments"
],
"summary": "Bulk Delete Deployments",
"description": "Bulk delete deployments matching the specified filter criteria.\n\nReturns the IDs of deployments that were deleted.",
"operationId": "bulk_delete_deployments_deployments_bulk_delete_post",
"parameters": [
{
"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_bulk_delete_deployments_deployments_bulk_delete_post"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeploymentBulkDeleteResponse"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/deployments/{id}/schedule": {
"post": {
"tags": [
"Deployments"
],
"summary": "Schedule Deployment",
"description": "Schedule runs for a deployment. For backfills, provide start/end times in the past.\n\nThis function will generate the minimum number of runs that satisfy the min\nand max times, and the min and max counts. Specifically, the following order\nwill be respected.\n\n - Runs will be generated starting on or after the `start_time`\n - No more than `max_runs` runs will be generated\n - No runs will be generated after `end_time` is reached\n - At least `min_runs` runs will be generated\n - Runs will be generated until at least `start_time + min_time` is reached",
"operationId": "schedule_deployment_deployments__id__schedule_post",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"description": "The deployment id",
"title": "Id"
},
"description": "The deployment 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_schedule_deployment_deployments__id__schedule_post"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/deployments/{id}/resume_deployment": {
"post": {
"tags": [
"Deployments"
],
"summary": "Resume Deployment",
"description": "Set a deployment schedule to active. Runs will be scheduled immediately.",
"operationId": "resume_deployment_deployments__id__resume_deployment_post",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"description": "The deployment id",
"title": "Id"
},
"description": "The deployment id"
},
{
"name": "x-prefect-api-version",
"in": "header",
"required": false,
"schema": {
"type": "string",
"title": "X-Prefect-Api-Version"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/deployments/{id}/pause_deployment": {
"post": {
"tags": [
"Deployments"
],
"summary": "Pause Deployment",
"description": "Set a deployment schedule to inactive. Any auto-scheduled runs still in a Scheduled\nstate will be deleted.",
"operationId": "pause_deployment_deployments__id__pause_deployment_post",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"description": "The deployment id",
"title": "Id"
},
"description": "The deployment id"
},
{
"name": "x-prefect-api-version",
"in": "header",
"required": false,
"schema": {
"type": "string",
"title": "X-Prefect-Api-Version"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/deployments/{id}/create_flow_run": {
"post": {
"tags": [
"Deployments"
],
"summary": "Create Flow Run From Deployment",
"description": "Create a flow run from a deployment.\n\nAny parameters not provided will be inferred from the deployment's parameters.\nIf tags are not provided, the deployment's tags will be used.\n\nIf no state is provided, the flow run will be created in a SCHEDULED state.",
"operationId": "create_flow_run_from_deployment_deployments__id__create_flow_run_post",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"description": "The deployment id",
"title": "Id"
},
"description": "The deployment 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/DeploymentFlowRunCreate"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FlowRunResponse"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/deployments/{id}/create_flow_run/bulk": {
"post": {
"tags": [
"Deployments"
],
"summary": "Bulk Create Flow Runs From Deployment",
"description": "Create multiple flow runs from a deployment.\n\nAny parameters not provided will be inferred from the deployment's parameters.\nIf tags are not provided, the deployment's tags will be used.\n\nIf no state is provided, the flow runs will be created in a SCHEDULED state.",
"operationId": "bulk_create_flow_runs_from_deployment_deployments__id__create_flow_run_bulk_post",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"description": "The deployment id",
"title": "Id"
},
"description": "The deployment 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": "array",
"items": {
"$ref": "#/components/schemas/DeploymentFlowRunCreate"
},
"description": "List of flow run configurations to create",
"title": "Flow Runs"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FlowRunBulkCreateResponse"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/deployments/{id}/work_queue_check": {
"get": {
"tags": [
"Deployments"
],
"summary": "Work Queue Check For Deployment",
"description": "Get list of work-queues that are able to pick up the specified deployment.\n\nThis endpoint is intended to be used by the UI to provide users warnings\nabout deployments that are unable to be executed because there are no work\nqueues that will pick up their runs, based on existing filter criteria. It\nmay be deprecated in the future because there is not a strict relationship\nbetween work queues and deployments.",
"operationId": "work_queue_check_for_deployment_deployments__id__work_queue_check_get",
"deprecated": true,
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"description": "The deployment id",
"title": "Id"
},
"description": "The deployment id"
},
{
"name": "x-prefect-api-version",
"in": "header",
"required": false,
"schema": {
"type": "string",
"title": "X-Prefect-Api-Version"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WorkQueue"
},
"title": "Response Work Queue Check For Deployment Deployments Id Work Queue Check Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/deployments/{id}/schedules": {
"get": {
"tags": [
"Deployments"
],
"summary": "Read Deployment Schedules",
"operationId": "read_deployment_schedules_deployments__id__schedules_get",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"description": "The deployment id",
"title": "Id"
},
"description": "The deployment id"
},
{
"name": "x-prefect-api-version",
"in": "header",
"required": false,
"schema": {
"type": "string",
"title": "X-Prefect-Api-Version"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DeploymentSchedule"
},
"title": "Response Read Deployment Schedules Deployments Id Schedules Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"post": {
"tags": [
"Deployments"
],
"summary": "Create Deployment Schedules",
"operationId": "create_deployment_schedules_deployments__id__schedules_post",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"description": "The deployment id",
"title": "Id"
},
"description": "The deployment 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": "array",
"items": {
"$ref": "#/components/schemas/DeploymentScheduleCreate"
},
"description": "The schedules to create",
"title": "Schedules"
}
}
}
},
"responses": {
"201": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DeploymentSchedule"
},
"title": "Response Create Deployment Schedules Deployments Id Schedules Post"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/deployments/{id}/schedules/{schedule_id}": {
"patch": {
"tags": [
"Deployments"
],
"summary": "Update Deployment Schedule",
"operationId": "update_deployment_schedule_deployments__id__schedules__schedule_id__patch",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"description": "The deployment id",
"title": "Id"
},
"description": "The deployment id"
},
{
"name": "schedule_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"description": "The schedule id",
"title": "Schedule Id"
},
"description": "The schedule 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/DeploymentScheduleUpdate",
"description": "The updated schedule"
}
}
}
},
"responses": {
"204": {
"description": "Successful Response"
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"delete": {
"tags": [
"Deployments"
],
"summary": "Delete Deployment Schedule",
"operationId": "delete_deployment_schedule_deployments__id__schedules__schedule_id__delete",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"description": "The deployment id",
"title": "Id"
},
"description": "The deployment id"
},
{
"name": "schedule_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"description": "The schedule id",
"title": "Schedule Id"
},
"description": "The schedule id"
},
{
"name": "x-prefect-api-version",
"in": "header",
"required": false,
"schema": {
"type": "string",
"title": "X-Prefect-Api-Version"
}
}
],
"responses": {
"204": {
"description": "Successful Response"
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/saved_searches/": {
"put": {
"tags": [
"SavedSearches"
],
"summary": "Create Saved Search",
"description": "Creates a new saved search from the provided schema.\n\nIf a saved search with the same name already exists, the saved search's fields are\nreplaced.",
"operationId": "create_saved_search_saved_searches__put",
"parameters": [
{
"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/SavedSearchCreate"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SavedSearch"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/saved_searches/{id}": {
"get": {
"tags": [
"SavedSearches"
],
"summary": "Read Saved Search",
"description": "Get a saved search by id.",
"operationId": "read_saved_search_saved_searches__id__get",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"description": "The saved search id",
"title": "Id"
},
"description": "The saved search id"
},
{
"name": "x-prefect-api-version",
"in": "header",
"required": false,
"schema": {
"type": "string",
"title": "X-Prefect-Api-Version"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SavedSearch"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"delete": {
"tags": [
"SavedSearches"
],
"summary": "Delete Saved Search",
"description": "Delete a saved search by id.",
"operationId": "delete_saved_search_saved_searches__id__delete",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"description": "The saved search id",
"title": "Id"
},
"description": "The saved search id"
},
{
"name": "x-prefect-api-version",
"in": "header",
"required": false,
"schema": {
"type": "string",
"title": "X-Prefect-Api-Version"
}
}
],
"responses": {
"204": {
"description": "Successful Response"
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/saved_searches/filter": {
"post": {
"tags": [
"SavedSearches"
],
"summary": "Read Saved Searches",
"description": "Query for saved searches.",
"operationId": "read_saved_searches_saved_searches_filter_post",
"parameters": [
{
"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_saved_searches_saved_searches_filter_post"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SavedSearch"
},
"title": "Response Read Saved Searches Saved Searches Filter Post"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/logs/": {
"post": {
"tags": [
"Logs"
],
"summary": "Create Logs",
"description": "Create new logs from the provided schema.\n\nFor more information, see https://docs.prefect.io/v3/how-to-guides/workflows/add-logging.",
"operationId": "create_logs_logs__post",
"parameters": [
{
"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": "array",
"items": {
"$ref": "#/components/schemas/LogCreate"
},
"title": "Logs"
}
}
}
},
"responses": {
"201": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/logs/filter": {
"post": {
"tags": [
"Logs"
],
"summary": "Read Logs",
"description": "Query for logs.",
"operationId": "read_logs_logs_filter_post",
"parameters": [
{
"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_logs_logs_filter_post"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Log"
},
"title": "Response Read Logs Logs Filter Post"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/concurrency_limits/": {
"post": {
"tags": [
"Concurrency Limits"
],
"summary": "Create Concurrency Limit",
"description": "Create a task run concurrency limit.\n\nFor more information, see https://docs.prefect.io/v3/concepts/tag-based-concurrency-limits.",
"operationId": "create_concurrency_limit_concurrency_limits__post",
"parameters": [
{
"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/ConcurrencyLimitCreate"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConcurrencyLimit"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/concurrency_limits/{id}": {
"get": {
"tags": [
"Concurrency Limits"
],
"summary": "Read Concurrency Limit",
"description": "Get a concurrency limit by id.\n\nThe `active slots` field contains a list of TaskRun IDs currently using a\nconcurrency slot for the specified tag.",
"operationId": "read_concurrency_limit_concurrency_limits__id__get",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"description": "The concurrency limit id",
"title": "Id"
},
"description": "The concurrency limit id"
},
{
"name": "x-prefect-api-version",
"in": "header",
"required": false,
"schema": {
"type": "string",
"title": "X-Prefect-Api-Version"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConcurrencyLimit"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"delete": {
"tags": [
"Concurrency Limits"
],
"summary": "Delete Concurrency Limit",
"operationId": "delete_concurrency_limit_concurrency_limits__id__delete",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"description": "The concurrency limit id",
"title": "Id"
},
"description": "The concurrency limit id"
},
{
"name": "x-prefect-api-version",
"in": "header",
"required": false,
"schema": {
"type": "string",
"title": "X-Prefect-Api-Version"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/concurrency_limits/tag/{tag}": {
"get": {
"tags": [
"Concurrency Limits"
],
"summary": "Read Concurrency Limit By Tag",
"description": "Get a concurrency limit by tag.\n\nThe `active slots` field contains a list of TaskRun IDs currently using a\nconcurrency slot for the specified tag.",
"operationId": "read_concurrency_limit_by_tag_concurrency_limits_tag__tag__get",
"parameters": [
{
"name": "tag",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "The tag name",
"title": "Tag"
},
"description": "The tag name"
},
{
"name": "x-prefect-api-version",
"in": "header",
"required": false,
"schema": {
"type": "string",
"title": "X-Prefect-Api-Version"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConcurrencyLimit"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"delete": {
"tags": [
"Concurrency Limits"
],
"summary": "Delete Concurrency Limit By Tag",
"operationId": "delete_concurrency_limit_by_tag_concurrency_limits_tag__tag__delete",
"parameters": [
{
"name": "tag",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "The tag name",
"title": "Tag"
},
"description": "The tag name"
},
{
"name": "x-prefect-api-version",
"in": "header",
"required": false,
"schema": {
"type": "string",
"title": "X-Prefect-Api-Version"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/concurrency_limits/filter": {
"post": {
"tags": [
"Concurrency Limits"
],
"summary": "Read Concurrency Limits",
"description": "Query for concurrency limits.\n\nFor each concurrency limit the `active slots` field contains a list of TaskRun IDs\ncurrently using a concurrency slot for the specified tag.",
"operationId": "read_concurrency_limits_concurrency_limits_filter_post",
"parameters": [
{
"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_concurrency_limits_concurrency_limits_filter_post"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConcurrencyLimit"
},
"title": "Response Read Concurrency Limits Concurrency Limits Filter Post"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/concurrency_limits/tag/{tag}/reset": {
"post": {
"tags": [
"Concurrency Limits"
],
"summary": "Reset Concurrency Limit By Tag",
"operationId": "reset_concurrency_limit_by_tag_concurrency_limits_tag__tag__reset_post",
"parameters": [
{
"name": "tag",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "The tag name",
"title": "Tag"
},
"description": "The tag name"
},
{
"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_reset_concurrency_limit_by_tag_concurrency_limits_tag__tag__reset_post"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/concurrency_limits/increment": {
"post": {
"tags": [
"Concurrency Limits"
],
"summary": "Increment Concurrency Limits V1",
"description": "Increment concurrency limits for the given tags.\n\nDuring migration, this handles both V1 and V2 limits to support mixed states.\nPost-migration, it only uses V2 with lease-based concurrency.",
"operationId": "increment_concurrency_limits_v1_concurrency_limits_increment_post",
"parameters": [
{
"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_increment_concurrency_limits_v1_concurrency_limits_increment_post"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MinimalConcurrencyLimitResponse"
},
"title": "Response Increment Concurrency Limits V1 Concurrency Limits Increment Post"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/concurrency_limits/decrement": {
"post": {
"tags": [
"Concurrency Limits"
],
"summary": "Decrement Concurrency Limits V1",
"description": "Decrement concurrency limits for the given tags.\n\nFinds and revokes the lease for V2 limits or decrements V1 active slots.\nReturns the list of limits that were decremented.",
"operationId": "decrement_concurrency_limits_v1_concurrency_limits_decrement_post",
"parameters": [
{
"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_decrement_concurrency_limits_v1_concurrency_limits_decrement_post"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MinimalConcurrencyLimitResponse"
},
"title": "Response Decrement Concurrency Limits V1 Concurrency Limits Decrement Post"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/v2/concurrency_limits/": {
"post": {
"tags": [
"Concurrency Limits V2"
],
"summary": "Create Concurrency Limit V2",
"description": "Create a task run concurrency limit.\n\nFor more information, see https://docs.prefect.io/v3/how-to-guides/workflows/global-concurrency-limits.",
"operationId": "create_concurrency_limit_v2_v2_concurrency_limits__post",
"parameters": [
{
"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/ConcurrencyLimitV2Create"
}
}
}
},
"responses": {
"201": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConcurrencyLimitV2"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/v2/concurrency_limits/{id_or_name}": {
"get": {
"tags": [
"Concurrency Limits V2"
],
"summary": "Read Concurrency Limit V2",
"operationId": "read_concurrency_limit_v2_v2_concurrency_limits__id_or_name__get",
"parameters": [
{
"name": "id_or_name",
"in": "path",
"required": true,
"schema": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "string"
}
],
"description": "The ID or name of the concurrency limit",
"title": "Id Or Name"
},
"description": "The ID or name of the concurrency limit"
},
{
"name": "x-prefect-api-version",
"in": "header",
"required": false,
"schema": {
"type": "string",
"title": "X-Prefect-Api-Version"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GlobalConcurrencyLimitResponse"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"patch": {
"tags": [
"Concurrency Limits V2"
],
"summary": "Update Concurrency Limit V2",
"operationId": "update_concurrency_limit_v2_v2_concurrency_limits__id_or_name__patch",
"parameters": [
{
"name": "id_or_name",
"in": "path",
"required": true,
"schema": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "string"
}
],
"description": "The ID or name of the concurrency limit",
"title": "Id Or Name"
},
"description": "The ID or name of the concurrency limit"
},
{
"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/ConcurrencyLimitV2Update"
}
}
}
},
"responses": {
"204": {
"description": "Successful Response"
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"delete": {
"tags": [
"Concurrency Limits V2"
],
"summary": "Delete Concurrency Limit V2",
"operationId": "delete_concurrency_limit_v2_v2_concurrency_limits__id_or_name__delete",
"parameters": [
{
"name": "id_or_name",
"in": "path",
"required": true,
"schema": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "string"
}
],
"description": "The ID or name of the concurrency limit",
"title": "Id Or Name"
},
"description": "The ID or name of the concurrency limit"
},
{
"name": "x-prefect-api-version",
"in": "header",
"required": false,
"schema": {
"type": "string",
"title": "X-Prefect-Api-Version"
}
}
],
"responses": {
"204": {
"description": "Successful Response"
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/v2/concurrency_limits/filter": {
"post": {
"tags": [
"Concurrency Limits V2"
],
"summary": "Read All Concurrency Limits V2",
"operationId": "read_all_concurrency_limits_v2_v2_concurrency_limits_filter_post",
"parameters": [
{
"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_all_concurrency_limits_v2_v2_concurrency_limits_filter_post"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GlobalConcurrencyLimitResponse"
},
"title": "Response Read All Concurrency Limits V2 V2 Concurrency Limits Filter Post"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/v2/concurrency_limits/increment": {
"post": {
"tags": [
"Concurrency Limits V2"
],
"summary": "Bulk Increment Active Slots",
"operationId": "bulk_increment_active_slots_v2_concurrency_limits_increment_post",
"parameters": [
{
"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_bulk_increment_active_slots_v2_concurrency_limits_increment_post"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MinimalConcurrencyLimitResponse"
},
"title": "Response Bulk Increment Active Slots V2 Concurrency Limits Increment Post"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/v2/concurrency_limits/increment-with-lease": {
"post": {
"tags": [
"Concurrency Limits V2"
],
"summary": "Bulk Increment Active Slots With Lease",
"operationId": "bulk_increment_active_slots_with_lease_v2_concurrency_limits_increment_with_lease_post",
"parameters": [
{
"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_bulk_increment_active_slots_with_lease_v2_concurrency_limits_increment_with_lease_post"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConcurrencyLimitWithLeaseResponse"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/v2/concurrency_limits/decrement": {
"post": {
"tags": [
"Concurrency Limits V2"
],
"summary": "Bulk Decrement Active Slots",
"operationId": "bulk_decrement_active_slots_v2_concurrency_limits_decrement_post",
"parameters": [
{
"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_bulk_decrement_active_slots_v2_concurrency_limits_decrement_post"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MinimalConcurrencyLimitResponse"
},
"title": "Response Bulk Decrement Active Slots V2 Concurrency Limits Decrement Post"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/v2/concurrency_limits/decrement-with-lease": {
"post": {
"tags": [
"Concurrency Limits V2"
],
"summary": "Bulk Decrement Active Slots With Lease",
"operationId": "bulk_decrement_active_slots_with_lease_v2_concurrency_limits_decrement_with_lease_post",
"parameters": [
{
"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_bulk_decrement_active_slots_with_lease_v2_concurrency_limits_decrement_with_lease_post"
}
}
}
},
"responses": {
"204": {
"description": "Successful Response"
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/v2/concurrency_limits/leases/{lease_id}/renew": {
"post": {
"tags": [
"Concurrency Limits V2"
],
"summary": "Renew Concurrency Lease",
"operationId": "renew_concurrency_lease_v2_concurrency_limits_leases__lease_id__renew_post",
"parameters": [
{
"name": "lease_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"description": "The ID of the lease to renew",
"title": "Lease Id"
},
"description": "The ID of the lease to renew"
},
{
"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_renew_concurrency_lease_v2_concurrency_limits_leases__lease_id__renew_post"
}
}
}
},
"responses": {
"204": {
"description": "Successful Response"
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/block_types/": {
"post": {
"tags": [
"Block types"
],
"summary": "Create Block Type",
"description": "Create a new block type.\n\nFor more information, see https://docs.prefect.io/v3/concepts/blocks.",
"operationId": "create_block_type_block_types__post",
"parameters": [
{
"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/BlockTypeCreate"
}
}
}
},
"responses": {
"201": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BlockType"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/block_types/{id}": {
"get": {
"tags": [
"Block types"
],
"summary": "Read Block Type By Id",
"description": "Get a block type by ID.",
"operationId": "read_block_type_by_id_block_types__id__get",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"description": "The block type ID",
"title": "Id"
},
"description": "The block type ID"
},
{
"name": "x-prefect-api-version",
"in": "header",
"required": false,
"schema": {
"type": "string",
"title": "X-Prefect-Api-Version"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BlockType"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"patch": {
"tags": [
"Block types"
],
"summary": "Update Block Type",
"description": "Update a block type.",
"operationId": "update_block_type_block_types__id__patch",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"description": "The block type ID",
"title": "Id"
},
"description": "The block type 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/BlockTypeUpdate"
}
}
}
},
"responses": {
"204": {
"description": "Successful Response"
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"delete": {
"tags": [
"Block types"
],
"summary": "Delete Block Type",
"operationId": "delete_block_type_block_types__id__delete",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"description": "The block type ID",
"title": "Id"
},
"description": "The block type ID"
},
{
"name": "x-prefect-api-version",
"in": "header",
"required": false,
"schema": {
"type": "string",
"title": "X-Prefect-Api-Version"
}
}
],
"responses": {
"204": {
"description": "Successful Response"
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/block_types/slug/{slug}": {
"get": {
"tags": [
"Block types"
],
"summary": "Read Block Type By Slug",
"description": "Get a block type by name.",
"operationId": "read_block_type_by_slug_block_types_slug__slug__get",
"parameters": [
{
"name": "slug",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "The block type name",
"title": "Slug"
},
"description": "The block type name"
},
{
"name": "x-prefect-api-version",
"in": "header",
"required": false,
"schema": {
"type": "string",
"title": "X-Prefect-Api-Version"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BlockType"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/block_types/filter": {
"post": {
"tags": [
"Block types"
],
"summary": "Read Block Types",
"description": "Gets all block types. Optionally limit return with limit and offset.",
"operationId": "read_block_types_block_types_filter_post",
"parameters": [
{
"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_block_types_block_types_filter_post"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BlockType"
},
"title": "Response Read Block Types Block Types Filter Post"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/block_types/slug/{slug}/block_documents": {
"get": {
"tags": [
"Block types",
"Block types",
"Block documents"
],
"summary": "Read Block Documents For Block Type",
"operationId": "read_block_documents_for_block_type_block_types_slug__slug__block_documents_get",
"parameters": [
{
"name": "slug",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "The block type name",
"title": "Slug"
},
"description": "The block type name"
},
{
"name": "include_secrets",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "Whether to include sensitive values in the block document.",
"default": false,
"title": "Include Secrets"
},
"description": "Whether to include sensitive values in the block document."
},
{
"name": "x-prefect-api-version",
"in": "header",
"required": false,
"schema": {
"type": "string",
"title": "X-Prefect-Api-Version"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BlockDocument"
},
"title": "Response Read Block Documents For Block Type Block Types Slug Slug Block Documents Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/block_types/slug/{slug}/block_documents/name/{block_document_name}": {
"get": {
"tags": [
"Block types",
"Block types",
"Block documents"
],
"summary": "Read Block Document By Name For Block Type",
"operationId": "read_block_document_by_name_for_block_type_block_types_slug__slug__block_documents_name__block_document_name__get",
"parameters": [
{
"name": "slug",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "The block type name",
"title": "Slug"
},
"description": "The block type name"
},
{
"name": "block_document_name",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "The block type name",
"title": "Block Document Name"
},
"description": "The block type name"
},
{
"name": "include_secrets",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "Whether to include sensitive values in the block document.",
"default": false,
"title": "Include Secrets"
},
"description": "Whether to include sensitive values in the block document."
},
{
"name": "x-prefect-api-version",
"in": "header",
"required": false,
"schema": {
"type": "string",
"title": "X-Prefect-Api-Version"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BlockDocument"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/block_types/install_system_block_types": {
"post": {
"tags": [
"Block types"
],
"summary": "Install System Block Types",
"operationId": "install_system_block_types_block_types_install_system_block_types_post",
"parameters": [
{
"name": "x-prefect-api-version",
"in": "header",
"required": false,
"schema": {
"type": "string",
"title": "X-Prefect-Api-Version"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/block_documents/": {
"post": {
"tags": [
"Block documents"
],
"summary": "Create Block Document",
"description": "Create a new block document.\n\nFor more information, see https://docs.prefect.io/v3/concepts/blocks.",
"operationId": "create_block_document_block_documents__post",
"parameters": [
{
"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/BlockDocumentCreate"
}
}
}
},
"responses": {
"201": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BlockDocument"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/block_documents/filter": {
"post": {
"tags": [
"Block documents"
],
"summary": "Read Block Documents",
"description": "Query for block documents.",
"operationId": "read_block_documents_block_documents_filter_post",
"parameters": [
{
"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_block_documents_block_documents_filter_post"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BlockDocument"
},
"title": "Response Read Block Documents Block Documents Filter Post"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/block_documents/count": {
"post": {
"tags": [
"Block documents"
],
"summary": "Count Block Documents",
"description": "Count block documents.",
"operationId": "count_block_documents_block_documents_count_post",
"parameters": [
{
"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_count_block_documents_block_documents_count_post"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "integer",
"title": "Response Count Block Documents Block Documents Count Post"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/block_documents/{id}": {
"get": {
"tags": [
"Block documents"
],
"summary": "Read Block Document By Id",
"operationId": "read_block_document_by_id_block_documents__id__get",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"description": "The block document id",
"title": "Id"
},
"description": "The block document id"
},
{
"name": "include_secrets",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "Whether to include sensitive values in the block document.",
"default": false,
"title": "Include Secrets"
},
"description": "Whether to include sensitive values in the block document."
},
{
"name": "x-prefect-api-version",
"in": "header",
"required": false,
"schema": {
"type": "string",
"title": "X-Prefect-Api-Version"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BlockDocument"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"delete": {
"tags": [
"Block documents"
],
"summary": "Delete Block Document",
"operationId": "delete_block_document_block_documents__id__delete",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"description": "The block document id",
"title": "Id"
},
"description": "The block document id"
},
{
"name": "x-prefect-api-version",
"in": "header",
"required": false,
"schema": {
"type": "string",
"title": "X-Prefect-Api-Version"
}
}
],
"responses": {
"204": {
"description": "Successful Response"
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"patch": {
"tags": [
"Block documents"
],
"summary": "Update Block Document Data",
"operationId": "update_block_document_data_block_documents__id__patch",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"description": "The block document id",
"title": "Id"
},
"description": "The block document 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/BlockDocumentUpdate"
}
}
}
},
"responses": {
"204": {
"description": "Successful Response"
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/work_pools/": {
"post": {
"tags": [
"Work Pools"
],
"summary": "Create Work Pool",
"description": "Creates a new work pool. If a work pool with the same\nname already exists, an error will be raised.\n\nFor more information, see https://docs.prefect.io/v3/concepts/work-pools.",
"operationId": "create_work_pool_work_pools__post",
"parameters": [
{
"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/WorkPoolCreate"
}
}
}
},
"responses": {
"201": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WorkPool"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/work_pools/{name}": {
"get": {
"tags": [
"Work Pools"
],
"summary": "Read Work Pool",
"description": "Read a work pool by name",
"operationId": "read_work_pool_work_pools__name__get",
"parameters": [
{
"name": "name",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "The work pool name",
"title": "Name"
},
"description": "The work pool name"
},
{
"name": "x-prefect-api-version",
"in": "header",
"required": false,
"schema": {
"type": "string",
"title": "X-Prefect-Api-Version"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WorkPool"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"patch": {
"tags": [
"Work Pools"
],
"summary": "Update Work Pool",
"description": "Update a work pool",
"operationId": "update_work_pool_work_pools__name__patch",
"parameters": [
{
"name": "name",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "The work pool name",
"title": "Name"
},
"description": "The work pool name"
},
{
"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/WorkPoolUpdate"
}
}
}
},
"responses": {
"204": {
"description": "Successful Response"
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"delete": {
"tags": [
"Work Pools"
],
"summary": "Delete Work Pool",
"description": "Delete a work pool",
"operationId": "delete_work_pool_work_pools__name__delete",
"parameters": [
{
"name": "name",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "The work pool name",
"title": "Name"
},
"description": "The work pool name"
},
{
"name": "x-prefect-api-version",
"in": "header",
"required": false,
"schema": {
"type": "string",
"title": "X-Prefect-Api-Version"
}
}
],
"responses": {
"204": {
"description": "Successful Response"
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/work_pools/filter": {
"post": {
"tags": [
"Work Pools"
],
"summary": "Read Work Pools",
"description": "Read multiple work pools",
"operationId": "read_work_pools_work_pools_filter_post",
"parameters": [
{
"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_work_pools_work_pools_filter_post"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WorkPool"
},
"title": "Response Read Work Pools Work Pools Filter Post"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/work_pools/count": {
"post": {
"tags": [
"Work Pools"
],
"summary": "Count Work Pools",
"description": "Count work pools",
"operationId": "count_work_pools_work_pools_count_post",
"parameters": [
{
"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_count_work_pools_work_pools_count_post"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "integer",
"title": "Response Count Work Pools Work Pools Count Post"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/work_pools/{name}/get_scheduled_flow_runs": {
"post": {
"tags": [
"Work Pools"
],
"summary": "Get Scheduled Flow Runs",
"description": "Load scheduled runs for a worker",
"operationId": "get_scheduled_flow_runs_work_pools__name__get_scheduled_flow_runs_post",
"parameters": [
{
"name": "name",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "The work pool name",
"title": "Name"
},
"description": "The work pool name"
},
{
"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_get_scheduled_flow_runs_work_pools__name__get_scheduled_flow_runs_post"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WorkerFlowRunResponse"
},
"title": "Response Get Scheduled Flow Runs Work Pools Name Get Scheduled Flow Runs Post"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/work_pools/{work_pool_name}/queues": {
"post": {
"tags": [
"Work Pools"
],
"summary": "Create Work Queue",
"description": "Creates a new work pool queue. If a work pool queue with the same\nname already exists, an error will be raised.\n\nFor more information, see https://docs.prefect.io/v3/concepts/work-pools#work-queues.",
"operationId": "create_work_queue_work_pools__work_pool_name__queues_post",
"parameters": [
{
"name": "work_pool_name",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "The work pool name",
"title": "Work Pool Name"
},
"description": "The work pool name"
},
{
"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/WorkQueueCreate"
}
}
}
},
"responses": {
"201": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WorkQueueResponse"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/work_pools/{work_pool_name}/queues/{name}": {
"get": {
"tags": [
"Work Pools"
],
"summary": "Read Work Queue",
"description": "Read a work pool queue",
"operationId": "read_work_queue_work_pools__work_pool_name__queues__name__get",
"parameters": [
{
"name": "work_pool_name",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "The work pool name",
"title": "Work Pool Name"
},
"description": "The work pool name"
},
{
"name": "name",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "The work pool queue name",
"title": "Name"
},
"description": "The work pool queue name"
},
{
"name": "x-prefect-api-version",
"in": "header",
"required": false,
"schema": {
"type": "string",
"title": "X-Prefect-Api-Version"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WorkQueueResponse"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"patch": {
"tags": [
"Work Pools"
],
"summary": "Update Work Queue",
"description": "Update a work pool queue",
"operationId": "update_work_queue_work_pools__work_pool_name__queues__name__patch",
"parameters": [
{
"name": "work_pool_name",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "The work pool name",
"title": "Work Pool Name"
},
"description": "The work pool name"
},
{
"name": "name",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "The work pool queue name",
"title": "Name"
},
"description": "The work pool queue name"
},
{
"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/WorkQueueUpdate"
}
}
}
},
"responses": {
"204": {
"description": "Successful Response"
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"delete": {
"tags": [
"Work Pools"
],
"summary": "Delete Work Queue",
"description": "Delete a work pool queue",
"operationId": "delete_work_queue_work_pools__work_pool_name__queues__name__delete",
"parameters": [
{
"name": "work_pool_name",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "The work pool name",
"title": "Work Pool Name"
},
"description": "The work pool name"
},
{
"name": "name",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "The work pool queue name",
"title": "Name"
},
"description": "The work pool queue name"
},
{
"name": "x-prefect-api-version",
"in": "header",
"required": false,
"schema": {
"type": "string",
"title": "X-Prefect-Api-Version"
}
}
],
"responses": {
"204": {
"description": "Successful Response"
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/work_pools/{work_pool_name}/queues/filter": {
"post": {
"tags": [
"Work Pools"
],
"summary": "Read Work Queues",
"description": "Read all work pool queues",
"operationId": "read_work_queues_work_pools__work_pool_name__queues_filter_post",
"parameters": [
{
"name": "work_pool_name",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "The work pool name",
"title": "Work Pool Name"
},
"description": "The work pool name"
},
{
"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_work_queues_work_pools__work_pool_name__queues_filter_post"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WorkQueueResponse"
},
"title": "Response Read Work Queues Work Pools Work Pool Name Queues Filter Post"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/work_pools/{work_pool_name}/workers/heartbeat": {
"post": {
"tags": [
"Work Pools"
],
"summary": "Worker Heartbeat",
"operationId": "worker_heartbeat_work_pools__work_pool_name__workers_heartbeat_post",
"parameters": [
{
"name": "work_pool_name",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "The work pool name",
"title": "Work Pool Name"
},
"description": "The work pool name"
},
{
"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_worker_heartbeat_work_pools__work_pool_name__workers_heartbeat_post"
}
}
}
},
"responses": {
"204": {
"description": "Successful Response"
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/work_pools/{work_pool_name}/workers/filter": {
"post": {
"tags": [
"Work Pools"
],
"summary": "Read Workers",
"description": "Read all worker processes",
"operationId": "read_workers_work_pools__work_pool_name__workers_filter_post",
"parameters": [
{
"name": "work_pool_name",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "The work pool name",
"title": "Work Pool Name"
},
"description": "The work pool name"
},
{
"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_workers_work_pools__work_pool_name__workers_filter_post"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WorkerResponse"
},
"title": "Response Read Workers Work Pools Work Pool Name Workers Filter Post"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/work_pools/{work_pool_name}/workers/{name}": {
"delete": {
"tags": [
"Work Pools"
],
"summary": "Delete Worker",
"description": "Delete a work pool's worker",
"operationId": "delete_worker_work_pools__work_pool_name__workers__name__delete",
"parameters": [
{
"name": "work_pool_name",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "The work pool name",
"title": "Work Pool Name"
},
"description": "The work pool name"
},
{
"name": "name",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "The work pool's worker name",
"title": "Name"
},
"description": "The work pool's worker name"
},
{
"name": "x-prefect-api-version",
"in": "header",
"required": false,
"schema": {
"type": "string",
"title": "X-Prefect-Api-Version"
}
}
],
"responses": {
"204": {
"description": "Successful Response"
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/task_workers/filter": {
"post": {
"tags": [
"Task Workers"
],
"summary": "Read Task Workers",
"description": "Read active task workers. Optionally filter by task keys.\n\nFor more information, see https://docs.prefect.io/v3/how-to-guides/workflows/run-background-tasks.",
"operationId": "read_task_workers_task_workers_filter_post",
"parameters": [
{
"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_workers_task_workers_filter_post"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TaskWorkerResponse"
},
"title": "Response Read Task Workers Task Workers Filter Post"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/work_queues/": {
"post": {
"tags": [
"Work Queues"
],
"summary": "Create Work Queue",
"description": "Creates a new work queue.\n\nIf a work queue with the same name already exists, an error\nwill be raised.\n\nFor more information, see https://docs.prefect.io/v3/concepts/work-pools#work-queues.",
"operationId": "create_work_queue_work_queues__post",
"parameters": [
{
"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/WorkQueueCreate"
}
}
}
},
"responses": {
"201": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WorkQueueResponse"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/work_queues/{id}": {
"patch": {
"tags": [
"Work Queues"
],
"summary": "Update Work Queue",
"description": "Updates an existing work queue.",
"operationId": "update_work_queue_work_queues__id__patch",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"description": "The work queue id",
"title": "Id"
},
"description": "The work queue 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/WorkQueueUpdate"
}
}
}
},
"responses": {
"204": {
"description": "Successful Response"
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"get": {
"tags": [
"Work Queues"
],
"summary": "Read Work Queue",
"description": "Get a work queue by id.",
"operationId": "read_work_queue_work_queues__id__get",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"description": "The work queue id",
"title": "Id"
},
"description": "The work queue id"
},
{
"name": "x-prefect-api-version",
"in": "header",
"required": false,
"schema": {
"type": "string",
"title": "X-Prefect-Api-Version"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WorkQueueResponse"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"delete": {
"tags": [
"Work Queues"
],
"summary": "Delete Work Queue",
"description": "Delete a work queue by id.",
"operationId": "delete_work_queue_work_queues__id__delete",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"description": "The work queue id",
"title": "Id"
},
"description": "The work queue id"
},
{
"name": "x-prefect-api-version",
"in": "header",
"required": false,
"schema": {
"type": "string",
"title": "X-Prefect-Api-Version"
}
}
],
"responses": {
"204": {
"description": "Successful Response"
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/work_queues/name/{name}": {
"get": {
"tags": [
"Work Queues"
],
"summary": "Read Work Queue By Name",
"description": "Get a work queue by id.",
"operationId": "read_work_queue_by_name_work_queues_name__name__get",
"parameters": [
{
"name": "name",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "The work queue name",
"title": "Name"
},
"description": "The work queue name"
},
{
"name": "x-prefect-api-version",
"in": "header",
"required": false,
"schema": {
"type": "string",
"title": "X-Prefect-Api-Version"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WorkQueueResponse"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/work_queues/{id}/get_runs": {
"post": {
"tags": [
"Work Queues"
],
"summary": "Read Work Queue Runs",
"description": "Get flow runs from the work queue.",
"operationId": "read_work_queue_runs_work_queues__id__get_runs_post",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"description": "The work queue id",
"title": "Id"
},
"description": "The work queue id"
},
{
"name": "x-prefect-ui",
"in": "header",
"required": false,
"schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"description": "A header to indicate this request came from the Prefect UI.",
"default": false,
"title": "X-Prefect-Ui"
},
"description": "A header to indicate this request came from the Prefect UI."
},
{
"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_work_queue_runs_work_queues__id__get_runs_post"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FlowRunResponse"
},
"title": "Response Read Work Queue Runs Work Queues Id Get Runs Post"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/work_queues/filter": {
"post": {
"tags": [
"Work Queues"
],
"summary": "Read Work Queues",
"description": "Query for work queues.",
"operationId": "read_work_queues_work_queues_filter_post",
"parameters": [
{
"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_work_queues_work_queues_filter_post"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WorkQueueResponse"
},
"title": "Response Read Work Queues Work Queues Filter Post"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/work_queues/{id}/status": {
"get": {
"tags": [
"Work Queues"
],
"summary": "Read Work Queue Status",
"description": "Get the status of a work queue.",
"operationId": "read_work_queue_status_work_queues__id__status_get",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"description": "The work queue id",
"title": "Id"
},
"description": "The work queue id"
},
{
"name": "x-prefect-api-version",
"in": "header",
"required": false,
"schema": {
"type": "string",
"title": "X-Prefect-Api-Version"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WorkQueueStatusDetail"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/artifacts/": {
"post": {
"tags": [
"Artifacts"
],
"summary": "Create Artifact",
"description": "Create an artifact.\n\nFor more information, see https://docs.prefect.io/v3/concepts/artifacts.",
"operationId": "create_artifact_artifacts__post",
"parameters": [
{
"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/ArtifactCreate"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Artifact"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/artifacts/{id}": {
"get": {
"tags": [
"Artifacts"
],
"summary": "Read Artifact",
"description": "Retrieve an artifact from the database.",
"operationId": "read_artifact_artifacts__id__get",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"description": "The ID of the artifact to retrieve.",
"title": "Id"
},
"description": "The ID of the artifact to retrieve."
},
{
"name": "x-prefect-api-version",
"in": "header",
"required": false,
"schema": {
"type": "string",
"title": "X-Prefect-Api-Version"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Artifact"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"patch": {
"tags": [
"Artifacts"
],
"summary": "Update Artifact",
"description": "Update an artifact in the database.",
"operationId": "update_artifact_artifacts__id__patch",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"description": "The ID of the artifact to update.",
"title": "Id"
},
"description": "The ID of the artifact to update."
},
{
"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/ArtifactUpdate"
}
}
}
},
"responses": {
"204": {
"description": "Successful Response"
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"delete": {
"tags": [
"Artifacts"
],
"summary": "Delete Artifact",
"description": "Delete an artifact from the database.",
"operationId": "delete_artifact_artifacts__id__delete",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"description": "The ID of the artifact to delete.",
"title": "Id"
},
"description": "The ID of the artifact to delete."
},
{
"name": "x-prefect-api-version",
"in": "header",
"required": false,
"schema": {
"type": "string",
"title": "X-Prefect-Api-Version"
}
}
],
"responses": {
"204": {
"description": "Successful Response"
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/artifacts/{key}/latest": {
"get": {
"tags": [
"Artifacts"
],
"summary": "Read Latest Artifact",
"description": "Retrieve the latest artifact from the artifact table.",
"operationId": "read_latest_artifact_artifacts__key__latest_get",
"parameters": [
{
"name": "key",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "The key of the artifact to retrieve.",
"title": "Key"
},
"description": "The key of the artifact to retrieve."
},
{
"name": "x-prefect-api-version",
"in": "header",
"required": false,
"schema": {
"type": "string",
"title": "X-Prefect-Api-Version"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Artifact"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/artifacts/filter": {
"post": {
"tags": [
"Artifacts"
],
"summary": "Read Artifacts",
"description": "Retrieve artifacts from the database.",
"operationId": "read_artifacts_artifacts_filter_post",
"parameters": [
{
"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_artifacts_artifacts_filter_post"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Artifact"
},
"title": "Response Read Artifacts Artifacts Filter Post"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/artifacts/latest/filter": {
"post": {
"tags": [
"Artifacts"
],
"summary": "Read Latest Artifacts",
"description": "Retrieve artifacts from the database.",
"operationId": "read_latest_artifacts_artifacts_latest_filter_post",
"parameters": [
{
"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_latest_artifacts_artifacts_latest_filter_post"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ArtifactCollection"
},
"title": "Response Read Latest Artifacts Artifacts Latest Filter Post"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/artifacts/count": {
"post": {
"tags": [
"Artifacts"
],
"summary": "Count Artifacts",
"description": "Count artifacts from the database.",
"operationId": "count_artifacts_artifacts_count_post",
"parameters": [
{
"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_count_artifacts_artifacts_count_post"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "integer",
"title": "Response Count Artifacts Artifacts Count Post"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/artifacts/latest/count": {
"post": {
"tags": [
"Artifacts"
],
"summary": "Count Latest Artifacts",
"description": "Count artifacts from the database.",
"operationId": "count_latest_artifacts_artifacts_latest_count_post",
"parameters": [
{
"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_count_latest_artifacts_artifacts_latest_count_post"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "integer",
"title": "Response Count Latest Artifacts Artifacts Latest Count Post"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/block_schemas/": {
"post": {
"tags": [
"Block schemas"
],
"summary": "Create Block Schema",
"description": "Create a block schema.\n\nFor more information, see https://docs.prefect.io/v3/concepts/blocks.",
"operationId": "create_block_schema_block_schemas__post",
"parameters": [
{
"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/BlockSchemaCreate"
}
}
}
},
"responses": {
"201": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BlockSchema"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/block_schemas/{id}": {
"delete": {
"tags": [
"Block schemas"
],
"summary": "Delete Block Schema",
"description": "Delete a block schema by id.",
"operationId": "delete_block_schema_block_schemas__id__delete",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"description": "The block schema id",
"title": "Id"
},
"description": "The block schema id"
},
{
"name": "x-prefect-api-version",
"in": "header",
"required": false,
"schema": {
"type": "string",
"title": "X-Prefect-Api-Version"
}
}
],
"responses": {
"204": {
"description": "Successful Response"
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"get": {
"tags": [
"Block schemas"
],
"summary": "Read Block Schema By Id",
"description": "Get a block schema by id.",
"operationId": "read_block_schema_by_id_block_schemas__id__get",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"description": "The block schema id",
"title": "Id"
},
"description": "The block schema id"
},
{
"name": "x-prefect-api-version",
"in": "header",
"required": false,
"schema": {
"type": "string",
"title": "X-Prefect-Api-Version"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BlockSchema"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/block_schemas/filter": {
"post": {
"tags": [
"Block schemas"
],
"summary": "Read Block Schemas",
"description": "Read all block schemas, optionally filtered by type",
"operationId": "read_block_schemas_block_schemas_filter_post",
"parameters": [
{
"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_block_schemas_block_schemas_filter_post"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BlockSchema"
},
"title": "Response Read Block Schemas Block Schemas Filter Post"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/block_schemas/checksum/{checksum}": {
"get": {
"tags": [
"Block schemas"
],
"summary": "Read Block Schema By Checksum",
"operationId": "read_block_schema_by_checksum_block_schemas_checksum__checksum__get",
"parameters": [
{
"name": "checksum",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "The block schema checksum",
"title": "Checksum"
},
"description": "The block schema checksum"
},
{
"name": "version",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Version of block schema. If not provided the most recently created block schema with the matching checksum will be returned.",
"title": "Version"
},
"description": "Version of block schema. If not provided the most recently created block schema with the matching checksum will be returned."
},
{
"name": "x-prefect-api-version",
"in": "header",
"required": false,
"schema": {
"type": "string",
"title": "X-Prefect-Api-Version"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BlockSchema"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/block_capabilities/": {
"get": {
"tags": [
"Block capabilities"
],
"summary": "Read Available Block Capabilities",
"description": "Get available block capabilities.\n\nFor more information, see https://docs.prefect.io/v3/concepts/blocks.",
"operationId": "read_available_block_capabilities_block_capabilities__get",
"parameters": [
{
"name": "x-prefect-api-version",
"in": "header",
"required": false,
"schema": {
"type": "string",
"title": "X-Prefect-Api-Version"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "string"
},
"title": "Response Read Available Block Capabilities Block Capabilities Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/collections/views/{view}": {
"get": {
"tags": [
"Collections"
],
"summary": "Read View Content",
"description": "Reads the content of a view from the prefect-collection-registry.",
"operationId": "read_view_content_collections_views__view__get",
"parameters": [
{
"name": "view",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "View"
}
},
{
"name": "x-prefect-api-version",
"in": "header",
"required": false,
"schema": {
"type": "string",
"title": "X-Prefect-Api-Version"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"additionalProperties": true,
"title": "Response Read View Content Collections Views View Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/variables/": {
"post": {
"tags": [
"Variables"
],
"summary": "Create Variable",
"description": "Create a variable.\n\nFor more information, see https://docs.prefect.io/v3/concepts/variables.",
"operationId": "create_variable_variables__post",
"parameters": [
{
"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/VariableCreate"
}
}
}
},
"responses": {
"201": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Variable"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/variables/{id}": {
"get": {
"tags": [
"Variables"
],
"summary": "Read Variable",
"operationId": "read_variable_variables__id__get",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"title": "Id"
}
},
{
"name": "x-prefect-api-version",
"in": "header",
"required": false,
"schema": {
"type": "string",
"title": "X-Prefect-Api-Version"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Variable"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"patch": {
"tags": [
"Variables"
],
"summary": "Update Variable",
"operationId": "update_variable_variables__id__patch",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"title": "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/VariableUpdate"
}
}
}
},
"responses": {
"204": {
"description": "Successful Response"
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"delete": {
"tags": [
"Variables"
],
"summary": "Delete Variable",
"operationId": "delete_variable_variables__id__delete",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"title": "Id"
}
},
{
"name": "x-prefect-api-version",
"in": "header",
"required": false,
"schema": {
"type": "string",
"title": "X-Prefect-Api-Version"
}
}
],
"responses": {
"204": {
"description": "Successful Response"
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/variables/name/{name}": {
"get": {
"tags": [
"Variables"
],
"summary": "Read Variable By Name",
"operationId": "read_variable_by_name_variables_name__name__get",
"parameters": [
{
"name": "name",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Name"
}
},
{
"name": "x-prefect-api-version",
"in": "header",
"required": false,
"schema": {
"type": "string",
"title": "X-Prefect-Api-Version"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Variable"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"patch": {
"tags": [
"Variables"
],
"summary": "Update Variable By Name",
"operationId": "update_variable_by_name_variables_name__name__patch",
"parameters": [
{
"name": "name",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Name"
}
},
{
"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/VariableUpdate"
}
}
}
},
"responses": {
"204": {
"description": "Successful Response"
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"delete": {
"tags": [
"Variables"
],
"summary": "Delete Variable By Name",
"operationId": "delete_variable_by_name_variables_name__name__delete",
"parameters": [
{
"name": "name",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Name"
}
},
{
"name": "x-prefect-api-version",
"in": "header",
"required": false,
"schema": {
"type": "string",
"title": "X-Prefect-Api-Version"
}
}
],
"responses": {
"204": {
"description": "Successful Response"
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/variables/filter": {
"post": {
"tags": [
"Variables"
],
"summary": "Read Variables",
"operationId": "read_variables_variables_filter_post",
"parameters": [
{
"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_variables_variables_filter_post"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Variable"
},
"title": "Response Read Variables Variables Filter Post"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/variables/count": {
"post": {
"tags": [
"Variables"
],
"summary": "Count Variables",
"operationId": "count_variables_variables_count_post",
"parameters": [
{
"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_count_variables_variables_count_post"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "integer",
"title": "Response Count Variables Variables Count Post"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/csrf-token": {
"get": {
"summary": "Create Csrf Token",
"description": "Create or update a CSRF token for a client",
"operationId": "create_csrf_token_csrf_token_get",
"parameters": [
{
"name": "client",
"in": "query",
"required": true,
"schema": {
"type": "string",
"description": "The client to create a CSRF token for",
"title": "Client"
},
"description": "The client to create a CSRF token for"
},
{
"name": "x-prefect-api-version",
"in": "header",
"required": false,
"schema": {
"type": "string",
"title": "X-Prefect-Api-Version"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CsrfToken"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/events": {
"post": {
"tags": [
"Events"
],
"summary": "Create Events",
"description": "Record a batch of Events.\n\nFor more information, see https://docs.prefect.io/v3/concepts/events.",
"operationId": "create_events_events_post",
"parameters": [
{
"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": "array",
"items": {
"$ref": "#/components/schemas/Event"
},
"title": "Events"
}
}
}
},
"responses": {
"204": {
"description": "Successful Response"
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/events/filter": {
"post": {
"tags": [
"Events"
],
"summary": "Read Events",
"description": "Queries for Events matching the given filter criteria in the given Account. Returns\nthe first page of results, and the URL to request the next page (if there are more\nresults).",
"operationId": "read_events_events_filter_post",
"parameters": [
{
"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_events_events_filter_post"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EventPage"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/events/filter/next": {
"get": {
"tags": [
"Events"
],
"summary": "Read Account Events Page",
"description": "Returns the next page of Events for a previous query against the given Account, and\nthe URL to request the next page (if there are more results).",
"operationId": "read_account_events_page_events_filter_next_get",
"parameters": [
{
"name": "page-token",
"in": "query",
"required": true,
"schema": {
"type": "string",
"title": "Page-Token"
}
},
{
"name": "x-prefect-api-version",
"in": "header",
"required": false,
"schema": {
"type": "string",
"title": "X-Prefect-Api-Version"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EventPage"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/events/count-by/{countable}": {
"post": {
"tags": [
"Events"
],
"summary": "Count Account Events",
"description": "Returns distinct objects and the count of events associated with them. Objects\nthat can be counted include the day the event occurred, the type of event, or\nthe IDs of the resources associated with the event.",
"operationId": "count_account_events_events_count_by__countable__post",
"parameters": [
{
"name": "countable",
"in": "path",
"required": true,
"schema": {
"$ref": "#/components/schemas/Countable"
}
},
{
"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_account_events_events_count_by__countable__post"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EventCount"
},
"title": "Response Count Account Events Events Count By Countable Post"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/automations/": {
"post": {
"tags": [
"Automations"
],
"summary": "Create Automation",
"description": "Create an automation.\n\nFor more information, see https://docs.prefect.io/v3/concepts/automations.",
"operationId": "create_automation_automations__post",
"parameters": [
{
"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/AutomationCreate"
}
}
}
},
"responses": {
"201": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Automation"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/automations/{id}": {
"put": {
"tags": [
"Automations"
],
"summary": "Update Automation",
"operationId": "update_automation_automations__id__put",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"title": "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/AutomationUpdate"
}
}
}
},
"responses": {
"204": {
"description": "Successful Response"
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"patch": {
"tags": [
"Automations"
],
"summary": "Patch Automation",
"operationId": "patch_automation_automations__id__patch",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"title": "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/AutomationPartialUpdate"
}
}
}
},
"responses": {
"204": {
"description": "Successful Response"
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"delete": {
"tags": [
"Automations"
],
"summary": "Delete Automation",
"operationId": "delete_automation_automations__id__delete",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"title": "Id"
}
},
{
"name": "x-prefect-api-version",
"in": "header",
"required": false,
"schema": {
"type": "string",
"title": "X-Prefect-Api-Version"
}
}
],
"responses": {
"204": {
"description": "Successful Response"
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"get": {
"tags": [
"Automations"
],
"summary": "Read Automation",
"operationId": "read_automation_automations__id__get",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"title": "Id"
}
},
{
"name": "x-prefect-api-version",
"in": "header",
"required": false,
"schema": {
"type": "string",
"title": "X-Prefect-Api-Version"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Automation"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/automations/filter": {
"post": {
"tags": [
"Automations"
],
"summary": "Read Automations",
"operationId": "read_automations_automations_filter_post",
"parameters": [
{
"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_automations_automations_filter_post"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Automation"
},
"title": "Response Read Automations Automations Filter Post"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/automations/count": {
"post": {
"tags": [
"Automations"
],
"summary": "Count Automations",
"operationId": "count_automations_automations_count_post",
"parameters": [
{
"name": "x-prefect-api-version",
"in": "header",
"required": false,
"schema": {
"type": "string",
"title": "X-Prefect-Api-Version"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "integer",
"title": "Response Count Automations Automations Count Post"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/automations/related-to/{resource_id}": {
"get": {
"tags": [
"Automations"
],
"summary": "Read Automations Related To Resource",
"operationId": "read_automations_related_to_resource_automations_related_to__resource_id__get",
"parameters": [
{
"name": "resource_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Resource Id"
}
},
{
"name": "x-prefect-api-version",
"in": "header",
"required": false,
"schema": {
"type": "string",
"title": "X-Prefect-Api-Version"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Automation"
},
"title": "Response Read Automations Related To Resource Automations Related To Resource Id Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/automations/owned-by/{resource_id}": {
"delete": {
"tags": [
"Automations"
],
"summary": "Delete Automations Owned By Resource",
"operationId": "delete_automations_owned_by_resource_automations_owned_by__resource_id__delete",
"parameters": [
{
"name": "resource_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Resource Id"
}
},
{
"name": "x-prefect-api-version",
"in": "header",
"required": false,
"schema": {
"type": "string",
"title": "X-Prefect-Api-Version"
}
}
],
"responses": {
"202": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/templates/validate": {
"post": {
"tags": [
"Automations"
],
"summary": "Validate Template",
"operationId": "validate_template_templates_validate_post",
"parameters": [
{
"name": "x-prefect-api-version",
"in": "header",
"required": false,
"schema": {
"type": "string",
"title": "X-Prefect-Api-Version"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "string",
"default": "",
"title": "Template"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response"
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/automations/templates/validate": {
"post": {
"tags": [
"Automations"
],
"summary": "Validate Template",
"operationId": "validate_template_automations_templates_validate_post",
"parameters": [
{
"name": "x-prefect-api-version",
"in": "header",
"required": false,
"schema": {
"type": "string",
"title": "X-Prefect-Api-Version"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "string",
"default": "",
"title": "Template"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response"
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/ui/flows/count-deployments": {
"post": {
"tags": [
"Flows",
"UI"
],
"summary": "Count Deployments By Flow",
"description": "Get deployment counts by flow id.",
"operationId": "count_deployments_by_flow_ui_flows_count_deployments_post",
"parameters": [
{
"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_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 Ui Flows Count Deployments Post"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/ui/flows/next-runs": {
"post": {
"tags": [
"Flows",
"UI"
],
"summary": "Next Runs By Flow",
"description": "Get the next flow run by flow id.",
"operationId": "next_runs_by_flow_ui_flows_next_runs_post",
"parameters": [
{
"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_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 Ui Flows Next Runs Post"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/ui/flow_runs/history": {
"post": {
"tags": [
"Flow Runs",
"UI"
],
"summary": "Read Flow Run History",
"operationId": "read_flow_run_history_ui_flow_runs_history_post",
"parameters": [
{
"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_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 Ui Flow Runs History Post"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/ui/flow_runs/count-task-runs": {
"post": {
"tags": [
"Flow Runs",
"UI"
],
"summary": "Count Task Runs By Flow Run",
"description": "Get task run counts by flow run id.",
"operationId": "count_task_runs_by_flow_run_ui_flow_runs_count_task_runs_post",
"parameters": [
{
"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_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 Ui Flow Runs Count Task Runs Post"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/ui/schemas/validate": {
"post": {
"tags": [
"UI",
"Schemas"
],
"summary": "Validate Obj",
"operationId": "validate_obj_ui_schemas_validate_post",
"parameters": [
{
"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_ui_schemas_validate_post"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SchemaValuesValidationResponse"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/ui/task_runs/dashboard/counts": {
"post": {
"tags": [
"Task Runs",
"UI"
],
"summary": "Read Dashboard Task Run Counts",
"operationId": "read_dashboard_task_run_counts_ui_task_runs_dashboard_counts_post",
"parameters": [
{
"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_ui_task_runs_dashboard_counts_post"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TaskRunCount"
},
"title": "Response Read Dashboard Task Run Counts Ui Task Runs Dashboard Counts Post"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/ui/task_runs/count": {
"post": {
"tags": [
"Task Runs",
"UI"
],
"summary": "Read Task Run Counts By State",
"operationId": "read_task_run_counts_by_state_ui_task_runs_count_post",
"parameters": [
{
"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_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"
}
}
}
}
}
}
},
"/ui/task_runs/{id}": {
"get": {
"tags": [
"Task Runs",
"UI"
],
"summary": "Read Task Run With Flow Run Name",
"description": "Get a task run by id.",
"operationId": "read_task_run_with_flow_run_name_ui_task_runs__id__get",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"description": "The task run id",
"title": "Id"
},
"description": "The task run id"
},
{
"name": "x-prefect-api-version",
"in": "header",
"required": false,
"schema": {
"type": "string",
"title": "X-Prefect-Api-Version"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UITaskRun"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/admin/settings": {
"get": {
"tags": [
"Admin"
],
"summary": "Read Settings",
"description": "Get the current Prefect REST API settings.\n\nSecret setting values will be obfuscated.",
"operationId": "read_settings_admin_settings_get",
"parameters": [
{
"name": "x-prefect-api-version",
"in": "header",
"required": false,
"schema": {
"type": "string",
"title": "X-Prefect-Api-Version"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Settings"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/admin/version": {
"get": {
"tags": [
"Admin"
],
"summary": "Read Version",
"description": "Returns the Prefect version number",
"operationId": "read_version_admin_version_get",
"parameters": [
{
"name": "x-prefect-api-version",
"in": "header",
"required": false,
"schema": {
"type": "string",
"title": "X-Prefect-Api-Version"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "string",
"title": "Response Read Version Admin Version Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/hello": {
"get": {
"tags": [
"Root"
],
"summary": "Hello",
"description": "Say hello!",
"operationId": "hello_hello_get",
"parameters": [
{
"name": "x-prefect-api-version",
"in": "header",
"required": false,
"schema": {
"type": "string",
"title": "X-Prefect-Api-Version"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "string",
"title": "Response Hello Hello Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/ready": {
"get": {
"tags": [
"Root"
],
"summary": "Perform Readiness Check",
"operationId": "perform_readiness_check_ready_get",
"parameters": [
{
"name": "x-prefect-api-version",
"in": "header",
"required": false,
"schema": {
"type": "string",
"title": "X-Prefect-Api-Version"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"APISettings": {
"properties": {
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url",
"description": "The URL of the Prefect API. If not set, the client will attempt to infer it.",
"supported_environment_variables": [
"PREFECT_API_URL"
]
},
"auth_string": {
"anyOf": [
{
"type": "string",
"format": "password",
"writeOnly": true
},
{
"type": "null"
}
],
"title": "Auth String",
"description": "The auth string used for basic authentication with a self-hosted Prefect API. Should be kept secret.",
"supported_environment_variables": [
"PREFECT_API_AUTH_STRING"
]
},
"key": {
"anyOf": [
{
"type": "string",
"format": "password",
"writeOnly": true
},
{
"type": "null"
}
],
"title": "Key",
"description": "The API key used for authentication with the Prefect API. Should be kept secret.",
"supported_environment_variables": [
"PREFECT_API_KEY"
]
},
"tls_insecure_skip_verify": {
"type": "boolean",
"title": "Tls Insecure Skip Verify",
"description": "If `True`, disables SSL checking to allow insecure requests. Setting to False is recommended only during development. For example, when using self-signed certificates.",
"default": false,
"supported_environment_variables": [
"PREFECT_API_TLS_INSECURE_SKIP_VERIFY"
]
},
"ssl_cert_file": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Ssl Cert File",
"description": "This configuration settings option specifies the path to an SSL certificate file.",
"supported_environment_variables": [
"PREFECT_API_SSL_CERT_FILE"
]
},
"enable_http2": {
"type": "boolean",
"title": "Enable Http2",
"description": "If true, enable support for HTTP/2 for communicating with an API. If the API does not support HTTP/2, this will have no effect and connections will be made via HTTP/1.1.",
"default": false,
"supported_environment_variables": [
"PREFECT_API_ENABLE_HTTP2"
]
},
"request_timeout": {
"type": "number",
"title": "Request Timeout",
"description": "The default timeout for requests to the API",
"default": 60.0,
"supported_environment_variables": [
"PREFECT_API_REQUEST_TIMEOUT"
]
}
},
"type": "object",
"title": "APISettings",
"description": "Settings for interacting with the Prefect API"
},
"Artifact": {
"properties": {
"id": {
"type": "string",
"format": "uuid",
"title": "Id"
},
"created": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Created"
},
"updated": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Updated"
},
"key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Key",
"description": "An optional unique reference key for this artifact."
},
"type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Type",
"description": "An identifier that describes the shape of the data field. e.g. 'result', 'table', 'markdown'"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Description",
"description": "A markdown-enabled description of the artifact."
},
"data": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{},
{
"type": "null"
}
],
"title": "Data",
"description": "Data associated with the artifact, e.g. a result.; structure depends on the artifact type."
},
"metadata_": {
"anyOf": [
{
"additionalProperties": {
"type": "string"
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Metadata",
"description": "User-defined artifact metadata. Content must be string key and value pairs."
},
"flow_run_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Flow Run Id",
"description": "The flow run associated with the artifact."
},
"task_run_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Task Run Id",
"description": "The task run associated with the artifact."
}
},
"type": "object",
"required": [],
"title": "Artifact"
},
"ArtifactCollection": {
"properties": {
"id": {
"type": "string",
"format": "uuid",
"title": "Id"
},
"created": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Created"
},
"updated": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Updated"
},
"key": {
"type": "string",
"title": "Key",
"description": "An optional unique reference key for this artifact."
},
"latest_id": {
"type": "string",
"format": "uuid",
"title": "Latest Id",
"description": "The latest artifact ID associated with the key."
},
"type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Type",
"description": "An identifier that describes the shape of the data field. e.g. 'result', 'table', 'markdown'"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Description",
"description": "A markdown-enabled description of the artifact."
},
"data": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{},
{
"type": "null"
}
],
"title": "Data",
"description": "Data associated with the artifact, e.g. a result.; structure depends on the artifact type."
},
"metadata_": {
"anyOf": [
{
"additionalProperties": {
"type": "string"
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Metadata",
"description": "User-defined artifact metadata. Content must be string key and value pairs."
},
"flow_run_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Flow Run Id",
"description": "The flow run associated with the artifact."
},
"task_run_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Task Run Id",
"description": "The task run associated with the artifact."
}
},
"type": "object",
"required": [
"key",
"latest_id",
"id",
"created",
"updated"
],
"title": "ArtifactCollection"
},
"ArtifactCollectionFilter": {
"properties": {
"operator": {
"$ref": "#/components/schemas/Operator",
"description": "Operator for combining filter criteria. Defaults to 'and_'.",
"default": "and_"
},
"latest_id": {
"anyOf": [
{
"$ref": "#/components/schemas/ArtifactCollectionFilterLatestId"
},
{
"type": "null"
}
],
"description": "Filter criteria for `Artifact.id`"
},
"key": {
"anyOf": [
{
"$ref": "#/components/schemas/ArtifactCollectionFilterKey"
},
{
"type": "null"
}
],
"description": "Filter criteria for `Artifact.key`"
},
"flow_run_id": {
"anyOf": [
{
"$ref": "#/components/schemas/ArtifactCollectionFilterFlowRunId"
},
{
"type": "null"
}
],
"description": "Filter criteria for `Artifact.flow_run_id`"
},
"task_run_id": {
"anyOf": [
{
"$ref": "#/components/schemas/ArtifactCollectionFilterTaskRunId"
},
{
"type": "null"
}
],
"description": "Filter criteria for `Artifact.task_run_id`"
},
"type": {
"anyOf": [
{
"$ref": "#/components/schemas/ArtifactCollectionFilterType"
},
{
"type": "null"
}
],
"description": "Filter criteria for `Artifact.type`"
}
},
"additionalProperties": false,
"type": "object",
"title": "ArtifactCollectionFilter",
"description": "Filter artifact collections. Only artifact collections matching all criteria will be returned"
},
"ArtifactCollectionFilterFlowRunId": {
"properties": {
"any_": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Any",
"description": "A list of flow run IDs to include"
}
},
"additionalProperties": false,
"type": "object",
"title": "ArtifactCollectionFilterFlowRunId",
"description": "Filter by `ArtifactCollection.flow_run_id`."
},
"ArtifactCollectionFilterKey": {
"properties": {
"any_": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Any",
"description": "A list of artifact keys to include"
},
"like_": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Like",
"description": "A string to match artifact keys against. This can include SQL wildcard characters like `%` and `_`.",
"examples": [
"my-artifact-%"
]
},
"exists_": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Exists",
"description": "If `true`, only include artifacts with a non-null key. If `false`, only include artifacts with a null key. Should return all rows in the ArtifactCollection table if specified."
}
},
"additionalProperties": false,
"type": "object",
"title": "ArtifactCollectionFilterKey",
"description": "Filter by `ArtifactCollection.key`."
},
"ArtifactCollectionFilterLatestId": {
"properties": {
"any_": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Any",
"description": "A list of artifact ids to include"
}
},
"additionalProperties": false,
"type": "object",
"title": "ArtifactCollectionFilterLatestId",
"description": "Filter by `ArtifactCollection.latest_id`."
},
"ArtifactCollectionFilterTaskRunId": {
"properties": {
"any_": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Any",
"description": "A list of task run IDs to include"
}
},
"additionalProperties": false,
"type": "object",
"title": "ArtifactCollectionFilterTaskRunId",
"description": "Filter by `ArtifactCollection.task_run_id`."
},
"ArtifactCollectionFilterType": {
"properties": {
"any_": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Any",
"description": "A list of artifact types to include"
},
"not_any_": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Not Any",
"description": "A list of artifact types to exclude"
}
},
"additionalProperties": false,
"type": "object",
"title": "ArtifactCollectionFilterType",
"description": "Filter by `ArtifactCollection.type`."
},
"ArtifactCollectionSort": {
"type": "string",
"enum": [
"CREATED_DESC",
"UPDATED_DESC",
"ID_DESC",
"KEY_DESC",
"KEY_ASC"
],
"title": "ArtifactCollectionSort",
"description": "Defines artifact collection sorting options."
},
"ArtifactCreate": {
"properties": {
"key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Key",
"description": "An optional unique reference key for this artifact."
},
"type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Type",
"description": "An identifier that describes the shape of the data field. e.g. 'result', 'table', 'markdown'"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Description",
"description": "A markdown-enabled description of the artifact."
},
"data": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{},
{
"type": "null"
}
],
"title": "Data",
"description": "Data associated with the artifact, e.g. a result.; structure depends on the artifact type."
},
"metadata_": {
"anyOf": [
{
"additionalProperties": {
"type": "string"
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Metadata",
"description": "User-defined artifact metadata. Content must be string key and value pairs."
},
"flow_run_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Flow Run Id",
"description": "The flow run associated with the artifact."
},
"task_run_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Task Run Id",
"description": "The task run associated with the artifact."
}
},
"additionalProperties": false,
"type": "object",
"title": "ArtifactCreate",
"description": "Data used by the Prefect REST API to create an artifact."
},
"ArtifactFilter": {
"properties": {
"operator": {
"$ref": "#/components/schemas/Operator",
"description": "Operator for combining filter criteria. Defaults to 'and_'.",
"default": "and_"
},
"id": {
"anyOf": [
{
"$ref": "#/components/schemas/ArtifactFilterId"
},
{
"type": "null"
}
],
"description": "Filter criteria for `Artifact.id`"
},
"key": {
"anyOf": [
{
"$ref": "#/components/schemas/ArtifactFilterKey"
},
{
"type": "null"
}
],
"description": "Filter criteria for `Artifact.key`"
},
"flow_run_id": {
"anyOf": [
{
"$ref": "#/components/schemas/ArtifactFilterFlowRunId"
},
{
"type": "null"
}
],
"description": "Filter criteria for `Artifact.flow_run_id`"
},
"task_run_id": {
"anyOf": [
{
"$ref": "#/components/schemas/ArtifactFilterTaskRunId"
},
{
"type": "null"
}
],
"description": "Filter criteria for `Artifact.task_run_id`"
},
"type": {
"anyOf": [
{
"$ref": "#/components/schemas/ArtifactFilterType"
},
{
"type": "null"
}
],
"description": "Filter criteria for `Artifact.type`"
}
},
"additionalProperties": false,
"type": "object",
"title": "ArtifactFilter",
"description": "Filter artifacts. Only artifacts matching all criteria will be returned"
},
"ArtifactFilterFlowRunId": {
"properties": {
"any_": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Any",
"description": "A list of flow run IDs to include"
}
},
"additionalProperties": false,
"type": "object",
"title": "ArtifactFilterFlowRunId",
"description": "Filter by `Artifact.flow_run_id`."
},
"ArtifactFilterId": {
"properties": {
"any_": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Any",
"description": "A list of artifact ids to include"
}
},
"additionalProperties": false,
"type": "object",
"title": "ArtifactFilterId",
"description": "Filter by `Artifact.id`."
},
"ArtifactFilterKey": {
"properties": {
"any_": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Any",
"description": "A list of artifact keys to include"
},
"like_": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Like",
"description": "A string to match artifact keys against. This can include SQL wildcard characters like `%` and `_`.",
"examples": [
"my-artifact-%"
]
},
"exists_": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Exists",
"description": "If `true`, only include artifacts with a non-null key. If `false`, only include artifacts with a null key."
}
},
"additionalProperties": false,
"type": "object",
"title": "ArtifactFilterKey",
"description": "Filter by `Artifact.key`."
},
"ArtifactFilterTaskRunId": {
"properties": {
"any_": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Any",
"description": "A list of task run IDs to include"
}
},
"additionalProperties": false,
"type": "object",
"title": "ArtifactFilterTaskRunId",
"description": "Filter by `Artifact.task_run_id`."
},
"ArtifactFilterType": {
"properties": {
"any_": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Any",
"description": "A list of artifact types to include"
},
"not_any_": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Not Any",
"description": "A list of artifact types to exclude"
}
},
"additionalProperties": false,
"type": "object",
"title": "ArtifactFilterType",
"description": "Filter by `Artifact.type`."
},
"ArtifactSort": {
"type": "string",
"enum": [
"CREATED_DESC",
"UPDATED_DESC",
"ID_DESC",
"KEY_DESC",
"KEY_ASC"
],
"title": "ArtifactSort",
"description": "Defines artifact sorting options."
},
"ArtifactUpdate": {
"properties": {
"data": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{},
{
"type": "null"
}
],
"title": "Data"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Description"
},
"metadata_": {
"anyOf": [
{
"additionalProperties": {
"type": "string"
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Metadata"
}
},
"additionalProperties": false,
"type": "object",
"title": "ArtifactUpdate",
"description": "Data used by the Prefect REST API to update an artifact."
},
"Automation": {
"properties": {
"name": {
"type": "string",
"title": "Name",
"description": "The name of this automation"
},
"description": {
"type": "string",
"title": "Description",
"description": "A longer description of this automation",
"default": ""
},
"enabled": {
"type": "boolean",
"title": "Enabled",
"description": "Whether this automation will be evaluated",
"default": true
},
"tags": {
"items": {
"type": "string"
},
"type": "array",
"title": "Tags",
"description": "A list of tags associated with this automation"
},
"trigger": {
"anyOf": [
{
"$ref": "#/components/schemas/EventTrigger"
},
{
"$ref": "#/components/schemas/CompoundTrigger-Output"
},
{
"$ref": "#/components/schemas/SequenceTrigger-Output"
}
],
"title": "Trigger",
"description": "The criteria for which events this Automation covers and how it will respond to the presence or absence of those events"
},
"actions": {
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/DoNothing"
},
{
"$ref": "#/components/schemas/RunDeployment"
},
{
"$ref": "#/components/schemas/PauseDeployment"
},
{
"$ref": "#/components/schemas/ResumeDeployment"
},
{
"$ref": "#/components/schemas/CancelFlowRun"
},
{
"$ref": "#/components/schemas/ChangeFlowRunState"
},
{
"$ref": "#/components/schemas/PauseWorkQueue"
},
{
"$ref": "#/components/schemas/ResumeWorkQueue"
},
{
"$ref": "#/components/schemas/SendNotification"
},
{
"$ref": "#/components/schemas/CallWebhook"
},
{
"$ref": "#/components/schemas/PauseAutomation"
},
{
"$ref": "#/components/schemas/ResumeAutomation"
},
{
"$ref": "#/components/schemas/SuspendFlowRun"
},
{
"$ref": "#/components/schemas/ResumeFlowRun"
},
{
"$ref": "#/components/schemas/PauseWorkPool"
},
{
"$ref": "#/components/schemas/ResumeWorkPool"
}
]
},
"type": "array",
"title": "Actions",
"description": "The actions to perform when this Automation triggers"
},
"actions_on_trigger": {
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/DoNothing"
},
{
"$ref": "#/components/schemas/RunDeployment"
},
{
"$ref": "#/components/schemas/PauseDeployment"
},
{
"$ref": "#/components/schemas/ResumeDeployment"
},
{
"$ref": "#/components/schemas/CancelFlowRun"
},
{
"$ref": "#/components/schemas/ChangeFlowRunState"
},
{
"$ref": "#/components/schemas/PauseWorkQueue"
},
{
"$ref": "#/components/schemas/ResumeWorkQueue"
},
{
"$ref": "#/components/schemas/SendNotification"
},
{
"$ref": "#/components/schemas/CallWebhook"
},
{
"$ref": "#/components/schemas/PauseAutomation"
},
{
"$ref": "#/components/schemas/ResumeAutomation"
},
{
"$ref": "#/components/schemas/SuspendFlowRun"
},
{
"$ref": "#/components/schemas/ResumeFlowRun"
},
{
"$ref": "#/components/schemas/PauseWorkPool"
},
{
"$ref": "#/components/schemas/ResumeWorkPool"
}
]
},
"type": "array",
"title": "Actions On Trigger",
"description": "The actions to perform when an Automation goes into a triggered state"
},
"actions_on_resolve": {
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/DoNothing"
},
{
"$ref": "#/components/schemas/RunDeployment"
},
{
"$ref": "#/components/schemas/PauseDeployment"
},
{
"$ref": "#/components/schemas/ResumeDeployment"
},
{
"$ref": "#/components/schemas/CancelFlowRun"
},
{
"$ref": "#/components/schemas/ChangeFlowRunState"
},
{
"$ref": "#/components/schemas/PauseWorkQueue"
},
{
"$ref": "#/components/schemas/ResumeWorkQueue"
},
{
"$ref": "#/components/schemas/SendNotification"
},
{
"$ref": "#/components/schemas/CallWebhook"
},
{
"$ref": "#/components/schemas/PauseAutomation"
},
{
"$ref": "#/components/schemas/ResumeAutomation"
},
{
"$ref": "#/components/schemas/SuspendFlowRun"
},
{
"$ref": "#/components/schemas/ResumeFlowRun"
},
{
"$ref": "#/components/schemas/PauseWorkPool"
},
{
"$ref": "#/components/schemas/ResumeWorkPool"
}
]
},
"type": "array",
"title": "Actions On Resolve",
"description": "The actions to perform when an Automation goes into a resolving state"
},
"id": {
"type": "string",
"format": "uuid",
"title": "Id"
},
"created": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Created"
},
"updated": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Updated"
}
},
"type": "object",
"required": [
"name",
"trigger",
"actions",
"id",
"created",
"updated"
],
"title": "Automation"
},
"AutomationCreate": {
"properties": {
"name": {
"type": "string",
"title": "Name",
"description": "The name of this automation"
},
"description": {
"type": "string",
"title": "Description",
"description": "A longer description of this automation",
"default": ""
},
"enabled": {
"type": "boolean",
"title": "Enabled",
"description": "Whether this automation will be evaluated",
"default": true
},
"tags": {
"items": {
"type": "string"
},
"type": "array",
"title": "Tags",
"description": "A list of tags associated with this automation"
},
"trigger": {
"anyOf": [
{
"$ref": "#/components/schemas/EventTrigger"
},
{
"$ref": "#/components/schemas/CompoundTrigger-Input"
},
{
"$ref": "#/components/schemas/SequenceTrigger-Input"
}
],
"title": "Trigger",
"description": "The criteria for which events this Automation covers and how it will respond to the presence or absence of those events"
},
"actions": {
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/DoNothing"
},
{
"$ref": "#/components/schemas/RunDeployment"
},
{
"$ref": "#/components/schemas/PauseDeployment"
},
{
"$ref": "#/components/schemas/ResumeDeployment"
},
{
"$ref": "#/components/schemas/CancelFlowRun"
},
{
"$ref": "#/components/schemas/ChangeFlowRunState"
},
{
"$ref": "#/components/schemas/PauseWorkQueue"
},
{
"$ref": "#/components/schemas/ResumeWorkQueue"
},
{
"$ref": "#/components/schemas/SendNotification"
},
{
"$ref": "#/components/schemas/CallWebhook"
},
{
"$ref": "#/components/schemas/PauseAutomation"
},
{
"$ref": "#/components/schemas/ResumeAutomation"
},
{
"$ref": "#/components/schemas/SuspendFlowRun"
},
{
"$ref": "#/components/schemas/ResumeFlowRun"
},
{
"$ref": "#/components/schemas/PauseWorkPool"
},
{
"$ref": "#/components/schemas/ResumeWorkPool"
}
]
},
"type": "array",
"title": "Actions",
"description": "The actions to perform when this Automation triggers"
},
"actions_on_trigger": {
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/DoNothing"
},
{
"$ref": "#/components/schemas/RunDeployment"
},
{
"$ref": "#/components/schemas/PauseDeployment"
},
{
"$ref": "#/components/schemas/ResumeDeployment"
},
{
"$ref": "#/components/schemas/CancelFlowRun"
},
{
"$ref": "#/components/schemas/ChangeFlowRunState"
},
{
"$ref": "#/components/schemas/PauseWorkQueue"
},
{
"$ref": "#/components/schemas/ResumeWorkQueue"
},
{
"$ref": "#/components/schemas/SendNotification"
},
{
"$ref": "#/components/schemas/CallWebhook"
},
{
"$ref": "#/components/schemas/PauseAutomation"
},
{
"$ref": "#/components/schemas/ResumeAutomation"
},
{
"$ref": "#/components/schemas/SuspendFlowRun"
},
{
"$ref": "#/components/schemas/ResumeFlowRun"
},
{
"$ref": "#/components/schemas/PauseWorkPool"
},
{
"$ref": "#/components/schemas/ResumeWorkPool"
}
]
},
"type": "array",
"title": "Actions On Trigger",
"description": "The actions to perform when an Automation goes into a triggered state"
},
"actions_on_resolve": {
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/DoNothing"
},
{
"$ref": "#/components/schemas/RunDeployment"
},
{
"$ref": "#/components/schemas/PauseDeployment"
},
{
"$ref": "#/components/schemas/ResumeDeployment"
},
{
"$ref": "#/components/schemas/CancelFlowRun"
},
{
"$ref": "#/components/schemas/ChangeFlowRunState"
},
{
"$ref": "#/components/schemas/PauseWorkQueue"
},
{
"$ref": "#/components/schemas/ResumeWorkQueue"
},
{
"$ref": "#/components/schemas/SendNotification"
},
{
"$ref": "#/components/schemas/CallWebhook"
},
{
"$ref": "#/components/schemas/PauseAutomation"
},
{
"$ref": "#/components/schemas/ResumeAutomation"
},
{
"$ref": "#/components/schemas/SuspendFlowRun"
},
{
"$ref": "#/components/schemas/ResumeFlowRun"
},
{
"$ref": "#/components/schemas/PauseWorkPool"
},
{
"$ref": "#/components/schemas/ResumeWorkPool"
}
]
},
"type": "array",
"title": "Actions On Resolve",
"description": "The actions to perform when an Automation goes into a resolving state"
},
"owner_resource": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Owner Resource",
"description": "The resource to which this automation belongs"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"name",
"trigger",
"actions"
],
"title": "AutomationCreate"
},
"AutomationFilter": {
"properties": {
"operator": {
"$ref": "#/components/schemas/Operator",
"description": "Operator for combining filter criteria. Defaults to 'and_'.",
"default": "and_"
},
"name": {
"anyOf": [
{
"$ref": "#/components/schemas/AutomationFilterName"
},
{
"type": "null"
}
],
"description": "Filter criteria for `Automation.name`"
},
"created": {
"anyOf": [
{
"$ref": "#/components/schemas/AutomationFilterCreated"
},
{
"type": "null"
}
],
"description": "Filter criteria for `Automation.created`"
},
"tags": {
"anyOf": [
{
"$ref": "#/components/schemas/AutomationFilterTags"
},
{
"type": "null"
}
],
"description": "Filter criteria for `Automation.tags`"
}
},
"additionalProperties": false,
"type": "object",
"title": "AutomationFilter"
},
"AutomationFilterCreated": {
"properties": {
"before_": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Before",
"description": "Only include automations created before this datetime"
}
},
"additionalProperties": false,
"type": "object",
"title": "AutomationFilterCreated",
"description": "Filter by `Automation.created`."
},
"AutomationFilterName": {
"properties": {
"any_": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Any",
"description": "Only include automations with names that match any of these strings"
}
},
"additionalProperties": false,
"type": "object",
"title": "AutomationFilterName",
"description": "Filter by `Automation.created`."
},
"AutomationFilterTags": {
"properties": {
"operator": {
"$ref": "#/components/schemas/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. Automations 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. Automations 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 automations without tags"
}
},
"additionalProperties": false,
"type": "object",
"title": "AutomationFilterTags",
"description": "Filter by `Automation.tags`."
},
"AutomationPartialUpdate": {
"properties": {
"enabled": {
"type": "boolean",
"title": "Enabled",
"description": "Whether this automation will be evaluated",
"default": true
}
},
"additionalProperties": false,
"type": "object",
"title": "AutomationPartialUpdate"
},
"AutomationSort": {
"type": "string",
"enum": [
"CREATED_DESC",
"UPDATED_DESC",
"NAME_ASC",
"NAME_DESC"
],
"title": "AutomationSort",
"description": "Defines automations sorting options."
},
"AutomationUpdate": {
"properties": {
"name": {
"type": "string",
"title": "Name",
"description": "The name of this automation"
},
"description": {
"type": "string",
"title": "Description",
"description": "A longer description of this automation",
"default": ""
},
"enabled": {
"type": "boolean",
"title": "Enabled",
"description": "Whether this automation will be evaluated",
"default": true
},
"tags": {
"items": {
"type": "string"
},
"type": "array",
"title": "Tags",
"description": "A list of tags associated with this automation"
},
"trigger": {
"anyOf": [
{
"$ref": "#/components/schemas/EventTrigger"
},
{
"$ref": "#/components/schemas/CompoundTrigger-Input"
},
{
"$ref": "#/components/schemas/SequenceTrigger-Input"
}
],
"title": "Trigger",
"description": "The criteria for which events this Automation covers and how it will respond to the presence or absence of those events"
},
"actions": {
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/DoNothing"
},
{
"$ref": "#/components/schemas/RunDeployment"
},
{
"$ref": "#/components/schemas/PauseDeployment"
},
{
"$ref": "#/components/schemas/ResumeDeployment"
},
{
"$ref": "#/components/schemas/CancelFlowRun"
},
{
"$ref": "#/components/schemas/ChangeFlowRunState"
},
{
"$ref": "#/components/schemas/PauseWorkQueue"
},
{
"$ref": "#/components/schemas/ResumeWorkQueue"
},
{
"$ref": "#/components/schemas/SendNotification"
},
{
"$ref": "#/components/schemas/CallWebhook"
},
{
"$ref": "#/components/schemas/PauseAutomation"
},
{
"$ref": "#/components/schemas/ResumeAutomation"
},
{
"$ref": "#/components/schemas/SuspendFlowRun"
},
{
"$ref": "#/components/schemas/ResumeFlowRun"
},
{
"$ref": "#/components/schemas/PauseWorkPool"
},
{
"$ref": "#/components/schemas/ResumeWorkPool"
}
]
},
"type": "array",
"title": "Actions",
"description": "The actions to perform when this Automation triggers"
},
"actions_on_trigger": {
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/DoNothing"
},
{
"$ref": "#/components/schemas/RunDeployment"
},
{
"$ref": "#/components/schemas/PauseDeployment"
},
{
"$ref": "#/components/schemas/ResumeDeployment"
},
{
"$ref": "#/components/schemas/CancelFlowRun"
},
{
"$ref": "#/components/schemas/ChangeFlowRunState"
},
{
"$ref": "#/components/schemas/PauseWorkQueue"
},
{
"$ref": "#/components/schemas/ResumeWorkQueue"
},
{
"$ref": "#/components/schemas/SendNotification"
},
{
"$ref": "#/components/schemas/CallWebhook"
},
{
"$ref": "#/components/schemas/PauseAutomation"
},
{
"$ref": "#/components/schemas/ResumeAutomation"
},
{
"$ref": "#/components/schemas/SuspendFlowRun"
},
{
"$ref": "#/components/schemas/ResumeFlowRun"
},
{
"$ref": "#/components/schemas/PauseWorkPool"
},
{
"$ref": "#/components/schemas/ResumeWorkPool"
}
]
},
"type": "array",
"title": "Actions On Trigger",
"description": "The actions to perform when an Automation goes into a triggered state"
},
"actions_on_resolve": {
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/DoNothing"
},
{
"$ref": "#/components/schemas/RunDeployment"
},
{
"$ref": "#/components/schemas/PauseDeployment"
},
{
"$ref": "#/components/schemas/ResumeDeployment"
},
{
"$ref": "#/components/schemas/CancelFlowRun"
},
{
"$ref": "#/components/schemas/ChangeFlowRunState"
},
{
"$ref": "#/components/schemas/PauseWorkQueue"
},
{
"$ref": "#/components/schemas/ResumeWorkQueue"
},
{
"$ref": "#/components/schemas/SendNotification"
},
{
"$ref": "#/components/schemas/CallWebhook"
},
{
"$ref": "#/components/schemas/PauseAutomation"
},
{
"$ref": "#/components/schemas/ResumeAutomation"
},
{
"$ref": "#/components/schemas/SuspendFlowRun"
},
{
"$ref": "#/components/schemas/ResumeFlowRun"
},
{
"$ref": "#/components/schemas/PauseWorkPool"
},
{
"$ref": "#/components/schemas/ResumeWorkPool"
}
]
},
"type": "array",
"title": "Actions On Resolve",
"description": "The actions to perform when an Automation goes into a resolving state"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"name",
"trigger",
"actions"
],
"title": "AutomationUpdate"
},
"BlockDocument": {
"properties": {
"id": {
"type": "string",
"format": "uuid",
"title": "Id"
},
"created": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Created"
},
"updated": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Updated"
},
"name": {
"anyOf": [
{
"type": "string",
"pattern": "^[^/%&><]+$"
},
{
"type": "null"
}
],
"title": "Name",
"description": "The block document's name. Not required for anonymous block documents."
},
"data": {
"additionalProperties": true,
"type": "object",
"title": "Data",
"description": "The block document's data"
},
"block_schema_id": {
"type": "string",
"format": "uuid",
"title": "Block Schema Id",
"description": "A block schema ID"
},
"block_schema": {
"anyOf": [
{
"$ref": "#/components/schemas/BlockSchema"
},
{
"type": "null"
}
],
"description": "The associated block schema"
},
"block_type_id": {
"type": "string",
"format": "uuid",
"title": "Block Type Id",
"description": "A block type ID"
},
"block_type_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Block Type Name",
"description": "The associated block type's name"
},
"block_type": {
"anyOf": [
{
"$ref": "#/components/schemas/BlockType"
},
{
"type": "null"
}
],
"description": "The associated block type"
},
"block_document_references": {
"additionalProperties": {
"additionalProperties": true,
"type": "object"
},
"type": "object",
"title": "Block Document References",
"description": "Record of the block document's references"
},
"is_anonymous": {
"type": "boolean",
"title": "Is Anonymous",
"description": "Whether the block is anonymous (anonymous blocks are usually created by Prefect automatically)",
"default": false
}
},
"type": "object",
"required": [
"block_schema_id",
"block_type_id",
"id",
"created",
"updated"
],
"title": "BlockDocument",
"description": "An ORM representation of a block document."
},
"BlockDocumentCreate": {
"properties": {
"name": {
"anyOf": [
{
"type": "string",
"pattern": "^[^/%&><]+$"
},
{
"type": "null"
}
],
"title": "Name",
"description": "The block document's name. Not required for anonymous block documents."
},
"data": {
"additionalProperties": true,
"type": "object",
"title": "Data",
"description": "The block document's data"
},
"block_schema_id": {
"type": "string",
"format": "uuid",
"title": "Block Schema Id",
"description": "A block schema ID"
},
"block_type_id": {
"type": "string",
"format": "uuid",
"title": "Block Type Id",
"description": "A block type ID"
},
"is_anonymous": {
"type": "boolean",
"title": "Is Anonymous",
"description": "Whether the block is anonymous (anonymous blocks are usually created by Prefect automatically)",
"default": false
}
},
"additionalProperties": false,
"type": "object",
"required": [
"block_schema_id",
"block_type_id"
],
"title": "BlockDocumentCreate",
"description": "Data used by the Prefect REST API to create a block document."
},
"BlockDocumentFilter": {
"properties": {
"operator": {
"$ref": "#/components/schemas/Operator",
"description": "Operator for combining filter criteria. Defaults to 'and_'.",
"default": "and_"
},
"id": {
"anyOf": [
{
"$ref": "#/components/schemas/BlockDocumentFilterId"
},
{
"type": "null"
}
],
"description": "Filter criteria for `BlockDocument.id`"
},
"is_anonymous": {
"anyOf": [
{
"$ref": "#/components/schemas/BlockDocumentFilterIsAnonymous"
},
{
"type": "null"
}
],
"description": "Filter criteria for `BlockDocument.is_anonymous`. Defaults to excluding anonymous blocks.",
"default": {
"eq_": false
}
},
"block_type_id": {
"anyOf": [
{
"$ref": "#/components/schemas/BlockDocumentFilterBlockTypeId"
},
{
"type": "null"
}
],
"description": "Filter criteria for `BlockDocument.block_type_id`"
},
"name": {
"anyOf": [
{
"$ref": "#/components/schemas/BlockDocumentFilterName"
},
{
"type": "null"
}
],
"description": "Filter criteria for `BlockDocument.name`"
}
},
"additionalProperties": false,
"type": "object",
"title": "BlockDocumentFilter",
"description": "Filter BlockDocuments. Only BlockDocuments matching all criteria will be returned"
},
"BlockDocumentFilterBlockTypeId": {
"properties": {
"any_": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Any",
"description": "A list of block type ids to include"
}
},
"additionalProperties": false,
"type": "object",
"title": "BlockDocumentFilterBlockTypeId",
"description": "Filter by `BlockDocument.block_type_id`."
},
"BlockDocumentFilterId": {
"properties": {
"any_": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Any",
"description": "A list of block ids to include"
}
},
"additionalProperties": false,
"type": "object",
"title": "BlockDocumentFilterId",
"description": "Filter by `BlockDocument.id`."
},
"BlockDocumentFilterIsAnonymous": {
"properties": {
"eq_": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Eq",
"description": "Filter block documents for only those that are or are not anonymous."
}
},
"additionalProperties": false,
"type": "object",
"title": "BlockDocumentFilterIsAnonymous",
"description": "Filter by `BlockDocument.is_anonymous`."
},
"BlockDocumentFilterName": {
"properties": {
"any_": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Any",
"description": "A list of block names to include"
},
"like_": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Like",
"description": "A string to match block names against. This can include SQL wildcard characters like `%` and `_`.",
"examples": [
"my-block%"
]
}
},
"additionalProperties": false,
"type": "object",
"title": "BlockDocumentFilterName",
"description": "Filter by `BlockDocument.name`."
},
"BlockDocumentSort": {
"type": "string",
"enum": [
"NAME_DESC",
"NAME_ASC",
"BLOCK_TYPE_AND_NAME_ASC"
],
"title": "BlockDocumentSort",
"description": "Defines block document sorting options."
},
"BlockDocumentUpdate": {
"properties": {
"block_schema_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Block Schema Id",
"description": "A block schema ID"
},
"data": {
"additionalProperties": true,
"type": "object",
"title": "Data",
"description": "The block document's data"
},
"merge_existing_data": {
"type": "boolean",
"title": "Merge Existing Data",
"default": true
}
},
"additionalProperties": false,
"type": "object",
"title": "BlockDocumentUpdate",
"description": "Data used by the Prefect REST API to update a block document."
},
"BlockSchema": {
"properties": {
"id": {
"type": "string",
"format": "uuid",
"title": "Id"
},
"created": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Created"
},
"updated": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Updated"
},
"checksum": {
"type": "string",
"title": "Checksum",
"description": "The block schema's unique checksum"
},
"fields": {
"additionalProperties": true,
"type": "object",
"title": "Fields",
"description": "The block schema's field schema"
},
"block_type_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Block Type Id",
"description": "A block type ID"
},
"block_type": {
"anyOf": [
{
"$ref": "#/components/schemas/BlockType"
},
{
"type": "null"
}
],
"description": "The associated block type"
},
"capabilities": {
"items": {
"type": "string"
},
"type": "array",
"title": "Capabilities",
"description": "A list of Block capabilities"
},
"version": {
"type": "string",
"title": "Version",
"description": "Human readable identifier for the block schema",
"default": "non-versioned"
}
},
"type": "object",
"required": [
"checksum",
"block_type_id",
"id",
"created",
"updated"
],
"title": "BlockSchema",
"description": "An ORM representation of a block schema."
},
"BlockSchemaCreate": {
"properties": {
"fields": {
"additionalProperties": true,
"type": "object",
"title": "Fields",
"description": "The block schema's field schema"
},
"block_type_id": {
"type": "string",
"format": "uuid",
"title": "Block Type Id",
"description": "A block type ID"
},
"capabilities": {
"items": {
"type": "string"
},
"type": "array",
"title": "Capabilities",
"description": "A list of Block capabilities"
},
"version": {
"type": "string",
"title": "Version",
"description": "Human readable identifier for the block schema",
"default": "non-versioned"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"block_type_id"
],
"title": "BlockSchemaCreate",
"description": "Data used by the Prefect REST API to create a block schema."
},
"BlockSchemaFilter": {
"properties": {
"operator": {
"$ref": "#/components/schemas/Operator",
"description": "Operator for combining filter criteria. Defaults to 'and_'.",
"default": "and_"
},
"block_type_id": {
"anyOf": [
{
"$ref": "#/components/schemas/BlockSchemaFilterBlockTypeId"
},
{
"type": "null"
}
],
"description": "Filter criteria for `BlockSchema.block_type_id`"
},
"block_capabilities": {
"anyOf": [
{
"$ref": "#/components/schemas/BlockSchemaFilterCapabilities"
},
{
"type": "null"
}
],
"description": "Filter criteria for `BlockSchema.capabilities`"
},
"id": {
"anyOf": [
{
"$ref": "#/components/schemas/BlockSchemaFilterId"
},
{
"type": "null"
}
],
"description": "Filter criteria for `BlockSchema.id`"
},
"version": {
"anyOf": [
{
"$ref": "#/components/schemas/BlockSchemaFilterVersion"
},
{
"type": "null"
}
],
"description": "Filter criteria for `BlockSchema.version`"
}
},
"additionalProperties": false,
"type": "object",
"title": "BlockSchemaFilter",
"description": "Filter BlockSchemas"
},
"BlockSchemaFilterBlockTypeId": {
"properties": {
"any_": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Any",
"description": "A list of block type ids to include"
}
},
"additionalProperties": false,
"type": "object",
"title": "BlockSchemaFilterBlockTypeId",
"description": "Filter by `BlockSchema.block_type_id`."
},
"BlockSchemaFilterCapabilities": {
"properties": {
"all_": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "All",
"description": "A list of block capabilities. Block entities will be returned only if an associated block schema has a superset of the defined capabilities.",
"examples": [
[
"write-storage",
"read-storage"
]
]
}
},
"additionalProperties": false,
"type": "object",
"title": "BlockSchemaFilterCapabilities",
"description": "Filter by `BlockSchema.capabilities`"
},
"BlockSchemaFilterId": {
"properties": {
"any_": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Any",
"description": "A list of IDs to include"
}
},
"additionalProperties": false,
"type": "object",
"title": "BlockSchemaFilterId",
"description": "Filter by BlockSchema.id"
},
"BlockSchemaFilterVersion": {
"properties": {
"any_": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Any",
"description": "A list of block schema versions.",
"examples": [
[
"2.0.0",
"2.1.0"
]
]
}
},
"additionalProperties": false,
"type": "object",
"title": "BlockSchemaFilterVersion",
"description": "Filter by `BlockSchema.capabilities`"
},
"BlockType": {
"properties": {
"id": {
"type": "string",
"format": "uuid",
"title": "Id"
},
"created": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Created"
},
"updated": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Updated"
},
"name": {
"type": "string",
"pattern": "^[^/%&><]+$",
"title": "Name",
"description": "A block type's name"
},
"slug": {
"type": "string",
"title": "Slug",
"description": "A block type's slug"
},
"logo_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Logo Url",
"description": "Web URL for the block type's logo"
},
"documentation_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Documentation Url",
"description": "Web URL for the block type's documentation"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Description",
"description": "A short blurb about the corresponding block's intended use"
},
"code_example": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Code Example",
"description": "A code snippet demonstrating use of the corresponding block"
},
"is_protected": {
"type": "boolean",
"title": "Is Protected",
"description": "Protected block types cannot be modified via API.",
"default": false
}
},
"type": "object",
"required": [
"name",
"slug",
"id",
"created",
"updated"
],
"title": "BlockType",
"description": "An ORM representation of a block type"
},
"BlockTypeCreate": {
"properties": {
"name": {
"type": "string",
"pattern": "^[^/%&><]+$",
"title": "Name",
"description": "A block type's name"
},
"slug": {
"type": "string",
"title": "Slug",
"description": "A block type's slug"
},
"logo_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Logo Url",
"description": "Web URL for the block type's logo"
},
"documentation_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Documentation Url",
"description": "Web URL for the block type's documentation"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Description",
"description": "A short blurb about the corresponding block's intended use"
},
"code_example": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Code Example",
"description": "A code snippet demonstrating use of the corresponding block"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"name",
"slug"
],
"title": "BlockTypeCreate",
"description": "Data used by the Prefect REST API to create a block type."
},
"BlockTypeFilter": {
"properties": {
"name": {
"anyOf": [
{
"$ref": "#/components/schemas/BlockTypeFilterName"
},
{
"type": "null"
}
],
"description": "Filter criteria for `BlockType.name`"
},
"slug": {
"anyOf": [
{
"$ref": "#/components/schemas/BlockTypeFilterSlug"
},
{
"type": "null"
}
],
"description": "Filter criteria for `BlockType.slug`"
}
},
"additionalProperties": false,
"type": "object",
"title": "BlockTypeFilter",
"description": "Filter BlockTypes"
},
"BlockTypeFilterName": {
"properties": {
"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": "BlockTypeFilterName",
"description": "Filter by `BlockType.name`"
},
"BlockTypeFilterSlug": {
"properties": {
"any_": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Any",
"description": "A list of slugs to match"
}
},
"additionalProperties": false,
"type": "object",
"title": "BlockTypeFilterSlug",
"description": "Filter by `BlockType.slug`"
},
"BlockTypeUpdate": {
"properties": {
"logo_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Logo Url"
},
"documentation_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Documentation Url"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Description"
},
"code_example": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Code Example"
}
},
"additionalProperties": false,
"type": "object",
"title": "BlockTypeUpdate",
"description": "Data used by the Prefect REST API to update a block type."
},
"Body_average_flow_run_lateness_flow_runs_lateness_post": {
"properties": {
"flows": {
"anyOf": [
{
"$ref": "#/components/schemas/FlowFilter"
},
{
"type": "null"
}
]
},
"flow_runs": {
"anyOf": [
{
"$ref": "#/components/schemas/FlowRunFilter"
},
{
"type": "null"
}
]
},
"task_runs": {
"anyOf": [
{
"$ref": "#/components/schemas/TaskRunFilter"
},
{
"type": "null"
}
]
},
"deployments": {
"anyOf": [
{
"$ref": "#/components/schemas/DeploymentFilter"
},
{
"type": "null"
}
]
},
"work_pools": {
"anyOf": [
{
"$ref": "#/components/schemas/WorkPoolFilter"
},
{
"type": "null"
}
]
},
"work_pool_queues": {
"anyOf": [
{
"$ref": "#/components/schemas/WorkQueueFilter"
},
{
"type": "null"
}
]
}
},
"type": "object",
"title": "Body_average_flow_run_lateness_flow_runs_lateness_post"
},
"Body_bulk_decrement_active_slots_v2_concurrency_limits_decrement_post": {
"properties": {
"slots": {
"type": "integer",
"exclusiveMinimum": 0.0,
"title": "Slots"
},
"names": {
"items": {
"type": "string"
},
"type": "array",
"title": "Names",
"min_items": 1
},
"occupancy_seconds": {
"anyOf": [
{
"type": "number",
"exclusiveMinimum": 0.0
},
{
"type": "null"
}
],
"title": "Occupancy Seconds"
},
"create_if_missing": {
"type": "boolean",
"title": "Create If Missing",
"deprecated": true
}
},
"type": "object",
"required": [
"slots",
"names"
],
"title": "Body_bulk_decrement_active_slots_v2_concurrency_limits_decrement_post"
},
"Body_bulk_decrement_active_slots_with_lease_v2_concurrency_limits_decrement_with_lease_post": {
"properties": {
"lease_id": {
"type": "string",
"format": "uuid",
"title": "Lease Id",
"description": "The ID of the lease corresponding to the concurrency limits to decrement."
}
},
"type": "object",
"required": [
"lease_id"
],
"title": "Body_bulk_decrement_active_slots_with_lease_v2_concurrency_limits_decrement_with_lease_post"
},
"Body_bulk_delete_deployments_deployments_bulk_delete_post": {
"properties": {
"deployments": {
"anyOf": [
{
"$ref": "#/components/schemas/DeploymentFilter"
},
{
"type": "null"
}
],
"description": "Filter criteria for deployments to delete"
},
"limit": {
"type": "integer",
"maximum": 50.0,
"minimum": 1.0,
"title": "Limit",
"description": "Maximum number of deployments to delete. Defaults to 50.",
"default": 50
}
},
"type": "object",
"title": "Body_bulk_delete_deployments_deployments_bulk_delete_post"
},
"Body_bulk_delete_flow_runs_flow_runs_bulk_delete_post": {
"properties": {
"flow_runs": {
"anyOf": [
{
"$ref": "#/components/schemas/FlowRunFilter"
},
{
"type": "null"
}
],
"description": "Filter criteria for flow runs to delete"
},
"limit": {
"type": "integer",
"maximum": 50.0,
"minimum": 1.0,
"title": "Limit",
"description": "Maximum number of flow runs to delete. Defaults to 50.",
"default": 50
}
},
"type": "object",
"title": "Body_bulk_delete_flow_runs_flow_runs_bulk_delete_post"
},
"Body_bulk_delete_flows_flows_bulk_delete_post": {
"properties": {
"flows": {
"anyOf": [
{
"$ref": "#/components/schemas/FlowFilter"
},
{
"type": "null"
}
],
"description": "Filter criteria for flows to delete"
},
"limit": {
"type": "integer",
"maximum": 50.0,
"minimum": 1.0,
"title": "Limit",
"description": "Maximum number of flows to delete. Defaults to 50.",
"default": 50
}
},
"type": "object",
"title": "Body_bulk_delete_flows_flows_bulk_delete_post"
},
"Body_bulk_increment_active_slots_v2_concurrency_limits_increment_post": {
"properties": {
"slots": {
"type": "integer",
"exclusiveMinimum": 0.0,
"title": "Slots"
},
"names": {
"items": {
"type": "string"
},
"type": "array",
"title": "Names",
"min_items": 1
},
"mode": {
"type": "string",
"enum": [
"concurrency",
"rate_limit"
],
"title": "Mode",
"default": "concurrency"
},
"create_if_missing": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Create If Missing",
"deprecated": true
}
},
"type": "object",
"required": [
"slots",
"names"
],
"title": "Body_bulk_increment_active_slots_v2_concurrency_limits_increment_post"
},
"Body_bulk_increment_active_slots_with_lease_v2_concurrency_limits_increment_with_lease_post": {
"properties": {
"slots": {
"type": "integer",
"exclusiveMinimum": 0.0,
"title": "Slots"
},
"names": {
"items": {
"type": "string"
},
"type": "array",
"title": "Names",
"min_items": 1
},
"mode": {
"type": "string",
"enum": [
"concurrency",
"rate_limit"
],
"title": "Mode",
"default": "concurrency"
},
"lease_duration": {
"type": "number",
"maximum": 86400.0,
"minimum": 60.0,
"title": "Lease Duration",
"description": "The duration of the lease in seconds.",
"default": 300
},
"holder": {
"anyOf": [
{
"$ref": "#/components/schemas/ConcurrencyLeaseHolder"
},
{
"type": "null"
}
],
"description": "The holder of the lease with type (flow_run, task_run, or deployment) and id."
}
},
"type": "object",
"required": [
"slots",
"names"
],
"title": "Body_bulk_increment_active_slots_with_lease_v2_concurrency_limits_increment_with_lease_post"
},
"Body_bulk_set_flow_run_state_flow_runs_bulk_set_state_post": {
"properties": {
"flow_runs": {
"anyOf": [
{
"$ref": "#/components/schemas/FlowRunFilter"
},
{
"type": "null"
}
],
"description": "Filter criteria for flow runs to update"
},
"state": {
"$ref": "#/components/schemas/StateCreate",
"description": "The state to set"
},
"force": {
"type": "boolean",
"title": "Force",
"description": "If false, orchestration rules will be applied that may alter or prevent the state transition. If True, orchestration rules are not applied.",
"default": false
},
"limit": {
"type": "integer",
"maximum": 50.0,
"minimum": 1.0,
"title": "Limit",
"description": "Maximum number of flow runs to update. Defaults to 50.",
"default": 50
}
},
"type": "object",
"required": [
"state"
],
"title": "Body_bulk_set_flow_run_state_flow_runs_bulk_set_state_post"
},
"Body_count_account_events_events_count_by__countable__post": {
"properties": {
"filter": {
"$ref": "#/components/schemas/EventFilter"
},
"time_unit": {
"$ref": "#/components/schemas/TimeUnit",
"default": "day"
},
"time_interval": {
"type": "number",
"minimum": 0.01,
"title": "Time Interval",
"default": 1.0
}
},
"type": "object",
"required": [
"filter"
],
"title": "Body_count_account_events_events_count_by__countable__post"
},
"Body_count_artifacts_artifacts_count_post": {
"properties": {
"artifacts": {
"$ref": "#/components/schemas/ArtifactFilter"
},
"flow_runs": {
"$ref": "#/components/schemas/FlowRunFilter"
},
"task_runs": {
"$ref": "#/components/schemas/TaskRunFilter"
},
"flows": {
"$ref": "#/components/schemas/FlowFilter"
},
"deployments": {
"$ref": "#/components/schemas/DeploymentFilter"
}
},
"type": "object",
"title": "Body_count_artifacts_artifacts_count_post"
},
"Body_count_block_documents_block_documents_count_post": {
"properties": {
"block_documents": {
"anyOf": [
{
"$ref": "#/components/schemas/BlockDocumentFilter"
},
{
"type": "null"
}
]
},
"block_types": {
"anyOf": [
{
"$ref": "#/components/schemas/BlockTypeFilter"
},
{
"type": "null"
}
]
},
"block_schemas": {
"anyOf": [
{
"$ref": "#/components/schemas/BlockSchemaFilter"
},
{
"type": "null"
}
]
}
},
"type": "object",
"title": "Body_count_block_documents_block_documents_count_post"
},
"Body_count_deployments_by_flow_ui_flows_count_deployments_post": {
"properties": {
"flow_ids": {
"items": {
"type": "string",
"format": "uuid"
},
"type": "array",
"title": "Flow Ids",
"max_items": 200
}
},
"type": "object",
"required": [
"flow_ids"
],
"title": "Body_count_deployments_by_flow_ui_flows_count_deployments_post"
},
"Body_count_deployments_deployments_count_post": {
"properties": {
"flows": {
"anyOf": [
{
"$ref": "#/components/schemas/FlowFilter"
},
{
"type": "null"
}
]
},
"flow_runs": {
"anyOf": [
{
"$ref": "#/components/schemas/FlowRunFilter"
},
{
"type": "null"
}
]
},
"task_runs": {
"anyOf": [
{
"$ref": "#/components/schemas/TaskRunFilter"
},
{
"type": "null"
}
]
},
"deployments": {
"anyOf": [
{
"$ref": "#/components/schemas/DeploymentFilter"
},
{
"type": "null"
}
]
},
"work_pools": {
"anyOf": [
{
"$ref": "#/components/schemas/WorkPoolFilter"
},
{
"type": "null"
}
]
},
"work_pool_queues": {
"anyOf": [
{
"$ref": "#/components/schemas/WorkQueueFilter"
},
{
"type": "null"
}
]
}
},
"type": "object",
"title": "Body_count_deployments_deployments_count_post"
},
"Body_count_flow_runs_flow_runs_count_post": {
"properties": {
"flows": {
"anyOf": [
{
"$ref": "#/components/schemas/FlowFilter"
},
{
"type": "null"
}
]
},
"flow_runs": {
"anyOf": [
{
"$ref": "#/components/schemas/FlowRunFilter"
},
{
"type": "null"
}
]
},
"task_runs": {
"anyOf": [
{
"$ref": "#/components/schemas/TaskRunFilter"
},
{
"type": "null"
}
]
},
"deployments": {
"anyOf": [
{
"$ref": "#/components/schemas/DeploymentFilter"
},
{
"type": "null"
}
]
},
"work_pools": {
"anyOf": [
{
"$ref": "#/components/schemas/WorkPoolFilter"
},
{
"type": "null"
}
]
},
"work_pool_queues": {
"anyOf": [
{
"$ref": "#/components/schemas/WorkQueueFilter"
},
{
"type": "null"
}
]
}
},
"type": "object",
"title": "Body_count_flow_runs_flow_runs_count_post"
},
"Body_count_flows_flows_count_post": {
"properties": {
"flows": {
"$ref": "#/components/schemas/FlowFilter"
},
"flow_runs": {
"$ref": "#/components/schemas/FlowRunFilter"
},
"task_runs": {
"$ref": "#/components/schemas/TaskRunFilter"
},
"deployments": {
"$ref": "#/components/schemas/DeploymentFilter"
},
"work_pools": {
"$ref": "#/components/schemas/WorkPoolFilter"
}
},
"type": "object",
"title": "Body_count_flows_flows_count_post"
},
"Body_count_latest_artifacts_artifacts_latest_count_post": {
"properties": {
"artifacts": {
"$ref": "#/components/schemas/ArtifactCollectionFilter"
},
"flow_runs": {
"$ref": "#/components/schemas/FlowRunFilter"
},
"task_runs": {
"$ref": "#/components/schemas/TaskRunFilter"
},
"flows": {
"$ref": "#/components/schemas/FlowFilter"
},
"deployments": {
"$ref": "#/components/schemas/DeploymentFilter"
}
},
"type": "object",
"title": "Body_count_latest_artifacts_artifacts_latest_count_post"
},
"Body_count_task_runs_by_flow_run_ui_flow_runs_count_task_runs_post": {
"properties": {
"flow_run_ids": {
"items": {
"type": "string",
"format": "uuid"
},
"type": "array",
"title": "Flow Run Ids",
"max_items": 200
}
},
"type": "object",
"required": [
"flow_run_ids"
],
"title": "Body_count_task_runs_by_flow_run_ui_flow_runs_count_task_runs_post"
},
"Body_count_task_runs_task_runs_count_post": {
"properties": {
"flows": {
"$ref": "#/components/schemas/FlowFilter"
},
"flow_runs": {
"$ref": "#/components/schemas/FlowRunFilter"
},
"task_runs": {
"$ref": "#/components/schemas/TaskRunFilter"
},
"deployments": {
"$ref": "#/components/schemas/DeploymentFilter"
}
},
"type": "object",
"title": "Body_count_task_runs_task_runs_count_post"
},
"Body_count_variables_variables_count_post": {
"properties": {
"variables": {
"anyOf": [
{
"$ref": "#/components/schemas/VariableFilter"
},
{
"type": "null"
}
]
}
},
"type": "object",
"title": "Body_count_variables_variables_count_post"
},
"Body_count_work_pools_work_pools_count_post": {
"properties": {
"work_pools": {
"anyOf": [
{
"$ref": "#/components/schemas/WorkPoolFilter"
},
{
"type": "null"
}
]
}
},
"type": "object",
"title": "Body_count_work_pools_work_pools_count_post"
},
"Body_create_flow_run_input_flow_runs__id__input_post": {
"properties": {
"key": {
"type": "string",
"title": "Key",
"description": "The input key"
},
"value": {
"type": "string",
"contentMediaType": "application/octet-stream",
"title": "Value",
"description": "The value of the input"
},
"sender": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Sender",
"description": "The sender of the input"
}
},
"type": "object",
"required": [
"key",
"value"
],
"title": "Body_create_flow_run_input_flow_runs__id__input_post"
},
"Body_decrement_concurrency_limits_v1_concurrency_limits_decrement_post": {
"properties": {
"names": {
"items": {
"type": "string"
},
"type": "array",
"title": "Names",
"description": "The tags to release a slot for"
},
"task_run_id": {
"type": "string",
"format": "uuid",
"title": "Task Run Id",
"description": "The ID of the task run releasing the slot"
}
},
"type": "object",
"required": [
"names",
"task_run_id"
],
"title": "Body_decrement_concurrency_limits_v1_concurrency_limits_decrement_post"
},
"Body_filter_flow_run_input_flow_runs__id__input_filter_post": {
"properties": {
"prefix": {
"type": "string",
"title": "Prefix",
"description": "The input key prefix"
},
"limit": {
"type": "integer",
"title": "Limit",
"description": "The maximum number of results to return",
"default": 1
},
"exclude_keys": {
"items": {
"type": "string"
},
"type": "array",
"title": "Exclude Keys",
"description": "Exclude inputs with these keys",
"default": []
}
},
"type": "object",
"required": [
"prefix"
],
"title": "Body_filter_flow_run_input_flow_runs__id__input_filter_post"
},
"Body_flow_run_history_flow_runs_history_post": {
"properties": {
"history_start": {
"type": "string",
"format": "date-time",
"title": "History Start",
"description": "The history's start time."
},
"history_end": {
"type": "string",
"format": "date-time",
"title": "History End",
"description": "The history's end time."
},
"history_interval_seconds": {
"type": "number",
"format": "time-delta",
"title": "History Interval Seconds",
"description": "The size of each history interval, in seconds. Must be at least 1 second."
},
"flows": {
"anyOf": [
{
"$ref": "#/components/schemas/FlowFilter"
},
{
"type": "null"
}
]
},
"flow_runs": {
"anyOf": [
{
"$ref": "#/components/schemas/FlowRunFilter"
},
{
"type": "null"
}
]
},
"task_runs": {
"anyOf": [
{
"$ref": "#/components/schemas/TaskRunFilter"
},
{
"type": "null"
}
]
},
"deployments": {
"anyOf": [
{
"$ref": "#/components/schemas/DeploymentFilter"
},
{
"type": "null"
}
]
},
"work_pools": {
"anyOf": [
{
"$ref": "#/components/schemas/WorkPoolFilter"
},
{
"type": "null"
}
]
},
"work_queues": {
"anyOf": [
{
"$ref": "#/components/schemas/WorkQueueFilter"
},
{
"type": "null"
}
]
}
},
"type": "object",
"required": [
"history_start",
"history_end",
"history_interval_seconds"
],
"title": "Body_flow_run_history_flow_runs_history_post"
},
"Body_get_scheduled_flow_runs_for_deployments_deployments_get_scheduled_flow_runs_post": {
"properties": {
"deployment_ids": {
"items": {
"type": "string",
"format": "uuid"
},
"type": "array",
"title": "Deployment Ids",
"description": "The deployment IDs to get scheduled runs for"
},
"scheduled_before": {
"type": "string",
"format": "date-time",
"title": "Scheduled Before",
"description": "The maximum time to look for scheduled flow runs"
},
"limit": {
"type": "integer",
"title": "Limit",
"description": "Defaults to PREFECT_API_DEFAULT_LIMIT if not provided."
}
},
"type": "object",
"required": [
"deployment_ids"
],
"title": "Body_get_scheduled_flow_runs_for_deployments_deployments_get_scheduled_flow_runs_post"
},
"Body_get_scheduled_flow_runs_work_pools__name__get_scheduled_flow_runs_post": {
"properties": {
"work_queue_names": {
"items": {
"type": "string"
},
"type": "array",
"title": "Work Queue Names",
"description": "The names of work pool queues"
},
"scheduled_before": {
"type": "string",
"format": "date-time",
"title": "Scheduled Before",
"description": "The maximum time to look for scheduled flow runs"
},
"scheduled_after": {
"type": "string",
"format": "date-time",
"title": "Scheduled After",
"description": "The minimum time to look for scheduled flow runs"
},
"limit": {
"type": "integer",
"title": "Limit",
"description": "Defaults to PREFECT_API_DEFAULT_LIMIT if not provided."
}
},
"type": "object",
"title": "Body_get_scheduled_flow_runs_work_pools__name__get_scheduled_flow_runs_post"
},
"Body_increment_concurrency_limits_v1_concurrency_limits_increment_post": {
"properties": {
"names": {
"items": {
"type": "string"
},
"type": "array",
"title": "Names",
"description": "The tags to acquire a slot for"
},
"task_run_id": {
"type": "string",
"format": "uuid",
"title": "Task Run Id",
"description": "The ID of the task run acquiring the slot"
}
},
"type": "object",
"required": [
"names",
"task_run_id"
],
"title": "Body_increment_concurrency_limits_v1_concurrency_limits_increment_post"
},
"Body_next_runs_by_flow_ui_flows_next_runs_post": {
"properties": {
"flow_ids": {
"items": {
"type": "string",
"format": "uuid"
},
"type": "array",
"title": "Flow Ids",
"max_items": 200
}
},
"type": "object",
"required": [
"flow_ids"
],
"title": "Body_next_runs_by_flow_ui_flows_next_runs_post"
},
"Body_paginate_deployments_deployments_paginate_post": {
"properties": {
"page": {
"type": "integer",
"minimum": 1.0,
"title": "Page",
"default": 1
},
"flows": {
"anyOf": [
{
"$ref": "#/components/schemas/FlowFilter"
},
{
"type": "null"
}
]
},
"flow_runs": {
"anyOf": [
{
"$ref": "#/components/schemas/FlowRunFilter"
},
{
"type": "null"
}
]
},
"task_runs": {
"anyOf": [
{
"$ref": "#/components/schemas/TaskRunFilter"
},
{
"type": "null"
}
]
},
"deployments": {
"anyOf": [
{
"$ref": "#/components/schemas/DeploymentFilter"
},
{
"type": "null"
}
]
},
"work_pools": {
"anyOf": [
{
"$ref": "#/components/schemas/WorkPoolFilter"
},
{
"type": "null"
}
]
},
"work_pool_queues": {
"anyOf": [
{
"$ref": "#/components/schemas/WorkQueueFilter"
},
{
"type": "null"
}
]
},
"sort": {
"$ref": "#/components/schemas/DeploymentSort",
"default": "NAME_ASC"
},
"limit": {
"type": "integer",
"title": "Limit",
"description": "Defaults to PREFECT_API_DEFAULT_LIMIT if not provided."
}
},
"type": "object",
"title": "Body_paginate_deployments_deployments_paginate_post"
},
"Body_paginate_flow_runs_flow_runs_paginate_post": {
"properties": {
"sort": {
"$ref": "#/components/schemas/FlowRunSort",
"default": "ID_DESC"
},
"page": {
"type": "integer",
"minimum": 1.0,
"title": "Page",
"default": 1
},
"flows": {
"anyOf": [
{
"$ref": "#/components/schemas/FlowFilter"
},
{
"type": "null"
}
]
},
"flow_runs": {
"anyOf": [
{
"$ref": "#/components/schemas/FlowRunFilter"
},
{
"type": "null"
}
]
},
"task_runs": {
"anyOf": [
{
"$ref": "#/components/schemas/TaskRunFilter"
},
{
"type": "null"
}
]
},
"deployments": {
"anyOf": [
{
"$ref": "#/components/schemas/DeploymentFilter"
},
{
"type": "null"
}
]
},
"work_pools": {
"anyOf": [
{
"$ref": "#/components/schemas/WorkPoolFilter"
},
{
"type": "null"
}
]
},
"work_pool_queues": {
"anyOf": [
{
"$ref": "#/components/schemas/WorkQueueFilter"
},
{
"type": "null"
}
]
},
"limit": {
"type": "integer",
"title": "Limit",
"description": "Defaults to PREFECT_API_DEFAULT_LIMIT if not provided."
}
},
"type": "object",
"title": "Body_paginate_flow_runs_flow_runs_paginate_post"
},
"Body_paginate_flows_flows_paginate_post": {
"properties": {
"page": {
"type": "integer",
"minimum": 1.0,
"title": "Page",
"default": 1
},
"flows": {
"anyOf": [
{
"$ref": "#/components/schemas/FlowFilter"
},
{
"type": "null"
}
]
},
"flow_runs": {
"anyOf": [
{
"$ref": "#/components/schemas/FlowRunFilter"
},
{
"type": "null"
}
]
},
"task_runs": {
"anyOf": [
{
"$ref": "#/components/schemas/TaskRunFilter"
},
{
"type": "null"
}
]
},
"deployments": {
"anyOf": [
{
"$ref": "#/components/schemas/DeploymentFilter"
},
{
"type": "null"
}
]
},
"work_pools": {
"anyOf": [
{
"$ref": "#/components/schemas/WorkPoolFilter"
},
{
"type": "null"
}
]
},
"sort": {
"$ref": "#/components/schemas/FlowSort",
"default": "NAME_ASC"
},
"limit": {
"type": "integer",
"title": "Limit",
"description": "Defaults to PREFECT_API_DEFAULT_LIMIT if not provided."
}
},
"type": "object",
"title": "Body_paginate_flows_flows_paginate_post"
},
"Body_paginate_task_runs_task_runs_paginate_post": {
"properties": {
"sort": {
"$ref": "#/components/schemas/TaskRunSort",
"default": "ID_DESC"
},
"page": {
"type": "integer",
"minimum": 1.0,
"title": "Page",
"default": 1
},
"flows": {
"anyOf": [
{
"$ref": "#/components/schemas/FlowFilter"
},
{
"type": "null"
}
]
},
"flow_runs": {
"anyOf": [
{
"$ref": "#/components/schemas/FlowRunFilter"
},
{
"type": "null"
}
]
},
"task_runs": {
"anyOf": [
{
"$ref": "#/components/schemas/TaskRunFilter"
},
{
"type": "null"
}
]
},
"deployments": {
"anyOf": [
{
"$ref": "#/components/schemas/DeploymentFilter"
},
{
"type": "null"
}
]
},
"limit": {
"type": "integer",
"title": "Limit",
"description": "Defaults to PREFECT_API_DEFAULT_LIMIT if not provided."
}
},
"type": "object",
"title": "Body_paginate_task_runs_task_runs_paginate_post"
},
"Body_read_all_concurrency_limits_v2_v2_concurrency_limits_filter_post": {
"properties": {
"offset": {
"type": "integer",
"minimum": 0.0,
"title": "Offset",
"default": 0
},
"limit": {
"type": "integer",
"title": "Limit",
"description": "Defaults to PREFECT_API_DEFAULT_LIMIT if not provided."
}
},
"type": "object",
"title": "Body_read_all_concurrency_limits_v2_v2_concurrency_limits_filter_post"
},
"Body_read_artifacts_artifacts_filter_post": {
"properties": {
"sort": {
"$ref": "#/components/schemas/ArtifactSort",
"default": "ID_DESC"
},
"offset": {
"type": "integer",
"minimum": 0.0,
"title": "Offset",
"default": 0
},
"artifacts": {
"$ref": "#/components/schemas/ArtifactFilter"
},
"flow_runs": {
"$ref": "#/components/schemas/FlowRunFilter"
},
"task_runs": {
"$ref": "#/components/schemas/TaskRunFilter"
},
"flows": {
"$ref": "#/components/schemas/FlowFilter"
},
"deployments": {
"$ref": "#/components/schemas/DeploymentFilter"
},
"limit": {
"type": "integer",
"title": "Limit",
"description": "Defaults to PREFECT_API_DEFAULT_LIMIT if not provided."
}
},
"type": "object",
"title": "Body_read_artifacts_artifacts_filter_post"
},
"Body_read_automations_automations_filter_post": {
"properties": {
"sort": {
"$ref": "#/components/schemas/AutomationSort",
"default": "NAME_ASC"
},
"offset": {
"type": "integer",
"minimum": 0.0,
"title": "Offset",
"default": 0
},
"automations": {
"anyOf": [
{
"$ref": "#/components/schemas/AutomationFilter"
},
{
"type": "null"
}
]
},
"limit": {
"type": "integer",
"title": "Limit",
"description": "Defaults to PREFECT_API_DEFAULT_LIMIT if not provided."
}
},
"type": "object",
"title": "Body_read_automations_automations_filter_post"
},
"Body_read_block_documents_block_documents_filter_post": {
"properties": {
"block_documents": {
"anyOf": [
{
"$ref": "#/components/schemas/BlockDocumentFilter"
},
{
"type": "null"
}
]
},
"block_types": {
"anyOf": [
{
"$ref": "#/components/schemas/BlockTypeFilter"
},
{
"type": "null"
}
]
},
"block_schemas": {
"anyOf": [
{
"$ref": "#/components/schemas/BlockSchemaFilter"
},
{
"type": "null"
}
]
},
"include_secrets": {
"type": "boolean",
"title": "Include Secrets",
"description": "Whether to include sensitive values in the block document.",
"default": false
},
"sort": {
"anyOf": [
{
"$ref": "#/components/schemas/BlockDocumentSort"
},
{
"type": "null"
}
],
"default": "NAME_ASC"
},
"offset": {
"type": "integer",
"minimum": 0.0,
"title": "Offset",
"default": 0
},
"limit": {
"type": "integer",
"title": "Limit",
"description": "Defaults to PREFECT_API_DEFAULT_LIMIT if not provided."
}
},
"type": "object",
"title": "Body_read_block_documents_block_documents_filter_post"
},
"Body_read_block_schemas_block_schemas_filter_post": {
"properties": {
"block_schemas": {
"anyOf": [
{
"$ref": "#/components/schemas/BlockSchemaFilter"
},
{
"type": "null"
}
]
},
"offset": {
"type": "integer",
"minimum": 0.0,
"title": "Offset",
"default": 0
},
"limit": {
"type": "integer",
"title": "Limit",
"description": "Defaults to PREFECT_API_DEFAULT_LIMIT if not provided."
}
},
"type": "object",
"title": "Body_read_block_schemas_block_schemas_filter_post"
},
"Body_read_block_types_block_types_filter_post": {
"properties": {
"block_types": {
"anyOf": [
{
"$ref": "#/components/schemas/BlockTypeFilter"
},
{
"type": "null"
}
]
},
"block_schemas": {
"anyOf": [
{
"$ref": "#/components/schemas/BlockSchemaFilter"
},
{
"type": "null"
}
]
},
"offset": {
"type": "integer",
"minimum": 0.0,
"title": "Offset",
"default": 0
},
"limit": {
"type": "integer",
"title": "Limit",
"description": "Defaults to PREFECT_API_DEFAULT_LIMIT if not provided."
}
},
"type": "object",
"title": "Body_read_block_types_block_types_filter_post"
},
"Body_read_concurrency_limits_concurrency_limits_filter_post": {
"properties": {
"offset": {
"type": "integer",
"minimum": 0.0,
"title": "Offset",
"default": 0
},
"limit": {
"type": "integer",
"title": "Limit",
"description": "Defaults to PREFECT_API_DEFAULT_LIMIT if not provided."
}
},
"type": "object",
"title": "Body_read_concurrency_limits_concurrency_limits_filter_post"
},
"Body_read_dashboard_task_run_counts_ui_task_runs_dashboard_counts_post": {
"properties": {
"task_runs": {
"$ref": "#/components/schemas/TaskRunFilter"
},
"flows": {
"anyOf": [
{
"$ref": "#/components/schemas/FlowFilter"
},
{
"type": "null"
}
]
},
"flow_runs": {
"anyOf": [
{
"$ref": "#/components/schemas/FlowRunFilter"
},
{
"type": "null"
}
]
},
"deployments": {
"anyOf": [
{
"$ref": "#/components/schemas/DeploymentFilter"
},
{
"type": "null"
}
]
},
"work_pools": {
"anyOf": [
{
"$ref": "#/components/schemas/WorkPoolFilter"
},
{
"type": "null"
}
]
},
"work_queues": {
"anyOf": [
{
"$ref": "#/components/schemas/WorkQueueFilter"
},
{
"type": "null"
}
]
}
},
"type": "object",
"required": [
"task_runs"
],
"title": "Body_read_dashboard_task_run_counts_ui_task_runs_dashboard_counts_post"
},
"Body_read_deployments_deployments_filter_post": {
"properties": {
"offset": {
"type": "integer",
"minimum": 0.0,
"title": "Offset",
"default": 0
},
"flows": {
"anyOf": [
{
"$ref": "#/components/schemas/FlowFilter"
},
{
"type": "null"
}
]
},
"flow_runs": {
"anyOf": [
{
"$ref": "#/components/schemas/FlowRunFilter"
},
{
"type": "null"
}
]
},
"task_runs": {
"anyOf": [
{
"$ref": "#/components/schemas/TaskRunFilter"
},
{
"type": "null"
}
]
},
"deployments": {
"anyOf": [
{
"$ref": "#/components/schemas/DeploymentFilter"
},
{
"type": "null"
}
]
},
"work_pools": {
"anyOf": [
{
"$ref": "#/components/schemas/WorkPoolFilter"
},
{
"type": "null"
}
]
},
"work_pool_queues": {
"anyOf": [
{
"$ref": "#/components/schemas/WorkQueueFilter"
},
{
"type": "null"
}
]
},
"sort": {
"$ref": "#/components/schemas/DeploymentSort",
"default": "NAME_ASC"
},
"limit": {
"type": "integer",
"title": "Limit",
"description": "Defaults to PREFECT_API_DEFAULT_LIMIT if not provided."
}
},
"type": "object",
"title": "Body_read_deployments_deployments_filter_post"
},
"Body_read_events_events_filter_post": {
"properties": {
"filter": {
"anyOf": [
{
"$ref": "#/components/schemas/EventFilter"
},
{
"type": "null"
}
],
"description": "Additional optional filter criteria to narrow down the set of Events"
},
"limit": {
"type": "integer",
"maximum": 50.0,
"minimum": 0.0,
"title": "Limit",
"description": "The number of events to return with each page",
"default": 50
}
},
"type": "object",
"title": "Body_read_events_events_filter_post"
},
"Body_read_flow_run_history_ui_flow_runs_history_post": {
"properties": {
"sort": {
"$ref": "#/components/schemas/FlowRunSort",
"default": "EXPECTED_START_TIME_DESC"
},
"limit": {
"type": "integer",
"maximum": 1000.0,
"title": "Limit",
"default": 1000
},
"offset": {
"type": "integer",
"minimum": 0.0,
"title": "Offset",
"default": 0
},
"flows": {
"$ref": "#/components/schemas/FlowFilter"
},
"flow_runs": {
"$ref": "#/components/schemas/FlowRunFilter"
},
"task_runs": {
"$ref": "#/components/schemas/TaskRunFilter"
},
"deployments": {
"$ref": "#/components/schemas/DeploymentFilter"
},
"work_pools": {
"$ref": "#/components/schemas/WorkPoolFilter"
}
},
"type": "object",
"title": "Body_read_flow_run_history_ui_flow_runs_history_post"
},
"Body_read_flow_runs_flow_runs_filter_post": {
"properties": {
"sort": {
"$ref": "#/components/schemas/FlowRunSort",
"default": "ID_DESC"
},
"offset": {
"type": "integer",
"minimum": 0.0,
"title": "Offset",
"default": 0
},
"flows": {
"anyOf": [
{
"$ref": "#/components/schemas/FlowFilter"
},
{
"type": "null"
}
]
},
"flow_runs": {
"anyOf": [
{
"$ref": "#/components/schemas/FlowRunFilter"
},
{
"type": "null"
}
]
},
"task_runs": {
"anyOf": [
{
"$ref": "#/components/schemas/TaskRunFilter"
},
{
"type": "null"
}
]
},
"deployments": {
"anyOf": [
{
"$ref": "#/components/schemas/DeploymentFilter"
},
{
"type": "null"
}
]
},
"work_pools": {
"anyOf": [
{
"$ref": "#/components/schemas/WorkPoolFilter"
},
{
"type": "null"
}
]
},
"work_pool_queues": {
"anyOf": [
{
"$ref": "#/components/schemas/WorkQueueFilter"
},
{
"type": "null"
}
]
},
"limit": {
"type": "integer",
"title": "Limit",
"description": "Defaults to PREFECT_API_DEFAULT_LIMIT if not provided."
}
},
"type": "object",
"title": "Body_read_flow_runs_flow_runs_filter_post"
},
"Body_read_flows_flows_filter_post": {
"properties": {
"offset": {
"type": "integer",
"minimum": 0.0,
"title": "Offset",
"default": 0
},
"flows": {
"$ref": "#/components/schemas/FlowFilter"
},
"flow_runs": {
"$ref": "#/components/schemas/FlowRunFilter"
},
"task_runs": {
"$ref": "#/components/schemas/TaskRunFilter"
},
"deployments": {
"$ref": "#/components/schemas/DeploymentFilter"
},
"work_pools": {
"$ref": "#/components/schemas/WorkPoolFilter"
},
"sort": {
"$ref": "#/components/schemas/FlowSort",
"default": "NAME_ASC"
},
"limit": {
"type": "integer",
"title": "Limit",
"description": "Defaults to PREFECT_API_DEFAULT_LIMIT if not provided."
}
},
"type": "object",
"title": "Body_read_flows_flows_filter_post"
},
"Body_read_latest_artifacts_artifacts_latest_filter_post": {
"properties": {
"sort": {
"$ref": "#/components/schemas/ArtifactCollectionSort",
"default": "ID_DESC"
},
"offset": {
"type": "integer",
"minimum": 0.0,
"title": "Offset",
"default": 0
},
"artifacts": {
"$ref": "#/components/schemas/ArtifactCollectionFilter"
},
"flow_runs": {
"$ref": "#/components/schemas/FlowRunFilter"
},
"task_runs": {
"$ref": "#/components/schemas/TaskRunFilter"
},
"flows": {
"$ref": "#/components/schemas/FlowFilter"
},
"deployments": {
"$ref": "#/components/schemas/DeploymentFilter"
},
"limit": {
"type": "integer",
"title": "Limit",
"description": "Defaults to PREFECT_API_DEFAULT_LIMIT if not provided."
}
},
"type": "object",
"title": "Body_read_latest_artifacts_artifacts_latest_filter_post"
},
"Body_read_logs_logs_filter_post": {
"properties": {
"offset": {
"type": "integer",
"minimum": 0.0,
"title": "Offset",
"default": 0
},
"logs": {
"anyOf": [
{
"$ref": "#/components/schemas/LogFilter"
},
{
"type": "null"
}
]
},
"sort": {
"$ref": "#/components/schemas/LogSort",
"default": "TIMESTAMP_ASC"
},
"limit": {
"type": "integer",
"title": "Limit",
"description": "Defaults to PREFECT_API_DEFAULT_LIMIT if not provided."
}
},
"type": "object",
"title": "Body_read_logs_logs_filter_post"
},
"Body_read_saved_searches_saved_searches_filter_post": {
"properties": {
"offset": {
"type": "integer",
"minimum": 0.0,
"title": "Offset",
"default": 0
},
"limit": {
"type": "integer",
"title": "Limit",
"description": "Defaults to PREFECT_API_DEFAULT_LIMIT if not provided."
}
},
"type": "object",
"title": "Body_read_saved_searches_saved_searches_filter_post"
},
"Body_read_task_run_counts_by_state_ui_task_runs_count_post": {
"properties": {
"flows": {
"anyOf": [
{
"$ref": "#/components/schemas/FlowFilter"
},
{
"type": "null"
}
]
},
"flow_runs": {
"anyOf": [
{
"$ref": "#/components/schemas/FlowRunFilter"
},
{
"type": "null"
}
]
},
"task_runs": {
"anyOf": [
{
"$ref": "#/components/schemas/TaskRunFilter"
},
{
"type": "null"
}
]
},
"deployments": {
"anyOf": [
{
"$ref": "#/components/schemas/DeploymentFilter"
},
{
"type": "null"
}
]
}
},
"type": "object",
"title": "Body_read_task_run_counts_by_state_ui_task_runs_count_post"
},
"Body_read_task_runs_task_runs_filter_post": {
"properties": {
"sort": {
"$ref": "#/components/schemas/TaskRunSort",
"default": "ID_DESC"
},
"offset": {
"type": "integer",
"minimum": 0.0,
"title": "Offset",
"default": 0
},
"flows": {
"anyOf": [
{
"$ref": "#/components/schemas/FlowFilter"
},
{
"type": "null"
}
]
},
"flow_runs": {
"anyOf": [
{
"$ref": "#/components/schemas/FlowRunFilter"
},
{
"type": "null"
}
]
},
"task_runs": {
"anyOf": [
{
"$ref": "#/components/schemas/TaskRunFilter"
},
{
"type": "null"
}
]
},
"deployments": {
"anyOf": [
{
"$ref": "#/components/schemas/DeploymentFilter"
},
{
"type": "null"
}
]
},
"limit": {
"type": "integer",
"title": "Limit",
"description": "Defaults to PREFECT_API_DEFAULT_LIMIT if not provided."
}
},
"type": "object",
"title": "Body_read_task_runs_task_runs_filter_post"
},
"Body_read_task_workers_task_workers_filter_post": {
"properties": {
"task_worker_filter": {
"anyOf": [
{
"$ref": "#/components/schemas/TaskWorkerFilter"
},
{
"type": "null"
}
],
"description": "The task worker filter"
}
},
"type": "object",
"title": "Body_read_task_workers_task_workers_filter_post"
},
"Body_read_variables_variables_filter_post": {
"properties": {
"offset": {
"type": "integer",
"minimum": 0.0,
"title": "Offset",
"default": 0
},
"variables": {
"anyOf": [
{
"$ref": "#/components/schemas/VariableFilter"
},
{
"type": "null"
}
]
},
"sort": {
"$ref": "#/components/schemas/VariableSort",
"default": "NAME_ASC"
},
"limit": {
"type": "integer",
"title": "Limit",
"description": "Defaults to PREFECT_API_DEFAULT_LIMIT if not provided."
}
},
"type": "object",
"title": "Body_read_variables_variables_filter_post"
},
"Body_read_work_pools_work_pools_filter_post": {
"properties": {
"work_pools": {
"anyOf": [
{
"$ref": "#/components/schemas/WorkPoolFilter"
},
{
"type": "null"
}
]
},
"offset": {
"type": "integer",
"minimum": 0.0,
"title": "Offset",
"default": 0
},
"limit": {
"type": "integer",
"title": "Limit",
"description": "Defaults to PREFECT_API_DEFAULT_LIMIT if not provided."
}
},
"type": "object",
"title": "Body_read_work_pools_work_pools_filter_post"
},
"Body_read_work_queue_runs_work_queues__id__get_runs_post": {
"properties": {
"scheduled_before": {
"type": "string",
"format": "date-time",
"title": "Scheduled Before",
"description": "Only flow runs scheduled to start before this time will be returned."
},
"limit": {
"type": "integer",
"title": "Limit",
"description": "Defaults to PREFECT_API_DEFAULT_LIMIT if not provided."
}
},
"type": "object",
"title": "Body_read_work_queue_runs_work_queues__id__get_runs_post"
},
"Body_read_work_queues_work_pools__work_pool_name__queues_filter_post": {
"properties": {
"work_queues": {
"$ref": "#/components/schemas/WorkQueueFilter"
},
"offset": {
"type": "integer",
"minimum": 0.0,
"title": "Offset",
"default": 0
},
"limit": {
"type": "integer",
"title": "Limit",
"description": "Defaults to PREFECT_API_DEFAULT_LIMIT if not provided."
}
},
"type": "object",
"title": "Body_read_work_queues_work_pools__work_pool_name__queues_filter_post"
},
"Body_read_work_queues_work_queues_filter_post": {
"properties": {
"offset": {
"type": "integer",
"minimum": 0.0,
"title": "Offset",
"default": 0
},
"work_queues": {
"anyOf": [
{
"$ref": "#/components/schemas/WorkQueueFilter"
},
{
"type": "null"
}
]
},
"limit": {
"type": "integer",
"title": "Limit",
"description": "Defaults to PREFECT_API_DEFAULT_LIMIT if not provided."
}
},
"type": "object",
"title": "Body_read_work_queues_work_queues_filter_post"
},
"Body_read_workers_work_pools__work_pool_name__workers_filter_post": {
"properties": {
"workers": {
"anyOf": [
{
"$ref": "#/components/schemas/WorkerFilter"
},
{
"type": "null"
}
]
},
"offset": {
"type": "integer",
"minimum": 0.0,
"title": "Offset",
"default": 0
},
"limit": {
"type": "integer",
"title": "Limit",
"description": "Defaults to PREFECT_API_DEFAULT_LIMIT if not provided."
}
},
"type": "object",
"title": "Body_read_workers_work_pools__work_pool_name__workers_filter_post"
},
"Body_renew_concurrency_lease_v2_concurrency_limits_leases__lease_id__renew_post": {
"properties": {
"lease_duration": {
"type": "number",
"maximum": 86400.0,
"minimum": 60.0,
"title": "Lease Duration",
"description": "The duration of the lease in seconds.",
"default": 300
}
},
"type": "object",
"title": "Body_renew_concurrency_lease_v2_concurrency_limits_leases__lease_id__renew_post"
},
"Body_reset_concurrency_limit_by_tag_concurrency_limits_tag__tag__reset_post": {
"properties": {
"slot_override": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Slot Override",
"description": "Manual override for active concurrency limit slots."
}
},
"type": "object",
"title": "Body_reset_concurrency_limit_by_tag_concurrency_limits_tag__tag__reset_post"
},
"Body_resume_flow_run_flow_runs__id__resume_post": {
"properties": {
"run_input": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"title": "Run Input"
}
},
"type": "object",
"title": "Body_resume_flow_run_flow_runs__id__resume_post"
},
"Body_schedule_deployment_deployments__id__schedule_post": {
"properties": {
"start_time": {
"type": "string",
"format": "date-time",
"title": "Start Time",
"description": "The earliest date to schedule"
},
"end_time": {
"type": "string",
"format": "date-time",
"title": "End Time",
"description": "The latest date to schedule"
},
"min_time": {
"type": "number",
"format": "time-delta",
"title": "Min Time",
"description": "Runs will be scheduled until at least this long after the `start_time`"
},
"min_runs": {
"type": "integer",
"title": "Min Runs",
"description": "The minimum number of runs to schedule"
},
"max_runs": {
"type": "integer",
"title": "Max Runs",
"description": "The maximum number of runs to schedule"
}
},
"type": "object",
"title": "Body_schedule_deployment_deployments__id__schedule_post"
},
"Body_set_flow_run_state_flow_runs__id__set_state_post": {
"properties": {
"state": {
"$ref": "#/components/schemas/StateCreate",
"description": "The intended state."
},
"force": {
"type": "boolean",
"title": "Force",
"description": "If false, orchestration rules will be applied that may alter or prevent the state transition. If True, orchestration rules are not applied.",
"default": false
}
},
"type": "object",
"required": [
"state"
],
"title": "Body_set_flow_run_state_flow_runs__id__set_state_post"
},
"Body_set_task_run_state_task_runs__id__set_state_post": {
"properties": {
"state": {
"$ref": "#/components/schemas/StateCreate",
"description": "The intended state."
},
"force": {
"type": "boolean",
"title": "Force",
"description": "If false, orchestration rules will be applied that may alter or prevent the state transition. If True, orchestration rules are not applied.",
"default": false
}
},
"type": "object",
"required": [
"state"
],
"title": "Body_set_task_run_state_task_runs__id__set_state_post"
},
"Body_task_run_history_task_runs_history_post": {
"properties": {
"history_start": {
"type": "string",
"format": "date-time",
"title": "History Start",
"description": "The history's start time."
},
"history_end": {
"type": "string",
"format": "date-time",
"title": "History End",
"description": "The history's end time."
},
"history_interval_seconds": {
"type": "number",
"format": "time-delta",
"title": "History Interval Seconds",
"description": "The size of each history interval, in seconds. Must be at least 1 second."
},
"flows": {
"$ref": "#/components/schemas/FlowFilter"
},
"flow_runs": {
"$ref": "#/components/schemas/FlowRunFilter"
},
"task_runs": {
"$ref": "#/components/schemas/TaskRunFilter"
},
"deployments": {
"$ref": "#/components/schemas/DeploymentFilter"
}
},
"type": "object",
"required": [
"history_start",
"history_end",
"history_interval_seconds"
],
"title": "Body_task_run_history_task_runs_history_post"
},
"Body_validate_obj_ui_schemas_validate_post": {
"properties": {
"schema": {
"additionalProperties": true,
"type": "object",
"title": "Schema"
},
"values": {
"additionalProperties": true,
"type": "object",
"title": "Values"
}
},
"type": "object",
"required": [
"schema",
"values"
],
"title": "Body_validate_obj_ui_schemas_validate_post"
},
"Body_worker_heartbeat_work_pools__work_pool_name__workers_heartbeat_post": {
"properties": {
"name": {
"type": "string",
"title": "Name",
"description": "The worker process name"
},
"heartbeat_interval_seconds": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Heartbeat Interval Seconds",
"description": "The worker's heartbeat interval in seconds"
}
},
"type": "object",
"required": [
"name"
],
"title": "Body_worker_heartbeat_work_pools__work_pool_name__workers_heartbeat_post"
},
"CLISettings": {
"properties": {
"colors": {
"type": "boolean",
"title": "Colors",
"description": "If True, use colors in CLI output. If `False`, output will not include colors codes.",
"default": true,
"supported_environment_variables": [
"PREFECT_CLI_COLORS"
]
},
"prompt": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Prompt",
"description": "If `True`, use interactive prompts in CLI commands. If `False`, no interactive prompts will be used. If `None`, the value will be dynamically determined based on the presence of an interactive-enabled terminal.",
"supported_environment_variables": [
"PREFECT_CLI_PROMPT"
]
},
"wrap_lines": {
"type": "boolean",
"title": "Wrap Lines",
"description": "If `True`, wrap text by inserting new lines in long lines in CLI output. If `False`, output will not be wrapped.",
"default": true,
"supported_environment_variables": [
"PREFECT_CLI_WRAP_LINES"
]
}
},
"type": "object",
"title": "CLISettings",
"description": "Settings for controlling CLI behavior"
},
"CallWebhook": {
"properties": {
"type": {
"type": "string",
"const": "call-webhook",
"title": "Type",
"default": "call-webhook"
},
"block_document_id": {
"type": "string",
"format": "uuid",
"title": "Block Document Id",
"description": "The identifier of the webhook block to use"
},
"payload": {
"type": "string",
"title": "Payload",
"description": "An optional templatable payload to send when calling the webhook.",
"default": ""
}
},
"type": "object",
"required": [
"block_document_id"
],
"title": "CallWebhook",
"description": "Call a webhook when an Automation is triggered."
},
"CancelFlowRun": {
"properties": {
"type": {
"type": "string",
"const": "cancel-flow-run",
"title": "Type",
"default": "cancel-flow-run"
}
},
"type": "object",
"title": "CancelFlowRun",
"description": "Cancels a flow run associated with the trigger"
},
"ChangeFlowRunState": {
"properties": {
"type": {
"type": "string",
"const": "change-flow-run-state",
"title": "Type",
"default": "change-flow-run-state"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Name",
"description": "The name of the state to change the flow run to"
},
"state": {
"$ref": "#/components/schemas/StateType",
"description": "The type of the state to change the flow run to"
},
"message": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Message",
"description": "An optional message to associate with the state change"
},
"force": {
"type": "boolean",
"title": "Force",
"description": "Force the state change even if the transition is not allowed",
"default": false
}
},
"type": "object",
"required": [
"state"
],
"title": "ChangeFlowRunState",
"description": "Changes the state of a flow run associated with the trigger"
},
"ClientMetricsSettings": {
"properties": {
"enabled": {
"type": "boolean",
"title": "Enabled",
"description": "Whether or not to enable Prometheus metrics in the client.",
"default": false,
"supported_environment_variables": [
"PREFECT_CLIENT_METRICS_ENABLED",
"PREFECT_CLIENT_ENABLE_METRICS"
]
},
"port": {
"type": "integer",
"title": "Port",
"description": "The port to expose the client Prometheus metrics on.",
"default": 4201,
"supported_environment_variables": [
"PREFECT_CLIENT_METRICS_PORT"
]
}
},
"type": "object",
"title": "ClientMetricsSettings",
"description": "Settings for controlling metrics reporting from the client"
},
"ClientSettings": {
"properties": {
"max_retries": {
"type": "integer",
"minimum": 0.0,
"title": "Max Retries",
"description": "\n The maximum number of retries to perform on failed HTTP requests.\n Defaults to 5. Set to 0 to disable retries.\n See `PREFECT_CLIENT_RETRY_EXTRA_CODES` for details on which HTTP status codes are\n retried.\n ",
"default": 5,
"supported_environment_variables": [
"PREFECT_CLIENT_MAX_RETRIES"
]
},
"retry_jitter_factor": {
"type": "number",
"minimum": 0.0,
"title": "Retry Jitter Factor",
"description": "\n A value greater than or equal to zero to control the amount of jitter added to retried\n client requests. Higher values introduce larger amounts of jitter.\n Set to 0 to disable jitter. See `clamped_poisson_interval` for details on the how jitter\n can affect retry lengths.\n ",
"default": 0.2,
"supported_environment_variables": [
"PREFECT_CLIENT_RETRY_JITTER_FACTOR"
]
},
"retry_extra_codes": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer",
"maximum": 599.0,
"minimum": 100.0
},
{
"items": {
"type": "integer",
"maximum": 599.0,
"minimum": 100.0
},
"type": "array",
"uniqueItems": true
},
{
"type": "null"
}
],
"title": "Retry Extra Codes",
"description": "\n A list of extra HTTP status codes to retry on. Defaults to an empty list.\n 429, 502 and 503 are always retried. Please note that not all routes are idempotent and retrying\n may result in unexpected behavior.\n ",
"examples": [
"404,429,503",
"429",
[
404,
429,
503
]
],
"supported_environment_variables": [
"PREFECT_CLIENT_RETRY_EXTRA_CODES"
]
},
"csrf_support_enabled": {
"type": "boolean",
"title": "Csrf Support Enabled",
"description": "\n Determines if CSRF token handling is active in the Prefect client for API\n requests.\n\n When enabled (`True`), the client automatically manages CSRF tokens by\n retrieving, storing, and including them in applicable state-changing requests\n ",
"default": true,
"supported_environment_variables": [
"PREFECT_CLIENT_CSRF_SUPPORT_ENABLED"
]
},
"custom_headers": {
"additionalProperties": {
"type": "string"
},
"type": "object",
"title": "Custom Headers",
"description": "\n Custom HTTP headers to include with every API request to the Prefect server.\n Headers are specified as key-value pairs. Note that headers like 'User-Agent'\n and CSRF-related headers are managed by Prefect and cannot be overridden.\n ",
"examples": [
{
"X-Custom-Header": "value"
},
{
"Authorization": "Bearer token"
}
],
"supported_environment_variables": [
"PREFECT_CLIENT_CUSTOM_HEADERS"
]
},
"metrics": {
"$ref": "#/components/schemas/ClientMetricsSettings",
"supported_environment_variables": []
}
},
"type": "object",
"title": "ClientSettings",
"description": "Settings for controlling API client behavior"
},
"CloudSettings": {
"properties": {
"api_url": {
"type": "string",
"title": "Api Url",
"description": "API URL for Prefect Cloud. Used for authentication with Prefect Cloud.",
"default": "https://api.prefect.cloud/api",
"supported_environment_variables": [
"PREFECT_CLOUD_API_URL"
]
},
"enable_orchestration_telemetry": {
"type": "boolean",
"title": "Enable Orchestration Telemetry",
"description": "Whether or not to enable orchestration telemetry.",
"default": true,
"supported_environment_variables": [
"PREFECT_CLOUD_ENABLE_ORCHESTRATION_TELEMETRY"
]
},
"max_log_size": {
"type": "integer",
"title": "Max Log Size",
"description": "Maximum size in characters for a single log when sending logs to Prefect Cloud.",
"default": 25000,
"supported_environment_variables": [
"PREFECT_CLOUD_MAX_LOG_SIZE"
]
},
"ui_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Ui Url",
"description": "The URL of the Prefect Cloud UI. If not set, the client will attempt to infer it.",
"supported_environment_variables": [
"PREFECT_CLOUD_UI_URL"
]
}
},
"type": "object",
"title": "CloudSettings",
"description": "Settings for interacting with Prefect Cloud"
},
"CompoundTrigger-Input": {
"properties": {
"type": {
"type": "string",
"const": "compound",
"title": "Type",
"default": "compound"
},
"id": {
"type": "string",
"format": "uuid",
"title": "Id",
"description": "The unique ID of this trigger"
},
"triggers": {
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/EventTrigger"
},
{
"$ref": "#/components/schemas/CompoundTrigger-Input"
},
{
"$ref": "#/components/schemas/SequenceTrigger-Input"
}
]
},
"type": "array",
"title": "Triggers"
},
"within": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Within"
},
"require": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string",
"enum": [
"any",
"all"
]
}
],
"title": "Require"
}
},
"type": "object",
"required": [
"triggers",
"within",
"require"
],
"title": "CompoundTrigger",
"description": "A composite trigger that requires some number of triggers to have\nfired within the given time period"
},
"CompoundTrigger-Output": {
"properties": {
"type": {
"type": "string",
"const": "compound",
"title": "Type",
"default": "compound"
},
"id": {
"type": "string",
"format": "uuid",
"title": "Id",
"description": "The unique ID of this trigger"
},
"triggers": {
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/EventTrigger"
},
{
"$ref": "#/components/schemas/CompoundTrigger-Output"
},
{
"$ref": "#/components/schemas/SequenceTrigger-Output"
}
]
},
"type": "array",
"title": "Triggers"
},
"within": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Within"
},
"require": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string",
"enum": [
"any",
"all"
]
}
],
"title": "Require"
}
},
"type": "object",
"required": [
"triggers",
"within",
"require"
],
"title": "CompoundTrigger",
"description": "A composite trigger that requires some number of triggers to have\nfired within the given time period"
},
"ConcurrencyLeaseHolder": {
"properties": {
"type": {
"type": "string",
"enum": [
"flow_run",
"task_run",
"deployment"
],
"title": "Type"
},
"id": {
"type": "string",
"format": "uuid",
"title": "Id"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"type",
"id"
],
"title": "ConcurrencyLeaseHolder",
"description": "Model for validating concurrency lease holder information."
},
"ConcurrencyLimit": {
"properties": {
"id": {
"type": "string",
"format": "uuid",
"title": "Id"
},
"created": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Created"
},
"updated": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Updated"
},
"tag": {
"type": "string",
"title": "Tag",
"description": "A tag the concurrency limit is applied to."
},
"concurrency_limit": {
"type": "integer",
"title": "Concurrency Limit",
"description": "The concurrency limit."
},
"active_slots": {
"items": {
"type": "string",
"format": "uuid"
},
"type": "array",
"title": "Active Slots",
"description": "A list of active run ids using a concurrency slot"
}
},
"type": "object",
"required": [
"tag",
"concurrency_limit",
"id",
"created",
"updated"
],
"title": "ConcurrencyLimit",
"description": "An ORM representation of a concurrency limit."
},
"ConcurrencyLimitCreate": {
"properties": {
"tag": {
"type": "string",
"title": "Tag",
"description": "A tag the concurrency limit is applied to."
},
"concurrency_limit": {
"type": "integer",
"title": "Concurrency Limit",
"description": "The concurrency limit."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"tag",
"concurrency_limit"
],
"title": "ConcurrencyLimitCreate",
"description": "Data used by the Prefect REST API to create a concurrency limit."
},
"ConcurrencyLimitStrategy": {
"type": "string",
"enum": [
"ENQUEUE",
"CANCEL_NEW"
],
"title": "ConcurrencyLimitStrategy",
"description": "Enumeration of concurrency collision strategies."
},
"ConcurrencyLimitV2": {
"properties": {
"id": {
"type": "string",
"format": "uuid",
"title": "Id"
},
"created": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Created"
},
"updated": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Updated"
},
"active": {
"type": "boolean",
"title": "Active",
"description": "Whether the concurrency limit is active.",
"default": true
},
"name": {
"type": "string",
"pattern": "^[^/%&><]+$",
"title": "Name",
"description": "The name of the concurrency limit."
},
"limit": {
"type": "integer",
"title": "Limit",
"description": "The concurrency limit."
},
"active_slots": {
"type": "integer",
"title": "Active Slots",
"description": "The number of active slots.",
"default": 0
},
"denied_slots": {
"type": "integer",
"title": "Denied Slots",
"description": "The number of denied slots.",
"default": 0
},
"slot_decay_per_second": {
"type": "number",
"title": "Slot Decay Per Second",
"description": "The decay rate for active slots when used as a rate limit.",
"default": 0
},
"avg_slot_occupancy_seconds": {
"type": "number",
"title": "Avg Slot Occupancy Seconds",
"description": "The average amount of time a slot is occupied.",
"default": 2.0
}
},
"type": "object",
"required": [
"name",
"limit",
"id",
"created",
"updated"
],
"title": "ConcurrencyLimitV2",
"description": "An ORM representation of a v2 concurrency limit."
},
"ConcurrencyLimitV2Create": {
"properties": {
"active": {
"type": "boolean",
"title": "Active",
"description": "Whether the concurrency limit is active.",
"default": true
},
"name": {
"type": "string",
"pattern": "^[^/%&><]+$",
"title": "Name",
"description": "The name of the concurrency limit."
},
"limit": {
"type": "integer",
"minimum": 0.0,
"title": "Limit",
"description": "The concurrency limit."
},
"active_slots": {
"type": "integer",
"minimum": 0.0,
"title": "Active Slots",
"description": "The number of active slots.",
"default": 0
},
"denied_slots": {
"type": "integer",
"minimum": 0.0,
"title": "Denied Slots",
"description": "The number of denied slots.",
"default": 0
},
"slot_decay_per_second": {
"type": "number",
"minimum": 0.0,
"title": "Slot Decay Per Second",
"description": "The decay rate for active slots when used as a rate limit.",
"default": 0
}
},
"additionalProperties": false,
"type": "object",
"required": [
"name",
"limit"
],
"title": "ConcurrencyLimitV2Create",
"description": "Data used by the Prefect REST API to create a v2 concurrency limit."
},
"ConcurrencyLimitV2Update": {
"properties": {
"active": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Active"
},
"name": {
"anyOf": [
{
"type": "string",
"pattern": "^[^/%&><]+$"
},
{
"type": "null"
}
],
"title": "Name"
},
"limit": {
"anyOf": [
{
"type": "integer",
"minimum": 0.0
},
{
"type": "null"
}
],
"title": "Limit"
},
"active_slots": {
"anyOf": [
{
"type": "integer",
"minimum": 0.0
},
{
"type": "null"
}
],
"title": "Active Slots"
},
"denied_slots": {
"anyOf": [
{
"type": "integer",
"minimum": 0.0
},
{
"type": "null"
}
],
"title": "Denied Slots"
},
"slot_decay_per_second": {
"anyOf": [
{
"type": "number",
"minimum": 0.0
},
{
"type": "null"
}
],
"title": "Slot Decay Per Second"
}
},
"additionalProperties": false,
"type": "object",
"title": "ConcurrencyLimitV2Update",
"description": "Data used by the Prefect REST API to update a v2 concurrency limit."
},
"ConcurrencyLimitWithLeaseResponse": {
"properties": {
"lease_id": {
"type": "string",
"format": "uuid",
"title": "Lease Id"
},
"limits": {
"items": {
"$ref": "#/components/schemas/MinimalConcurrencyLimitResponse"
},
"type": "array",
"title": "Limits"
}
},
"type": "object",
"required": [
"lease_id",
"limits"
],
"title": "ConcurrencyLimitWithLeaseResponse"
},
"ConcurrencyOptions": {
"properties": {
"collision_strategy": {
"$ref": "#/components/schemas/ConcurrencyLimitStrategy"
},
"grace_period_seconds": {
"anyOf": [
{
"type": "integer",
"maximum": 86400.0,
"minimum": 60.0
},
{
"type": "null"
}
],
"title": "Grace Period Seconds",
"description": "Grace period in seconds for infrastructure to start before concurrency slots are revoked. If not set, falls back to server setting."
}
},
"type": "object",
"required": [
"collision_strategy"
],
"title": "ConcurrencyOptions",
"description": "Class for storing the concurrency config in database."
},
"Constant": {
"properties": {
"input_type": {
"type": "string",
"const": "constant",
"title": "Input Type",
"default": "constant"
},
"type": {
"type": "string",
"title": "Type"
}
},
"type": "object",
"required": [
"type"
],
"title": "Constant",
"description": "Represents constant input value to a task run."
},
"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",
"title": "Cancelled",
"default": 0
},
"CRASHED": {
"type": "integer",
"title": "Crashed",
"default": 0
},
"PAUSED": {
"type": "integer",
"title": "Paused",
"default": 0
},
"CANCELLING": {
"type": "integer",
"title": "Cancelling",
"default": 0
},
"SCHEDULED": {
"type": "integer",
"title": "Scheduled",
"default": 0
}
},
"type": "object",
"title": "CountByState"
},
"Countable": {
"type": "string",
"enum": [
"day",
"time",
"event",
"resource"
],
"title": "Countable"
},
"CreatedBy": {
"properties": {
"id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Id",
"description": "The id of the creator of the object."
},
"type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Type",
"description": "The type of the creator of the object."
},
"display_value": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Display Value",
"description": "The display value for the creator."
}
},
"type": "object",
"title": "CreatedBy"
},
"CronSchedule": {
"properties": {
"cron": {
"type": "string",
"title": "Cron",
"examples": [
"0 0 * * *"
]
},
"timezone": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Timezone",
"examples": [
"America/New_York"
]
},
"day_or": {
"type": "boolean",
"title": "Day Or",
"description": "Control croniter behavior for handling day and day_of_week entries.",
"default": true
}
},
"additionalProperties": false,
"type": "object",
"required": [
"cron"
],
"title": "CronSchedule",
"description": "Cron schedule\n\nNOTE: If the timezone is a DST-observing one, then the schedule will adjust\nitself appropriately. Cron's rules for DST are based on schedule times, not\nintervals. This means that an hourly cron schedule will fire on every new\nschedule hour, not every elapsed hour; for example, when clocks are set back\nthis will result in a two-hour pause as the schedule will fire *the first\ntime* 1am is reached and *the first time* 2am is reached, 120 minutes later.\nLonger schedules, such as one that fires at 9am every morning, will\nautomatically adjust for DST.\n\nArgs:\n cron (str): a valid cron string\n timezone (str): a valid timezone string in IANA tzdata format (for example,\n America/New_York).\n day_or (bool, optional): Control how croniter handles `day` and `day_of_week`\n entries. Defaults to True, matching cron which connects those values using\n OR. If the switch is set to False, the values are connected using AND. This\n behaves like fcron and enables you to e.g. define a job that executes each\n 2nd friday of a month by setting the days of month and the weekday."
},
"CsrfToken": {
"properties": {
"id": {
"type": "string",
"format": "uuid",
"title": "Id"
},
"created": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Created"
},
"updated": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Updated"
},
"token": {
"type": "string",
"title": "Token",
"description": "The CSRF token"
},
"client": {
"type": "string",
"title": "Client",
"description": "The client id associated with the CSRF token"
},
"expiration": {
"type": "string",
"format": "date-time",
"title": "Expiration",
"description": "The expiration time of the CSRF token"
}
},
"type": "object",
"required": [
"token",
"client",
"expiration",
"id",
"created",
"updated"
],
"title": "CsrfToken"
},
"DependencyResult": {
"properties": {
"id": {
"type": "string",
"format": "uuid",
"title": "Id"
},
"name": {
"type": "string",
"title": "Name"
},
"upstream_dependencies": {
"items": {
"$ref": "#/components/schemas/TaskRunResult"
},
"type": "array",
"title": "Upstream Dependencies"
},
"state": {
"anyOf": [
{
"$ref": "#/components/schemas/State"
},
{
"type": "null"
}
]
},
"expected_start_time": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Expected Start Time"
},
"start_time": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start Time"
},
"end_time": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End Time"
},
"total_run_time": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Total Run Time"
},
"estimated_run_time": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Estimated Run Time"
},
"untrackable_result": {
"type": "boolean",
"title": "Untrackable Result"
}
},
"type": "object",
"required": [
"id",
"name",
"upstream_dependencies",
"state",
"expected_start_time",
"start_time",
"end_time",
"total_run_time",
"estimated_run_time",
"untrackable_result"
],
"title": "DependencyResult"
},
"DeploymentBulkDeleteResponse": {
"properties": {
"deleted": {
"items": {
"type": "string",
"format": "uuid"
},
"type": "array",
"title": "Deleted"
}
},
"type": "object",
"title": "DeploymentBulkDeleteResponse",
"description": "Response from bulk deployment deletion."
},
"DeploymentCreate": {
"properties": {
"name": {
"type": "string",
"title": "Name",
"description": "The name of the deployment.",
"examples": [
"my-deployment"
]
},
"flow_id": {
"type": "string",
"format": "uuid",
"title": "Flow Id",
"description": "The ID of the flow associated with the deployment."
},
"paused": {
"type": "boolean",
"title": "Paused",
"description": "Whether or not the deployment is paused.",
"default": false
},
"schedules": {
"items": {
"$ref": "#/components/schemas/DeploymentScheduleCreate"
},
"type": "array",
"title": "Schedules",
"description": "A list of schedules for the deployment."
},
"concurrency_limit": {
"anyOf": [
{
"type": "integer",
"exclusiveMinimum": 0.0
},
{
"type": "null"
}
],
"title": "Concurrency Limit",
"description": "The deployment's concurrency limit."
},
"concurrency_options": {
"anyOf": [
{
"$ref": "#/components/schemas/ConcurrencyOptions"
},
{
"type": "null"
}
],
"description": "The deployment's concurrency options."
},
"global_concurrency_limit_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Global Concurrency Limit Id",
"description": "The ID of the global concurrency limit to apply to the deployment."
},
"enforce_parameter_schema": {
"type": "boolean",
"title": "Enforce Parameter Schema",
"description": "Whether or not the deployment should enforce the parameter schema.",
"default": true
},
"parameter_openapi_schema": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"additionalProperties": true,
"title": "Parameter Openapi Schema",
"description": "The parameter schema of the flow, including defaults."
},
"parameters": {
"additionalProperties": true,
"type": "object",
"title": "Parameters",
"description": "Parameters for flow runs scheduled by the deployment."
},
"tags": {
"items": {
"type": "string"
},
"type": "array",
"title": "Tags",
"description": "A list of deployment tags.",
"examples": [
[
"tag-1",
"tag-2"
]
]
},
"labels": {
"anyOf": [
{
"additionalProperties": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "integer"
},
{
"type": "number"
},
{
"type": "string"
}
]
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Labels",
"description": "A dictionary of key-value labels. Values can be strings, numbers, or booleans.",
"examples": [
{
"key": "value1",
"key2": 42
}
]
},
"pull_steps": {
"anyOf": [
{
"items": {
"additionalProperties": true,
"type": "object"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Pull Steps"
},
"work_queue_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Work Queue Name"
},
"work_pool_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Work Pool Name",
"description": "The name of the deployment's work pool.",
"examples": [
"my-work-pool"
]
},
"storage_document_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Storage Document Id"
},
"infrastructure_document_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Infrastructure Document Id"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Description"
},
"path": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Path"
},
"version": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Version"
},
"entrypoint": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Entrypoint"
},
"job_variables": {
"additionalProperties": true,
"type": "object",
"title": "Job Variables",
"description": "Overrides for the flow's infrastructure configuration."
},
"version_info": {
"anyOf": [
{
"$ref": "#/components/schemas/VersionInfo"
},
{
"type": "null"
}
],
"description": "A description of this version of the deployment."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"name",
"flow_id"
],
"title": "DeploymentCreate",
"description": "Data used by the Prefect REST API to create a deployment."
},
"DeploymentFilter": {
"properties": {
"operator": {
"$ref": "#/components/schemas/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`"
},
"name": {
"anyOf": [
{
"$ref": "#/components/schemas/DeploymentFilterName"
},
{
"type": "null"
}
],
"description": "Filter criteria for `Deployment.name`"
},
"flow_or_deployment_name": {
"anyOf": [
{
"$ref": "#/components/schemas/DeploymentOrFlowNameFilter"
},
{
"type": "null"
}
],
"description": "Filter criteria for `Deployment.name` or `Flow.name`"
},
"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
}
},
"additionalProperties": false,
"type": "object",
"title": "DeploymentFilter",
"description": "Filter for deployments. Only deployments matching all criteria will be returned."
},
"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`."
},
"DeploymentFilterId": {
"properties": {
"any_": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Any",
"description": "A list of deployment ids to include"
},
"not_any_": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Not Any",
"description": "A list of deployment ids to exclude"
}
},
"additionalProperties": false,
"type": "object",
"title": "DeploymentFilterId",
"description": "Filter by `Deployment.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`."
},
"DeploymentFilterPaused": {
"properties": {
"eq_": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Eq",
"description": "Only returns where deployment is/is not paused"
}
},
"additionalProperties": false,
"type": "object",
"title": "DeploymentFilterPaused",
"description": "Filter by `Deployment.paused`."
},
"DeploymentFilterTags": {
"properties": {
"operator": {
"$ref": "#/components/schemas/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. Deployments 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 to include",
"examples": [
[
"tag-1",
"tag-2"
]
]
},
"is_null_": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Is Null",
"description": "If true, only include deployments without tags"
}
},
"additionalProperties": false,
"type": "object",
"title": "DeploymentFilterTags",
"description": "Filter by `Deployment.tags`."
},
"DeploymentFilterWorkQueueName": {
"properties": {
"any_": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Any",
"description": "A list of work queue names to include",
"examples": [
[
"work_queue_1",
"work_queue_2"
]
]
}
},
"additionalProperties": false,
"type": "object",
"title": "DeploymentFilterWorkQueueName",
"description": "Filter by `Deployment.work_queue_name`."
},
"DeploymentFlowRunCreate": {
"properties": {
"state": {
"anyOf": [
{
"$ref": "#/components/schemas/StateCreate"
},
{
"type": "null"
}
],
"description": "The state of the flow run to create"
},
"name": {
"type": "string",
"title": "Name",
"description": "The name of the flow run. Defaults to a random slug if not specified.",
"examples": [
"my-flow-run"
]
},
"parameters": {
"additionalProperties": true,
"type": "object",
"title": "Parameters"
},
"enforce_parameter_schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Enforce Parameter Schema",
"description": "Whether or not to enforce the parameter schema on this run."
},
"context": {
"additionalProperties": true,
"type": "object",
"title": "Context"
},
"infrastructure_document_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Infrastructure Document Id"
},
"empirical_policy": {
"$ref": "#/components/schemas/FlowRunPolicy",
"description": "The empirical policy for the flow run."
},
"tags": {
"items": {
"type": "string"
},
"type": "array",
"title": "Tags",
"description": "A list of tags for the flow run.",
"examples": [
[
"tag-1",
"tag-2"
]
]
},
"idempotency_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Idempotency Key",
"description": "An optional idempotency key. If a flow run with the same idempotency key has already been created, the existing flow run will be returned."
},
"labels": {
"anyOf": [
{
"additionalProperties": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "integer"
},
{
"type": "number"
},
{
"type": "string"
}
]
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Labels",
"description": "A dictionary of key-value labels. Values can be strings, numbers, or booleans.",
"examples": [
{
"key": "value1",
"key2": 42
}
]
},
"parent_task_run_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Parent Task Run Id"
},
"work_queue_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Work Queue Name"
},
"job_variables": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"additionalProperties": true,
"title": "Job Variables"
}
},
"additionalProperties": false,
"type": "object",
"title": "DeploymentFlowRunCreate",
"description": "Data used by the Prefect REST API to create a flow run from a deployment."
},
"DeploymentOrFlowNameFilter": {
"properties": {
"like_": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Like",
"description": "A case-insensitive partial match on deployment or flow names. For example, passing 'example' might match deployments or flows with 'example' in their names."
}
},
"additionalProperties": false,
"type": "object",
"title": "DeploymentOrFlowNameFilter",
"description": "Filter by `Deployment.name` or `Flow.name` with a single input string for ilike filtering."
},
"DeploymentPaginationResponse": {
"properties": {
"results": {
"items": {
"$ref": "#/components/schemas/DeploymentResponse"
},
"type": "array",
"title": "Results"
},
"count": {
"type": "integer",
"title": "Count"
},
"limit": {
"type": "integer",
"title": "Limit"
},
"pages": {
"type": "integer",
"title": "Pages"
},
"page": {
"type": "integer",
"title": "Page"
}
},
"type": "object",
"required": [
"results",
"count",
"limit",
"pages",
"page"
],
"title": "DeploymentPaginationResponse"
},
"DeploymentResponse": {
"properties": {
"id": {
"type": "string",
"format": "uuid",
"title": "Id"
},
"created": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Created"
},
"updated": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Updated"
},
"name": {
"type": "string",
"title": "Name",
"description": "The name of the deployment."
},
"version": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Version",
"description": "An optional version for the deployment."
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Description",
"description": "A description for the deployment."
},
"flow_id": {
"type": "string",
"format": "uuid",
"title": "Flow Id",
"description": "The flow id associated with the deployment."
},
"paused": {
"type": "boolean",
"title": "Paused",
"description": "Whether or not the deployment is paused.",
"default": false
},
"schedules": {
"items": {
"$ref": "#/components/schemas/DeploymentSchedule"
},
"type": "array",
"title": "Schedules",
"description": "A list of schedules for the deployment."
},
"concurrency_limit": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Concurrency Limit",
"description": "DEPRECATED: Prefer `global_concurrency_limit`. Will always be None for backwards compatibility. Will be removed after December 2024.",
"deprecated": true
},
"global_concurrency_limit": {
"anyOf": [
{
"$ref": "#/components/schemas/GlobalConcurrencyLimitResponse"
},
{
"type": "null"
}
],
"description": "The global concurrency limit object for enforcing the maximum number of flow runs that can be active at once."
},
"concurrency_options": {
"anyOf": [
{
"$ref": "#/components/schemas/ConcurrencyOptions"
},
{
"type": "null"
}
],
"description": "The concurrency options for the deployment."
},
"job_variables": {
"additionalProperties": true,
"type": "object",
"title": "Job Variables",
"description": "Overrides to apply to the base infrastructure block at runtime."
},
"parameters": {
"additionalProperties": true,
"type": "object",
"title": "Parameters",
"description": "Parameters for flow runs scheduled by the deployment."
},
"tags": {
"items": {
"type": "string"
},
"type": "array",
"title": "Tags",
"description": "A list of tags for the deployment",
"examples": [
[
"tag-1",
"tag-2"
]
]
},
"labels": {
"additionalProperties": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "integer"
},
{
"type": "number"
},
{
"type": "string"
}
]
},
"type": "object",
"title": "Labels",
"description": "A dictionary of key-value labels. Values can be strings, numbers, or booleans.",
"examples": [
{
"key": "value1",
"key2": 42
}
]
},
"work_queue_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Work Queue Name",
"description": "The work queue for the deployment. If no work queue is set, work will not be scheduled."
},
"work_queue_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Work Queue Id",
"description": "The id of the work pool queue to which this deployment is assigned."
},
"last_polled": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Last Polled",
"description": "The last time the deployment was polled for status updates."
},
"parameter_openapi_schema": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"additionalProperties": true,
"title": "Parameter Openapi Schema",
"description": "The parameter schema of the flow, including defaults."
},
"path": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Path",
"description": "The path to the working directory for the workflow, relative to remote storage or an absolute path."
},
"pull_steps": {
"anyOf": [
{
"items": {
"additionalProperties": true,
"type": "object"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Pull Steps",
"description": "Pull steps for cloning and running this deployment."
},
"entrypoint": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Entrypoint",
"description": "The path to the entrypoint for the workflow, relative to the `path`."
},
"storage_document_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Storage Document Id",
"description": "The block document defining storage used for this flow."
},
"infrastructure_document_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Infrastructure Document Id",
"description": "The block document defining infrastructure to use for flow runs."
},
"created_by": {
"anyOf": [
{
"$ref": "#/components/schemas/CreatedBy"
},
{
"type": "null"
}
],
"description": "Optional information about the creator of this deployment."
},
"updated_by": {
"anyOf": [
{
"$ref": "#/components/schemas/UpdatedBy"
},
{
"type": "null"
}
],
"description": "Optional information about the updater of this deployment."
},
"work_pool_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Work Pool Name",
"description": "The name of the deployment's work pool."
},
"status": {
"anyOf": [
{
"$ref": "#/components/schemas/DeploymentStatus"
},
{
"type": "null"
}
],
"description": "Whether the deployment is ready to run flows.",
"default": "NOT_READY"
},
"enforce_parameter_schema": {
"type": "boolean",
"title": "Enforce Parameter Schema",
"description": "Whether or not the deployment should enforce the parameter schema.",
"default": true
}
},
"type": "object",
"required": [
"name",
"flow_id",
"id",
"created",
"updated"
],
"title": "DeploymentResponse"
},
"DeploymentSchedule": {
"properties": {
"id": {
"type": "string",
"format": "uuid",
"title": "Id"
},
"created": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Created"
},
"updated": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Updated"
},
"deployment_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Deployment Id",
"description": "The deployment id associated with this schedule."
},
"schedule": {
"anyOf": [
{
"$ref": "#/components/schemas/IntervalSchedule"
},
{
"$ref": "#/components/schemas/CronSchedule"
},
{
"$ref": "#/components/schemas/RRuleSchedule"
}
],
"title": "Schedule",
"description": "The schedule for the deployment."
},
"active": {
"type": "boolean",
"title": "Active",
"description": "Whether or not the schedule is active.",
"default": true
},
"max_scheduled_runs": {
"anyOf": [
{
"type": "integer",
"exclusiveMinimum": 0.0
},
{
"type": "null"
}
],
"title": "Max Scheduled Runs",
"description": "The maximum number of scheduled runs for the schedule."
},
"parameters": {
"additionalProperties": true,
"type": "object",
"title": "Parameters",
"description": "A dictionary of parameter value overrides."
},
"slug": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Slug",
"description": "A unique slug for the schedule."
}
},
"type": "object",
"required": [
"schedule",
"id",
"created",
"updated"
],
"title": "DeploymentSchedule"
},
"DeploymentScheduleCreate": {
"properties": {
"active": {
"type": "boolean",
"title": "Active",
"description": "Whether or not the schedule is active.",
"default": true
},
"schedule": {
"anyOf": [
{
"$ref": "#/components/schemas/IntervalSchedule"
},
{
"$ref": "#/components/schemas/CronSchedule"
},
{
"$ref": "#/components/schemas/RRuleSchedule"
}
],
"title": "Schedule",
"description": "The schedule for the deployment."
},
"max_scheduled_runs": {
"anyOf": [
{
"type": "integer",
"exclusiveMinimum": 0.0
},
{
"type": "null"
}
],
"title": "Max Scheduled Runs",
"description": "The maximum number of scheduled runs for the schedule."
},
"parameters": {
"additionalProperties": true,
"type": "object",
"title": "Parameters",
"description": "A dictionary of parameter value overrides."
},
"slug": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Slug",
"description": "A unique identifier for the schedule."
},
"replaces": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Replaces",
"description": "The slug of an existing schedule that this schedule replaces. Used for renaming slugs."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"schedule"
],
"title": "DeploymentScheduleCreate"
},
"DeploymentScheduleUpdate": {
"properties": {
"active": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Active",
"description": "Whether or not the schedule is active."
},
"schedule": {
"anyOf": [
{
"$ref": "#/components/schemas/IntervalSchedule"
},
{
"$ref": "#/components/schemas/CronSchedule"
},
{
"$ref": "#/components/schemas/RRuleSchedule"
},
{
"type": "null"
}
],
"title": "Schedule",
"description": "The schedule for the deployment."
},
"max_scheduled_runs": {
"anyOf": [
{
"type": "integer",
"exclusiveMinimum": 0.0
},
{
"type": "null"
}
],
"title": "Max Scheduled Runs",
"description": "The maximum number of scheduled runs for the schedule."
},
"parameters": {
"additionalProperties": true,
"type": "object",
"title": "Parameters",
"description": "A dictionary of parameter value overrides."
},
"slug": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Slug",
"description": "A unique identifier for the schedule."
},
"replaces": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Replaces",
"description": "The slug of an existing schedule that this schedule replaces. Used for renaming slugs."
}
},
"additionalProperties": false,
"type": "object",
"title": "DeploymentScheduleUpdate"
},
"DeploymentSort": {
"type": "string",
"enum": [
"CREATED_DESC",
"UPDATED_DESC",
"NAME_ASC",
"NAME_DESC"
],
"title": "DeploymentSort",
"description": "Defines deployment sorting options."
},
"DeploymentStatus": {
"type": "string",
"enum": [
"READY",
"NOT_READY"
],
"title": "DeploymentStatus",
"description": "Enumeration of deployment statuses."
},
"DeploymentUpdate": {
"properties": {
"version": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Version"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Description"
},
"paused": {
"type": "boolean",
"title": "Paused",
"description": "Whether or not the deployment is paused.",
"default": false
},
"schedules": {
"items": {
"$ref": "#/components/schemas/DeploymentScheduleUpdate"
},
"type": "array",
"title": "Schedules",
"description": "A list of schedules for the deployment."
},
"concurrency_limit": {
"anyOf": [
{
"type": "integer",
"exclusiveMinimum": 0.0
},
{
"type": "null"
}
],
"title": "Concurrency Limit",
"description": "The deployment's concurrency limit."
},
"concurrency_options": {
"anyOf": [
{
"$ref": "#/components/schemas/ConcurrencyOptions"
},
{
"type": "null"
}
],
"description": "The deployment's concurrency options."
},
"global_concurrency_limit_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Global Concurrency Limit Id",
"description": "The ID of the global concurrency limit to apply to the deployment."
},
"parameters": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"title": "Parameters",
"description": "Parameters for flow runs scheduled by the deployment."
},
"parameter_openapi_schema": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"title": "Parameter Openapi Schema",
"description": "The parameter schema of the flow, including defaults."
},
"tags": {
"items": {
"type": "string"
},
"type": "array",
"title": "Tags",
"description": "A list of deployment tags.",
"examples": [
[
"tag-1",
"tag-2"
]
]
},
"work_queue_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Work Queue Name"
},
"work_pool_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Work Pool Name",
"description": "The name of the deployment's work pool.",
"examples": [
"my-work-pool"
]
},
"path": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Path"
},
"job_variables": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"title": "Job Variables",
"description": "Overrides for the flow's infrastructure configuration."
},
"pull_steps": {
"anyOf": [
{
"items": {
"additionalProperties": true,
"type": "object"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Pull Steps"
},
"entrypoint": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Entrypoint"
},
"storage_document_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Storage Document Id"
},
"infrastructure_document_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Infrastructure Document Id"
},
"enforce_parameter_schema": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Enforce Parameter Schema",
"description": "Whether or not the deployment should enforce the parameter schema."
},
"version_info": {
"anyOf": [
{
"$ref": "#/components/schemas/VersionInfo"
},
{
"type": "null"
}
],
"description": "A description of this version of the deployment."
}
},
"additionalProperties": false,
"type": "object",
"title": "DeploymentUpdate",
"description": "Data used by the Prefect REST API to update a deployment."
},
"DeploymentsSettings": {
"properties": {
"default_work_pool_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Default Work Pool Name",
"description": "The default work pool to use when creating deployments.",
"supported_environment_variables": [
"PREFECT_DEPLOYMENTS_DEFAULT_WORK_POOL_NAME",
"PREFECT_DEFAULT_WORK_POOL_NAME"
]
},
"default_docker_build_namespace": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Default Docker Build Namespace",
"description": "The default Docker namespace to use when building images.",
"examples": [
"my-dockerhub-registry",
"4999999999999.dkr.ecr.us-east-2.amazonaws.com/my-ecr-repo"
],
"supported_environment_variables": [
"PREFECT_DEPLOYMENTS_DEFAULT_DOCKER_BUILD_NAMESPACE",
"PREFECT_DEFAULT_DOCKER_BUILD_NAMESPACE"
]
}
},
"type": "object",
"title": "DeploymentsSettings",
"description": "Settings for configuring deployments defaults"
},
"DoNothing": {
"properties": {
"type": {
"type": "string",
"const": "do-nothing",
"title": "Type",
"default": "do-nothing"
}
},
"type": "object",
"title": "DoNothing",
"description": "Do nothing when an Automation is triggered"
},
"Edge": {
"properties": {
"id": {
"type": "string",
"format": "uuid",
"title": "Id"
}
},
"type": "object",
"required": [
"id"
],
"title": "Edge"
},
"Event": {
"properties": {
"occurred": {
"type": "string",
"format": "date-time",
"title": "Occurred",
"description": "When the event happened from the sender's perspective"
},
"event": {
"type": "string",
"title": "Event",
"description": "The name of the event that happened"
},
"resource": {
"$ref": "#/components/schemas/Resource",
"description": "The primary Resource this event concerns"
},
"related": {
"items": {
"$ref": "#/components/schemas/RelatedResource"
},
"type": "array",
"title": "Related",
"description": "A list of additional Resources involved in this event"
},
"payload": {
"additionalProperties": true,
"type": "object",
"title": "Payload",
"description": "An open-ended set of data describing what happened"
},
"id": {
"type": "string",
"format": "uuid",
"title": "Id",
"description": "The client-provided identifier of this event"
},
"follows": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Follows",
"description": "The ID of an event that is known to have occurred prior to this one. If set, this may be used to establish a more precise ordering of causally-related events when they occur close enough together in time that the system may receive them out-of-order."
}
},
"type": "object",
"required": [
"occurred",
"event",
"resource",
"id"
],
"title": "Event",
"description": "The client-side view of an event that has happened to a Resource"
},
"EventAnyResourceFilter": {
"properties": {
"id": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Id",
"description": "Only include events for resources with these IDs"
},
"id_prefix": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Id Prefix",
"description": "Only include events for resources with IDs starting with these prefixes"
},
"labels": {
"anyOf": [
{
"$ref": "#/components/schemas/ResourceSpecification"
},
{
"type": "null"
}
],
"description": "Only include events for related resources with these labels"
}
},
"additionalProperties": false,
"type": "object",
"title": "EventAnyResourceFilter"
},
"EventCount": {
"properties": {
"value": {
"type": "string",
"title": "Value",
"description": "The value to use for filtering"
},
"label": {
"type": "string",
"title": "Label",
"description": "The value to display for this count"
},
"count": {
"type": "integer",
"title": "Count",
"description": "The count of matching events"
},
"start_time": {
"type": "string",
"format": "date-time",
"title": "Start Time",
"description": "The start time of this group of events"
},
"end_time": {
"type": "string",
"format": "date-time",
"title": "End Time",
"description": "The end time of this group of events"
}
},
"type": "object",
"required": [
"value",
"label",
"count",
"start_time",
"end_time"
],
"title": "EventCount",
"description": "The count of events with the given filter value"
},
"EventFilter": {
"properties": {
"occurred": {
"$ref": "#/components/schemas/EventOccurredFilter",
"description": "Filter criteria for when the events occurred"
},
"event": {
"anyOf": [
{
"$ref": "#/components/schemas/EventNameFilter"
},
{
"type": "null"
}
],
"description": "Filter criteria for the event name"
},
"resource": {
"anyOf": [
{
"$ref": "#/components/schemas/EventResourceFilter"
},
{
"type": "null"
}
],
"description": "Filter criteria for the resource of the event"
},
"related": {
"anyOf": [
{
"$ref": "#/components/schemas/EventRelatedFilter"
},
{
"items": {
"$ref": "#/components/schemas/EventRelatedFilter"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Related",
"description": "Filter criteria for the related resources of the event"
},
"any_resource": {
"anyOf": [
{
"$ref": "#/components/schemas/EventAnyResourceFilter"
},
{
"items": {
"$ref": "#/components/schemas/EventAnyResourceFilter"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Any Resource",
"description": "Filter criteria for any resource involved in the event"
},
"id": {
"$ref": "#/components/schemas/EventIDFilter",
"description": "Filter criteria for the events' ID"
},
"text": {
"anyOf": [
{
"$ref": "#/components/schemas/EventTextFilter"
},
{
"type": "null"
}
],
"description": "Filter criteria for text search across event content"
},
"order": {
"$ref": "#/components/schemas/EventOrder",
"description": "The order to return filtered events",
"default": "DESC"
}
},
"additionalProperties": false,
"type": "object",
"title": "EventFilter"
},
"EventIDFilter": {
"properties": {
"id": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Id",
"description": "Only include events with one of these IDs"
}
},
"additionalProperties": false,
"type": "object",
"title": "EventIDFilter"
},
"EventNameFilter": {
"properties": {
"prefix": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Prefix",
"description": "Only include events matching one of these prefixes"
},
"exclude_prefix": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Exclude Prefix",
"description": "Exclude events matching one of these prefixes"
},
"name": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Name",
"description": "Only include events matching one of these names exactly"
},
"exclude_name": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Exclude Name",
"description": "Exclude events matching one of these names exactly"
}
},
"additionalProperties": false,
"type": "object",
"title": "EventNameFilter"
},
"EventOccurredFilter": {
"properties": {
"since": {
"type": "string",
"format": "date-time",
"title": "Since",
"description": "Only include events after this time (inclusive)"
},
"until": {
"type": "string",
"format": "date-time",
"title": "Until",
"description": "Only include events prior to this time (inclusive)"
}
},
"additionalProperties": false,
"type": "object",
"title": "EventOccurredFilter"
},
"EventOrder": {
"type": "string",
"enum": [
"ASC",
"DESC"
],
"title": "EventOrder"
},
"EventPage": {
"properties": {
"events": {
"items": {
"$ref": "#/components/schemas/ReceivedEvent"
},
"type": "array",
"title": "Events",
"description": "The Events matching the query"
},
"total": {
"type": "integer",
"title": "Total",
"description": "The total number of matching Events"
},
"next_page": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"format": "uri"
},
{
"type": "null"
}
],
"title": "Next Page",
"description": "The URL for the next page of results, if there are more"
}
},
"type": "object",
"required": [
"events",
"total",
"next_page"
],
"title": "EventPage",
"description": "A single page of events returned from the API, with an optional link to the\nnext page of results"
},
"EventRelatedFilter": {
"properties": {
"id": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Id",
"description": "Only include events for related resources with these IDs"
},
"role": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Role",
"description": "Only include events for related resources in these roles"
},
"resources_in_roles": {
"anyOf": [
{
"items": {
"prefixItems": [
{
"type": "string"
},
{
"type": "string"
}
],
"type": "array",
"maxItems": 2,
"minItems": 2
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Resources In Roles",
"description": "Only include events with specific related resources in specific roles"
},
"labels": {
"anyOf": [
{
"$ref": "#/components/schemas/ResourceSpecification"
},
{
"type": "null"
}
],
"description": "Only include events for related resources with these labels"
}
},
"additionalProperties": false,
"type": "object",
"title": "EventRelatedFilter"
},
"EventResourceFilter": {
"properties": {
"id": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Id",
"description": "Only include events for resources with these IDs"
},
"id_prefix": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Id Prefix",
"description": "Only include events for resources with IDs starting with these prefixes."
},
"labels": {
"anyOf": [
{
"$ref": "#/components/schemas/ResourceSpecification"
},
{
"type": "null"
}
],
"description": "Only include events for resources with these labels"
},
"distinct": {
"type": "boolean",
"title": "Distinct",
"description": "Only include events for distinct resources",
"default": false
}
},
"additionalProperties": false,
"type": "object",
"title": "EventResourceFilter"
},
"EventTextFilter": {
"properties": {
"query": {
"type": "string",
"maxLength": 200,
"title": "Query",
"description": "Text search query string",
"examples": [
"error",
"error -debug",
"\"connection timeout\"",
"+required -excluded"
]
}
},
"additionalProperties": false,
"type": "object",
"required": [
"query"
],
"title": "EventTextFilter",
"description": "Filter by text search across event content."
},
"EventTrigger": {
"properties": {
"type": {
"type": "string",
"const": "event",
"title": "Type",
"default": "event"
},
"id": {
"type": "string",
"format": "uuid",
"title": "Id",
"description": "The unique ID of this trigger"
},
"match": {
"$ref": "#/components/schemas/ResourceSpecification",
"description": "Labels for resources which this trigger will match."
},
"match_related": {
"anyOf": [
{
"$ref": "#/components/schemas/ResourceSpecification"
},
{
"items": {
"$ref": "#/components/schemas/ResourceSpecification"
},
"type": "array"
}
],
"title": "Match Related",
"description": "Labels for related resources which this trigger will match."
},
"after": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "After",
"description": "The event(s) which must first been seen to fire this trigger. If empty, then fire this trigger immediately. Events may include trailing wildcards, like `prefect.flow-run.*`"
},
"expect": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Expect",
"description": "The event(s) this trigger is expecting to see. If empty, this trigger will match any event. Events may include trailing wildcards, like `prefect.flow-run.*`"
},
"for_each": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "For Each",
"description": "Evaluate the trigger separately for each distinct value of these labels on the resource. By default, labels refer to the primary resource of the triggering event. You may also refer to labels from related resources by specifying `related:<role>:<label>`. This will use the value of that label for the first related resource in that role. For example, `\"for_each\": [\"related:flow:prefect.resource.id\"]` would evaluate the trigger for each flow."
},
"posture": {
"type": "string",
"enum": [
"Reactive",
"Proactive"
],
"title": "Posture",
"description": "The posture of this trigger, either Reactive or Proactive. Reactive triggers respond to the _presence_ of the expected events, while Proactive triggers respond to the _absence_ of those expected events."
},
"threshold": {
"type": "integer",
"title": "Threshold",
"description": "The number of events required for this trigger to fire (for Reactive triggers), or the number of events expected (for Proactive triggers)",
"default": 1
},
"within": {
"type": "number",
"title": "Within",
"description": "The time period over which the events must occur. For Reactive triggers, this may be as low as 0 seconds, but must be at least 10 seconds for Proactive triggers",
"default": 0.0
}
},
"type": "object",
"required": [
"posture"
],
"title": "EventTrigger",
"description": "A trigger that fires based on the presence or absence of events within a given\nperiod of time."
},
"ExperimentsSettings": {
"properties": {
"warn": {
"type": "boolean",
"title": "Warn",
"description": "If `True`, warn on usage of experimental features.",
"default": true,
"supported_environment_variables": [
"PREFECT_EXPERIMENTS_WARN",
"PREFECT_EXPERIMENTAL_WARN"
]
},
"plugins": {
"$ref": "#/components/schemas/PluginsSettings",
"description": "Settings for the experimental plugin system",
"supported_environment_variables": []
}
},
"type": "object",
"title": "ExperimentsSettings",
"description": "Settings for configuring experimental features"
},
"Flow": {
"properties": {
"id": {
"type": "string",
"format": "uuid",
"title": "Id"
},
"created": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Created"
},
"updated": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Updated"
},
"name": {
"type": "string",
"pattern": "^[^/%&><]+$",
"title": "Name",
"description": "The name of the flow",
"examples": [
"my-flow"
]
},
"tags": {
"items": {
"type": "string"
},
"type": "array",
"title": "Tags",
"description": "A list of flow tags",
"examples": [
[
"tag-1",
"tag-2"
]
]
},
"labels": {
"anyOf": [
{
"additionalProperties": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "integer"
},
{
"type": "number"
},
{
"type": "string"
}
]
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Labels",
"description": "A dictionary of key-value labels. Values can be strings, numbers, or booleans.",
"examples": [
{
"key": "value1",
"key2": 42
}
]
}
},
"type": "object",
"required": [
"name",
"id",
"created",
"updated"
],
"title": "Flow",
"description": "An ORM representation of flow data."
},
"FlowBulkDeleteResponse": {
"properties": {
"deleted": {
"items": {
"type": "string",
"format": "uuid"
},
"type": "array",
"title": "Deleted"
}
},
"type": "object",
"title": "FlowBulkDeleteResponse",
"description": "Response from bulk flow deletion."
},
"FlowCreate": {
"properties": {
"name": {
"type": "string",
"pattern": "^[^/%&><]+$",
"title": "Name",
"description": "The name of the flow",
"examples": [
"my-flow"
]
},
"tags": {
"items": {
"type": "string"
},
"type": "array",
"title": "Tags",
"description": "A list of flow tags",
"examples": [
[
"tag-1",
"tag-2"
]
]
},
"labels": {
"anyOf": [
{
"additionalProperties": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "integer"
},
{
"type": "number"
},
{
"type": "string"
}
]
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Labels",
"description": "A dictionary of key-value labels. Values can be strings, numbers, or booleans.",
"examples": [
{
"key": "value1",
"key2": 42
}
]
}
},
"additionalProperties": false,
"type": "object",
"required": [
"name"
],
"title": "FlowCreate",
"description": "Data used by the Prefect REST API to create a flow."
},
"FlowFilter": {
"properties": {
"operator": {
"$ref": "#/components/schemas/Operator",
"description": "Operator for combining filter criteria. Defaults to 'and_'.",
"default": "and_"
},
"id": {
"anyOf": [
{
"$ref": "#/components/schemas/FlowFilterId"
},
{
"type": "null"
}
],
"description": "Filter criteria for `Flow.id`"
},
"deployment": {
"anyOf": [
{
"$ref": "#/components/schemas/FlowFilterDeployment"
},
{
"type": "null"
}
],
"description": "Filter criteria for Flow deployments"
},
"name": {
"anyOf": [
{
"$ref": "#/components/schemas/FlowFilterName"
},
{
"type": "null"
}
],
"description": "Filter criteria for `Flow.name`"
},
"tags": {
"anyOf": [
{
"$ref": "#/components/schemas/FlowFilterTags"
},
{
"type": "null"
}
],
"description": "Filter criteria for `Flow.tags`"
}
},
"additionalProperties": false,
"type": "object",
"title": "FlowFilter",
"description": "Filter for flows. Only flows matching all criteria will be returned."
},
"FlowFilterDeployment": {
"properties": {
"operator": {
"$ref": "#/components/schemas/Operator",
"description": "Operator for combining filter criteria. Defaults to 'and_'.",
"default": "and_"
},
"is_null_": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Is Null",
"description": "If true, only include flows without deployments"
}
},
"additionalProperties": false,
"type": "object",
"title": "FlowFilterDeployment",
"description": "Filter by flows by deployment"
},
"FlowFilterId": {
"properties": {
"any_": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Any",
"description": "A list of flow ids to include"
},
"not_any_": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Not Any",
"description": "A list of flow ids to exclude"
}
},
"additionalProperties": false,
"type": "object",
"title": "FlowFilterId",
"description": "Filter by `Flow.id`."
},
"FlowFilterName": {
"properties": {
"any_": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Any",
"description": "A list of flow names to include",
"examples": [
[
"my-flow-1",
"my-flow-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": "FlowFilterName",
"description": "Filter by `Flow.name`."
},
"FlowFilterTags": {
"properties": {
"operator": {
"$ref": "#/components/schemas/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. Flows will be returned only if their tags are a superset of the list",
"examples": [
[
"tag-1",
"tag-2"
]
]
},
"is_null_": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Is Null",
"description": "If true, only include flows without tags"
}
},
"additionalProperties": false,
"type": "object",
"title": "FlowFilterTags",
"description": "Filter by `Flow.tags`."
},
"FlowPaginationResponse": {
"properties": {
"results": {
"items": {
"$ref": "#/components/schemas/Flow"
},
"type": "array",
"title": "Results"
},
"count": {
"type": "integer",
"title": "Count"
},
"limit": {
"type": "integer",
"title": "Limit"
},
"pages": {
"type": "integer",
"title": "Pages"
},
"page": {
"type": "integer",
"title": "Page"
}
},
"type": "object",
"required": [
"results",
"count",
"limit",
"pages",
"page"
],
"title": "FlowPaginationResponse"
},
"FlowRun": {
"properties": {
"id": {
"type": "string",
"format": "uuid",
"title": "Id"
},
"created": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Created"
},
"updated": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Updated"
},
"name": {
"type": "string",
"title": "Name",
"description": "The name of the flow run. Defaults to a random slug if not specified.",
"examples": [
"my-flow-run"
]
},
"flow_id": {
"type": "string",
"format": "uuid",
"title": "Flow Id",
"description": "The id of the flow being run."
},
"state_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "State Id",
"description": "The id of the flow run's current state."
},
"deployment_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Deployment Id",
"description": "The id of the deployment associated with this flow run, if available."
},
"deployment_version": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Deployment Version",
"description": "The version of the deployment associated with this flow run.",
"examples": [
"1.0"
]
},
"work_queue_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Work Queue Name",
"description": "The work queue that handled this flow run."
},
"flow_version": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Flow Version",
"description": "The version of the flow executed in this flow run.",
"examples": [
"1.0"
]
},
"parameters": {
"additionalProperties": true,
"type": "object",
"title": "Parameters",
"description": "Parameters for the flow run."
},
"idempotency_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Idempotency Key",
"description": "An optional idempotency key for the flow run. Used to ensure the same flow run is not created multiple times."
},
"context": {
"additionalProperties": true,
"type": "object",
"title": "Context",
"description": "Additional context for the flow run.",
"examples": [
{
"my_var": "my_value"
}
]
},
"empirical_policy": {
"$ref": "#/components/schemas/FlowRunPolicy"
},
"tags": {
"items": {
"type": "string"
},
"type": "array",
"title": "Tags",
"description": "A list of tags on the flow run",
"examples": [
[
"tag-1",
"tag-2"
]
]
},
"labels": {
"anyOf": [
{
"additionalProperties": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "integer"
},
{
"type": "number"
},
{
"type": "string"
}
]
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Labels",
"description": "A dictionary of key-value labels. Values can be strings, numbers, or booleans.",
"examples": [
{
"key": "value1",
"key2": 42
}
]
},
"parent_task_run_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Parent Task Run Id",
"description": "If the flow run is a subflow, the id of the 'dummy' task in the parent flow used to track subflow state."
},
"state_type": {
"anyOf": [
{
"$ref": "#/components/schemas/StateType"
},
{
"type": "null"
}
],
"description": "The type of the current flow run state."
},
"state_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "State Name",
"description": "The name of the current flow run state."
},
"run_count": {
"type": "integer",
"title": "Run Count",
"description": "The number of times the flow run was executed.",
"default": 0
},
"expected_start_time": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Expected Start Time",
"description": "The flow run's expected start time."
},
"next_scheduled_start_time": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Next Scheduled Start Time",
"description": "The next time the flow run is scheduled to start."
},
"start_time": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start Time",
"description": "The actual start time."
},
"end_time": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End Time",
"description": "The actual end time."
},
"total_run_time": {
"type": "number",
"title": "Total Run Time",
"description": "Total run time. If the flow run was executed multiple times, the time of each run will be summed.",
"default": 0.0
},
"estimated_run_time": {
"type": "number",
"title": "Estimated Run Time",
"description": "A real-time estimate of the total run time.",
"default": 0.0
},
"estimated_start_time_delta": {
"type": "number",
"title": "Estimated Start Time Delta",
"description": "The difference between actual and expected start time.",
"default": 0.0
},
"auto_scheduled": {
"type": "boolean",
"title": "Auto Scheduled",
"description": "Whether or not the flow run was automatically scheduled.",
"default": false
},
"infrastructure_document_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Infrastructure Document Id",
"description": "The block document defining infrastructure to use this flow run."
},
"infrastructure_pid": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Infrastructure Pid",
"description": "The id of the flow run as returned by an infrastructure block."
},
"created_by": {
"anyOf": [
{
"$ref": "#/components/schemas/CreatedBy"
},
{
"type": "null"
}
],
"description": "Optional information about the creator of this flow run."
},
"work_queue_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Work Queue Id",
"description": "The id of the run's work pool queue."
},
"state": {
"anyOf": [
{
"$ref": "#/components/schemas/State"
},
{
"type": "null"
}
],
"description": "The current state of the flow run."
},
"job_variables": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"title": "Job Variables",
"description": "Variables used as overrides in the base job template"
}
},
"type": "object",
"required": [
"flow_id",
"id",
"created",
"updated"
],
"title": "FlowRun",
"description": "An ORM representation of flow run data."
},
"FlowRunBulkCreateResponse": {
"properties": {
"results": {
"items": {
"$ref": "#/components/schemas/FlowRunCreateResult"
},
"type": "array",
"title": "Results"
}
},
"type": "object",
"title": "FlowRunBulkCreateResponse",
"description": "Response from bulk flow run creation."
},
"FlowRunBulkDeleteResponse": {
"properties": {
"deleted": {
"items": {
"type": "string",
"format": "uuid"
},
"type": "array",
"title": "Deleted"
}
},
"type": "object",
"title": "FlowRunBulkDeleteResponse",
"description": "Response from bulk flow run deletion."
},
"FlowRunBulkSetStateResponse": {
"properties": {
"results": {
"items": {
"$ref": "#/components/schemas/FlowRunOrchestrationResult"
},
"type": "array",
"title": "Results"
}
},
"type": "object",
"title": "FlowRunBulkSetStateResponse",
"description": "Response from bulk set state operation."
},
"FlowRunCreate": {
"properties": {
"state": {
"anyOf": [
{
"$ref": "#/components/schemas/StateCreate"
},
{
"type": "null"
}
],
"description": "The state of the flow run to create"
},
"name": {
"type": "string",
"title": "Name",
"description": "The name of the flow run. Defaults to a random slug if not specified.",
"examples": [
"my-flow-run"
]
},
"flow_id": {
"type": "string",
"format": "uuid",
"title": "Flow Id",
"description": "The id of the flow being run."
},
"flow_version": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Flow Version",
"description": "The version of the flow being run."
},
"parameters": {
"additionalProperties": true,
"type": "object",
"title": "Parameters"
},
"context": {
"additionalProperties": true,
"type": "object",
"title": "Context",
"description": "The context of the flow run."
},
"parent_task_run_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Parent Task Run Id"
},
"infrastructure_document_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Infrastructure Document Id"
},
"empirical_policy": {
"$ref": "#/components/schemas/FlowRunPolicy",
"description": "The empirical policy for the flow run."
},
"tags": {
"items": {
"type": "string"
},
"type": "array",
"title": "Tags",
"description": "A list of tags for the flow run.",
"examples": [
[
"tag-1",
"tag-2"
]
]
},
"labels": {
"anyOf": [
{
"additionalProperties": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "integer"
},
{
"type": "number"
},
{
"type": "string"
}
]
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Labels",
"description": "A dictionary of key-value labels. Values can be strings, numbers, or booleans.",
"examples": [
{
"key": "value1",
"key2": 42
}
]
},
"idempotency_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Idempotency Key",
"description": "An optional idempotency key. If a flow run with the same idempotency key has already been created, the existing flow run will be returned."
},
"work_pool_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Work Pool Name",
"description": "The name of the work pool to run the flow run in."
},
"work_queue_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Work Queue Name",
"description": "The name of the work queue to place the flow run in."
},
"job_variables": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"title": "Job Variables",
"description": "The job variables to use when setting up flow run infrastructure."
},
"deployment_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Deployment Id",
"description": "DEPRECATED: The id of the deployment associated with this flow run, if available.",
"deprecated": true
}
},
"additionalProperties": false,
"type": "object",
"required": [
"flow_id"
],
"title": "FlowRunCreate",
"description": "Data used by the Prefect REST API to create a flow run."
},
"FlowRunCreateResult": {
"properties": {
"flow_run_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Flow Run Id"
},
"status": {
"type": "string",
"enum": [
"CREATED",
"FAILED"
],
"title": "Status"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Error"
}
},
"type": "object",
"required": [
"status"
],
"title": "FlowRunCreateResult",
"description": "Per-run result for bulk create operations."
},
"FlowRunFilter": {
"properties": {
"operator": {
"$ref": "#/components/schemas/Operator",
"description": "Operator for combining filter criteria. Defaults to 'and_'.",
"default": "and_"
},
"id": {
"anyOf": [
{
"$ref": "#/components/schemas/FlowRunFilterId"
},
{
"type": "null"
}
],
"description": "Filter criteria for `FlowRun.id`"
},
"name": {
"anyOf": [
{
"$ref": "#/components/schemas/FlowRunFilterName"
},
{
"type": "null"
}
],
"description": "Filter criteria for `FlowRun.name`"
},
"tags": {
"anyOf": [
{
"$ref": "#/components/schemas/FlowRunFilterTags"
},
{
"type": "null"
}
],
"description": "Filter criteria for `FlowRun.tags`"
},
"deployment_id": {
"anyOf": [
{
"$ref": "#/components/schemas/FlowRunFilterDeploymentId"
},
{
"type": "null"
}
],
"description": "Filter criteria for `FlowRun.deployment_id`"
},
"work_queue_name": {
"anyOf": [
{
"$ref": "#/components/schemas/FlowRunFilterWorkQueueName"
},
{
"type": "null"
}
],
"description": "Filter criteria for `FlowRun.work_queue_name"
},
"state": {
"anyOf": [
{
"$ref": "#/components/schemas/FlowRunFilterState"
},
{
"type": "null"
}
],
"description": "Filter criteria for `FlowRun.state`"
},
"flow_version": {
"anyOf": [
{
"$ref": "#/components/schemas/FlowRunFilterFlowVersion"
},
{
"type": "null"
}
],
"description": "Filter criteria for `FlowRun.flow_version`"
},
"start_time": {
"anyOf": [
{
"$ref": "#/components/schemas/FlowRunFilterStartTime"
},
{
"type": "null"
}
],
"description": "Filter criteria for `FlowRun.start_time`"
},
"end_time": {
"anyOf": [
{
"$ref": "#/components/schemas/FlowRunFilterEndTime"
},
{
"type": "null"
}
],
"description": "Filter criteria for `FlowRun.end_time`"
},
"expected_start_time": {
"anyOf": [
{
"$ref": "#/components/schemas/FlowRunFilterExpectedStartTime"
},
{
"type": "null"
}
],
"description": "Filter criteria for `FlowRun.expected_start_time`"
},
"next_scheduled_start_time": {
"anyOf": [
{
"$ref": "#/components/schemas/FlowRunFilterNextScheduledStartTime"
},
{
"type": "null"
}
],
"description": "Filter criteria for `FlowRun.next_scheduled_start_time`"
},
"parent_flow_run_id": {
"anyOf": [
{
"$ref": "#/components/schemas/FlowRunFilterParentFlowRunId"
},
{
"type": "null"
}
],
"description": "Filter criteria for subflows of the given flow runs"
},
"parent_task_run_id": {
"anyOf": [
{
"$ref": "#/components/schemas/FlowRunFilterParentTaskRunId"
},
{
"type": "null"
}
],
"description": "Filter criteria for `FlowRun.parent_task_run_id`"
},
"idempotency_key": {
"anyOf": [
{
"$ref": "#/components/schemas/FlowRunFilterIdempotencyKey"
},
{
"type": "null"
}
],
"description": "Filter criteria for `FlowRun.idempotency_key`"
},
"created_by": {
"anyOf": [
{
"$ref": "#/components/schemas/FlowRunFilterCreatedBy"
},
{
"type": "null"
}
],
"description": "Filter criteria for `FlowRun.created_by`"
}
},
"additionalProperties": false,
"type": "object",
"title": "FlowRunFilter",
"description": "Filter flow runs. Only flow runs matching all criteria will be returned"
},
"FlowRunFilterCreatedBy": {
"properties": {
"operator": {
"$ref": "#/components/schemas/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. For example, 'DEPLOYMENT' for scheduled runs or 'AUTOMATION' for runs triggered by automations.",
"examples": [
[
"DEPLOYMENT",
"AUTOMATION"
]
]
},
"is_null_": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Is Null",
"description": "If true, only include flow runs without a creator"
}
},
"additionalProperties": false,
"type": "object",
"title": "FlowRunFilterCreatedBy",
"description": "Filter by `FlowRun.created_by`."
},
"FlowRunFilterDeploymentId": {
"properties": {
"operator": {
"$ref": "#/components/schemas/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 deployment ids to include"
},
"is_null_": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Is Null",
"description": "If true, only include flow runs without deployment ids"
}
},
"additionalProperties": false,
"type": "object",
"title": "FlowRunFilterDeploymentId",
"description": "Filter by `FlowRun.deployment_id`."
},
"FlowRunFilterEndTime": {
"properties": {
"before_": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Before",
"description": "Only include flow runs ending at or before this time"
},
"after_": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "After",
"description": "Only include flow runs ending at or after this time"
},
"is_null_": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Is Null",
"description": "If true, only return flow runs without an end time"
}
},
"additionalProperties": false,
"type": "object",
"title": "FlowRunFilterEndTime",
"description": "Filter by `FlowRun.end_time`."
},
"FlowRunFilterExpectedStartTime": {
"properties": {
"before_": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Before",
"description": "Only include flow runs scheduled to start at or before this time"
},
"after_": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "After",
"description": "Only include flow runs scheduled to start at or after this time"
}
},
"additionalProperties": false,
"type": "object",
"title": "FlowRunFilterExpectedStartTime",
"description": "Filter by `FlowRun.expected_start_time`."
},
"FlowRunFilterFlowVersion": {
"properties": {
"any_": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Any",
"description": "A list of flow run flow_versions to include"
}
},
"additionalProperties": false,
"type": "object",
"title": "FlowRunFilterFlowVersion",
"description": "Filter by `FlowRun.flow_version`."
},
"FlowRunFilterId": {
"properties": {
"any_": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Any",
"description": "A list of flow run ids to include"
},
"not_any_": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Not Any",
"description": "A list of flow run ids to exclude"
}
},
"additionalProperties": false,
"type": "object",
"title": "FlowRunFilterId",
"description": "Filter by `FlowRun.id`."
},
"FlowRunFilterIdempotencyKey": {
"properties": {
"any_": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Any",
"description": "A list of flow run idempotency keys to include"
},
"not_any_": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Not Any",
"description": "A list of flow run idempotency keys to exclude"
}
},
"additionalProperties": false,
"type": "object",
"title": "FlowRunFilterIdempotencyKey",
"description": "Filter by FlowRun.idempotency_key."
},
"FlowRunFilterName": {
"properties": {
"any_": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Any",
"description": "A list of flow run names to include",
"examples": [
[
"my-flow-run-1",
"my-flow-run-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": "FlowRunFilterName",
"description": "Filter by `FlowRun.name`."
},
"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`."
},
"FlowRunFilterParentFlowRunId": {
"properties": {
"operator": {
"$ref": "#/components/schemas/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 parent flow run ids to include"
}
},
"additionalProperties": false,
"type": "object",
"title": "FlowRunFilterParentFlowRunId",
"description": "Filter for subflows of a given flow run"
},
"FlowRunFilterParentTaskRunId": {
"properties": {
"operator": {
"$ref": "#/components/schemas/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`."
},
"FlowRunFilterStartTime": {
"properties": {
"before_": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Before",
"description": "Only include flow runs starting at or before this time"
},
"after_": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "After",
"description": "Only include flow runs starting at or after this time"
},
"is_null_": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Is Null",
"description": "If true, only return flow runs without a start time"
}
},
"additionalProperties": false,
"type": "object",
"title": "FlowRunFilterStartTime",
"description": "Filter by `FlowRun.start_time`."
},
"FlowRunFilterState": {
"properties": {
"operator": {
"$ref": "#/components/schemas/Operator",
"description": "Operator for combining filter criteria. Defaults to 'and_'.",
"default": "and_"
},
"type": {
"anyOf": [
{
"$ref": "#/components/schemas/FlowRunFilterStateType"
},
{
"type": "null"
}
],
"description": "Filter criteria for `FlowRun.state_type`"
},
"name": {
"anyOf": [
{
"$ref": "#/components/schemas/FlowRunFilterStateName"
},
{
"type": "null"
}
],
"description": "Filter criteria for `FlowRun.state_name`"
}
},
"additionalProperties": false,
"type": "object",
"title": "FlowRunFilterState",
"description": "Filter by `FlowRun.state_type` and `FlowRun.state_name`."
},
"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",
"description": "Filter by `FlowRun.state_name`."
},
"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`."
},
"FlowRunFilterTags": {
"properties": {
"operator": {
"$ref": "#/components/schemas/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 to include",
"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`."
},
"FlowRunFilterWorkQueueName": {
"properties": {
"operator": {
"$ref": "#/components/schemas/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 work queue names to include",
"examples": [
[
"work_queue_1",
"work_queue_2"
]
]
},
"is_null_": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Is Null",
"description": "If true, only include flow runs without work queue names"
}
},
"additionalProperties": false,
"type": "object",
"title": "FlowRunFilterWorkQueueName",
"description": "Filter by `FlowRun.work_queue_name`."
},
"FlowRunInput": {
"properties": {
"id": {
"type": "string",
"format": "uuid",
"title": "Id"
},
"created": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Created"
},
"updated": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Updated"
},
"flow_run_id": {
"type": "string",
"format": "uuid",
"title": "Flow Run Id",
"description": "The flow run ID associated with the input."
},
"key": {
"type": "string",
"title": "Key",
"description": "The key of the input."
},
"value": {
"type": "string",
"title": "Value",
"description": "The value of the input."
},
"sender": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Sender",
"description": "The sender of the input."
}
},
"type": "object",
"required": [
"flow_run_id",
"key",
"value",
"id",
"created",
"updated"
],
"title": "FlowRunInput"
},
"FlowRunOrchestrationResult": {
"properties": {
"flow_run_id": {
"type": "string",
"format": "uuid",
"title": "Flow Run Id"
},
"status": {
"$ref": "#/components/schemas/SetStateStatus"
},
"state": {
"anyOf": [
{
"$ref": "#/components/schemas/State"
},
{
"type": "null"
}
]
},
"details": {
"anyOf": [
{
"$ref": "#/components/schemas/StateAcceptDetails"
},
{
"$ref": "#/components/schemas/StateWaitDetails"
},
{
"$ref": "#/components/schemas/StateRejectDetails"
},
{
"$ref": "#/components/schemas/StateAbortDetails"
}
],
"title": "Details"
}
},
"type": "object",
"required": [
"flow_run_id",
"status",
"details"
],
"title": "FlowRunOrchestrationResult",
"description": "Per-run result for bulk state operations."
},
"FlowRunPaginationResponse": {
"properties": {
"results": {
"items": {
"$ref": "#/components/schemas/FlowRunResponse"
},
"type": "array",
"title": "Results"
},
"count": {
"type": "integer",
"title": "Count"
},
"limit": {
"type": "integer",
"title": "Limit"
},
"pages": {
"type": "integer",
"title": "Pages"
},
"page": {
"type": "integer",
"title": "Page"
}
},
"type": "object",
"required": [
"results",
"count",
"limit",
"pages",
"page"
],
"title": "FlowRunPaginationResponse"
},
"FlowRunPolicy": {
"properties": {
"max_retries": {
"type": "integer",
"title": "Max Retries",
"description": "The maximum number of retries. Field is not used. Please use `retries` instead.",
"default": 0,
"deprecated": true
},
"retry_delay_seconds": {
"type": "number",
"title": "Retry Delay Seconds",
"description": "The delay between retries. Field is not used. Please use `retry_delay` instead.",
"default": 0,
"deprecated": true
},
"retries": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Retries",
"description": "The number of retries."
},
"retry_delay": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Retry Delay",
"description": "The delay time between retries, in seconds."
},
"pause_keys": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
{
"type": "null"
}
],
"title": "Pause Keys",
"description": "Tracks pauses this run has observed."
},
"resuming": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Resuming",
"description": "Indicates if this run is resuming from a pause.",
"default": false
},
"retry_type": {
"anyOf": [
{
"type": "string",
"enum": [
"in_process",
"reschedule"
]
},
{
"type": "null"
}
],
"title": "Retry Type",
"description": "The type of retry this run is undergoing."
}
},
"type": "object",
"title": "FlowRunPolicy",
"description": "Defines of how a flow run should retry."
},
"FlowRunResponse": {
"properties": {
"id": {
"type": "string",
"format": "uuid",
"title": "Id"
},
"created": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Created"
},
"updated": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Updated"
},
"name": {
"type": "string",
"title": "Name",
"description": "The name of the flow run. Defaults to a random slug if not specified.",
"examples": [
"my-flow-run"
]
},
"flow_id": {
"type": "string",
"format": "uuid",
"title": "Flow Id",
"description": "The id of the flow being run."
},
"state_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "State Id",
"description": "The id of the flow run's current state."
},
"deployment_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Deployment Id",
"description": "The id of the deployment associated with this flow run, if available."
},
"deployment_version": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Deployment Version",
"description": "The version of the deployment associated with this flow run.",
"examples": [
"1.0"
]
},
"work_queue_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Work Queue Id",
"description": "The id of the run's work pool queue."
},
"work_queue_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Work Queue Name",
"description": "The work queue that handled this flow run."
},
"flow_version": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Flow Version",
"description": "The version of the flow executed in this flow run.",
"examples": [
"1.0"
]
},
"parameters": {
"additionalProperties": true,
"type": "object",
"title": "Parameters",
"description": "Parameters for the flow run."
},
"idempotency_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Idempotency Key",
"description": "An optional idempotency key for the flow run. Used to ensure the same flow run is not created multiple times."
},
"context": {
"additionalProperties": true,
"type": "object",
"title": "Context",
"description": "Additional context for the flow run.",
"examples": [
{
"my_var": "my_val"
}
]
},
"empirical_policy": {
"$ref": "#/components/schemas/FlowRunPolicy"
},
"tags": {
"items": {
"type": "string"
},
"type": "array",
"title": "Tags",
"description": "A list of tags on the flow run",
"examples": [
[
"tag-1",
"tag-2"
]
]
},
"labels": {
"additionalProperties": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "integer"
},
{
"type": "number"
},
{
"type": "string"
}
]
},
"type": "object",
"title": "Labels",
"description": "A dictionary of key-value labels. Values can be strings, numbers, or booleans.",
"examples": [
{
"key": "value1",
"key2": 42
}
]
},
"parent_task_run_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Parent Task Run Id",
"description": "If the flow run is a subflow, the id of the 'dummy' task in the parent flow used to track subflow state."
},
"state_type": {
"anyOf": [
{
"$ref": "#/components/schemas/StateType"
},
{
"type": "null"
}
],
"description": "The type of the current flow run state."
},
"state_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "State Name",
"description": "The name of the current flow run state."
},
"run_count": {
"type": "integer",
"title": "Run Count",
"description": "The number of times the flow run was executed.",
"default": 0
},
"expected_start_time": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Expected Start Time",
"description": "The flow run's expected start time."
},
"next_scheduled_start_time": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Next Scheduled Start Time",
"description": "The next time the flow run is scheduled to start."
},
"start_time": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start Time",
"description": "The actual start time."
},
"end_time": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End Time",
"description": "The actual end time."
},
"total_run_time": {
"type": "number",
"title": "Total Run Time",
"description": "Total run time. If the flow run was executed multiple times, the time of each run will be summed.",
"default": 0.0
},
"estimated_run_time": {
"type": "number",
"title": "Estimated Run Time",
"description": "A real-time estimate of the total run time.",
"default": 0.0
},
"estimated_start_time_delta": {
"type": "number",
"title": "Estimated Start Time Delta",
"description": "The difference between actual and expected start time.",
"default": 0.0
},
"auto_scheduled": {
"type": "boolean",
"title": "Auto Scheduled",
"description": "Whether or not the flow run was automatically scheduled.",
"default": false
},
"infrastructure_document_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Infrastructure Document Id",
"description": "The block document defining infrastructure to use this flow run."
},
"infrastructure_pid": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Infrastructure Pid",
"description": "The id of the flow run as returned by an infrastructure block."
},
"created_by": {
"anyOf": [
{
"$ref": "#/components/schemas/CreatedBy"
},
{
"type": "null"
}
],
"description": "Optional information about the creator of this flow run."
},
"work_pool_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Work Pool Id",
"description": "The id of the flow run's work pool."
},
"work_pool_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Work Pool Name",
"description": "The name of the flow run's work pool.",
"examples": [
"my-work-pool"
]
},
"state": {
"anyOf": [
{
"$ref": "#/components/schemas/State"
},
{
"type": "null"
}
],
"description": "The current state of the flow run."
},
"job_variables": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"title": "Job Variables",
"description": "Variables used as overrides in the base job template"
}
},
"type": "object",
"required": [
"flow_id",
"id",
"created",
"updated"
],
"title": "FlowRunResponse"
},
"FlowRunResult": {
"properties": {
"input_type": {
"type": "string",
"const": "flow_run",
"title": "Input Type",
"default": "flow_run"
},
"id": {
"type": "string",
"format": "uuid",
"title": "Id"
}
},
"type": "object",
"required": [
"id"
],
"title": "FlowRunResult"
},
"FlowRunSort": {
"type": "string",
"enum": [
"ID_DESC",
"START_TIME_ASC",
"START_TIME_DESC",
"EXPECTED_START_TIME_ASC",
"EXPECTED_START_TIME_DESC",
"NAME_ASC",
"NAME_DESC",
"NEXT_SCHEDULED_START_TIME_ASC",
"END_TIME_DESC"
],
"title": "FlowRunSort",
"description": "Defines flow run sorting options."
},
"FlowRunUpdate": {
"properties": {
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Name"
},
"flow_version": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Flow Version"
},
"parameters": {
"additionalProperties": true,
"type": "object",
"title": "Parameters"
},
"empirical_policy": {
"$ref": "#/components/schemas/FlowRunPolicy"
},
"tags": {
"items": {
"type": "string"
},
"type": "array",
"title": "Tags"
},
"infrastructure_pid": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Infrastructure Pid"
},
"job_variables": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"title": "Job Variables"
}
},
"additionalProperties": false,
"type": "object",
"title": "FlowRunUpdate",
"description": "Data used by the Prefect REST API to update a flow run."
},
"FlowSort": {
"type": "string",
"enum": [
"CREATED_DESC",
"UPDATED_DESC",
"NAME_ASC",
"NAME_DESC"
],
"title": "FlowSort",
"description": "Defines flow sorting options."
},
"FlowUpdate": {
"properties": {
"tags": {
"items": {
"type": "string"
},
"type": "array",
"title": "Tags",
"description": "A list of flow tags",
"examples": [
[
"tag-1",
"tag-2"
]
]
}
},
"additionalProperties": false,
"type": "object",
"title": "FlowUpdate",
"description": "Data used by the Prefect REST API to update a flow."
},
"FlowsSettings": {
"properties": {
"heartbeat_frequency": {
"anyOf": [
{
"type": "integer",
"minimum": 30.0
},
{
"type": "null"
}
],
"title": "Heartbeat Frequency",
"description": "Number of seconds between flow run heartbeats. Heartbeats are used to detect crashed flow runs.",
"supported_environment_variables": [
"PREFECT_FLOWS_HEARTBEAT_FREQUENCY",
"PREFECT_RUNNER_HEARTBEAT_FREQUENCY"
]
},
"default_retries": {
"type": "integer",
"minimum": 0.0,
"title": "Default Retries",
"description": "This value sets the default number of retries for all flows.",
"default": 0,
"supported_environment_variables": [
"PREFECT_FLOWS_DEFAULT_RETRIES",
"PREFECT_FLOW_DEFAULT_RETRIES"
]
},
"default_retry_delay_seconds": {
"anyOf": [
{
"type": "integer"
},
{
"type": "number"
},
{
"items": {
"type": "number"
},
"type": "array"
}
],
"title": "Default Retry Delay Seconds",
"description": "This value sets the default retry delay seconds for all flows.",
"default": 0,
"supported_environment_variables": [
"PREFECT_FLOWS_DEFAULT_RETRY_DELAY_SECONDS",
"PREFECT_FLOW_DEFAULT_RETRY_DELAY_SECONDS"
]
}
},
"type": "object",
"title": "FlowsSettings",
"description": "Settings for controlling flow behavior"
},
"GlobalConcurrencyLimitResponse": {
"properties": {
"id": {
"type": "string",
"format": "uuid",
"title": "Id"
},
"created": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Created"
},
"updated": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Updated"
},
"active": {
"type": "boolean",
"title": "Active",
"description": "Whether the global concurrency limit is active.",
"default": true
},
"name": {
"type": "string",
"title": "Name",
"description": "The name of the global concurrency limit."
},
"limit": {
"type": "integer",
"title": "Limit",
"description": "The concurrency limit."
},
"active_slots": {
"type": "integer",
"title": "Active Slots",
"description": "The number of active slots."
},
"slot_decay_per_second": {
"type": "number",
"title": "Slot Decay Per Second",
"description": "The decay rate for active slots when used as a rate limit.",
"default": 2.0
}
},
"type": "object",
"required": [
"name",
"limit",
"active_slots",
"id",
"created",
"updated"
],
"title": "GlobalConcurrencyLimitResponse",
"description": "A response object for global concurrency limits."
},
"Graph": {
"properties": {
"start_time": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start Time"
},
"end_time": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End Time"
},
"root_node_ids": {
"items": {
"type": "string",
"format": "uuid"
},
"type": "array",
"title": "Root Node Ids"
},
"nodes": {
"items": {
"prefixItems": [
{
"type": "string",
"format": "uuid"
},
{
"$ref": "#/components/schemas/Node"
}
],
"type": "array",
"maxItems": 2,
"minItems": 2
},
"type": "array",
"title": "Nodes"
},
"artifacts": {
"items": {
"$ref": "#/components/schemas/GraphArtifact"
},
"type": "array",
"title": "Artifacts"
},
"states": {
"items": {
"$ref": "#/components/schemas/GraphState"
},
"type": "array",
"title": "States"
}
},
"type": "object",
"required": [
"start_time",
"end_time",
"root_node_ids",
"nodes",
"artifacts",
"states"
],
"title": "Graph"
},
"GraphArtifact": {
"properties": {
"id": {
"type": "string",
"format": "uuid",
"title": "Id"
},
"created": {
"type": "string",
"format": "date-time",
"title": "Created"
},
"key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Key"
},
"type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Type"
},
"is_latest": {
"type": "boolean",
"title": "Is Latest"
},
"data": {
"anyOf": [
{},
{
"type": "null"
}
],
"title": "Data"
}
},
"type": "object",
"required": [
"id",
"created",
"key",
"type",
"is_latest",
"data"
],
"title": "GraphArtifact"
},
"GraphState": {
"properties": {
"id": {
"type": "string",
"format": "uuid",
"title": "Id"
},
"timestamp": {
"type": "string",
"format": "date-time",
"title": "Timestamp"
},
"type": {
"$ref": "#/components/schemas/StateType"
},
"name": {
"type": "string",
"title": "Name"
}
},
"type": "object",
"required": [
"id",
"timestamp",
"type",
"name"
],
"title": "GraphState"
},
"HTTPValidationError": {
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
},
"HistoryResponse": {
"properties": {
"interval_start": {
"type": "string",
"format": "date-time",
"title": "Interval Start",
"description": "The start date of the interval."
},
"interval_end": {
"type": "string",
"format": "date-time",
"title": "Interval End",
"description": "The end date of the interval."
},
"states": {
"items": {
"$ref": "#/components/schemas/HistoryResponseState"
},
"type": "array",
"title": "States",
"description": "A list of state histories during the interval."
}
},
"type": "object",
"required": [
"interval_start",
"interval_end",
"states"
],
"title": "HistoryResponse",
"description": "Represents a history of aggregation states over an interval"
},
"HistoryResponseState": {
"properties": {
"state_type": {
"$ref": "#/components/schemas/StateType",
"description": "The state type."
},
"state_name": {
"type": "string",
"title": "State Name",
"description": "The state name."
},
"count_runs": {
"type": "integer",
"title": "Count Runs",
"description": "The number of runs in the specified state during the interval."
},
"sum_estimated_run_time": {
"type": "number",
"title": "Sum Estimated Run Time",
"description": "The total estimated run time of all runs during the interval."
},
"sum_estimated_lateness": {
"type": "number",
"title": "Sum Estimated Lateness",
"description": "The sum of differences between actual and expected start time during the interval."
}
},
"type": "object",
"required": [
"state_type",
"state_name",
"count_runs",
"sum_estimated_run_time",
"sum_estimated_lateness"
],
"title": "HistoryResponseState",
"description": "Represents a single state's history over an interval."
},
"InternalSettings": {
"properties": {
"logging_level": {
"type": "string",
"enum": [
"DEBUG",
"INFO",
"WARNING",
"ERROR",
"CRITICAL"
],
"title": "Logging Level",
"description": "The default logging level for Prefect's internal machinery loggers.",
"default": "ERROR",
"supported_environment_variables": [
"PREFECT_INTERNAL_LOGGING_LEVEL",
"PREFECT_LOGGING_INTERNAL_LEVEL"
]
}
},
"type": "object",
"title": "InternalSettings"
},
"IntervalSchedule": {
"properties": {
"interval": {
"anyOf": [
{
"type": "number"
},
{
"type": "string"
}
],
"title": "Interval"
},
"anchor_date": {
"type": "string",
"format": "date-time",
"title": "Anchor Date",
"examples": [
"2020-01-01T00:00:00Z"
]
},
"timezone": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Timezone",
"examples": [
"America/New_York"
]
}
},
"additionalProperties": false,
"type": "object",
"required": [
"interval"
],
"title": "IntervalSchedule",
"description": "A schedule formed by adding `interval` increments to an `anchor_date`. If no\n`anchor_date` is supplied, the current UTC time is used. If a\ntimezone-naive datetime is provided for `anchor_date`, it is assumed to be\nin the schedule's timezone (or UTC). Even if supplied with an IANA timezone,\nanchor dates are always stored as UTC offsets, so a `timezone` can be\nprovided to determine localization behaviors like DST boundary handling. If\nnone is provided it will be inferred from the anchor date.\n\nNOTE: If the `IntervalSchedule` `anchor_date` or `timezone` is provided in a\nDST-observing timezone, then the schedule will adjust itself appropriately.\nIntervals greater than 24 hours will follow DST conventions, while intervals\nof less than 24 hours will follow UTC intervals. For example, an hourly\nschedule will fire every UTC hour, even across DST boundaries. When clocks\nare set back, this will result in two runs that *appear* to both be\nscheduled for 1am local time, even though they are an hour apart in UTC\ntime. For longer intervals, like a daily schedule, the interval schedule\nwill adjust for DST boundaries so that the clock-hour remains constant. This\nmeans that a daily schedule that always fires at 9am will observe DST and\ncontinue to fire at 9am in the local time zone.\n\nArgs:\n interval (datetime.timedelta): an interval to schedule on.\n anchor_date (DateTime, optional): an anchor date to schedule increments against;\n if not provided, the current timestamp will be used.\n timezone (str, optional): a valid timezone string."
},
"Log": {
"properties": {
"id": {
"type": "string",
"format": "uuid",
"title": "Id"
},
"created": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Created"
},
"updated": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Updated"
},
"name": {
"type": "string",
"title": "Name",
"description": "The logger name."
},
"level": {
"type": "integer",
"title": "Level",
"description": "The log level."
},
"message": {
"type": "string",
"title": "Message",
"description": "The log message."
},
"timestamp": {
"type": "string",
"format": "date-time",
"title": "Timestamp",
"description": "The log timestamp."
},
"flow_run_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Flow Run Id",
"description": "The flow run ID associated with the log."
},
"task_run_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Task Run Id",
"description": "The task run ID associated with the log."
}
},
"type": "object",
"required": [
"name",
"level",
"message",
"timestamp",
"id",
"created",
"updated"
],
"title": "Log",
"description": "An ORM representation of log data."
},
"LogCreate": {
"properties": {
"name": {
"type": "string",
"title": "Name",
"description": "The logger name."
},
"level": {
"type": "integer",
"title": "Level",
"description": "The log level."
},
"message": {
"type": "string",
"title": "Message",
"description": "The log message."
},
"timestamp": {
"type": "string",
"format": "date-time",
"title": "Timestamp",
"description": "The log timestamp."
},
"flow_run_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Flow Run Id"
},
"task_run_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Task Run Id"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"name",
"level",
"message",
"timestamp"
],
"title": "LogCreate",
"description": "Data used by the Prefect REST API to create a log."
},
"LogFilter": {
"properties": {
"operator": {
"$ref": "#/components/schemas/Operator",
"description": "Operator for combining filter criteria. Defaults to 'and_'.",
"default": "and_"
},
"level": {
"anyOf": [
{
"$ref": "#/components/schemas/LogFilterLevel"
},
{
"type": "null"
}
],
"description": "Filter criteria for `Log.level`"
},
"timestamp": {
"anyOf": [
{
"$ref": "#/components/schemas/LogFilterTimestamp"
},
{
"type": "null"
}
],
"description": "Filter criteria for `Log.timestamp`"
},
"flow_run_id": {
"anyOf": [
{
"$ref": "#/components/schemas/LogFilterFlowRunId"
},
{
"type": "null"
}
],
"description": "Filter criteria for `Log.flow_run_id`"
},
"task_run_id": {
"anyOf": [
{
"$ref": "#/components/schemas/LogFilterTaskRunId"
},
{
"type": "null"
}
],
"description": "Filter criteria for `Log.task_run_id`"
},
"text": {
"anyOf": [
{
"$ref": "#/components/schemas/LogFilterTextSearch"
},
{
"type": "null"
}
],
"description": "Filter criteria for text search across log content"
}
},
"additionalProperties": false,
"type": "object",
"title": "LogFilter",
"description": "Filter logs. Only logs matching all criteria will be returned"
},
"LogFilterFlowRunId": {
"properties": {
"any_": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Any",
"description": "A list of flow run IDs to include"
}
},
"additionalProperties": false,
"type": "object",
"title": "LogFilterFlowRunId",
"description": "Filter by `Log.flow_run_id`."
},
"LogFilterLevel": {
"properties": {
"ge_": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Ge",
"description": "Include logs with a level greater than or equal to this level",
"examples": [
20
]
},
"le_": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Le",
"description": "Include logs with a level less than or equal to this level",
"examples": [
50
]
}
},
"additionalProperties": false,
"type": "object",
"title": "LogFilterLevel",
"description": "Filter by `Log.level`."
},
"LogFilterTaskRunId": {
"properties": {
"any_": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Any",
"description": "A list of task run IDs to include"
},
"is_null_": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Is Null",
"description": "If true, only include logs without a task run id"
}
},
"additionalProperties": false,
"type": "object",
"title": "LogFilterTaskRunId",
"description": "Filter by `Log.task_run_id`."
},
"LogFilterTextSearch": {
"properties": {
"query": {
"type": "string",
"maxLength": 200,
"title": "Query",
"description": "Text search query string",
"examples": [
"error",
"error -debug",
"\"connection timeout\"",
"+required -excluded"
]
}
},
"additionalProperties": false,
"type": "object",
"required": [
"query"
],
"title": "LogFilterTextSearch",
"description": "Filter by text search across log content."
},
"LogFilterTimestamp": {
"properties": {
"before_": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Before",
"description": "Only include logs with a timestamp at or before this time"
},
"after_": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "After",
"description": "Only include logs with a timestamp at or after this time"
}
},
"additionalProperties": false,
"type": "object",
"title": "LogFilterTimestamp",
"description": "Filter by `Log.timestamp`."
},
"LogSort": {
"type": "string",
"enum": [
"TIMESTAMP_ASC",
"TIMESTAMP_DESC"
],
"title": "LogSort",
"description": "Defines log sorting options."
},
"LoggingSettings": {
"properties": {
"level": {
"type": "string",
"enum": [
"DEBUG",
"INFO",
"WARNING",
"ERROR",
"CRITICAL"
],
"title": "Level",
"description": "The default logging level for Prefect loggers.",
"default": "INFO",
"supported_environment_variables": [
"PREFECT_LOGGING_LEVEL"
]
},
"config_path": {
"type": "string",
"format": "path",
"title": "Config Path",
"description": "A path to a logging configuration file. Defaults to $PREFECT_HOME/logging.yml",
"supported_environment_variables": [
"PREFECT_LOGGING_CONFIG_PATH",
"PREFECT_LOGGING_SETTINGS_PATH"
]
},
"extra_loggers": {
"anyOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Extra Loggers",
"description": "Additional loggers to attach to Prefect logging at runtime.",
"supported_environment_variables": [
"PREFECT_LOGGING_EXTRA_LOGGERS"
]
},
"log_prints": {
"type": "boolean",
"title": "Log Prints",
"description": "If `True`, `print` statements in flows and tasks will be redirected to the Prefect logger for the given run.",
"default": false,
"supported_environment_variables": [
"PREFECT_LOGGING_LOG_PRINTS"
]
},
"colors": {
"type": "boolean",
"title": "Colors",
"description": "If `True`, use colors in CLI output. If `False`, output will not include colors codes.",
"default": true,
"supported_environment_variables": [
"PREFECT_LOGGING_COLORS"
]
},
"markup": {
"type": "boolean",
"title": "Markup",
"description": "\n Whether to interpret strings wrapped in square brackets as a style.\n This allows styles to be conveniently added to log messages, e.g.\n `[red]This is a red message.[/red]`. However, the downside is, if enabled,\n strings that contain square brackets may be inaccurately interpreted and\n lead to incomplete output, e.g.\n `[red]This is a red message.[/red]` may be interpreted as\n `[red]This is a red message.[/red]`.\n ",
"default": false,
"supported_environment_variables": [
"PREFECT_LOGGING_MARKUP"
]
},
"to_api": {
"$ref": "#/components/schemas/LoggingToAPISettings",
"supported_environment_variables": []
}
},
"type": "object",
"title": "LoggingSettings",
"description": "Settings for controlling logging behavior"
},
"LoggingToAPISettings": {
"properties": {
"enabled": {
"type": "boolean",
"title": "Enabled",
"description": "If `True`, logs will be sent to the API.",
"default": true,
"supported_environment_variables": [
"PREFECT_LOGGING_TO_API_ENABLED"
]
},
"batch_interval": {
"type": "number",
"title": "Batch Interval",
"description": "The number of seconds between batched writes of logs to the API.",
"default": 2.0,
"supported_environment_variables": [
"PREFECT_LOGGING_TO_API_BATCH_INTERVAL"
]
},
"batch_size": {
"type": "integer",
"title": "Batch Size",
"description": "The number of logs to batch before sending to the API.",
"default": 4000000,
"supported_environment_variables": [
"PREFECT_LOGGING_TO_API_BATCH_SIZE"
]
},
"max_log_size": {
"type": "integer",
"title": "Max Log Size",
"description": "The maximum size in characters for a single log. When connected to Prefect Cloud, this value is capped at `PREFECT_CLOUD_MAX_LOG_SIZE` (default 25,000).",
"default": 1000000,
"supported_environment_variables": [
"PREFECT_LOGGING_TO_API_MAX_LOG_SIZE"
]
},
"when_missing_flow": {
"type": "string",
"enum": [
"warn",
"error",
"ignore"
],
"title": "When Missing Flow",
"description": "\n Controls the behavior when loggers attempt to send logs to the API handler from outside of a flow.\n \n All logs sent to the API must be associated with a flow run. The API log handler can\n only be used outside of a flow by manually providing a flow run identifier. Logs\n that are not associated with a flow run will not be sent to the API. This setting can\n be used to determine if a warning or error is displayed when the identifier is missing.\n\n The following options are available:\n\n - \"warn\": Log a warning message.\n - \"error\": Raise an error.\n - \"ignore\": Do not log a warning message or raise an error.\n ",
"default": "warn",
"supported_environment_variables": [
"PREFECT_LOGGING_TO_API_WHEN_MISSING_FLOW"
]
}
},
"type": "object",
"title": "LoggingToAPISettings",
"description": "Settings for controlling logging to the API"
},
"MinimalConcurrencyLimitResponse": {
"properties": {
"id": {
"type": "string",
"format": "uuid",
"title": "Id"
},
"name": {
"type": "string",
"title": "Name"
},
"limit": {
"type": "integer",
"title": "Limit"
}
},
"type": "object",
"required": [
"id",
"name",
"limit"
],
"title": "MinimalConcurrencyLimitResponse"
},
"Node": {
"properties": {
"kind": {
"type": "string",
"enum": [
"flow-run",
"task-run"
],
"title": "Kind"
},
"id": {
"type": "string",
"format": "uuid",
"title": "Id"
},
"label": {
"type": "string",
"title": "Label"
},
"state_type": {
"$ref": "#/components/schemas/StateType"
},
"start_time": {
"type": "string",
"format": "date-time",
"title": "Start Time"
},
"end_time": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End Time"
},
"parents": {
"items": {
"$ref": "#/components/schemas/Edge"
},
"type": "array",
"title": "Parents"
},
"children": {
"items": {
"$ref": "#/components/schemas/Edge"
},
"type": "array",
"title": "Children"
},
"encapsulating": {
"items": {
"$ref": "#/components/schemas/Edge"
},
"type": "array",
"title": "Encapsulating"
},
"artifacts": {
"items": {
"$ref": "#/components/schemas/GraphArtifact"
},
"type": "array",
"title": "Artifacts"
}
},
"type": "object",
"required": [
"kind",
"id",
"label",
"state_type",
"start_time",
"end_time",
"parents",
"children",
"encapsulating",
"artifacts"
],
"title": "Node"
},
"Operator": {
"type": "string",
"enum": [
"and_",
"or_"
],
"title": "Operator",
"description": "Operators for combining filter criteria."
},
"OrchestrationResult": {
"properties": {
"state": {
"anyOf": [
{
"$ref": "#/components/schemas/State"
},
{
"type": "null"
}
]
},
"status": {
"$ref": "#/components/schemas/SetStateStatus"
},
"details": {
"anyOf": [
{
"$ref": "#/components/schemas/StateAcceptDetails"
},
{
"$ref": "#/components/schemas/StateWaitDetails"
},
{
"$ref": "#/components/schemas/StateRejectDetails"
},
{
"$ref": "#/components/schemas/StateAbortDetails"
}
],
"title": "Details"
}
},
"type": "object",
"required": [
"state",
"status",
"details"
],
"title": "OrchestrationResult",
"description": "A container for the output of state orchestration."
},
"Parameter": {
"properties": {
"input_type": {
"type": "string",
"const": "parameter",
"title": "Input Type",
"default": "parameter"
},
"name": {
"type": "string",
"title": "Name"
}
},
"type": "object",
"required": [
"name"
],
"title": "Parameter",
"description": "Represents a parameter input to a task run."
},
"PauseAutomation": {
"properties": {
"type": {
"type": "string",
"const": "pause-automation",
"title": "Type",
"default": "pause-automation"
},
"source": {
"type": "string",
"enum": [
"selected",
"inferred"
],
"title": "Source",
"description": "Whether this Action applies to a specific selected automation (given by `automation_id`), or to an automation that is inferred from the triggering event. If the source is 'inferred', the `automation_id` may not be set. If the source is 'selected', the `automation_id` must be set.",
"default": "selected"
},
"automation_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Automation Id",
"description": "The identifier of the automation to act on"
}
},
"type": "object",
"title": "PauseAutomation",
"description": "Pauses a Work Queue"
},
"PauseDeployment": {
"properties": {
"type": {
"type": "string",
"const": "pause-deployment",
"title": "Type",
"default": "pause-deployment"
},
"source": {
"type": "string",
"enum": [
"selected",
"inferred"
],
"title": "Source",
"description": "Whether this Action applies to a specific selected deployment (given by `deployment_id`), or to a deployment that is inferred from the triggering event. If the source is 'inferred', the `deployment_id` may not be set. If the source is 'selected', the `deployment_id` must be set.",
"default": "selected"
},
"deployment_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Deployment Id",
"description": "The identifier of the deployment"
}
},
"type": "object",
"title": "PauseDeployment",
"description": "Pauses the given Deployment"
},
"PauseWorkPool": {
"properties": {
"type": {
"type": "string",
"const": "pause-work-pool",
"title": "Type",
"default": "pause-work-pool"
},
"source": {
"type": "string",
"enum": [
"selected",
"inferred"
],
"title": "Source",
"description": "Whether this Action applies to a specific selected work pool (given by `work_pool_id`), or to a work pool that is inferred from the triggering event. If the source is 'inferred', the `work_pool_id` may not be set. If the source is 'selected', the `work_pool_id` must be set.",
"default": "selected"
},
"work_pool_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Work Pool Id",
"description": "The identifier of the work pool to pause"
}
},
"type": "object",
"title": "PauseWorkPool",
"description": "Pauses a Work Pool"
},
"PauseWorkQueue": {
"properties": {
"type": {
"type": "string",
"const": "pause-work-queue",
"title": "Type",
"default": "pause-work-queue"
},
"source": {
"type": "string",
"enum": [
"selected",
"inferred"
],
"title": "Source",
"description": "Whether this Action applies to a specific selected work queue (given by `work_queue_id`), or to a work queue that is inferred from the triggering event. If the source is 'inferred', the `work_queue_id` may not be set. If the source is 'selected', the `work_queue_id` must be set.",
"default": "selected"
},
"work_queue_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Work Queue Id",
"description": "The identifier of the work queue to pause"
}
},
"type": "object",
"title": "PauseWorkQueue",
"description": "Pauses a Work Queue"
},
"PluginsSettings": {
"properties": {
"enabled": {
"type": "boolean",
"title": "Enabled",
"description": "Enable the experimental plugin system.",
"default": false,
"supported_environment_variables": [
"PREFECT_EXPERIMENTS_PLUGINS_ENABLED"
]
},
"allow": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
{
"type": "null"
}
],
"title": "Allow",
"description": "Comma-separated list of plugin names to allow. If set, only these plugins will be loaded.",
"supported_environment_variables": [
"PREFECT_EXPERIMENTS_PLUGINS_ALLOW"
]
},
"deny": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
{
"type": "null"
}
],
"title": "Deny",
"description": "Comma-separated list of plugin names to deny. These plugins will not be loaded.",
"supported_environment_variables": [
"PREFECT_EXPERIMENTS_PLUGINS_DENY"
]
},
"setup_timeout_seconds": {
"type": "number",
"title": "Setup Timeout Seconds",
"description": "Maximum time in seconds for all plugins to complete their setup hooks.",
"default": 20.0,
"supported_environment_variables": [
"PREFECT_EXPERIMENTS_PLUGINS_SETUP_TIMEOUT_SECONDS"
]
},
"strict": {
"type": "boolean",
"title": "Strict",
"description": "If True, exit if a required plugin fails during setup.",
"default": false,
"supported_environment_variables": [
"PREFECT_EXPERIMENTS_PLUGINS_STRICT"
]
},
"safe_mode": {
"type": "boolean",
"title": "Safe Mode",
"description": "If True, load plugins but do not execute their hooks. Useful for testing.",
"default": false,
"supported_environment_variables": [
"PREFECT_EXPERIMENTS_PLUGINS_SAFE_MODE"
]
}
},
"type": "object",
"title": "PluginsSettings",
"description": "Settings for configuring the experimental plugin system"
},
"QueueFilter": {
"properties": {
"tags": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Tags",
"description": "Only include flow runs with these tags in the work queue."
},
"deployment_ids": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Deployment Ids",
"description": "Only include flow runs from these deployments in the work queue."
}
},
"type": "object",
"title": "QueueFilter",
"description": "Filter criteria definition for a work queue."
},
"RRuleSchedule": {
"properties": {
"rrule": {
"type": "string",
"title": "Rrule"
},
"timezone": {
"anyOf": [
{
"type": "string",
"pattern": "Africa/Abidjan|Africa/Accra|Africa/Addis_Ababa|Africa/Algiers|Africa/Asmara|Africa/Asmera|Africa/Bamako|Africa/Bangui|Africa/Banjul|Africa/Bissau|Africa/Blantyre|Africa/Brazzaville|Africa/Bujumbura|Africa/Cairo|Africa/Casablanca|Africa/Ceuta|Africa/Conakry|Africa/Dakar|Africa/Dar_es_Salaam|Africa/Djibouti|Africa/Douala|Africa/El_Aaiun|Africa/Freetown|Africa/Gaborone|Africa/Harare|Africa/Johannesburg|Africa/Juba|Africa/Kampala|Africa/Khartoum|Africa/Kigali|Africa/Kinshasa|Africa/Lagos|Africa/Libreville|Africa/Lome|Africa/Luanda|Africa/Lubumbashi|Africa/Lusaka|Africa/Malabo|Africa/Maputo|Africa/Maseru|Africa/Mbabane|Africa/Mogadishu|Africa/Monrovia|Africa/Nairobi|Africa/Ndjamena|Africa/Niamey|Africa/Nouakchott|Africa/Ouagadougou|Africa/Porto-Novo|Africa/Sao_Tome|Africa/Timbuktu|Africa/Tripoli|Africa/Tunis|Africa/Windhoek|America/Adak|America/Anchorage|America/Anguilla|America/Antigua|America/Araguaina|America/Argentina/Buenos_Aires|America/Argentina/Catamarca|America/Argentina/ComodRivadavia|America/Argentina/Cordoba|America/Argentina/Jujuy|America/Argentina/La_Rioja|America/Argentina/Mendoza|America/Argentina/Rio_Gallegos|America/Argentina/Salta|America/Argentina/San_Juan|America/Argentina/San_Luis|America/Argentina/Tucuman|America/Argentina/Ushuaia|America/Aruba|America/Asuncion|America/Atikokan|America/Atka|America/Bahia|America/Bahia_Banderas|America/Barbados|America/Belem|America/Belize|America/Blanc-Sablon|America/Boa_Vista|America/Bogota|America/Boise|America/Buenos_Aires|America/Cambridge_Bay|America/Campo_Grande|America/Cancun|America/Caracas|America/Catamarca|America/Cayenne|America/Cayman|America/Chicago|America/Chihuahua|America/Ciudad_Juarez|America/Coral_Harbour|America/Cordoba|America/Costa_Rica|America/Coyhaique|America/Creston|America/Cuiaba|America/Curacao|America/Danmarkshavn|America/Dawson|America/Dawson_Creek|America/Denver|America/Detroit|America/Dominica|America/Edmonton|America/Eirunepe|America/El_Salvador|America/Ensenada|America/Fort_Nelson|America/Fort_Wayne|America/Fortaleza|America/Glace_Bay|America/Godthab|America/Goose_Bay|America/Grand_Turk|America/Grenada|America/Guadeloupe|America/Guatemala|America/Guayaquil|America/Guyana|America/Halifax|America/Havana|America/Hermosillo|America/Indiana/Indianapolis|America/Indiana/Knox|America/Indiana/Marengo|America/Indiana/Petersburg|America/Indiana/Tell_City|America/Indiana/Vevay|America/Indiana/Vincennes|America/Indiana/Winamac|America/Indianapolis|America/Inuvik|America/Iqaluit|America/Jamaica|America/Jujuy|America/Juneau|America/Kentucky/Louisville|America/Kentucky/Monticello|America/Knox_IN|America/Kralendijk|America/La_Paz|America/Lima|America/Los_Angeles|America/Louisville|America/Lower_Princes|America/Maceio|America/Managua|America/Manaus|America/Marigot|America/Martinique|America/Matamoros|America/Mazatlan|America/Mendoza|America/Menominee|America/Merida|America/Metlakatla|America/Mexico_City|America/Miquelon|America/Moncton|America/Monterrey|America/Montevideo|America/Montreal|America/Montserrat|America/Nassau|America/New_York|America/Nipigon|America/Nome|America/Noronha|America/North_Dakota/Beulah|America/North_Dakota/Center|America/North_Dakota/New_Salem|America/Nuuk|America/Ojinaga|America/Panama|America/Pangnirtung|America/Paramaribo|America/Phoenix|America/Port-au-Prince|America/Port_of_Spain|America/Porto_Acre|America/Porto_Velho|America/Puerto_Rico|America/Punta_Arenas|America/Rainy_River|America/Rankin_Inlet|America/Recife|America/Regina|America/Resolute|America/Rio_Branco|America/Rosario|America/Santa_Isabel|America/Santarem|America/Santiago|America/Santo_Domingo|America/Sao_Paulo|America/Scoresbysund|America/Shiprock|America/Sitka|America/St_Barthelemy|America/St_Johns|America/St_Kitts|America/St_Lucia|America/St_Thomas|America/St_Vincent|America/Swift_Current|America/Tegucigalpa|America/Thule|America/Thunder_Bay|America/Tijuana|America/Toronto|America/Tortola|America/Vancouver|America/Virgin|America/Whitehorse|America/Winnipeg|America/Yakutat|America/Yellowknife|Antarctica/Casey|Antarctica/Davis|Antarctica/DumontDUrville|Antarctica/Macquarie|Antarctica/Mawson|Antarctica/McMurdo|Antarctica/Palmer|Antarctica/Rothera|Antarctica/South_Pole|Antarctica/Syowa|Antarctica/Troll|Antarctica/Vostok|Arctic/Longyearbyen|Asia/Aden|Asia/Almaty|Asia/Amman|Asia/Anadyr|Asia/Aqtau|Asia/Aqtobe|Asia/Ashgabat|Asia/Ashkhabad|Asia/Atyrau|Asia/Baghdad|Asia/Bahrain|Asia/Baku|Asia/Bangkok|Asia/Barnaul|Asia/Beirut|Asia/Bishkek|Asia/Brunei|Asia/Calcutta|Asia/Chita|Asia/Choibalsan|Asia/Chongqing|Asia/Chungking|Asia/Colombo|Asia/Dacca|Asia/Damascus|Asia/Dhaka|Asia/Dili|Asia/Dubai|Asia/Dushanbe|Asia/Famagusta|Asia/Gaza|Asia/Harbin|Asia/Hebron|Asia/Ho_Chi_Minh|Asia/Hong_Kong|Asia/Hovd|Asia/Irkutsk|Asia/Istanbul|Asia/Jakarta|Asia/Jayapura|Asia/Jerusalem|Asia/Kabul|Asia/Kamchatka|Asia/Karachi|Asia/Kashgar|Asia/Kathmandu|Asia/Katmandu|Asia/Khandyga|Asia/Kolkata|Asia/Krasnoyarsk|Asia/Kuala_Lumpur|Asia/Kuching|Asia/Kuwait|Asia/Macao|Asia/Macau|Asia/Magadan|Asia/Makassar|Asia/Manila|Asia/Muscat|Asia/Nicosia|Asia/Novokuznetsk|Asia/Novosibirsk|Asia/Omsk|Asia/Oral|Asia/Phnom_Penh|Asia/Pontianak|Asia/Pyongyang|Asia/Qatar|Asia/Qostanay|Asia/Qyzylorda|Asia/Rangoon|Asia/Riyadh|Asia/Saigon|Asia/Sakhalin|Asia/Samarkand|Asia/Seoul|Asia/Shanghai|Asia/Singapore|Asia/Srednekolymsk|Asia/Taipei|Asia/Tashkent|Asia/Tbilisi|Asia/Tehran|Asia/Tel_Aviv|Asia/Thimbu|Asia/Thimphu|Asia/Tokyo|Asia/Tomsk|Asia/Ujung_Pandang|Asia/Ulaanbaatar|Asia/Ulan_Bator|Asia/Urumqi|Asia/Ust-Nera|Asia/Vientiane|Asia/Vladivostok|Asia/Yakutsk|Asia/Yangon|Asia/Yekaterinburg|Asia/Yerevan|Atlantic/Azores|Atlantic/Bermuda|Atlantic/Canary|Atlantic/Cape_Verde|Atlantic/Faeroe|Atlantic/Faroe|Atlantic/Jan_Mayen|Atlantic/Madeira|Atlantic/Reykjavik|Atlantic/South_Georgia|Atlantic/St_Helena|Atlantic/Stanley|Australia/ACT|Australia/Adelaide|Australia/Brisbane|Australia/Broken_Hill|Australia/Canberra|Australia/Currie|Australia/Darwin|Australia/Eucla|Australia/Hobart|Australia/LHI|Australia/Lindeman|Australia/Lord_Howe|Australia/Melbourne|Australia/NSW|Australia/North|Australia/Perth|Australia/Queensland|Australia/South|Australia/Sydney|Australia/Tasmania|Australia/Victoria|Australia/West|Australia/Yancowinna|Brazil/Acre|Brazil/DeNoronha|Brazil/East|Brazil/West|CET|CST6CDT|Canada/Atlantic|Canada/Central|Canada/Eastern|Canada/Mountain|Canada/Newfoundland|Canada/Pacific|Canada/Saskatchewan|Canada/Yukon|Chile/Continental|Chile/EasterIsland|Cuba|EET|EST|EST5EDT|Egypt|Eire|Etc/GMT|Etc/GMT+0|Etc/GMT+1|Etc/GMT+10|Etc/GMT+11|Etc/GMT+12|Etc/GMT+2|Etc/GMT+3|Etc/GMT+4|Etc/GMT+5|Etc/GMT+6|Etc/GMT+7|Etc/GMT+8|Etc/GMT+9|Etc/GMT-0|Etc/GMT-1|Etc/GMT-10|Etc/GMT-11|Etc/GMT-12|Etc/GMT-13|Etc/GMT-14|Etc/GMT-2|Etc/GMT-3|Etc/GMT-4|Etc/GMT-5|Etc/GMT-6|Etc/GMT-7|Etc/GMT-8|Etc/GMT-9|Etc/GMT0|Etc/Greenwich|Etc/UCT|Etc/UTC|Etc/Universal|Etc/Zulu|Europe/Amsterdam|Europe/Andorra|Europe/Astrakhan|Europe/Athens|Europe/Belfast|Europe/Belgrade|Europe/Berlin|Europe/Bratislava|Europe/Brussels|Europe/Bucharest|Europe/Budapest|Europe/Busingen|Europe/Chisinau|Europe/Copenhagen|Europe/Dublin|Europe/Gibraltar|Europe/Guernsey|Europe/Helsinki|Europe/Isle_of_Man|Europe/Istanbul|Europe/Jersey|Europe/Kaliningrad|Europe/Kiev|Europe/Kirov|Europe/Kyiv|Europe/Lisbon|Europe/Ljubljana|Europe/London|Europe/Luxembourg|Europe/Madrid|Europe/Malta|Europe/Mariehamn|Europe/Minsk|Europe/Monaco|Europe/Moscow|Europe/Nicosia|Europe/Oslo|Europe/Paris|Europe/Podgorica|Europe/Prague|Europe/Riga|Europe/Rome|Europe/Samara|Europe/San_Marino|Europe/Sarajevo|Europe/Saratov|Europe/Simferopol|Europe/Skopje|Europe/Sofia|Europe/Stockholm|Europe/Tallinn|Europe/Tirane|Europe/Tiraspol|Europe/Ulyanovsk|Europe/Uzhgorod|Europe/Vaduz|Europe/Vatican|Europe/Vienna|Europe/Vilnius|Europe/Volgograd|Europe/Warsaw|Europe/Zagreb|Europe/Zaporozhye|Europe/Zurich|Factory|GB|GB-Eire|GMT|GMT+0|GMT-0|GMT0|Greenwich|HST|Hongkong|Iceland|Indian/Antananarivo|Indian/Chagos|Indian/Christmas|Indian/Cocos|Indian/Comoro|Indian/Kerguelen|Indian/Mahe|Indian/Maldives|Indian/Mauritius|Indian/Mayotte|Indian/Reunion|Iran|Israel|Jamaica|Japan|Kwajalein|Libya|MET|MST|MST7MDT|Mexico/BajaNorte|Mexico/BajaSur|Mexico/General|NZ|NZ-CHAT|Navajo|PRC|PST8PDT|Pacific/Apia|Pacific/Auckland|Pacific/Bougainville|Pacific/Chatham|Pacific/Chuuk|Pacific/Easter|Pacific/Efate|Pacific/Enderbury|Pacific/Fakaofo|Pacific/Fiji|Pacific/Funafuti|Pacific/Galapagos|Pacific/Gambier|Pacific/Guadalcanal|Pacific/Guam|Pacific/Honolulu|Pacific/Johnston|Pacific/Kanton|Pacific/Kiritimati|Pacific/Kosrae|Pacific/Kwajalein|Pacific/Majuro|Pacific/Marquesas|Pacific/Midway|Pacific/Nauru|Pacific/Niue|Pacific/Norfolk|Pacific/Noumea|Pacific/Pago_Pago|Pacific/Palau|Pacific/Pitcairn|Pacific/Pohnpei|Pacific/Ponape|Pacific/Port_Moresby|Pacific/Rarotonga|Pacific/Saipan|Pacific/Samoa|Pacific/Tahiti|Pacific/Tarawa|Pacific/Tongatapu|Pacific/Truk|Pacific/Wake|Pacific/Wallis|Pacific/Yap|Poland|Portugal|ROC|ROK|Singapore|Turkey|UCT|US/Alaska|US/Aleutian|US/Arizona|US/Central|US/East-Indiana|US/Eastern|US/Hawaii|US/Indiana-Starke|US/Michigan|US/Mountain|US/Pacific|US/Samoa|UTC|Universal|W-SU|WET|Zulu",
"examples": [
"America/New_York"
]
},
{
"type": "null"
}
],
"title": "Timezone",
"default": "UTC"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"rrule"
],
"title": "RRuleSchedule",
"description": "RRule schedule, based on the iCalendar standard\n([RFC 5545](https://datatracker.ietf.org/doc/html/rfc5545)) as\nimplemented in `dateutils.rrule`.\n\nRRules are appropriate for any kind of calendar-date manipulation, including\nirregular intervals, repetition, exclusions, week day or day-of-month\nadjustments, and more.\n\nNote that as a calendar-oriented standard, `RRuleSchedules` are sensitive to\nto the initial timezone provided. A 9am daily schedule with a daylight saving\ntime-aware start date will maintain a local 9am time through DST boundaries;\na 9am daily schedule with a UTC start date will maintain a 9am UTC time.\n\nArgs:\n rrule (str): a valid RRule string\n timezone (str, optional): a valid timezone string"
},
"ReceivedEvent": {
"properties": {
"occurred": {
"type": "string",
"format": "date-time",
"title": "Occurred",
"description": "When the event happened from the sender's perspective"
},
"event": {
"type": "string",
"title": "Event",
"description": "The name of the event that happened"
},
"resource": {
"$ref": "#/components/schemas/Resource",
"description": "The primary Resource this event concerns"
},
"related": {
"items": {
"$ref": "#/components/schemas/RelatedResource"
},
"type": "array",
"title": "Related",
"description": "A list of additional Resources involved in this event"
},
"payload": {
"additionalProperties": true,
"type": "object",
"title": "Payload",
"description": "An open-ended set of data describing what happened"
},
"id": {
"type": "string",
"format": "uuid",
"title": "Id",
"description": "The client-provided identifier of this event"
},
"follows": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Follows",
"description": "The ID of an event that is known to have occurred prior to this one. If set, this may be used to establish a more precise ordering of causally-related events when they occur close enough together in time that the system may receive them out-of-order."
},
"received": {
"type": "string",
"format": "date-time",
"title": "Received",
"description": "When the event was received by Prefect Cloud"
}
},
"type": "object",
"required": [
"occurred",
"event",
"resource",
"id"
],
"title": "ReceivedEvent",
"description": "The server-side view of an event that has happened to a Resource after it has\nbeen received by the server"
},
"RelatedResource": {
"additionalProperties": {
"type": "string"
},
"type": "object",
"title": "RelatedResource",
"description": "A Resource with a specific role in an Event"
},
"Resource": {
"additionalProperties": {
"type": "string"
},
"type": "object",
"title": "Resource",
"description": "An observable business object of interest to the user"
},
"ResourceSpecification": {
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"type": "object",
"title": "ResourceSpecification"
},
"ResultsSettings": {
"properties": {
"default_serializer": {
"type": "string",
"title": "Default Serializer",
"description": "The default serializer to use when not otherwise specified.",
"default": "pickle",
"supported_environment_variables": [
"PREFECT_RESULTS_DEFAULT_SERIALIZER"
]
},
"persist_by_default": {
"type": "boolean",
"title": "Persist By Default",
"description": "The default setting for persisting results when not otherwise specified.",
"default": false,
"supported_environment_variables": [
"PREFECT_RESULTS_PERSIST_BY_DEFAULT"
]
},
"default_storage_block": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Default Storage Block",
"description": "The `block-type/block-document` slug of a block to use as the default result storage.",
"supported_environment_variables": [
"PREFECT_RESULTS_DEFAULT_STORAGE_BLOCK",
"PREFECT_DEFAULT_RESULT_STORAGE_BLOCK"
]
},
"local_storage_path": {
"type": "string",
"format": "path",
"title": "Local Storage Path",
"description": "The default location for locally persisted results. Defaults to $PREFECT_HOME/storage.",
"supported_environment_variables": [
"PREFECT_RESULTS_LOCAL_STORAGE_PATH",
"PREFECT_LOCAL_STORAGE_PATH"
]
}
},
"type": "object",
"title": "ResultsSettings",
"description": "Settings for controlling result storage behavior"
},
"ResumeAutomation": {
"properties": {
"type": {
"type": "string",
"const": "resume-automation",
"title": "Type",
"default": "resume-automation"
},
"source": {
"type": "string",
"enum": [
"selected",
"inferred"
],
"title": "Source",
"description": "Whether this Action applies to a specific selected automation (given by `automation_id`), or to an automation that is inferred from the triggering event. If the source is 'inferred', the `automation_id` may not be set. If the source is 'selected', the `automation_id` must be set.",
"default": "selected"
},
"automation_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Automation Id",
"description": "The identifier of the automation to act on"
}
},
"type": "object",
"title": "ResumeAutomation",
"description": "Resumes a Work Queue"
},
"ResumeDeployment": {
"properties": {
"type": {
"type": "string",
"const": "resume-deployment",
"title": "Type",
"default": "resume-deployment"
},
"source": {
"type": "string",
"enum": [
"selected",
"inferred"
],
"title": "Source",
"description": "Whether this Action applies to a specific selected deployment (given by `deployment_id`), or to a deployment that is inferred from the triggering event. If the source is 'inferred', the `deployment_id` may not be set. If the source is 'selected', the `deployment_id` must be set.",
"default": "selected"
},
"deployment_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Deployment Id",
"description": "The identifier of the deployment"
}
},
"type": "object",
"title": "ResumeDeployment",
"description": "Resumes the given Deployment"
},
"ResumeFlowRun": {
"properties": {
"type": {
"type": "string",
"const": "resume-flow-run",
"title": "Type",
"default": "resume-flow-run"
}
},
"type": "object",
"title": "ResumeFlowRun",
"description": "Resumes a paused or suspended flow run associated with the trigger"
},
"ResumeWorkPool": {
"properties": {
"type": {
"type": "string",
"const": "resume-work-pool",
"title": "Type",
"default": "resume-work-pool"
},
"source": {
"type": "string",
"enum": [
"selected",
"inferred"
],
"title": "Source",
"description": "Whether this Action applies to a specific selected work pool (given by `work_pool_id`), or to a work pool that is inferred from the triggering event. If the source is 'inferred', the `work_pool_id` may not be set. If the source is 'selected', the `work_pool_id` must be set.",
"default": "selected"
},
"work_pool_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Work Pool Id",
"description": "The identifier of the work pool to pause"
}
},
"type": "object",
"title": "ResumeWorkPool",
"description": "Resumes a Work Pool"
},
"ResumeWorkQueue": {
"properties": {
"type": {
"type": "string",
"const": "resume-work-queue",
"title": "Type",
"default": "resume-work-queue"
},
"source": {
"type": "string",
"enum": [
"selected",
"inferred"
],
"title": "Source",
"description": "Whether this Action applies to a specific selected work queue (given by `work_queue_id`), or to a work queue that is inferred from the triggering event. If the source is 'inferred', the `work_queue_id` may not be set. If the source is 'selected', the `work_queue_id` must be set.",
"default": "selected"
},
"work_queue_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Work Queue Id",
"description": "The identifier of the work queue to pause"
}
},
"type": "object",
"title": "ResumeWorkQueue",
"description": "Resumes a Work Queue"
},
"RunDeployment": {
"properties": {
"type": {
"type": "string",
"const": "run-deployment",
"title": "Type",
"default": "run-deployment"
},
"source": {
"type": "string",
"enum": [
"selected",
"inferred"
],
"title": "Source",
"description": "Whether this Action applies to a specific selected deployment (given by `deployment_id`), or to a deployment that is inferred from the triggering event. If the source is 'inferred', the `deployment_id` may not be set. If the source is 'selected', the `deployment_id` must be set.",
"default": "selected"
},
"deployment_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Deployment Id",
"description": "The identifier of the deployment"
},
"parameters": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"title": "Parameters",
"description": "The parameters to pass to the deployment, or None to use the deployment's default parameters"
},
"job_variables": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"title": "Job Variables",
"description": "The job variables to pass to the created flow run, or None to use the deployment's default job variables"
},
"schedule_after": {
"type": "number",
"title": "Schedule After",
"description": "The amount of time to wait before running the deployment. Defaults to running the deployment immediately."
}
},
"type": "object",
"title": "RunDeployment",
"description": "Runs the given deployment with the given parameters"
},
"RunnerServerSettings": {
"properties": {
"enable": {
"type": "boolean",
"title": "Enable",
"description": "Whether or not to enable the runner's webserver.",
"default": false,
"supported_environment_variables": [
"PREFECT_RUNNER_SERVER_ENABLE"
]
},
"host": {
"type": "string",
"title": "Host",
"description": "The host address the runner's webserver should bind to.",
"default": "localhost",
"supported_environment_variables": [
"PREFECT_RUNNER_SERVER_HOST"
]
},
"port": {
"type": "integer",
"title": "Port",
"description": "The port the runner's webserver should bind to.",
"default": 8080,
"supported_environment_variables": [
"PREFECT_RUNNER_SERVER_PORT"
]
},
"log_level": {
"type": "string",
"enum": [
"DEBUG",
"INFO",
"WARNING",
"ERROR",
"CRITICAL"
],
"title": "Log Level",
"description": "The log level of the runner's webserver.",
"default": "ERROR",
"supported_environment_variables": [
"PREFECT_RUNNER_SERVER_LOG_LEVEL"
]
},
"missed_polls_tolerance": {
"type": "integer",
"title": "Missed Polls Tolerance",
"description": "Number of missed polls before a runner is considered unhealthy by its webserver.",
"default": 2,
"supported_environment_variables": [
"PREFECT_RUNNER_SERVER_MISSED_POLLS_TOLERANCE"
]
}
},
"type": "object",
"title": "RunnerServerSettings",
"description": "Settings for controlling runner server behavior"
},
"RunnerSettings": {
"properties": {
"process_limit": {
"type": "integer",
"title": "Process Limit",
"description": "Maximum number of processes a runner will execute in parallel.",
"default": 5,
"supported_environment_variables": [
"PREFECT_RUNNER_PROCESS_LIMIT"
]
},
"poll_frequency": {
"type": "integer",
"title": "Poll Frequency",
"description": "Number of seconds a runner should wait between queries for scheduled work.",
"default": 10,
"supported_environment_variables": [
"PREFECT_RUNNER_POLL_FREQUENCY"
]
},
"crash_on_cancellation_failure": {
"type": "boolean",
"title": "Crash On Cancellation Failure",
"description": "Whether to crash flow runs and shut down the runner when cancellation observing fails. When enabled, if both websocket and polling mechanisms for detecting cancellation events fail, all in-flight flow runs will be marked as crashed and the runner will shut down. When disabled (default), the runner will log an error but continue executing flow runs.",
"default": false,
"supported_environment_variables": [
"PREFECT_RUNNER_CRASH_ON_CANCELLATION_FAILURE"
]
},
"server": {
"$ref": "#/components/schemas/RunnerServerSettings",
"supported_environment_variables": []
}
},
"type": "object",
"title": "RunnerSettings",
"description": "Settings for controlling runner behavior"
},
"SQLAlchemyConnectArgsSettings": {
"properties": {
"application_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Application Name",
"description": "Controls the application_name field for connections opened from the connection pool when using a PostgreSQL database with the Prefect backend.",
"supported_environment_variables": [
"PREFECT_SERVER_DATABASE_SQLALCHEMY_CONNECT_ARGS_APPLICATION_NAME"
]
},
"search_path": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Search Path",
"description": "PostgreSQL schema name to set in search_path when using a PostgreSQL database with the Prefect backend. Note: The public schema should be included in the search path (e.g. 'myschema, public') to ensure that pg_trgm and other extensions remain available.",
"supported_environment_variables": [
"PREFECT_SERVER_DATABASE_SQLALCHEMY_CONNECT_ARGS_SEARCH_PATH"
]
},
"statement_cache_size": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Statement Cache Size",
"description": "Controls statement cache size for PostgreSQL connections. Setting this to 0 is required when using PgBouncer in transaction mode. Defaults to None.",
"supported_environment_variables": [
"PREFECT_SERVER_DATABASE_SQLALCHEMY_CONNECT_ARGS_STATEMENT_CACHE_SIZE"
]
},
"prepared_statement_cache_size": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Prepared Statement Cache Size",
"description": "Controls the size of the statement cache for PostgreSQL connections. When set to 0, statement caching is disabled. Defaults to None to use SQLAlchemy's default behavior.",
"supported_environment_variables": [
"PREFECT_SERVER_DATABASE_SQLALCHEMY_CONNECT_ARGS_PREPARED_STATEMENT_CACHE_SIZE"
]
},
"tls": {
"$ref": "#/components/schemas/SQLAlchemyTLSSettings",
"description": "Settings for controlling SQLAlchemy mTLS behavior",
"supported_environment_variables": []
}
},
"type": "object",
"title": "SQLAlchemyConnectArgsSettings",
"description": "Settings for controlling SQLAlchemy connection behavior; note that these settings only take effect when\nusing a PostgreSQL database."
},
"SQLAlchemySettings": {
"properties": {
"connect_args": {
"$ref": "#/components/schemas/SQLAlchemyConnectArgsSettings",
"description": "Settings for controlling SQLAlchemy connection behavior",
"supported_environment_variables": []
},
"pool_size": {
"type": "integer",
"title": "Pool Size",
"description": "Controls connection pool size of database connection pools from the Prefect backend.",
"default": 5,
"supported_environment_variables": [
"PREFECT_SERVER_DATABASE_SQLALCHEMY_POOL_SIZE",
"PREFECT_SQLALCHEMY_POOL_SIZE"
]
},
"pool_recycle": {
"type": "integer",
"title": "Pool Recycle",
"description": "This setting causes the pool to recycle connections after the given number of seconds has passed; set it to -1 to avoid recycling entirely.",
"default": 3600,
"supported_environment_variables": [
"PREFECT_SERVER_DATABASE_SQLALCHEMY_POOL_RECYCLE"
]
},
"pool_timeout": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Pool Timeout",
"description": "Number of seconds to wait before giving up on getting a connection from the pool. Defaults to 30 seconds.",
"default": 30.0,
"supported_environment_variables": [
"PREFECT_SERVER_DATABASE_SQLALCHEMY_POOL_TIMEOUT"
]
},
"max_overflow": {
"type": "integer",
"title": "Max Overflow",
"description": "Controls maximum overflow of the connection pool. To prevent overflow, set to -1.",
"default": 10,
"supported_environment_variables": [
"PREFECT_SERVER_DATABASE_SQLALCHEMY_MAX_OVERFLOW",
"PREFECT_SQLALCHEMY_MAX_OVERFLOW"
]
}
},
"type": "object",
"title": "SQLAlchemySettings",
"description": "Settings for controlling SQLAlchemy behavior; note that these settings only take effect when\nusing a PostgreSQL database."
},
"SQLAlchemyTLSSettings": {
"properties": {
"enabled": {
"type": "boolean",
"title": "Enabled",
"description": "Controls whether connected to mTLS enabled PostgreSQL when using a PostgreSQL database with the Prefect backend.",
"default": false,
"supported_environment_variables": [
"PREFECT_SERVER_DATABASE_SQLALCHEMY_CONNECT_ARGS_TLS_ENABLED"
]
},
"ca_file": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Ca File",
"description": "This configuration settings option specifies the path to PostgreSQL client certificate authority file.",
"supported_environment_variables": [
"PREFECT_SERVER_DATABASE_SQLALCHEMY_CONNECT_ARGS_TLS_CA_FILE"
]
},
"cert_file": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cert File",
"description": "This configuration settings option specifies the path to PostgreSQL client certificate file.",
"supported_environment_variables": [
"PREFECT_SERVER_DATABASE_SQLALCHEMY_CONNECT_ARGS_TLS_CERT_FILE"
]
},
"key_file": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Key File",
"description": "This configuration settings option specifies the path to PostgreSQL client key file.",
"supported_environment_variables": [
"PREFECT_SERVER_DATABASE_SQLALCHEMY_CONNECT_ARGS_TLS_KEY_FILE"
]
},
"check_hostname": {
"type": "boolean",
"title": "Check Hostname",
"description": "This configuration settings option specifies whether to verify PostgreSQL server hostname.",
"default": true,
"supported_environment_variables": [
"PREFECT_SERVER_DATABASE_SQLALCHEMY_CONNECT_ARGS_TLS_CHECK_HOSTNAME"
]
}
},
"type": "object",
"title": "SQLAlchemyTLSSettings",
"description": "Settings for controlling SQLAlchemy mTLS context when\nusing a PostgreSQL database."
},
"SavedSearch": {
"properties": {
"id": {
"type": "string",
"format": "uuid",
"title": "Id"
},
"created": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Created"
},
"updated": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Updated"
},
"name": {
"type": "string",
"title": "Name",
"description": "The name of the saved search."
},
"filters": {
"items": {
"$ref": "#/components/schemas/SavedSearchFilter"
},
"type": "array",
"title": "Filters",
"description": "The filter set for the saved search."
}
},
"type": "object",
"required": [
"name",
"id",
"created",
"updated"
],
"title": "SavedSearch",
"description": "An ORM representation of saved search data. Represents a set of filter criteria."
},
"SavedSearchCreate": {
"properties": {
"name": {
"type": "string",
"title": "Name",
"description": "The name of the saved search."
},
"filters": {
"items": {
"$ref": "#/components/schemas/SavedSearchFilter"
},
"type": "array",
"title": "Filters",
"description": "The filter set for the saved search."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"name"
],
"title": "SavedSearchCreate",
"description": "Data used by the Prefect REST API to create a saved search."
},
"SavedSearchFilter": {
"properties": {
"object": {
"type": "string",
"title": "Object",
"description": "The object over which to filter."
},
"property": {
"type": "string",
"title": "Property",
"description": "The property of the object on which to filter."
},
"type": {
"type": "string",
"title": "Type",
"description": "The type of the property."
},
"operation": {
"type": "string",
"title": "Operation",
"description": "The operator to apply to the object. For example, `equals`."
},
"value": {
"title": "Value",
"description": "A JSON-compatible value for the filter."
}
},
"type": "object",
"required": [
"object",
"property",
"type",
"operation",
"value"
],
"title": "SavedSearchFilter",
"description": "A filter for a saved search model. Intended for use by the Prefect UI."
},
"SchemaValueIndexError": {
"properties": {
"index": {
"type": "integer",
"title": "Index"
},
"errors": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"$ref": "#/components/schemas/SchemaValuePropertyError"
},
{
"$ref": "#/components/schemas/SchemaValueIndexError"
}
]
},
"type": "array",
"title": "Errors"
}
},
"type": "object",
"required": [
"index",
"errors"
],
"title": "SchemaValueIndexError"
},
"SchemaValuePropertyError": {
"properties": {
"property": {
"type": "string",
"title": "Property"
},
"errors": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"$ref": "#/components/schemas/SchemaValuePropertyError"
},
{
"$ref": "#/components/schemas/SchemaValueIndexError"
}
]
},
"type": "array",
"title": "Errors"
}
},
"type": "object",
"required": [
"property",
"errors"
],
"title": "SchemaValuePropertyError"
},
"SchemaValuesValidationResponse": {
"properties": {
"errors": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"$ref": "#/components/schemas/SchemaValuePropertyError"
},
{
"$ref": "#/components/schemas/SchemaValueIndexError"
}
]
},
"type": "array",
"title": "Errors"
},
"valid": {
"type": "boolean",
"title": "Valid"
}
},
"type": "object",
"required": [
"errors",
"valid"
],
"title": "SchemaValuesValidationResponse"
},
"SendNotification": {
"properties": {
"type": {
"type": "string",
"const": "send-notification",
"title": "Type",
"default": "send-notification"
},
"block_document_id": {
"type": "string",
"format": "uuid",
"title": "Block Document Id",
"description": "The identifier of the notification block to use"
},
"subject": {
"type": "string",
"title": "Subject",
"default": "Prefect automated notification"
},
"body": {
"type": "string",
"title": "Body",
"description": "The text of the notification to send"
}
},
"type": "object",
"required": [
"block_document_id",
"body"
],
"title": "SendNotification",
"description": "Send a notification when an Automation is triggered"
},
"SequenceTrigger-Input": {
"properties": {
"type": {
"type": "string",
"const": "sequence",
"title": "Type",
"default": "sequence"
},
"id": {
"type": "string",
"format": "uuid",
"title": "Id",
"description": "The unique ID of this trigger"
},
"triggers": {
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/EventTrigger"
},
{
"$ref": "#/components/schemas/CompoundTrigger-Input"
},
{
"$ref": "#/components/schemas/SequenceTrigger-Input"
}
]
},
"type": "array",
"title": "Triggers"
},
"within": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Within"
}
},
"type": "object",
"required": [
"triggers",
"within"
],
"title": "SequenceTrigger",
"description": "A composite trigger that requires some number of triggers to have fired\nwithin the given time period in a specific order"
},
"SequenceTrigger-Output": {
"properties": {
"type": {
"type": "string",
"const": "sequence",
"title": "Type",
"default": "sequence"
},
"id": {
"type": "string",
"format": "uuid",
"title": "Id",
"description": "The unique ID of this trigger"
},
"triggers": {
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/EventTrigger"
},
{
"$ref": "#/components/schemas/CompoundTrigger-Output"
},
{
"$ref": "#/components/schemas/SequenceTrigger-Output"
}
]
},
"type": "array",
"title": "Triggers"
},
"within": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Within"
}
},
"type": "object",
"required": [
"triggers",
"within"
],
"title": "SequenceTrigger",
"description": "A composite trigger that requires some number of triggers to have fired\nwithin the given time period in a specific order"
},
"ServerAPISettings": {
"properties": {
"auth_string": {
"anyOf": [
{
"type": "string",
"format": "password",
"writeOnly": true
},
{
"type": "null"
}
],
"title": "Auth String",
"description": "A string to use for basic authentication with the API in the form 'user:password'.",
"supported_environment_variables": [
"PREFECT_SERVER_API_AUTH_STRING"
]
},
"host": {
"type": "string",
"title": "Host",
"description": "The API's host address (defaults to `127.0.0.1`).",
"default": "127.0.0.1",
"supported_environment_variables": [
"PREFECT_SERVER_API_HOST"
]
},
"port": {
"type": "integer",
"title": "Port",
"description": "The API's port address (defaults to `4200`).",
"default": 4200,
"supported_environment_variables": [
"PREFECT_SERVER_API_PORT"
]
},
"base_path": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Base Path",
"description": "The base URL path to serve the API under.",
"examples": [
"/v2/api"
],
"supported_environment_variables": [
"PREFECT_SERVER_API_BASE_PATH"
]
},
"default_limit": {
"type": "integer",
"title": "Default Limit",
"description": "The default limit applied to queries that can return multiple objects, such as `POST /flow_runs/filter`.",
"default": 200,
"supported_environment_variables": [
"PREFECT_SERVER_API_DEFAULT_LIMIT",
"PREFECT_API_DEFAULT_LIMIT"
]
},
"keepalive_timeout": {
"type": "integer",
"title": "Keepalive Timeout",
"description": "\n The API's keep alive timeout (defaults to `5`).\n Refer to https://www.uvicorn.org/settings/#timeouts for details.\n\n When the API is hosted behind a load balancer, you may want to set this to a value\n greater than the load balancer's idle timeout.\n\n Note this setting only applies when calling `prefect server start`; if hosting the\n API with another tool you will need to configure this there instead.\n ",
"default": 5,
"supported_environment_variables": [
"PREFECT_SERVER_API_KEEPALIVE_TIMEOUT"
]
},
"csrf_protection_enabled": {
"type": "boolean",
"title": "Csrf Protection Enabled",
"description": "\n Controls the activation of CSRF protection for the Prefect server API.\n\n When enabled (`True`), the server enforces CSRF validation checks on incoming\n state-changing requests (POST, PUT, PATCH, DELETE), requiring a valid CSRF\n token to be included in the request headers or body. This adds a layer of\n security by preventing unauthorized or malicious sites from making requests on\n behalf of authenticated users.\n\n It is recommended to enable this setting in production environments where the\n API is exposed to web clients to safeguard against CSRF attacks.\n\n Note: Enabling this setting requires corresponding support in the client for\n CSRF token management. See PREFECT_CLIENT_CSRF_SUPPORT_ENABLED for more.\n ",
"default": false,
"supported_environment_variables": [
"PREFECT_SERVER_API_CSRF_PROTECTION_ENABLED",
"PREFECT_SERVER_CSRF_PROTECTION_ENABLED"
]
},
"csrf_token_expiration": {
"type": "string",
"format": "duration",
"title": "Csrf Token Expiration",
"description": "\n Specifies the duration for which a CSRF token remains valid after being issued\n by the server.\n\n The default expiration time is set to 1 hour, which offers a reasonable\n compromise. Adjust this setting based on your specific security requirements\n and usage patterns.\n ",
"default": "PT1H",
"supported_environment_variables": [
"PREFECT_SERVER_API_CSRF_TOKEN_EXPIRATION",
"PREFECT_SERVER_CSRF_TOKEN_EXPIRATION"
]
},
"cors_allowed_origins": {
"type": "string",
"title": "Cors Allowed Origins",
"description": "\n A comma-separated list of origins that are authorized to make cross-origin requests to the API.\n\n By default, this is set to `*`, which allows requests from all origins.\n ",
"default": "*",
"supported_environment_variables": [
"PREFECT_SERVER_API_CORS_ALLOWED_ORIGINS",
"PREFECT_SERVER_CORS_ALLOWED_ORIGINS"
]
},
"cors_allowed_methods": {
"type": "string",
"title": "Cors Allowed Methods",
"description": "\n A comma-separated list of methods that are authorized to make cross-origin requests to the API.\n\n By default, this is set to `*`, which allows requests from all methods.\n ",
"default": "*",
"supported_environment_variables": [
"PREFECT_SERVER_API_CORS_ALLOWED_METHODS",
"PREFECT_SERVER_CORS_ALLOWED_METHODS"
]
},
"cors_allowed_headers": {
"type": "string",
"title": "Cors Allowed Headers",
"description": "\n A comma-separated list of headers that are authorized to make cross-origin requests to the API.\n\n By default, this is set to `*`, which allows requests from all headers.\n ",
"default": "*",
"supported_environment_variables": [
"PREFECT_SERVER_API_CORS_ALLOWED_HEADERS",
"PREFECT_SERVER_CORS_ALLOWED_HEADERS"
]
}
},
"type": "object",
"title": "ServerAPISettings",
"description": "Settings for controlling API server behavior"
},
"ServerConcurrencySettings": {
"properties": {
"lease_storage": {
"type": "string",
"title": "Lease Storage",
"description": "The module to use for storing concurrency limit leases.",
"default": "prefect.server.concurrency.lease_storage.memory",
"supported_environment_variables": [
"PREFECT_SERVER_CONCURRENCY_LEASE_STORAGE"
]
},
"initial_deployment_lease_duration": {
"type": "number",
"maximum": 3600.0,
"minimum": 30.0,
"title": "Initial Deployment Lease Duration",
"description": "Initial duration for deployment concurrency lease in seconds.",
"default": 300.0,
"supported_environment_variables": [
"PREFECT_SERVER_CONCURRENCY_INITIAL_DEPLOYMENT_LEASE_DURATION"
]
},
"maximum_concurrency_slot_wait_seconds": {
"type": "number",
"minimum": 0.0,
"title": "Maximum Concurrency Slot Wait Seconds",
"description": "The maximum number of seconds to wait before retrying when a concurrency slot cannot be acquired.",
"default": 30,
"supported_environment_variables": [
"PREFECT_SERVER_CONCURRENCY_MAXIMUM_CONCURRENCY_SLOT_WAIT_SECONDS"
]
}
},
"type": "object",
"title": "ServerConcurrencySettings"
},
"ServerDatabaseSettings": {
"properties": {
"sqlalchemy": {
"$ref": "#/components/schemas/SQLAlchemySettings",
"description": "Settings for controlling SQLAlchemy behavior",
"supported_environment_variables": []
},
"connection_url": {
"anyOf": [
{
"type": "string",
"format": "password",
"writeOnly": true
},
{
"type": "null"
}
],
"title": "Connection Url",
"description": "\n A database connection URL in a SQLAlchemy-compatible\n format. Prefect currently supports SQLite and Postgres. Note that all\n Prefect database engines must use an async driver - for SQLite, use\n `sqlite+aiosqlite` and for Postgres use `postgresql+asyncpg`.\n\n SQLite in-memory databases can be used by providing the url\n `sqlite+aiosqlite:///file::memory:?cache=shared&uri=true&check_same_thread=false`,\n which will allow the database to be accessed by multiple threads. Note\n that in-memory databases can not be accessed from multiple processes and\n should only be used for simple tests.\n ",
"supported_environment_variables": [
"PREFECT_SERVER_DATABASE_CONNECTION_URL",
"PREFECT_API_DATABASE_CONNECTION_URL"
]
},
"driver": {
"anyOf": [
{
"type": "string",
"enum": [
"postgresql+asyncpg",
"sqlite+aiosqlite"
]
},
{
"type": "null"
}
],
"title": "Driver",
"description": "The database driver to use when connecting to the database. If not set, the driver will be inferred from the connection URL.",
"supported_environment_variables": [
"PREFECT_SERVER_DATABASE_DRIVER",
"PREFECT_API_DATABASE_DRIVER"
]
},
"host": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Host",
"description": "The database server host.",
"supported_environment_variables": [
"PREFECT_SERVER_DATABASE_HOST",
"PREFECT_API_DATABASE_HOST"
]
},
"port": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Port",
"description": "The database server port.",
"supported_environment_variables": [
"PREFECT_SERVER_DATABASE_PORT",
"PREFECT_API_DATABASE_PORT"
]
},
"user": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "User",
"description": "The user to use when connecting to the database.",
"supported_environment_variables": [
"PREFECT_SERVER_DATABASE_USER",
"PREFECT_API_DATABASE_USER"
]
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Name",
"description": "The name of the Prefect database on the remote server, or the path to the database file for SQLite.",
"supported_environment_variables": [
"PREFECT_SERVER_DATABASE_NAME",
"PREFECT_API_DATABASE_NAME"
]
},
"password": {
"anyOf": [
{
"type": "string",
"format": "password",
"writeOnly": true
},
{
"type": "null"
}
],
"title": "Password",
"description": "The password to use when connecting to the database. Should be kept secret.",
"supported_environment_variables": [
"PREFECT_SERVER_DATABASE_PASSWORD",
"PREFECT_API_DATABASE_PASSWORD"
]
},
"echo": {
"type": "boolean",
"title": "Echo",
"description": "If `True`, SQLAlchemy will log all SQL issued to the database. Defaults to `False`.",
"default": false,
"supported_environment_variables": [
"PREFECT_SERVER_DATABASE_ECHO",
"PREFECT_API_DATABASE_ECHO"
]
},
"migrate_on_start": {
"type": "boolean",
"title": "Migrate On Start",
"description": "If `True`, the database will be migrated on application startup.",
"default": true,
"supported_environment_variables": [
"PREFECT_SERVER_DATABASE_MIGRATE_ON_START",
"PREFECT_API_DATABASE_MIGRATE_ON_START"
]
},
"timeout": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Timeout",
"description": "A statement timeout, in seconds, applied to all database interactions made by the Prefect backend. Defaults to 10 seconds.",
"default": 10.0,
"supported_environment_variables": [
"PREFECT_SERVER_DATABASE_TIMEOUT",
"PREFECT_API_DATABASE_TIMEOUT"
]
},
"connection_timeout": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Connection Timeout",
"description": "A connection timeout, in seconds, applied to database connections. Defaults to `5`.",
"default": 5.0,
"supported_environment_variables": [
"PREFECT_SERVER_DATABASE_CONNECTION_TIMEOUT",
"PREFECT_API_DATABASE_CONNECTION_TIMEOUT"
]
}
},
"type": "object",
"title": "ServerDatabaseSettings",
"description": "Settings for controlling server database behavior"
},
"ServerDeploymentsSettings": {
"properties": {
"concurrency_slot_wait_seconds": {
"type": "number",
"minimum": 0.0,
"title": "Concurrency Slot Wait Seconds",
"description": "The number of seconds to wait before retrying when a deployment flow run cannot secure a concurrency slot from the server.",
"default": 30.0,
"supported_environment_variables": [
"PREFECT_SERVER_DEPLOYMENTS_CONCURRENCY_SLOT_WAIT_SECONDS",
"PREFECT_DEPLOYMENT_CONCURRENCY_SLOT_WAIT_SECONDS"
]
}
},
"type": "object",
"title": "ServerDeploymentsSettings"
},
"ServerDocketSettings": {
"properties": {
"name": {
"type": "string",
"title": "Name",
"description": "The name of the Docket instance.",
"default": "prefect-server",
"supported_environment_variables": [
"PREFECT_SERVER_DOCKET_NAME"
]
},
"url": {
"type": "string",
"title": "Url",
"description": "The URL of the Redis server to use for Docket.",
"default": "memory://",
"supported_environment_variables": [
"PREFECT_SERVER_DOCKET_URL"
]
}
},
"type": "object",
"title": "ServerDocketSettings",
"description": "Settings for controlling Docket behavior"
},
"ServerEphemeralSettings": {
"properties": {
"enabled": {
"type": "boolean",
"title": "Enabled",
"description": "\n Controls whether or not a subprocess server can be started when no API URL is provided.\n ",
"default": false,
"supported_environment_variables": [
"PREFECT_SERVER_EPHEMERAL_ENABLED",
"PREFECT_SERVER_ALLOW_EPHEMERAL_MODE"
]
},
"startup_timeout_seconds": {
"type": "integer",
"title": "Startup Timeout Seconds",
"description": "\n The number of seconds to wait for the server to start when ephemeral mode is enabled.\n Defaults to `20`.\n ",
"default": 20,
"supported_environment_variables": [
"PREFECT_SERVER_EPHEMERAL_STARTUP_TIMEOUT_SECONDS"
]
}
},
"type": "object",
"title": "ServerEphemeralSettings",
"description": "Settings for controlling ephemeral server behavior"
},
"ServerEventsSettings": {
"properties": {
"stream_out_enabled": {
"type": "boolean",
"title": "Stream Out Enabled",
"description": "Whether or not to stream events out to the API via websockets.",
"default": true,
"supported_environment_variables": [
"PREFECT_SERVER_EVENTS_STREAM_OUT_ENABLED",
"PREFECT_API_EVENTS_STREAM_OUT_ENABLED"
]
},
"related_resource_cache_ttl": {
"type": "string",
"format": "duration",
"title": "Related Resource Cache Ttl",
"description": "The number of seconds to cache related resources for in the API.",
"default": "PT5M",
"supported_environment_variables": [
"PREFECT_SERVER_EVENTS_RELATED_RESOURCE_CACHE_TTL",
"PREFECT_API_EVENTS_RELATED_RESOURCE_CACHE_TTL"
]
},
"maximum_labels_per_resource": {
"type": "integer",
"title": "Maximum Labels Per Resource",
"description": "The maximum number of labels a resource may have.",
"default": 500,
"supported_environment_variables": [
"PREFECT_SERVER_EVENTS_MAXIMUM_LABELS_PER_RESOURCE",
"PREFECT_EVENTS_MAXIMUM_LABELS_PER_RESOURCE"
]
},
"maximum_related_resources": {
"type": "integer",
"title": "Maximum Related Resources",
"description": "The maximum number of related resources an Event may have.",
"default": 100,
"supported_environment_variables": [
"PREFECT_SERVER_EVENTS_MAXIMUM_RELATED_RESOURCES",
"PREFECT_EVENTS_MAXIMUM_RELATED_RESOURCES"
]
},
"maximum_size_bytes": {
"type": "integer",
"title": "Maximum Size Bytes",
"description": "The maximum size of an Event when serialized to JSON",
"default": 1500000,
"supported_environment_variables": [
"PREFECT_SERVER_EVENTS_MAXIMUM_SIZE_BYTES",
"PREFECT_EVENTS_MAXIMUM_SIZE_BYTES"
]
},
"expired_bucket_buffer": {
"type": "string",
"format": "duration",
"title": "Expired Bucket Buffer",
"description": "The amount of time to retain expired automation buckets",
"default": "PT1M",
"supported_environment_variables": [
"PREFECT_SERVER_EVENTS_EXPIRED_BUCKET_BUFFER",
"PREFECT_EVENTS_EXPIRED_BUCKET_BUFFER"
]
},
"proactive_granularity": {
"type": "string",
"format": "duration",
"title": "Proactive Granularity",
"description": "How frequently proactive automations are evaluated",
"default": "PT5S",
"supported_environment_variables": [
"PREFECT_SERVER_EVENTS_PROACTIVE_GRANULARITY",
"PREFECT_EVENTS_PROACTIVE_GRANULARITY"
]
},
"retention_period": {
"type": "string",
"format": "duration",
"title": "Retention Period",
"description": "The amount of time to retain events in the database.",
"default": "P7D",
"supported_environment_variables": [
"PREFECT_SERVER_EVENTS_RETENTION_PERIOD",
"PREFECT_EVENTS_RETENTION_PERIOD"
]
},
"maximum_websocket_backfill": {
"type": "string",
"format": "duration",
"title": "Maximum Websocket Backfill",
"description": "The maximum range to look back for backfilling events for a websocket subscriber.",
"default": "PT15M",
"supported_environment_variables": [
"PREFECT_SERVER_EVENTS_MAXIMUM_WEBSOCKET_BACKFILL",
"PREFECT_EVENTS_MAXIMUM_WEBSOCKET_BACKFILL"
]
},
"websocket_backfill_page_size": {
"type": "integer",
"exclusiveMinimum": 0.0,
"title": "Websocket Backfill Page Size",
"description": "The page size for the queries to backfill events for websocket subscribers.",
"default": 250,
"supported_environment_variables": [
"PREFECT_SERVER_EVENTS_WEBSOCKET_BACKFILL_PAGE_SIZE",
"PREFECT_EVENTS_WEBSOCKET_BACKFILL_PAGE_SIZE"
]
},
"messaging_broker": {
"type": "string",
"title": "Messaging Broker",
"description": "Which message broker implementation to use for the messaging system, should point to a module that exports a Publisher and Consumer class.",
"default": "prefect.server.utilities.messaging.memory",
"supported_environment_variables": [
"PREFECT_SERVER_EVENTS_MESSAGING_BROKER",
"PREFECT_MESSAGING_BROKER"
]
},
"messaging_cache": {
"type": "string",
"title": "Messaging Cache",
"description": "Which cache implementation to use for the events system. Should point to a module that exports a Cache class.",
"default": "prefect.server.utilities.messaging.memory",
"supported_environment_variables": [
"PREFECT_SERVER_EVENTS_MESSAGING_CACHE",
"PREFECT_MESSAGING_CACHE"
]
},
"causal_ordering": {
"type": "string",
"title": "Causal Ordering",
"description": "Which causal ordering implementation to use for the events system. Should point to a module that exports a CausalOrdering class.",
"default": "prefect.server.events.ordering.memory",
"supported_environment_variables": [
"PREFECT_SERVER_EVENTS_CAUSAL_ORDERING"
]
},
"maximum_event_name_length": {
"type": "integer",
"exclusiveMinimum": 0.0,
"title": "Maximum Event Name Length",
"description": "The maximum length of an event name.",
"default": 1024,
"supported_environment_variables": [
"PREFECT_SERVER_EVENTS_MAXIMUM_EVENT_NAME_LENGTH"
]
}
},
"type": "object",
"title": "ServerEventsSettings",
"description": "Settings for controlling behavior of the events subsystem"
},
"ServerFlowRunGraphSettings": {
"properties": {
"max_nodes": {
"type": "integer",
"title": "Max Nodes",
"description": "The maximum size of a flow run graph on the v2 API",
"default": 10000,
"supported_environment_variables": [
"PREFECT_SERVER_FLOW_RUN_GRAPH_MAX_NODES",
"PREFECT_API_MAX_FLOW_RUN_GRAPH_NODES"
]
},
"max_artifacts": {
"type": "integer",
"title": "Max Artifacts",
"description": "The maximum number of artifacts to show on a flow run graph on the v2 API",
"default": 10000,
"supported_environment_variables": [
"PREFECT_SERVER_FLOW_RUN_GRAPH_MAX_ARTIFACTS",
"PREFECT_API_MAX_FLOW_RUN_GRAPH_ARTIFACTS"
]
}
},
"type": "object",
"title": "ServerFlowRunGraphSettings",
"description": "Settings for controlling behavior of the flow run graph"
},
"ServerLogsSettings": {
"properties": {
"stream_out_enabled": {
"type": "boolean",
"title": "Stream Out Enabled",
"description": "Whether or not to stream logs out to the API via websockets.",
"default": false,
"supported_environment_variables": [
"PREFECT_SERVER_LOGS_STREAM_OUT_ENABLED"
]
},
"stream_publishing_enabled": {
"type": "boolean",
"title": "Stream Publishing Enabled",
"description": "Whether or not to publish logs to the streaming system.",
"default": false,
"supported_environment_variables": [
"PREFECT_SERVER_LOGS_STREAM_PUBLISHING_ENABLED"
]
}
},
"type": "object",
"title": "ServerLogsSettings",
"description": "Settings for controlling behavior of the logs subsystem"
},
"ServerServicesCancellationCleanupSettings": {
"properties": {
"enabled": {
"type": "boolean",
"title": "Enabled",
"description": "Whether or not to start the cancellation cleanup service in the server application.",
"default": true,
"supported_environment_variables": [
"PREFECT_SERVER_SERVICES_CANCELLATION_CLEANUP_ENABLED",
"PREFECT_API_SERVICES_CANCELLATION_CLEANUP_ENABLED"
]
},
"loop_seconds": {
"type": "number",
"title": "Loop Seconds",
"description": "The cancellation cleanup service will look for non-terminal tasks and subflows this often. Defaults to `20`.",
"default": 20,
"supported_environment_variables": [
"PREFECT_SERVER_SERVICES_CANCELLATION_CLEANUP_LOOP_SECONDS",
"PREFECT_API_SERVICES_CANCELLATION_CLEANUP_LOOP_SECONDS"
]
}
},
"type": "object",
"title": "ServerServicesCancellationCleanupSettings",
"description": "Settings for controlling the cancellation cleanup service"
},
"ServerServicesDBVacuumSettings": {
"properties": {
"enabled": {
"type": "boolean",
"title": "Enabled",
"description": "Whether or not to start the database vacuum service in the server application. Disabled by default because it permanently deletes data.",
"default": false,
"supported_environment_variables": [
"PREFECT_SERVER_SERVICES_DB_VACUUM_ENABLED"
]
},
"loop_seconds": {
"type": "number",
"exclusiveMinimum": 0.0,
"title": "Loop Seconds",
"description": "The database vacuum service will run this often, in seconds. Defaults to `3600` (1 hour).",
"default": 3600,
"supported_environment_variables": [
"PREFECT_SERVER_SERVICES_DB_VACUUM_LOOP_SECONDS"
]
},
"retention_period": {
"type": "string",
"format": "duration",
"title": "Retention Period",
"description": "How old a flow run must be (based on end_time) before it is eligible for deletion. Accepts seconds. Minimum 1 hour. Defaults to 90 days.",
"default": "P90D",
"supported_environment_variables": [
"PREFECT_SERVER_SERVICES_DB_VACUUM_RETENTION_PERIOD"
]
},
"batch_size": {
"type": "integer",
"exclusiveMinimum": 0.0,
"title": "Batch Size",
"description": "The number of records to delete per database transaction. Defaults to `1000`.",
"default": 1000,
"supported_environment_variables": [
"PREFECT_SERVER_SERVICES_DB_VACUUM_BATCH_SIZE"
]
}
},
"type": "object",
"title": "ServerServicesDBVacuumSettings",
"description": "Settings for controlling the database vacuum service"
},
"ServerServicesEventLoggerSettings": {
"properties": {
"enabled": {
"type": "boolean",
"title": "Enabled",
"description": "Whether or not to start the event logger service in the server application.",
"default": false,
"supported_environment_variables": [
"PREFECT_SERVER_SERVICES_EVENT_LOGGER_ENABLED",
"PREFECT_API_SERVICES_EVENT_LOGGER_ENABLED"
]
}
},
"type": "object",
"title": "ServerServicesEventLoggerSettings",
"description": "Settings for controlling the event logger service"
},
"ServerServicesEventPersisterSettings": {
"properties": {
"enabled": {
"type": "boolean",
"title": "Enabled",
"description": "Whether or not to start the event persister service in the server application.",
"default": true,
"supported_environment_variables": [
"PREFECT_SERVER_SERVICES_EVENT_PERSISTER_ENABLED",
"PREFECT_API_SERVICES_EVENT_PERSISTER_ENABLED"
]
},
"batch_size": {
"type": "integer",
"exclusiveMinimum": 0.0,
"title": "Batch Size",
"description": "The number of events the event persister will attempt to insert in one batch.",
"default": 20,
"supported_environment_variables": [
"PREFECT_SERVER_SERVICES_EVENT_PERSISTER_BATCH_SIZE",
"PREFECT_API_SERVICES_EVENT_PERSISTER_BATCH_SIZE"
]
},
"read_batch_size": {
"type": "integer",
"exclusiveMinimum": 0.0,
"title": "Read Batch Size",
"description": "The number of events the event persister will attempt to read from the message broker in one batch.",
"default": 1,
"supported_environment_variables": [
"PREFECT_SERVER_SERVICES_EVENT_PERSISTER_READ_BATCH_SIZE",
"PREFECT_API_SERVICES_EVENT_PERSISTER_READ_BATCH_SIZE"
]
},
"flush_interval": {
"type": "number",
"exclusiveMinimum": 0.0,
"title": "Flush Interval",
"description": "The maximum number of seconds between flushes of the event persister.",
"default": 5,
"supported_environment_variables": [
"PREFECT_SERVER_SERVICES_EVENT_PERSISTER_FLUSH_INTERVAL",
"PREFECT_API_SERVICES_EVENT_PERSISTER_FLUSH_INTERVAL"
]
},
"batch_size_delete": {
"type": "integer",
"exclusiveMinimum": 0.0,
"title": "Batch Size Delete",
"description": "The number of expired events and event resources the event persister will attempt to delete in one batch.",
"default": 10000,
"supported_environment_variables": [
"PREFECT_SERVER_SERVICES_EVENT_PERSISTER_BATCH_SIZE_DELETE"
]
},
"queue_max_size": {
"type": "integer",
"exclusiveMinimum": 0.0,
"title": "Queue Max Size",
"description": "The maximum number of events that can be queued in memory for persistence. When the queue is full, new events will be dropped.",
"default": 50000,
"supported_environment_variables": [
"PREFECT_SERVER_SERVICES_EVENT_PERSISTER_QUEUE_MAX_SIZE"
]
},
"max_flush_retries": {
"type": "integer",
"exclusiveMinimum": 0.0,
"title": "Max Flush Retries",
"description": "The maximum number of consecutive flush failures before events are dropped instead of being re-queued.",
"default": 5,
"supported_environment_variables": [
"PREFECT_SERVER_SERVICES_EVENT_PERSISTER_MAX_FLUSH_RETRIES"
]
}
},
"type": "object",
"title": "ServerServicesEventPersisterSettings",
"description": "Settings for controlling the event persister service"
},
"ServerServicesForemanSettings": {
"properties": {
"enabled": {
"type": "boolean",
"title": "Enabled",
"description": "Whether or not to start the foreman service in the server application.",
"default": true,
"supported_environment_variables": [
"PREFECT_SERVER_SERVICES_FOREMAN_ENABLED",
"PREFECT_API_SERVICES_FOREMAN_ENABLED"
]
},
"loop_seconds": {
"type": "number",
"title": "Loop Seconds",
"description": "The foreman service will check for offline workers this often. Defaults to `15`.",
"default": 15,
"supported_environment_variables": [
"PREFECT_SERVER_SERVICES_FOREMAN_LOOP_SECONDS",
"PREFECT_API_SERVICES_FOREMAN_LOOP_SECONDS"
]
},
"inactivity_heartbeat_multiple": {
"type": "integer",
"title": "Inactivity Heartbeat Multiple",
"description": "\n The number of heartbeats that must be missed before a worker is marked as offline. Defaults to `3`.\n ",
"default": 3,
"supported_environment_variables": [
"PREFECT_SERVER_SERVICES_FOREMAN_INACTIVITY_HEARTBEAT_MULTIPLE",
"PREFECT_API_SERVICES_FOREMAN_INACTIVITY_HEARTBEAT_MULTIPLE"
]
},
"fallback_heartbeat_interval_seconds": {
"type": "integer",
"title": "Fallback Heartbeat Interval Seconds",
"description": "\n The number of seconds to use for online/offline evaluation if a worker's heartbeat\n interval is not set. Defaults to `30`.\n ",
"default": 30,
"supported_environment_variables": [
"PREFECT_SERVER_SERVICES_FOREMAN_FALLBACK_HEARTBEAT_INTERVAL_SECONDS",
"PREFECT_API_SERVICES_FOREMAN_FALLBACK_HEARTBEAT_INTERVAL_SECONDS"
]
},
"deployment_last_polled_timeout_seconds": {
"type": "integer",
"title": "Deployment Last Polled Timeout Seconds",
"description": "\n The number of seconds before a deployment is marked as not ready if it has not been\n polled. Defaults to `60`.\n ",
"default": 60,
"supported_environment_variables": [
"PREFECT_SERVER_SERVICES_FOREMAN_DEPLOYMENT_LAST_POLLED_TIMEOUT_SECONDS",
"PREFECT_API_SERVICES_FOREMAN_DEPLOYMENT_LAST_POLLED_TIMEOUT_SECONDS"
]
},
"work_queue_last_polled_timeout_seconds": {
"type": "integer",
"title": "Work Queue Last Polled Timeout Seconds",
"description": "\n The number of seconds before a work queue is marked as not ready if it has not been\n polled. Defaults to `60`.\n ",
"default": 60,
"supported_environment_variables": [
"PREFECT_SERVER_SERVICES_FOREMAN_WORK_QUEUE_LAST_POLLED_TIMEOUT_SECONDS",
"PREFECT_API_SERVICES_FOREMAN_WORK_QUEUE_LAST_POLLED_TIMEOUT_SECONDS"
]
}
},
"type": "object",
"title": "ServerServicesForemanSettings",
"description": "Settings for controlling the foreman service"
},
"ServerServicesLateRunsSettings": {
"properties": {
"enabled": {
"type": "boolean",
"title": "Enabled",
"description": "Whether or not to start the late runs service in the server application.",
"default": true,
"supported_environment_variables": [
"PREFECT_SERVER_SERVICES_LATE_RUNS_ENABLED",
"PREFECT_API_SERVICES_LATE_RUNS_ENABLED"
]
},
"loop_seconds": {
"type": "number",
"title": "Loop Seconds",
"description": "\n The late runs service will look for runs to mark as late this often. Defaults to `5`.\n ",
"default": 5,
"supported_environment_variables": [
"PREFECT_SERVER_SERVICES_LATE_RUNS_LOOP_SECONDS",
"PREFECT_API_SERVICES_LATE_RUNS_LOOP_SECONDS"
]
},
"after_seconds": {
"type": "string",
"format": "duration",
"title": "After Seconds",
"description": "\n The late runs service will mark runs as late after they have exceeded their scheduled start time by this many seconds. Defaults to `5` seconds.\n ",
"default": "PT15S",
"supported_environment_variables": [
"PREFECT_SERVER_SERVICES_LATE_RUNS_AFTER_SECONDS",
"PREFECT_API_SERVICES_LATE_RUNS_AFTER_SECONDS"
]
}
},
"type": "object",
"title": "ServerServicesLateRunsSettings",
"description": "Settings for controlling the late runs service"
},
"ServerServicesPauseExpirationsSettings": {
"properties": {
"enabled": {
"type": "boolean",
"title": "Enabled",
"description": "\n Whether or not to start the paused flow run expiration service in the server\n application. If disabled, paused flows that have timed out will remain in a Paused state\n until a resume attempt.\n ",
"default": true,
"supported_environment_variables": [
"PREFECT_SERVER_SERVICES_PAUSE_EXPIRATIONS_ENABLED",
"PREFECT_API_SERVICES_PAUSE_EXPIRATIONS_ENABLED"
]
},
"loop_seconds": {
"type": "number",
"title": "Loop Seconds",
"description": "\n The pause expiration service will look for runs to mark as failed this often. Defaults to `5`.\n ",
"default": 5,
"supported_environment_variables": [
"PREFECT_SERVER_SERVICES_PAUSE_EXPIRATIONS_LOOP_SECONDS",
"PREFECT_API_SERVICES_PAUSE_EXPIRATIONS_LOOP_SECONDS"
]
}
},
"type": "object",
"title": "ServerServicesPauseExpirationsSettings",
"description": "Settings for controlling the pause expiration service"
},
"ServerServicesRepossessorSettings": {
"properties": {
"enabled": {
"type": "boolean",
"title": "Enabled",
"description": "Whether or not to start the repossessor service in the server application.",
"default": true,
"supported_environment_variables": [
"PREFECT_SERVER_SERVICES_REPOSSESSOR_ENABLED"
]
},
"loop_seconds": {
"type": "number",
"title": "Loop Seconds",
"description": "The repossessor service will look for expired leases this often. Defaults to `15`.",
"default": 15,
"supported_environment_variables": [
"PREFECT_SERVER_SERVICES_REPOSSESSOR_LOOP_SECONDS"
]
}
},
"type": "object",
"title": "ServerServicesRepossessorSettings",
"description": "Settings for controlling the repossessor service"
},
"ServerServicesSchedulerSettings": {
"properties": {
"enabled": {
"type": "boolean",
"title": "Enabled",
"description": "Whether or not to start the scheduler service in the server application.",
"default": true,
"supported_environment_variables": [
"PREFECT_SERVER_SERVICES_SCHEDULER_ENABLED",
"PREFECT_API_SERVICES_SCHEDULER_ENABLED"
]
},
"loop_seconds": {
"type": "number",
"title": "Loop Seconds",
"description": "\n The scheduler loop interval, in seconds. This determines\n how often the scheduler will attempt to schedule new flow runs, but has no\n impact on how quickly either flow runs or task runs are actually executed.\n Defaults to `60`.\n ",
"default": 60,
"supported_environment_variables": [
"PREFECT_SERVER_SERVICES_SCHEDULER_LOOP_SECONDS",
"PREFECT_API_SERVICES_SCHEDULER_LOOP_SECONDS"
]
},
"deployment_batch_size": {
"type": "integer",
"title": "Deployment Batch Size",
"description": "\n The number of deployments the scheduler will attempt to\n schedule in a single batch. If there are more deployments than the batch\n size, the scheduler immediately attempts to schedule the next batch; it\n does not sleep for `scheduler_loop_seconds` until it has visited every\n deployment once. Defaults to `100`.\n ",
"default": 100,
"supported_environment_variables": [
"PREFECT_SERVER_SERVICES_SCHEDULER_DEPLOYMENT_BATCH_SIZE",
"PREFECT_API_SERVICES_SCHEDULER_DEPLOYMENT_BATCH_SIZE"
]
},
"max_runs": {
"type": "integer",
"title": "Max Runs",
"description": "\n The scheduler will attempt to schedule up to this many\n auto-scheduled runs in the future. Note that runs may have fewer than\n this many scheduled runs, depending on the value of\n `scheduler_max_scheduled_time`. Defaults to `100`.\n ",
"default": 100,
"supported_environment_variables": [
"PREFECT_SERVER_SERVICES_SCHEDULER_MAX_RUNS",
"PREFECT_API_SERVICES_SCHEDULER_MAX_RUNS"
]
},
"min_runs": {
"type": "integer",
"title": "Min Runs",
"description": "\n The scheduler will attempt to schedule at least this many\n auto-scheduled runs in the future. Note that runs may have more than\n this many scheduled runs, depending on the value of\n `scheduler_min_scheduled_time`. Defaults to `3`.\n ",
"default": 3,
"supported_environment_variables": [
"PREFECT_SERVER_SERVICES_SCHEDULER_MIN_RUNS",
"PREFECT_API_SERVICES_SCHEDULER_MIN_RUNS"
]
},
"max_scheduled_time": {
"type": "string",
"format": "duration",
"title": "Max Scheduled Time",
"description": "\n The scheduler will create new runs up to this far in the\n future. Note that this setting will take precedence over\n `scheduler_max_runs`: if a flow runs once a month and\n `scheduler_max_scheduled_time` is three months, then only three runs will be\n scheduled. Defaults to 100 days (`8640000` seconds).\n ",
"default": "P100D",
"supported_environment_variables": [
"PREFECT_SERVER_SERVICES_SCHEDULER_MAX_SCHEDULED_TIME",
"PREFECT_API_SERVICES_SCHEDULER_MAX_SCHEDULED_TIME"
]
},
"min_scheduled_time": {
"type": "string",
"format": "duration",
"title": "Min Scheduled Time",
"description": "\n The scheduler will create new runs at least this far in the\n future. Note that this setting will take precedence over `scheduler_min_runs`:\n if a flow runs every hour and `scheduler_min_scheduled_time` is three hours,\n then three runs will be scheduled even if `scheduler_min_runs` is 1. Defaults to\n ",
"default": "PT1H",
"supported_environment_variables": [
"PREFECT_SERVER_SERVICES_SCHEDULER_MIN_SCHEDULED_TIME",
"PREFECT_API_SERVICES_SCHEDULER_MIN_SCHEDULED_TIME"
]
},
"insert_batch_size": {
"type": "integer",
"title": "Insert Batch Size",
"description": "\n The number of runs the scheduler will attempt to insert in a single batch.\n Defaults to `500`.\n ",
"default": 500,
"supported_environment_variables": [
"PREFECT_SERVER_SERVICES_SCHEDULER_INSERT_BATCH_SIZE",
"PREFECT_API_SERVICES_SCHEDULER_INSERT_BATCH_SIZE"
]
},
"recent_deployments_loop_seconds": {
"type": "number",
"title": "Recent Deployments Loop Seconds",
"description": "\n The number of seconds the recent deployments scheduler will wait between checking for recently updated deployments. Defaults to `5`.\n ",
"default": 5,
"supported_environment_variables": [
"PREFECT_SERVER_SERVICES_SCHEDULER_RECENT_DEPLOYMENTS_LOOP_SECONDS"
]
}
},
"type": "object",
"title": "ServerServicesSchedulerSettings",
"description": "Settings for controlling the scheduler service"
},
"ServerServicesSettings": {
"properties": {
"cancellation_cleanup": {
"$ref": "#/components/schemas/ServerServicesCancellationCleanupSettings",
"supported_environment_variables": []
},
"db_vacuum": {
"$ref": "#/components/schemas/ServerServicesDBVacuumSettings",
"supported_environment_variables": []
},
"event_persister": {
"$ref": "#/components/schemas/ServerServicesEventPersisterSettings",
"supported_environment_variables": []
},
"event_logger": {
"$ref": "#/components/schemas/ServerServicesEventLoggerSettings",
"supported_environment_variables": []
},
"foreman": {
"$ref": "#/components/schemas/ServerServicesForemanSettings",
"supported_environment_variables": []
},
"late_runs": {
"$ref": "#/components/schemas/ServerServicesLateRunsSettings",
"supported_environment_variables": []
},
"scheduler": {
"$ref": "#/components/schemas/ServerServicesSchedulerSettings",
"supported_environment_variables": []
},
"pause_expirations": {
"$ref": "#/components/schemas/ServerServicesPauseExpirationsSettings",
"supported_environment_variables": []
},
"repossessor": {
"$ref": "#/components/schemas/ServerServicesRepossessorSettings",
"supported_environment_variables": []
},
"task_run_recorder": {
"$ref": "#/components/schemas/ServerServicesTaskRunRecorderSettings",
"supported_environment_variables": []
},
"triggers": {
"$ref": "#/components/schemas/ServerServicesTriggersSettings",
"supported_environment_variables": []
}
},
"type": "object",
"title": "ServerServicesSettings",
"description": "Settings for controlling server services"
},
"ServerServicesTaskRunRecorderSettings": {
"properties": {
"enabled": {
"type": "boolean",
"title": "Enabled",
"description": "Whether or not to start the task run recorder service in the server application.",
"default": true,
"supported_environment_variables": [
"PREFECT_SERVER_SERVICES_TASK_RUN_RECORDER_ENABLED",
"PREFECT_API_SERVICES_TASK_RUN_RECORDER_ENABLED"
]
},
"read_batch_size": {
"type": "integer",
"exclusiveMinimum": 0.0,
"title": "Read Batch Size",
"description": "The number of task runs the task run recorder will attempt to read from the message broker in one batch.",
"default": 1,
"supported_environment_variables": [
"PREFECT_SERVER_SERVICES_TASK_RUN_RECORDER_READ_BATCH_SIZE"
]
},
"batch_size": {
"type": "integer",
"exclusiveMinimum": 0.0,
"title": "Batch Size",
"description": "The number of task runs the task run recorder will attempt to insert in one batch.",
"default": 1,
"supported_environment_variables": [
"PREFECT_SERVER_SERVICES_TASK_RUN_RECORDER_BATCH_SIZE"
]
},
"flush_interval": {
"type": "number",
"exclusiveMinimum": 0.0,
"title": "Flush Interval",
"description": "The maximum number of seconds between flushes of the task run recorder.",
"default": 5,
"supported_environment_variables": [
"PREFECT_SERVER_SERVICES_TASK_RUN_RECORDER_FLUSH_INTERVAL"
]
}
},
"type": "object",
"title": "ServerServicesTaskRunRecorderSettings",
"description": "Settings for controlling the task run recorder service"
},
"ServerServicesTriggersSettings": {
"properties": {
"enabled": {
"type": "boolean",
"title": "Enabled",
"description": "Whether or not to start the triggers service in the server application.",
"default": true,
"supported_environment_variables": [
"PREFECT_SERVER_SERVICES_TRIGGERS_ENABLED",
"PREFECT_API_SERVICES_TRIGGERS_ENABLED"
]
},
"read_batch_size": {
"type": "integer",
"exclusiveMinimum": 0.0,
"title": "Read Batch Size",
"description": "The number of events the triggers service will attempt to read from the message broker in one batch.",
"default": 1,
"supported_environment_variables": [
"PREFECT_SERVER_SERVICES_TRIGGERS_READ_BATCH_SIZE"
]
},
"pg_notify_reconnect_interval_seconds": {
"type": "integer",
"title": "Pg Notify Reconnect Interval Seconds",
"description": "\n The number of seconds to wait before reconnecting to the PostgreSQL NOTIFY/LISTEN \n connection after an error. Only used when using PostgreSQL as the database.\n Defaults to `10`.\n ",
"default": 10,
"supported_environment_variables": [
"PREFECT_SERVER_SERVICES_TRIGGERS_PG_NOTIFY_RECONNECT_INTERVAL_SECONDS"
]
},
"pg_notify_heartbeat_interval_seconds": {
"type": "integer",
"title": "Pg Notify Heartbeat Interval Seconds",
"description": "\n The number of seconds between heartbeat checks for the PostgreSQL NOTIFY/LISTEN \n connection to ensure it's still alive. Only used when using PostgreSQL as the database.\n Defaults to `5`.\n ",
"default": 5,
"supported_environment_variables": [
"PREFECT_SERVER_SERVICES_TRIGGERS_PG_NOTIFY_HEARTBEAT_INTERVAL_SECONDS"
]
}
},
"type": "object",
"title": "ServerServicesTriggersSettings",
"description": "Settings for controlling the triggers service"
},
"ServerSettings": {
"properties": {
"logging_level": {
"type": "string",
"enum": [
"DEBUG",
"INFO",
"WARNING",
"ERROR",
"CRITICAL"
],
"title": "Logging Level",
"description": "The default logging level for the Prefect API server.",
"default": "WARNING",
"supported_environment_variables": [
"PREFECT_SERVER_LOGGING_LEVEL",
"PREFECT_LOGGING_SERVER_LEVEL"
]
},
"analytics_enabled": {
"type": "boolean",
"title": "Analytics Enabled",
"description": "\n When enabled, Prefect sends anonymous data (e.g. count of flow runs, package version)\n on server startup to help us improve our product.\n ",
"default": true,
"supported_environment_variables": [
"PREFECT_SERVER_ANALYTICS_ENABLED"
]
},
"metrics_enabled": {
"type": "boolean",
"title": "Metrics Enabled",
"description": "Whether or not to enable Prometheus metrics in the API.",
"default": false,
"supported_environment_variables": [
"PREFECT_SERVER_METRICS_ENABLED",
"PREFECT_API_ENABLE_METRICS"
]
},
"log_retryable_errors": {
"type": "boolean",
"title": "Log Retryable Errors",
"description": "If `True`, log retryable errors in the API and it's services.",
"default": false,
"supported_environment_variables": [
"PREFECT_SERVER_LOG_RETRYABLE_ERRORS",
"PREFECT_API_LOG_RETRYABLE_ERRORS"
]
},
"register_blocks_on_start": {
"type": "boolean",
"title": "Register Blocks On Start",
"description": "If set, any block types that have been imported will be registered with the backend on application startup. If not set, block types must be manually registered.",
"default": true,
"supported_environment_variables": [
"PREFECT_SERVER_REGISTER_BLOCKS_ON_START",
"PREFECT_API_BLOCKS_REGISTER_ON_START"
]
},
"memoize_block_auto_registration": {
"type": "boolean",
"title": "Memoize Block Auto Registration",
"description": "Controls whether or not block auto-registration on start",
"default": true,
"supported_environment_variables": [
"PREFECT_SERVER_MEMOIZE_BLOCK_AUTO_REGISTRATION",
"PREFECT_MEMOIZE_BLOCK_AUTO_REGISTRATION"
]
},
"memo_store_path": {
"type": "string",
"format": "path",
"title": "Memo Store Path",
"description": "Path to the memo store file. Defaults to $PREFECT_HOME/memo_store.toml",
"supported_environment_variables": [
"PREFECT_SERVER_MEMO_STORE_PATH",
"PREFECT_MEMO_STORE_PATH"
]
},
"deployment_schedule_max_scheduled_runs": {
"type": "integer",
"title": "Deployment Schedule Max Scheduled Runs",
"description": "The maximum number of scheduled runs to create for a deployment.",
"default": 50,
"supported_environment_variables": [
"PREFECT_SERVER_DEPLOYMENT_SCHEDULE_MAX_SCHEDULED_RUNS",
"PREFECT_DEPLOYMENT_SCHEDULE_MAX_SCHEDULED_RUNS"
]
},
"api": {
"$ref": "#/components/schemas/ServerAPISettings",
"supported_environment_variables": []
},
"concurrency": {
"$ref": "#/components/schemas/ServerConcurrencySettings",
"description": "Settings for controlling server-side concurrency limit handling",
"supported_environment_variables": []
},
"database": {
"$ref": "#/components/schemas/ServerDatabaseSettings",
"supported_environment_variables": []
},
"deployments": {
"$ref": "#/components/schemas/ServerDeploymentsSettings",
"description": "Settings for controlling server deployments behavior",
"supported_environment_variables": []
},
"docket": {
"$ref": "#/components/schemas/ServerDocketSettings",
"description": "Settings for controlling server Docket behavior",
"supported_environment_variables": []
},
"ephemeral": {
"$ref": "#/components/schemas/ServerEphemeralSettings",
"supported_environment_variables": []
},
"events": {
"$ref": "#/components/schemas/ServerEventsSettings",
"description": "Settings for controlling server events behavior",
"supported_environment_variables": []
},
"flow_run_graph": {
"$ref": "#/components/schemas/ServerFlowRunGraphSettings",
"description": "Settings for controlling flow run graph behavior",
"supported_environment_variables": []
},
"logs": {
"$ref": "#/components/schemas/ServerLogsSettings",
"description": "Settings for controlling server logs behavior",
"supported_environment_variables": []
},
"services": {
"$ref": "#/components/schemas/ServerServicesSettings",
"description": "Settings for controlling server services behavior",
"supported_environment_variables": []
},
"tasks": {
"$ref": "#/components/schemas/ServerTasksSettings",
"description": "Settings for controlling server tasks behavior",
"supported_environment_variables": []
},
"ui": {
"$ref": "#/components/schemas/ServerUISettings",
"description": "Settings for controlling server UI behavior",
"supported_environment_variables": []
}
},
"type": "object",
"title": "ServerSettings",
"description": "Settings for controlling server behavior"
},
"ServerTasksSchedulingSettings": {
"properties": {
"max_scheduled_queue_size": {
"type": "integer",
"title": "Max Scheduled Queue Size",
"description": "The maximum number of scheduled tasks to queue for submission.",
"default": 1000,
"supported_environment_variables": [
"PREFECT_SERVER_TASKS_SCHEDULING_MAX_SCHEDULED_QUEUE_SIZE",
"PREFECT_TASK_SCHEDULING_MAX_SCHEDULED_QUEUE_SIZE"
]
},
"max_retry_queue_size": {
"type": "integer",
"title": "Max Retry Queue Size",
"description": "The maximum number of retries to queue for submission.",
"default": 100,
"supported_environment_variables": [
"PREFECT_SERVER_TASKS_SCHEDULING_MAX_RETRY_QUEUE_SIZE",
"PREFECT_TASK_SCHEDULING_MAX_RETRY_QUEUE_SIZE"
]
},
"pending_task_timeout": {
"type": "string",
"format": "duration",
"title": "Pending Task Timeout",
"description": "How long before a PENDING task are made available to another task worker.",
"default": "PT0S",
"supported_environment_variables": [
"PREFECT_SERVER_TASKS_SCHEDULING_PENDING_TASK_TIMEOUT",
"PREFECT_TASK_SCHEDULING_PENDING_TASK_TIMEOUT"
]
}
},
"type": "object",
"title": "ServerTasksSchedulingSettings",
"description": "Settings for controlling server-side behavior related to task scheduling"
},
"ServerTasksSettings": {
"properties": {
"tag_concurrency_slot_wait_seconds": {
"type": "number",
"minimum": 0.0,
"title": "Tag Concurrency Slot Wait Seconds",
"description": "The number of seconds to wait before retrying when a task run cannot secure a concurrency slot from the server.",
"default": 30,
"supported_environment_variables": [
"PREFECT_SERVER_TASKS_TAG_CONCURRENCY_SLOT_WAIT_SECONDS",
"PREFECT_TASK_RUN_TAG_CONCURRENCY_SLOT_WAIT_SECONDS"
]
},
"max_cache_key_length": {
"type": "integer",
"title": "Max Cache Key Length",
"description": "The maximum number of characters allowed for a task run cache key.",
"default": 2000,
"supported_environment_variables": [
"PREFECT_SERVER_TASKS_MAX_CACHE_KEY_LENGTH",
"PREFECT_API_TASK_CACHE_KEY_MAX_LENGTH"
]
},
"scheduling": {
"$ref": "#/components/schemas/ServerTasksSchedulingSettings",
"supported_environment_variables": []
}
},
"type": "object",
"title": "ServerTasksSettings",
"description": "Settings for controlling server-side behavior related to tasks"
},
"ServerUISettings": {
"properties": {
"enabled": {
"type": "boolean",
"title": "Enabled",
"description": "Whether or not to serve the Prefect UI.",
"default": true,
"supported_environment_variables": [
"PREFECT_SERVER_UI_ENABLED",
"PREFECT_UI_ENABLED"
]
},
"v2_enabled": {
"type": "boolean",
"title": "V2 Enabled",
"description": "Whether to serve the experimental V2 UI instead of the default V1 UI.",
"default": false,
"supported_environment_variables": [
"PREFECT_SERVER_UI_V2_ENABLED"
]
},
"api_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Api Url",
"description": "The connection url for communication from the UI to the API. Defaults to `PREFECT_API_URL` if set. Otherwise, the default URL is generated from `PREFECT_SERVER_API_HOST` and `PREFECT_SERVER_API_PORT`.",
"supported_environment_variables": [
"PREFECT_SERVER_UI_API_URL",
"PREFECT_UI_API_URL"
]
},
"serve_base": {
"type": "string",
"title": "Serve Base",
"description": "The base URL path to serve the Prefect UI from.",
"default": "/",
"supported_environment_variables": [
"PREFECT_SERVER_UI_SERVE_BASE",
"PREFECT_UI_SERVE_BASE"
]
},
"static_directory": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Static Directory",
"description": "The directory to serve static files from. This should be used when running into permissions issues when attempting to serve the UI from the default directory (for example when running in a Docker container).",
"supported_environment_variables": [
"PREFECT_SERVER_UI_STATIC_DIRECTORY",
"PREFECT_UI_STATIC_DIRECTORY"
]
},
"show_promotional_content": {
"type": "boolean",
"title": "Show Promotional Content",
"description": "Whether or not to display promotional content in the UI, including upgrade prompts and marketing banners.",
"default": true,
"supported_environment_variables": [
"PREFECT_SERVER_UI_SHOW_PROMOTIONAL_CONTENT"
]
}
},
"type": "object",
"title": "ServerUISettings"
},
"SetStateStatus": {
"type": "string",
"enum": [
"ACCEPT",
"REJECT",
"ABORT",
"WAIT"
],
"title": "SetStateStatus",
"description": "Enumerates return statuses for setting run states."
},
"Settings": {
"properties": {
"home": {
"type": "string",
"format": "path",
"title": "Home",
"description": "The path to the Prefect home directory. Defaults to ~/.prefect",
"default": "~/.prefect",
"supported_environment_variables": [
"PREFECT_HOME"
]
},
"profiles_path": {
"type": "string",
"format": "path",
"title": "Profiles Path",
"description": "The path to a profiles configuration file. Supports \\$PREFECT_HOME templating. Defaults to \\$PREFECT_HOME/profiles.toml.",
"supported_environment_variables": [
"PREFECT_PROFILES_PATH"
]
},
"debug_mode": {
"type": "boolean",
"title": "Debug Mode",
"description": "If True, enables debug mode which may provide additional logging and debugging features.",
"default": false,
"supported_environment_variables": [
"PREFECT_DEBUG_MODE"
]
},
"api": {
"$ref": "#/components/schemas/APISettings",
"supported_environment_variables": []
},
"cli": {
"$ref": "#/components/schemas/CLISettings",
"supported_environment_variables": []
},
"client": {
"$ref": "#/components/schemas/ClientSettings",
"supported_environment_variables": []
},
"cloud": {
"$ref": "#/components/schemas/CloudSettings",
"supported_environment_variables": []
},
"deployments": {
"$ref": "#/components/schemas/DeploymentsSettings",
"supported_environment_variables": []
},
"experiments": {
"$ref": "#/components/schemas/ExperimentsSettings",
"description": "Settings for controlling experimental features",
"supported_environment_variables": []
},
"flows": {
"$ref": "#/components/schemas/FlowsSettings",
"supported_environment_variables": []
},
"internal": {
"$ref": "#/components/schemas/InternalSettings",
"description": "Settings for internal Prefect machinery",
"supported_environment_variables": []
},
"logging": {
"$ref": "#/components/schemas/LoggingSettings",
"supported_environment_variables": []
},
"results": {
"$ref": "#/components/schemas/ResultsSettings",
"supported_environment_variables": []
},
"runner": {
"$ref": "#/components/schemas/RunnerSettings",
"supported_environment_variables": []
},
"server": {
"$ref": "#/components/schemas/ServerSettings",
"supported_environment_variables": []
},
"tasks": {
"$ref": "#/components/schemas/TasksSettings",
"description": "Settings for controlling task behavior",
"supported_environment_variables": []
},
"testing": {
"$ref": "#/components/schemas/TestingSettings",
"description": "Settings used during testing",
"supported_environment_variables": []
},
"worker": {
"$ref": "#/components/schemas/WorkerSettings",
"description": "Settings for controlling worker behavior",
"supported_environment_variables": []
},
"ui_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Ui Url",
"description": "The URL of the Prefect UI. If not set, the client will attempt to infer it.",
"supported_environment_variables": [
"PREFECT_UI_URL"
]
},
"silence_api_url_misconfiguration": {
"type": "boolean",
"title": "Silence Api Url Misconfiguration",
"description": "\n If `True`, disable the warning when a user accidentally misconfigure its `PREFECT_API_URL`\n Sometimes when a user manually set `PREFECT_API_URL` to a custom url,reverse-proxy for example,\n we would like to silence this warning so we will set it to `FALSE`.\n ",
"default": false,
"supported_environment_variables": [
"PREFECT_SILENCE_API_URL_MISCONFIGURATION"
]
}
},
"type": "object",
"title": "Settings",
"description": "Settings for Prefect using Pydantic settings.\n\nSee https://docs.pydantic.dev/latest/concepts/pydantic_settings"
},
"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"
},
"SimpleNextFlowRun": {
"properties": {
"id": {
"type": "string",
"format": "uuid",
"title": "Id",
"description": "The flow run id."
},
"flow_id": {
"type": "string",
"format": "uuid",
"title": "Flow Id",
"description": "The flow id."
},
"name": {
"type": "string",
"title": "Name",
"description": "The flow run name"
},
"state_name": {
"type": "string",
"title": "State Name",
"description": "The state name."
},
"state_type": {
"$ref": "#/components/schemas/StateType",
"description": "The state type."
},
"next_scheduled_start_time": {
"type": "string",
"format": "date-time",
"title": "Next Scheduled Start Time",
"description": "The next scheduled start time"
}
},
"type": "object",
"required": [
"id",
"flow_id",
"name",
"state_name",
"state_type",
"next_scheduled_start_time"
],
"title": "SimpleNextFlowRun"
},
"State": {
"properties": {
"id": {
"type": "string",
"format": "uuid",
"title": "Id"
},
"type": {
"$ref": "#/components/schemas/StateType"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Name"
},
"timestamp": {
"type": "string",
"format": "date-time",
"title": "Timestamp"
},
"message": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Message",
"examples": [
"Run started"
]
},
"data": {
"anyOf": [
{},
{
"type": "null"
}
],
"title": "Data",
"description": "Data associated with the state, e.g. a result. Content must be storable as JSON."
},
"state_details": {
"$ref": "#/components/schemas/StateDetails"
}
},
"type": "object",
"required": [
"type",
"id"
],
"title": "State",
"description": "Represents the state of a run."
},
"StateAbortDetails": {
"properties": {
"type": {
"type": "string",
"const": "abort_details",
"title": "Type",
"description": "The type of state transition detail. Used to ensure pydantic does not coerce into a different type.",
"default": "abort_details"
},
"reason": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Reason",
"description": "The reason why the state transition was aborted."
}
},
"type": "object",
"title": "StateAbortDetails",
"description": "Details associated with an ABORT state transition."
},
"StateAcceptDetails": {
"properties": {
"type": {
"type": "string",
"const": "accept_details",
"title": "Type",
"description": "The type of state transition detail. Used to ensure pydantic does not coerce into a different type.",
"default": "accept_details"
}
},
"type": "object",
"title": "StateAcceptDetails",
"description": "Details associated with an ACCEPT state transition."
},
"StateCreate": {
"properties": {
"type": {
"$ref": "#/components/schemas/StateType",
"description": "The type of the state to create"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Name",
"description": "The name of the state to create"
},
"message": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Message",
"description": "The message of the state to create"
},
"data": {
"anyOf": [
{},
{
"type": "null"
}
],
"title": "Data",
"description": "The data of the state to create"
},
"state_details": {
"$ref": "#/components/schemas/StateDetails",
"description": "The details of the state to create"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"type"
],
"title": "StateCreate",
"description": "Data used by the Prefect REST API to create a new state."
},
"StateDetails": {
"properties": {
"flow_run_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Flow Run Id"
},
"task_run_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Task Run Id"
},
"child_flow_run_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Child Flow Run Id"
},
"scheduled_time": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Scheduled Time"
},
"cache_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cache Key"
},
"cache_expiration": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Cache Expiration"
},
"deferred": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Deferred",
"default": false
},
"untrackable_result": {
"type": "boolean",
"title": "Untrackable Result",
"default": false
},
"pause_timeout": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Pause Timeout"
},
"pause_reschedule": {
"type": "boolean",
"title": "Pause Reschedule",
"default": false
},
"pause_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Pause Key"
},
"run_input_keyset": {
"anyOf": [
{
"additionalProperties": {
"type": "string"
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Run Input Keyset"
},
"refresh_cache": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Refresh Cache"
},
"retriable": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Retriable"
},
"transition_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Transition Id"
},
"task_parameters_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Task Parameters Id"
},
"traceparent": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Traceparent"
},
"deployment_concurrency_lease_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Deployment Concurrency Lease Id"
}
},
"type": "object",
"title": "StateDetails"
},
"StateRejectDetails": {
"properties": {
"type": {
"type": "string",
"const": "reject_details",
"title": "Type",
"description": "The type of state transition detail. Used to ensure pydantic does not coerce into a different type.",
"default": "reject_details"
},
"reason": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Reason",
"description": "The reason why the state transition was rejected."
}
},
"type": "object",
"title": "StateRejectDetails",
"description": "Details associated with a REJECT state transition."
},
"StateType": {
"type": "string",
"enum": [
"SCHEDULED",
"PENDING",
"RUNNING",
"COMPLETED",
"FAILED",
"CANCELLED",
"CRASHED",
"PAUSED",
"CANCELLING"
],
"title": "StateType",
"description": "Enumeration of state types."
},
"StateWaitDetails": {
"properties": {
"type": {
"type": "string",
"const": "wait_details",
"title": "Type",
"description": "The type of state transition detail. Used to ensure pydantic does not coerce into a different type.",
"default": "wait_details"
},
"delay_seconds": {
"type": "integer",
"title": "Delay Seconds",
"description": "The length of time in seconds the client should wait before transitioning states."
},
"reason": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Reason",
"description": "The reason why the state transition should wait."
}
},
"type": "object",
"required": [
"delay_seconds"
],
"title": "StateWaitDetails",
"description": "Details associated with a WAIT state transition."
},
"SuspendFlowRun": {
"properties": {
"type": {
"type": "string",
"const": "suspend-flow-run",
"title": "Type",
"default": "suspend-flow-run"
}
},
"type": "object",
"title": "SuspendFlowRun",
"description": "Suspends a flow run associated with the trigger"
},
"TaskRun": {
"properties": {
"id": {
"type": "string",
"format": "uuid",
"title": "Id"
},
"created": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Created"
},
"updated": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Updated"
},
"name": {
"type": "string",
"title": "Name",
"examples": [
"my-task-run"
]
},
"flow_run_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Flow Run Id",
"description": "The flow run id of the task run."
},
"task_key": {
"type": "string",
"title": "Task Key",
"description": "A unique identifier for the task being run."
},
"dynamic_key": {
"type": "string",
"title": "Dynamic Key",
"description": "A dynamic key used to differentiate between multiple runs of the same task within the same flow run."
},
"cache_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cache Key",
"description": "An optional cache key. If a COMPLETED state associated with this cache key is found, the cached COMPLETED state will be used instead of executing the task run."
},
"cache_expiration": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Cache Expiration",
"description": "Specifies when the cached state should expire."
},
"task_version": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Task Version",
"description": "The version of the task being run."
},
"empirical_policy": {
"$ref": "#/components/schemas/TaskRunPolicy"
},
"tags": {
"items": {
"type": "string"
},
"type": "array",
"title": "Tags",
"description": "A list of tags for the task run.",
"examples": [
[
"tag-1",
"tag-2"
]
]
},
"labels": {
"anyOf": [
{
"additionalProperties": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "integer"
},
{
"type": "number"
},
{
"type": "string"
}
]
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Labels",
"description": "A dictionary of key-value labels. Values can be strings, numbers, or booleans.",
"examples": [
{
"key": "value1",
"key2": 42
}
]
},
"state_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "State Id",
"description": "The id of the current task run state."
},
"task_inputs": {
"additionalProperties": {
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/TaskRunResult"
},
{
"$ref": "#/components/schemas/FlowRunResult"
},
{
"$ref": "#/components/schemas/Parameter"
},
{
"$ref": "#/components/schemas/Constant"
}
]
},
"type": "array"
},
"type": "object",
"title": "Task Inputs",
"description": "Tracks the source of inputs to a task run. Used for internal bookkeeping."
},
"state_type": {
"anyOf": [
{
"$ref": "#/components/schemas/StateType"
},
{
"type": "null"
}
],
"description": "The type of the current task run state."
},
"state_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "State Name",
"description": "The name of the current task run state."
},
"run_count": {
"type": "integer",
"title": "Run Count",
"description": "The number of times the task run has been executed.",
"default": 0
},
"flow_run_run_count": {
"type": "integer",
"title": "Flow Run Run Count",
"description": "If the parent flow has retried, this indicates the flow retry this run is associated with.",
"default": 0
},
"expected_start_time": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Expected Start Time",
"description": "The task run's expected start time."
},
"next_scheduled_start_time": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Next Scheduled Start Time",
"description": "The next time the task run is scheduled to start."
},
"start_time": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start Time",
"description": "The actual start time."
},
"end_time": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End Time",
"description": "The actual end time."
},
"total_run_time": {
"type": "number",
"title": "Total Run Time",
"description": "Total run time. If the task run was executed multiple times, the time of each run will be summed.",
"default": 0.0
},
"estimated_run_time": {
"type": "number",
"title": "Estimated Run Time",
"description": "A real-time estimate of total run time.",
"default": 0.0
},
"estimated_start_time_delta": {
"type": "number",
"title": "Estimated Start Time Delta",
"description": "The difference between actual and expected start time.",
"default": 0.0
},
"state": {
"anyOf": [
{
"$ref": "#/components/schemas/State"
},
{
"type": "null"
}
],
"description": "The current task run state."
}
},
"type": "object",
"required": [
"task_key",
"dynamic_key",
"id",
"created",
"updated"
],
"title": "TaskRun",
"description": "An ORM representation of task run data."
},
"TaskRunCount": {
"additionalProperties": {
"type": "integer"
},
"type": "object"
},
"TaskRunCreate": {
"properties": {
"id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Id",
"description": "The ID to assign to the task run. If not provided, a random UUID will be generated."
},
"state": {
"anyOf": [
{
"$ref": "#/components/schemas/StateCreate"
},
{
"type": "null"
}
],
"description": "The state of the task run to create"
},
"name": {
"type": "string",
"title": "Name",
"examples": [
"my-task-run"
]
},
"flow_run_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Flow Run Id",
"description": "The flow run id of the task run."
},
"task_key": {
"type": "string",
"title": "Task Key",
"description": "A unique identifier for the task being run."
},
"dynamic_key": {
"type": "string",
"title": "Dynamic Key",
"description": "A dynamic key used to differentiate between multiple runs of the same task within the same flow run."
},
"cache_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cache Key",
"description": "An optional cache key. If a COMPLETED state associated with this cache key is found, the cached COMPLETED state will be used instead of executing the task run."
},
"cache_expiration": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Cache Expiration",
"description": "Specifies when the cached state should expire."
},
"task_version": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Task Version",
"description": "The version of the task being run."
},
"empirical_policy": {
"$ref": "#/components/schemas/TaskRunPolicy"
},
"tags": {
"items": {
"type": "string"
},
"type": "array",
"title": "Tags",
"description": "A list of tags for the task run.",
"examples": [
[
"tag-1",
"tag-2"
]
]
},
"labels": {
"anyOf": [
{
"additionalProperties": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "integer"
},
{
"type": "number"
},
{
"type": "string"
}
]
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Labels",
"description": "A dictionary of key-value labels. Values can be strings, numbers, or booleans.",
"examples": [
{
"key": "value1",
"key2": 42
}
]
},
"task_inputs": {
"additionalProperties": {
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/TaskRunResult"
},
{
"$ref": "#/components/schemas/FlowRunResult"
},
{
"$ref": "#/components/schemas/Parameter"
},
{
"$ref": "#/components/schemas/Constant"
}
]
},
"type": "array"
},
"type": "object",
"title": "Task Inputs",
"description": "The inputs to the task run."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"task_key",
"dynamic_key"
],
"title": "TaskRunCreate",
"description": "Data used by the Prefect REST API to create a task run"
},
"TaskRunFilter": {
"properties": {
"operator": {
"$ref": "#/components/schemas/Operator",
"description": "Operator for combining filter criteria. Defaults to 'and_'.",
"default": "and_"
},
"id": {
"anyOf": [
{
"$ref": "#/components/schemas/TaskRunFilterId"
},
{
"type": "null"
}
],
"description": "Filter criteria for `TaskRun.id`"
},
"name": {
"anyOf": [
{
"$ref": "#/components/schemas/TaskRunFilterName"
},
{
"type": "null"
}
],
"description": "Filter criteria for `TaskRun.name`"
},
"tags": {
"anyOf": [
{
"$ref": "#/components/schemas/TaskRunFilterTags"
},
{
"type": "null"
}
],
"description": "Filter criteria for `TaskRun.tags`"
},
"state": {
"anyOf": [
{
"$ref": "#/components/schemas/TaskRunFilterState"
},
{
"type": "null"
}
],
"description": "Filter criteria for `TaskRun.state`"
},
"start_time": {
"anyOf": [
{
"$ref": "#/components/schemas/TaskRunFilterStartTime"
},
{
"type": "null"
}
],
"description": "Filter criteria for `TaskRun.start_time`"
},
"expected_start_time": {
"anyOf": [
{
"$ref": "#/components/schemas/TaskRunFilterExpectedStartTime"
},
{
"type": "null"
}
],
"description": "Filter criteria for `TaskRun.expected_start_time`"
},
"subflow_runs": {
"anyOf": [
{
"$ref": "#/components/schemas/TaskRunFilterSubFlowRuns"
},
{
"type": "null"
}
],
"description": "Filter criteria for `TaskRun.subflow_run`"
},
"flow_run_id": {
"anyOf": [
{
"$ref": "#/components/schemas/TaskRunFilterFlowRunId"
},
{
"type": "null"
}
],
"description": "Filter criteria for `TaskRun.flow_run_id`"
}
},
"additionalProperties": false,
"type": "object",
"title": "TaskRunFilter",
"description": "Filter task runs. Only task runs matching all criteria will be returned"
},
"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`."
},
"TaskRunFilterFlowRunId": {
"properties": {
"operator": {
"$ref": "#/components/schemas/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 task run flow run ids to include"
},
"is_null_": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Is Null",
"description": "Filter for task runs with None as their flow run id",
"default": false
}
},
"additionalProperties": false,
"type": "object",
"title": "TaskRunFilterFlowRunId",
"description": "Filter by `TaskRun.flow_run_id`."
},
"TaskRunFilterId": {
"properties": {
"any_": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Any",
"description": "A list of task run ids to include"
}
},
"additionalProperties": false,
"type": "object",
"title": "TaskRunFilterId",
"description": "Filter by `TaskRun.id`."
},
"TaskRunFilterName": {
"properties": {
"any_": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Any",
"description": "A list of task run names to include",
"examples": [
[
"my-task-run-1",
"my-task-run-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": "TaskRunFilterName",
"description": "Filter by `TaskRun.name`."
},
"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`."
},
"TaskRunFilterState": {
"properties": {
"operator": {
"$ref": "#/components/schemas/Operator",
"description": "Operator for combining filter criteria. Defaults to 'and_'.",
"default": "and_"
},
"type": {
"anyOf": [
{
"$ref": "#/components/schemas/TaskRunFilterStateType"
},
{
"type": "null"
}
],
"description": "Filter criteria for `TaskRun.state_type`"
},
"name": {
"anyOf": [
{
"$ref": "#/components/schemas/TaskRunFilterStateName"
},
{
"type": "null"
}
],
"description": "Filter criteria for `TaskRun.state_name`"
}
},
"additionalProperties": false,
"type": "object",
"title": "TaskRunFilterState",
"description": "Filter by `TaskRun.type` and `TaskRun.name`."
},
"TaskRunFilterStateName": {
"properties": {
"any_": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Any",
"description": "A list of task run state names to include"
}
},
"additionalProperties": false,
"type": "object",
"title": "TaskRunFilterStateName",
"description": "Filter by `TaskRun.state_name`."
},
"TaskRunFilterStateType": {
"properties": {
"any_": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/StateType"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Any",
"description": "A list of task run state types to include"
}
},
"additionalProperties": false,
"type": "object",
"title": "TaskRunFilterStateType",
"description": "Filter by `TaskRun.state_type`."
},
"TaskRunFilterSubFlowRuns": {
"properties": {
"exists_": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Exists",
"description": "If true, only include task runs that are subflow run parents; if false, exclude parent task runs"
}
},
"additionalProperties": false,
"type": "object",
"title": "TaskRunFilterSubFlowRuns",
"description": "Filter by `TaskRun.subflow_run`."
},
"TaskRunFilterTags": {
"properties": {
"operator": {
"$ref": "#/components/schemas/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. Task runs will be returned only if their tags are a superset of the list",
"examples": [
[
"tag-1",
"tag-2"
]
]
},
"is_null_": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Is Null",
"description": "If true, only include task runs without tags"
}
},
"additionalProperties": false,
"type": "object",
"title": "TaskRunFilterTags",
"description": "Filter by `TaskRun.tags`."
},
"TaskRunPaginationResponse": {
"properties": {
"results": {
"items": {
"$ref": "#/components/schemas/TaskRunResponse"
},
"type": "array",
"title": "Results"
},
"count": {
"type": "integer",
"title": "Count"
},
"limit": {
"type": "integer",
"title": "Limit"
},
"pages": {
"type": "integer",
"title": "Pages"
},
"page": {
"type": "integer",
"title": "Page"
}
},
"type": "object",
"required": [
"results",
"count",
"limit",
"pages",
"page"
],
"title": "TaskRunPaginationResponse"
},
"TaskRunPolicy": {
"properties": {
"max_retries": {
"type": "integer",
"title": "Max Retries",
"description": "The maximum number of retries. Field is not used. Please use `retries` instead.",
"default": 0,
"deprecated": true
},
"retry_delay_seconds": {
"type": "number",
"title": "Retry Delay Seconds",
"description": "The delay between retries. Field is not used. Please use `retry_delay` instead.",
"default": 0,
"deprecated": true
},
"retries": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Retries",
"description": "The number of retries."
},
"retry_delay": {
"anyOf": [
{
"type": "integer"
},
{
"type": "number"
},
{
"items": {
"type": "integer"
},
"type": "array"
},
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Retry Delay",
"description": "A delay time or list of delay times between retries, in seconds."
},
"retry_jitter_factor": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Retry Jitter Factor",
"description": "Determines the amount a retry should jitter"
}
},
"type": "object",
"title": "TaskRunPolicy",
"description": "Defines of how a task run should retry."
},
"TaskRunResponse": {
"properties": {
"id": {
"type": "string",
"format": "uuid",
"title": "Id"
},
"created": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Created"
},
"updated": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Updated"
},
"name": {
"type": "string",
"title": "Name",
"description": "The name of the task run. Defaults to a random slug if not specified.",
"examples": [
"my-task-run"
]
},
"flow_run_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Flow Run Id",
"description": "The id of the flow run this task run belongs to."
},
"task_key": {
"type": "string",
"title": "Task Key",
"description": "The key of the task this run represents."
},
"state_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "State Id",
"description": "The id of the task run's current state."
},
"state": {
"anyOf": [
{
"$ref": "#/components/schemas/State"
},
{
"type": "null"
}
],
"description": "The current state of the task run."
},
"task_version": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Task Version",
"description": "The version of the task executed in this task run.",
"examples": [
"1.0"
]
},
"task_inputs": {
"additionalProperties": {
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/TaskRunResult"
},
{
"$ref": "#/components/schemas/FlowRunResult"
},
{
"$ref": "#/components/schemas/Parameter"
},
{
"$ref": "#/components/schemas/Constant"
}
]
},
"type": "array"
},
"type": "object",
"title": "Task Inputs",
"description": "Inputs provided to the task run."
},
"empirical_policy": {
"$ref": "#/components/schemas/TaskRunPolicy",
"description": "The task run's empirical retry policy."
},
"tags": {
"items": {
"type": "string"
},
"type": "array",
"title": "Tags",
"description": "A list of tags for the task run.",
"examples": [
[
"tag-1",
"tag-2"
]
]
},
"start_time": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start Time",
"description": "The actual start time."
},
"end_time": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End Time",
"description": "The actual end time."
},
"total_run_time": {
"type": "number",
"title": "Total Run Time",
"description": "Total run time. If the task run was executed multiple times, the time of each run will be summed.",
"default": 0.0
},
"estimated_run_time": {
"type": "number",
"title": "Estimated Run Time",
"description": "A real-time estimate of the total run time.",
"default": 0.0
},
"estimated_start_time_delta": {
"type": "number",
"title": "Estimated Start Time Delta",
"description": "The difference between actual and expected start time.",
"default": 0.0
}
},
"type": "object",
"required": [
"task_key",
"id",
"created",
"updated"
],
"title": "TaskRunResponse"
},
"TaskRunResult": {
"properties": {
"input_type": {
"type": "string",
"const": "task_run",
"title": "Input Type",
"default": "task_run"
},
"id": {
"type": "string",
"format": "uuid",
"title": "Id"
}
},
"type": "object",
"required": [
"id"
],
"title": "TaskRunResult",
"description": "Represents a task run result input to another task run."
},
"TaskRunSort": {
"type": "string",
"enum": [
"ID_DESC",
"EXPECTED_START_TIME_ASC",
"EXPECTED_START_TIME_DESC",
"NAME_ASC",
"NAME_DESC",
"NEXT_SCHEDULED_START_TIME_ASC",
"END_TIME_DESC"
],
"title": "TaskRunSort",
"description": "Defines task run sorting options."
},
"TaskRunUpdate": {
"properties": {
"name": {
"type": "string",
"title": "Name",
"examples": [
"my-task-run"
]
}
},
"additionalProperties": false,
"type": "object",
"title": "TaskRunUpdate",
"description": "Data used by the Prefect REST API to update a task run"
},
"TaskWorkerFilter": {
"properties": {
"task_keys": {
"items": {
"type": "string"
},
"type": "array",
"title": "Task Keys"
}
},
"type": "object",
"required": [
"task_keys"
],
"title": "TaskWorkerFilter"
},
"TaskWorkerResponse": {
"properties": {
"identifier": {
"type": "string",
"title": "Identifier"
},
"task_keys": {
"items": {
"type": "string"
},
"type": "array",
"title": "Task Keys"
},
"timestamp": {
"type": "string",
"format": "date-time",
"title": "Timestamp"
}
},
"type": "object",
"required": [
"identifier",
"task_keys",
"timestamp"
],
"title": "TaskWorkerResponse"
},
"TasksRunnerSettings": {
"properties": {
"thread_pool_max_workers": {
"anyOf": [
{
"type": "integer",
"exclusiveMinimum": 0.0
},
{
"type": "null"
}
],
"title": "Thread Pool Max Workers",
"description": "The maximum number of workers for ThreadPoolTaskRunner.",
"supported_environment_variables": [
"PREFECT_TASKS_RUNNER_THREAD_POOL_MAX_WORKERS",
"PREFECT_TASK_RUNNER_THREAD_POOL_MAX_WORKERS"
]
},
"process_pool_max_workers": {
"anyOf": [
{
"type": "integer",
"exclusiveMinimum": 0.0
},
{
"type": "null"
}
],
"title": "Process Pool Max Workers",
"description": "The maximum number of workers for ProcessPoolTaskRunner.",
"supported_environment_variables": [
"PREFECT_TASKS_RUNNER_PROCESS_POOL_MAX_WORKERS"
]
}
},
"type": "object",
"title": "TasksRunnerSettings"
},
"TasksSchedulingSettings": {
"properties": {
"default_storage_block": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Default Storage Block",
"description": "The `block-type/block-document` slug of a block to use as the default storage for autonomous tasks.",
"supported_environment_variables": [
"PREFECT_TASKS_SCHEDULING_DEFAULT_STORAGE_BLOCK",
"PREFECT_TASK_SCHEDULING_DEFAULT_STORAGE_BLOCK"
]
},
"delete_failed_submissions": {
"type": "boolean",
"title": "Delete Failed Submissions",
"description": "Whether or not to delete failed task submissions from the database.",
"default": true,
"supported_environment_variables": [
"PREFECT_TASKS_SCHEDULING_DELETE_FAILED_SUBMISSIONS",
"PREFECT_TASK_SCHEDULING_DELETE_FAILED_SUBMISSIONS"
]
}
},
"type": "object",
"title": "TasksSchedulingSettings"
},
"TasksSettings": {
"properties": {
"refresh_cache": {
"type": "boolean",
"title": "Refresh Cache",
"description": "If `True`, enables a refresh of cached results: re-executing the task will refresh the cached results.",
"default": false,
"supported_environment_variables": [
"PREFECT_TASKS_REFRESH_CACHE"
]
},
"default_no_cache": {
"type": "boolean",
"title": "Default No Cache",
"description": "If `True`, sets the default cache policy on all tasks to `NO_CACHE`.",
"default": false,
"supported_environment_variables": [
"PREFECT_TASKS_DEFAULT_NO_CACHE"
]
},
"disable_caching": {
"type": "boolean",
"title": "Disable Caching",
"description": "If `True`, disables caching on all tasks regardless of cache policy.",
"default": false,
"supported_environment_variables": [
"PREFECT_TASKS_DISABLE_CACHING"
]
},
"default_retries": {
"type": "integer",
"minimum": 0.0,
"title": "Default Retries",
"description": "This value sets the default number of retries for all tasks.",
"default": 0,
"supported_environment_variables": [
"PREFECT_TASKS_DEFAULT_RETRIES",
"PREFECT_TASK_DEFAULT_RETRIES"
]
},
"default_retry_delay_seconds": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "number"
},
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Default Retry Delay Seconds",
"description": "This value sets the default retry delay seconds for all tasks.",
"default": 0,
"supported_environment_variables": [
"PREFECT_TASKS_DEFAULT_RETRY_DELAY_SECONDS",
"PREFECT_TASK_DEFAULT_RETRY_DELAY_SECONDS"
]
},
"default_persist_result": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Default Persist Result",
"description": "If `True`, results will be persisted by default for all tasks. Set to `False` to disable persistence by default. Note that setting to `False` will override the behavior set by a parent flow or task.",
"supported_environment_variables": [
"PREFECT_TASKS_DEFAULT_PERSIST_RESULT"
]
},
"runner": {
"$ref": "#/components/schemas/TasksRunnerSettings",
"description": "Settings for controlling task runner behavior",
"supported_environment_variables": []
},
"scheduling": {
"$ref": "#/components/schemas/TasksSchedulingSettings",
"description": "Settings for controlling client-side task scheduling behavior",
"supported_environment_variables": []
}
},
"type": "object",
"title": "TasksSettings"
},
"TestingSettings": {
"properties": {
"test_mode": {
"type": "boolean",
"title": "Test Mode",
"description": "If `True`, places the API in test mode. This may modify behavior to facilitate testing.",
"default": false,
"supported_environment_variables": [
"PREFECT_TESTING_TEST_MODE",
"PREFECT_TEST_MODE"
]
},
"unit_test_mode": {
"type": "boolean",
"title": "Unit Test Mode",
"description": "This setting only exists to facilitate unit testing. If `True`, code is executing in a unit test context. Defaults to `False`.",
"default": false,
"supported_environment_variables": [
"PREFECT_TESTING_UNIT_TEST_MODE",
"PREFECT_UNIT_TEST_MODE"
]
},
"unit_test_loop_debug": {
"type": "boolean",
"title": "Unit Test Loop Debug",
"description": "If `True` turns on debug mode for the unit testing event loop.",
"default": true,
"supported_environment_variables": [
"PREFECT_TESTING_UNIT_TEST_LOOP_DEBUG",
"PREFECT_UNIT_TEST_LOOP_DEBUG"
]
},
"test_setting": {
"anyOf": [
{},
{
"type": "null"
}
],
"title": "Test Setting",
"description": "This setting only exists to facilitate unit testing. If in test mode, this setting will return its value. Otherwise, it returns `None`.",
"default": "FOO",
"supported_environment_variables": [
"PREFECT_TESTING_TEST_SETTING",
"PREFECT_TEST_SETTING"
]
}
},
"type": "object",
"title": "TestingSettings"
},
"TimeUnit": {
"type": "string",
"enum": [
"week",
"day",
"hour",
"minute",
"second"
],
"title": "TimeUnit"
},
"UITaskRun": {
"properties": {
"id": {
"type": "string",
"format": "uuid",
"title": "Id"
},
"created": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Created"
},
"updated": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Updated"
},
"name": {
"type": "string",
"title": "Name",
"examples": [
"my-task-run"
]
},
"flow_run_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Flow Run Id",
"description": "The flow run id of the task run."
},
"task_key": {
"type": "string",
"title": "Task Key",
"description": "A unique identifier for the task being run."
},
"dynamic_key": {
"type": "string",
"title": "Dynamic Key",
"description": "A dynamic key used to differentiate between multiple runs of the same task within the same flow run."
},
"cache_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cache Key",
"description": "An optional cache key. If a COMPLETED state associated with this cache key is found, the cached COMPLETED state will be used instead of executing the task run."
},
"cache_expiration": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Cache Expiration",
"description": "Specifies when the cached state should expire."
},
"task_version": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Task Version",
"description": "The version of the task being run."
},
"empirical_policy": {
"$ref": "#/components/schemas/TaskRunPolicy"
},
"tags": {
"items": {
"type": "string"
},
"type": "array",
"title": "Tags",
"description": "A list of tags for the task run.",
"examples": [
[
"tag-1",
"tag-2"
]
]
},
"labels": {
"anyOf": [
{
"additionalProperties": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "integer"
},
{
"type": "number"
},
{
"type": "string"
}
]
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Labels",
"description": "A dictionary of key-value labels. Values can be strings, numbers, or booleans.",
"examples": [
{
"key": "value1",
"key2": 42
}
]
},
"state_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "State Id",
"description": "The id of the current task run state."
},
"task_inputs": {
"additionalProperties": {
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/TaskRunResult"
},
{
"$ref": "#/components/schemas/FlowRunResult"
},
{
"$ref": "#/components/schemas/Parameter"
},
{
"$ref": "#/components/schemas/Constant"
}
]
},
"type": "array"
},
"type": "object",
"title": "Task Inputs",
"description": "Tracks the source of inputs to a task run. Used for internal bookkeeping."
},
"state_type": {
"anyOf": [
{
"$ref": "#/components/schemas/StateType"
},
{
"type": "null"
}
],
"description": "The type of the current task run state."
},
"state_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "State Name",
"description": "The name of the current task run state."
},
"run_count": {
"type": "integer",
"title": "Run Count",
"description": "The number of times the task run has been executed.",
"default": 0
},
"flow_run_run_count": {
"type": "integer",
"title": "Flow Run Run Count",
"description": "If the parent flow has retried, this indicates the flow retry this run is associated with.",
"default": 0
},
"expected_start_time": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Expected Start Time",
"description": "The task run's expected start time."
},
"next_scheduled_start_time": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Next Scheduled Start Time",
"description": "The next time the task run is scheduled to start."
},
"start_time": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start Time",
"description": "The actual start time."
},
"end_time": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End Time",
"description": "The actual end time."
},
"total_run_time": {
"type": "number",
"title": "Total Run Time",
"description": "Total run time. If the task run was executed multiple times, the time of each run will be summed.",
"default": 0.0
},
"estimated_run_time": {
"type": "number",
"title": "Estimated Run Time",
"description": "A real-time estimate of total run time.",
"default": 0.0
},
"estimated_start_time_delta": {
"type": "number",
"title": "Estimated Start Time Delta",
"description": "The difference between actual and expected start time.",
"default": 0.0
},
"state": {
"anyOf": [
{
"$ref": "#/components/schemas/State"
},
{
"type": "null"
}
],
"description": "The current task run state."
},
"flow_run_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Flow Run Name"
}
},
"type": "object",
"required": [
"task_key",
"dynamic_key",
"id",
"created",
"updated"
],
"title": "UITaskRun",
"description": "A task run with additional details for display in the UI."
},
"UpdatedBy": {
"properties": {
"id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Id",
"description": "The id of the updater of the object."
},
"type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Type",
"description": "The type of the updater of the object."
},
"display_value": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Display Value",
"description": "The display value for the updater."
}
},
"type": "object",
"title": "UpdatedBy"
},
"ValidationError": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
},
"input": {
"title": "Input"
},
"ctx": {
"type": "object",
"title": "Context"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"Variable": {
"properties": {
"id": {
"type": "string",
"format": "uuid",
"title": "Id"
},
"created": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Created"
},
"updated": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Updated"
},
"name": {
"type": "string",
"maxLength": 255,
"title": "Name",
"description": "The name of the variable",
"examples": [
"my-variable"
]
},
"value": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
},
{
"additionalProperties": true,
"type": "object"
},
{
"items": {},
"type": "array"
},
{
"type": "null"
}
],
"title": "Value",
"description": "The value of the variable",
"examples": [
"my-value"
]
},
"tags": {
"items": {
"type": "string"
},
"type": "array",
"title": "Tags",
"description": "A list of variable tags",
"examples": [
[
"tag-1",
"tag-2"
]
]
}
},
"type": "object",
"required": [
"name",
"value",
"id",
"created",
"updated"
],
"title": "Variable"
},
"VariableCreate": {
"properties": {
"name": {
"type": "string",
"maxLength": 255,
"title": "Name",
"description": "The name of the variable",
"examples": [
"my_variable"
]
},
"value": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
},
{
"additionalProperties": true,
"type": "object"
},
{
"items": {},
"type": "array"
},
{
"type": "null"
}
],
"title": "Value",
"description": "The value of the variable",
"examples": [
"my-value"
]
},
"tags": {
"items": {
"type": "string"
},
"type": "array",
"title": "Tags",
"description": "A list of variable tags",
"examples": [
[
"tag-1",
"tag-2"
]
]
}
},
"additionalProperties": false,
"type": "object",
"required": [
"name",
"value"
],
"title": "VariableCreate",
"description": "Data used by the Prefect REST API to create a Variable."
},
"VariableFilter": {
"properties": {
"operator": {
"$ref": "#/components/schemas/Operator",
"description": "Operator for combining filter criteria. Defaults to 'and_'.",
"default": "and_"
},
"id": {
"anyOf": [
{
"$ref": "#/components/schemas/VariableFilterId"
},
{
"type": "null"
}
],
"description": "Filter criteria for `Variable.id`"
},
"name": {
"anyOf": [
{
"$ref": "#/components/schemas/VariableFilterName"
},
{
"type": "null"
}
],
"description": "Filter criteria for `Variable.name`"
},
"tags": {
"anyOf": [
{
"$ref": "#/components/schemas/VariableFilterTags"
},
{
"type": "null"
}
],
"description": "Filter criteria for `Variable.tags`"
}
},
"additionalProperties": false,
"type": "object",
"title": "VariableFilter",
"description": "Filter variables. Only variables matching all criteria will be returned"
},
"VariableFilterId": {
"properties": {
"any_": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Any",
"description": "A list of variable ids to include"
}
},
"additionalProperties": false,
"type": "object",
"title": "VariableFilterId",
"description": "Filter by `Variable.id`."
},
"VariableFilterName": {
"properties": {
"any_": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Any",
"description": "A list of variables names to include"
},
"like_": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Like",
"description": "A string to match variable names against. This can include SQL wildcard characters like `%` and `_`.",
"examples": [
"my_variable_%"
]
}
},
"additionalProperties": false,
"type": "object",
"title": "VariableFilterName",
"description": "Filter by `Variable.name`."
},
"VariableFilterTags": {
"properties": {
"operator": {
"$ref": "#/components/schemas/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. Variables will be returned only if their tags are a superset of the list",
"examples": [
[
"tag-1",
"tag-2"
]
]
},
"is_null_": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Is Null",
"description": "If true, only include Variables without tags"
}
},
"additionalProperties": false,
"type": "object",
"title": "VariableFilterTags",
"description": "Filter by `Variable.tags`."
},
"VariableSort": {
"type": "string",
"enum": [
"CREATED_DESC",
"UPDATED_DESC",
"NAME_DESC",
"NAME_ASC"
],
"title": "VariableSort",
"description": "Defines variables sorting options."
},
"VariableUpdate": {
"properties": {
"name": {
"anyOf": [
{
"type": "string",
"maxLength": 255,
"description": "The name of the variable",
"examples": [
"my_variable"
]
},
{
"type": "null"
}
],
"title": "Name"
},
"value": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "number"
},
{
"additionalProperties": true,
"type": "object"
},
{
"items": {},
"type": "array"
},
{
"type": "null"
}
],
"title": "Value",
"description": "The value of the variable",
"examples": [
"my-value"
]
},
"tags": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Tags",
"description": "A list of variable tags",
"examples": [
[
"tag-1",
"tag-2"
]
]
}
},
"additionalProperties": false,
"type": "object",
"title": "VariableUpdate",
"description": "Data used by the Prefect REST API to update a Variable."
},
"VersionInfo": {
"properties": {
"type": {
"type": "string",
"title": "Type",
"description": "The type of version info."
},
"version": {
"type": "string",
"title": "Version",
"description": "The version of the deployment."
}
},
"additionalProperties": true,
"type": "object",
"required": [
"type",
"version"
],
"title": "VersionInfo"
},
"WorkPool": {
"properties": {
"id": {
"type": "string",
"format": "uuid",
"title": "Id"
},
"created": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Created"
},
"updated": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Updated"
},
"name": {
"type": "string",
"pattern": "^[^/%&><]+$",
"title": "Name",
"description": "The name of the work pool."
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Description",
"description": "A description of the work pool."
},
"type": {
"type": "string",
"title": "Type",
"description": "The work pool type."
},
"base_job_template": {
"additionalProperties": true,
"type": "object",
"title": "Base Job Template",
"description": "The work pool's base job template."
},
"is_paused": {
"type": "boolean",
"title": "Is Paused",
"description": "Pausing the work pool stops the delivery of all work.",
"default": false
},
"concurrency_limit": {
"anyOf": [
{
"type": "integer",
"minimum": 0.0
},
{
"type": "null"
}
],
"title": "Concurrency Limit",
"description": "A concurrency limit for the work pool."
},
"status": {
"anyOf": [
{
"$ref": "#/components/schemas/WorkPoolStatus"
},
{
"type": "null"
}
],
"description": "The current status of the work pool."
},
"default_queue_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Default Queue Id",
"description": "The id of the pool's default queue."
},
"storage_configuration": {
"$ref": "#/components/schemas/WorkPoolStorageConfiguration",
"description": "The storage configuration for the work pool."
}
},
"type": "object",
"required": [
"name",
"type",
"id",
"created",
"updated"
],
"title": "WorkPool",
"description": "An ORM representation of a work pool"
},
"WorkPoolCreate": {
"properties": {
"name": {
"type": "string",
"pattern": "^[^/%&><]+$",
"title": "Name",
"description": "The name of the work pool."
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Description",
"description": "The work pool description."
},
"type": {
"type": "string",
"title": "Type",
"description": "The work pool type.",
"default": "prefect-agent"
},
"base_job_template": {
"additionalProperties": true,
"type": "object",
"title": "Base Job Template",
"description": "The work pool's base job template."
},
"is_paused": {
"type": "boolean",
"title": "Is Paused",
"description": "Pausing the work pool stops the delivery of all work.",
"default": false
},
"concurrency_limit": {
"anyOf": [
{
"type": "integer",
"minimum": 0.0
},
{
"type": "null"
}
],
"title": "Concurrency Limit",
"description": "A concurrency limit for the work pool."
},
"storage_configuration": {
"$ref": "#/components/schemas/WorkPoolStorageConfiguration",
"description": "The storage configuration for the work pool."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"name"
],
"title": "WorkPoolCreate",
"description": "Data used by the Prefect REST API to create a work pool."
},
"WorkPoolFilter": {
"properties": {
"operator": {
"$ref": "#/components/schemas/Operator",
"description": "Operator for combining filter criteria. Defaults to 'and_'.",
"default": "and_"
},
"id": {
"anyOf": [
{
"$ref": "#/components/schemas/WorkPoolFilterId"
},
{
"type": "null"
}
],
"description": "Filter criteria for `WorkPool.id`"
},
"name": {
"anyOf": [
{
"$ref": "#/components/schemas/WorkPoolFilterName"
},
{
"type": "null"
}
],
"description": "Filter criteria for `WorkPool.name`"
},
"type": {
"anyOf": [
{
"$ref": "#/components/schemas/WorkPoolFilterType"
},
{
"type": "null"
}
],
"description": "Filter criteria for `WorkPool.type`"
}
},
"additionalProperties": false,
"type": "object",
"title": "WorkPoolFilter",
"description": "Filter work pools. Only work pools matching all criteria will be returned"
},
"WorkPoolFilterId": {
"properties": {
"any_": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Any",
"description": "A list of work pool ids to include"
}
},
"additionalProperties": false,
"type": "object",
"title": "WorkPoolFilterId",
"description": "Filter by `WorkPool.id`."
},
"WorkPoolFilterName": {
"properties": {
"any_": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Any",
"description": "A list of work pool names to include"
}
},
"additionalProperties": false,
"type": "object",
"title": "WorkPoolFilterName",
"description": "Filter by `WorkPool.name`."
},
"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`."
},
"WorkPoolStatus": {
"type": "string",
"enum": [
"READY",
"NOT_READY",
"PAUSED"
],
"title": "WorkPoolStatus",
"description": "Enumeration of work pool statuses."
},
"WorkPoolStorageConfiguration": {
"properties": {
"bundle_upload_step": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"title": "Bundle Upload Step",
"description": "The step to use for uploading bundles to storage."
},
"bundle_execution_step": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"title": "Bundle Execution Step",
"description": "The step to use for executing bundles."
},
"default_result_storage_block_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Default Result Storage Block Id",
"description": "The block document ID of the default result storage block."
}
},
"additionalProperties": false,
"type": "object",
"title": "WorkPoolStorageConfiguration",
"description": "A representation of a work pool's storage configuration"
},
"WorkPoolUpdate": {
"properties": {
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Description"
},
"is_paused": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Is Paused"
},
"base_job_template": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"title": "Base Job Template"
},
"concurrency_limit": {
"anyOf": [
{
"type": "integer",
"minimum": 0.0
},
{
"type": "null"
}
],
"title": "Concurrency Limit"
},
"storage_configuration": {
"anyOf": [
{
"$ref": "#/components/schemas/WorkPoolStorageConfiguration"
},
{
"type": "null"
}
],
"description": "The storage configuration for the work pool."
}
},
"additionalProperties": false,
"type": "object",
"title": "WorkPoolUpdate",
"description": "Data used by the Prefect REST API to update a work pool."
},
"WorkQueue": {
"properties": {
"id": {
"type": "string",
"format": "uuid",
"title": "Id"
},
"created": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Created"
},
"updated": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Updated"
},
"name": {
"type": "string",
"pattern": "^[^/%&><]+$",
"title": "Name",
"description": "The name of the work queue."
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Description",
"description": "An optional description for the work queue.",
"default": ""
},
"is_paused": {
"type": "boolean",
"title": "Is Paused",
"description": "Whether or not the work queue is paused.",
"default": false
},
"concurrency_limit": {
"anyOf": [
{
"type": "integer",
"minimum": 0.0
},
{
"type": "null"
}
],
"title": "Concurrency Limit",
"description": "An optional concurrency limit for the work queue."
},
"priority": {
"type": "integer",
"exclusiveMinimum": 0.0,
"title": "Priority",
"description": "The queue's priority. Lower values are higher priority (1 is the highest).",
"default": 1
},
"work_pool_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Work Pool Id",
"description": "The work pool with which the queue is associated."
},
"filter": {
"anyOf": [
{
"$ref": "#/components/schemas/QueueFilter"
},
{
"type": "null"
}
],
"description": "DEPRECATED: Filter criteria for the work queue.",
"deprecated": true
},
"last_polled": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Last Polled",
"description": "The last time an agent polled this queue for work."
}
},
"type": "object",
"required": [
"name",
"id",
"created",
"updated"
],
"title": "WorkQueue",
"description": "An ORM representation of a work queue"
},
"WorkQueueCreate": {
"properties": {
"name": {
"type": "string",
"pattern": "^[^/%&><]+$",
"title": "Name",
"description": "The name of the work queue."
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Description",
"description": "An optional description for the work queue.",
"default": ""
},
"is_paused": {
"type": "boolean",
"title": "Is Paused",
"description": "Whether or not the work queue is paused.",
"default": false
},
"concurrency_limit": {
"anyOf": [
{
"type": "integer",
"minimum": 0.0
},
{
"type": "null"
}
],
"title": "Concurrency Limit",
"description": "The work queue's concurrency limit."
},
"priority": {
"anyOf": [
{
"type": "integer",
"exclusiveMinimum": 0.0
},
{
"type": "null"
}
],
"title": "Priority",
"description": "The queue's priority. Lower values are higher priority (1 is the highest)."
},
"filter": {
"anyOf": [
{
"$ref": "#/components/schemas/QueueFilter"
},
{
"type": "null"
}
],
"description": "DEPRECATED: Filter criteria for the work queue.",
"deprecated": true
}
},
"additionalProperties": false,
"type": "object",
"required": [
"name"
],
"title": "WorkQueueCreate",
"description": "Data used by the Prefect REST API to create a work queue."
},
"WorkQueueFilter": {
"properties": {
"operator": {
"$ref": "#/components/schemas/Operator",
"description": "Operator for combining filter criteria. Defaults to 'and_'.",
"default": "and_"
},
"id": {
"anyOf": [
{
"$ref": "#/components/schemas/WorkQueueFilterId"
},
{
"type": "null"
}
],
"description": "Filter criteria for `WorkQueue.id`"
},
"name": {
"anyOf": [
{
"$ref": "#/components/schemas/WorkQueueFilterName"
},
{
"type": "null"
}
],
"description": "Filter criteria for `WorkQueue.name`"
}
},
"additionalProperties": false,
"type": "object",
"title": "WorkQueueFilter",
"description": "Filter work queues. Only work queues matching all criteria will be\nreturned"
},
"WorkQueueFilterId": {
"properties": {
"any_": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Any",
"description": "A list of work queue ids to include"
}
},
"additionalProperties": false,
"type": "object",
"title": "WorkQueueFilterId",
"description": "Filter by `WorkQueue.id`."
},
"WorkQueueFilterName": {
"properties": {
"any_": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Any",
"description": "A list of work queue names to include",
"examples": [
[
"wq-1",
"wq-2"
]
]
},
"startswith_": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Startswith",
"description": "A list of case-insensitive starts-with matches. For example, passing 'marvin' will match 'marvin', and 'Marvin-robot', but not 'sad-marvin'.",
"examples": [
[
"marvin",
"Marvin-robot"
]
]
}
},
"additionalProperties": false,
"type": "object",
"title": "WorkQueueFilterName",
"description": "Filter by `WorkQueue.name`."
},
"WorkQueueHealthPolicy": {
"properties": {
"maximum_late_runs": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Maximum Late Runs",
"description": "The maximum number of late runs in the work queue before it is deemed unhealthy. Defaults to `0`.",
"default": 0
},
"maximum_seconds_since_last_polled": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Maximum Seconds Since Last Polled",
"description": "The maximum number of time in seconds elapsed since work queue has been polled before it is deemed unhealthy. Defaults to `60`.",
"default": 60
}
},
"type": "object",
"title": "WorkQueueHealthPolicy"
},
"WorkQueueResponse": {
"properties": {
"id": {
"type": "string",
"format": "uuid",
"title": "Id"
},
"created": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Created"
},
"updated": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Updated"
},
"name": {
"type": "string",
"pattern": "^[^/%&><]+$",
"title": "Name",
"description": "The name of the work queue."
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Description",
"description": "An optional description for the work queue.",
"default": ""
},
"is_paused": {
"type": "boolean",
"title": "Is Paused",
"description": "Whether or not the work queue is paused.",
"default": false
},
"concurrency_limit": {
"anyOf": [
{
"type": "integer",
"minimum": 0.0
},
{
"type": "null"
}
],
"title": "Concurrency Limit",
"description": "An optional concurrency limit for the work queue."
},
"priority": {
"type": "integer",
"exclusiveMinimum": 0.0,
"title": "Priority",
"description": "The queue's priority. Lower values are higher priority (1 is the highest).",
"default": 1
},
"work_pool_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Work Pool Id",
"description": "The work pool with which the queue is associated."
},
"filter": {
"anyOf": [
{
"$ref": "#/components/schemas/QueueFilter"
},
{
"type": "null"
}
],
"description": "DEPRECATED: Filter criteria for the work queue.",
"deprecated": true
},
"last_polled": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Last Polled",
"description": "The last time an agent polled this queue for work."
},
"work_pool_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Work Pool Name",
"description": "The name of the work pool the work pool resides within."
},
"status": {
"anyOf": [
{
"$ref": "#/components/schemas/WorkQueueStatus"
},
{
"type": "null"
}
],
"description": "The queue status."
}
},
"type": "object",
"required": [
"name",
"id",
"created",
"updated"
],
"title": "WorkQueueResponse"
},
"WorkQueueStatus": {
"type": "string",
"enum": [
"READY",
"NOT_READY",
"PAUSED"
],
"title": "WorkQueueStatus",
"description": "Enumeration of work queue statuses."
},
"WorkQueueStatusDetail": {
"properties": {
"healthy": {
"type": "boolean",
"title": "Healthy",
"description": "Whether or not the work queue is healthy."
},
"late_runs_count": {
"type": "integer",
"title": "Late Runs Count",
"description": "The number of late flow runs in the work queue.",
"default": 0
},
"last_polled": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Last Polled",
"description": "The last time an agent polled this queue for work."
},
"health_check_policy": {
"$ref": "#/components/schemas/WorkQueueHealthPolicy",
"description": "The policy used to determine whether or not the work queue is healthy."
}
},
"type": "object",
"required": [
"healthy",
"health_check_policy"
],
"title": "WorkQueueStatusDetail"
},
"WorkQueueUpdate": {
"properties": {
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Name"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Description"
},
"is_paused": {
"type": "boolean",
"title": "Is Paused",
"description": "Whether or not the work queue is paused.",
"default": false
},
"concurrency_limit": {
"anyOf": [
{
"type": "integer",
"minimum": 0.0
},
{
"type": "null"
}
],
"title": "Concurrency Limit"
},
"priority": {
"anyOf": [
{
"type": "integer",
"exclusiveMinimum": 0.0
},
{
"type": "null"
}
],
"title": "Priority"
},
"last_polled": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Last Polled"
},
"filter": {
"anyOf": [
{
"$ref": "#/components/schemas/QueueFilter"
},
{
"type": "null"
}
],
"description": "DEPRECATED: Filter criteria for the work queue.",
"deprecated": true
}
},
"additionalProperties": false,
"type": "object",
"title": "WorkQueueUpdate",
"description": "Data used by the Prefect REST API to update a work queue."
},
"WorkerFilter": {
"properties": {
"operator": {
"$ref": "#/components/schemas/Operator",
"description": "Operator for combining filter criteria. Defaults to 'and_'.",
"default": "and_"
},
"last_heartbeat_time": {
"anyOf": [
{
"$ref": "#/components/schemas/WorkerFilterLastHeartbeatTime"
},
{
"type": "null"
}
],
"description": "Filter criteria for `Worker.last_heartbeat_time`"
},
"status": {
"anyOf": [
{
"$ref": "#/components/schemas/WorkerFilterStatus"
},
{
"type": "null"
}
],
"description": "Filter criteria for `Worker.status`"
}
},
"additionalProperties": false,
"type": "object",
"title": "WorkerFilter",
"description": "Filter by `Worker.last_heartbeat_time`."
},
"WorkerFilterLastHeartbeatTime": {
"properties": {
"before_": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Before",
"description": "Only include processes whose last heartbeat was at or before this time"
},
"after_": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "After",
"description": "Only include processes whose last heartbeat was at or after this time"
}
},
"additionalProperties": false,
"type": "object",
"title": "WorkerFilterLastHeartbeatTime",
"description": "Filter by `Worker.last_heartbeat_time`."
},
"WorkerFilterStatus": {
"properties": {
"any_": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/WorkerStatus"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Any",
"description": "A list of worker statuses to include"
},
"not_any_": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/WorkerStatus"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Not Any",
"description": "A list of worker statuses to exclude"
}
},
"additionalProperties": false,
"type": "object",
"title": "WorkerFilterStatus",
"description": "Filter by `Worker.status`."
},
"WorkerFlowRunResponse": {
"properties": {
"work_pool_id": {
"type": "string",
"format": "uuid",
"title": "Work Pool Id"
},
"work_queue_id": {
"type": "string",
"format": "uuid",
"title": "Work Queue Id"
},
"flow_run": {
"$ref": "#/components/schemas/FlowRun"
}
},
"type": "object",
"required": [
"work_pool_id",
"work_queue_id",
"flow_run"
],
"title": "WorkerFlowRunResponse"
},
"WorkerResponse": {
"properties": {
"id": {
"type": "string",
"format": "uuid",
"title": "Id"
},
"created": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Created"
},
"updated": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Updated"
},
"name": {
"type": "string",
"title": "Name",
"description": "The name of the worker."
},
"work_pool_id": {
"type": "string",
"format": "uuid",
"title": "Work Pool Id",
"description": "The work pool with which the queue is associated."
},
"last_heartbeat_time": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Last Heartbeat Time",
"description": "The last time the worker process sent a heartbeat."
},
"heartbeat_interval_seconds": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Heartbeat Interval Seconds",
"description": "The number of seconds to expect between heartbeats sent by the worker."
},
"status": {
"$ref": "#/components/schemas/WorkerStatus",
"description": "Current status of the worker.",
"default": "OFFLINE"
}
},
"type": "object",
"required": [
"name",
"work_pool_id",
"id",
"created",
"updated"
],
"title": "WorkerResponse"
},
"WorkerSettings": {
"properties": {
"debug_mode": {
"type": "boolean",
"title": "Debug Mode",
"description": "If True, enables debug mode for the worker only. Unlike PREFECT_DEBUG_MODE, this setting does not propagate to flow runs executed by the worker.",
"default": false,
"supported_environment_variables": [
"PREFECT_WORKER_DEBUG_MODE"
]
},
"heartbeat_seconds": {
"type": "number",
"title": "Heartbeat Seconds",
"description": "Number of seconds a worker should wait between sending a heartbeat.",
"default": 30,
"supported_environment_variables": [
"PREFECT_WORKER_HEARTBEAT_SECONDS"
]
},
"query_seconds": {
"type": "number",
"title": "Query Seconds",
"description": "Number of seconds a worker should wait between queries for scheduled work.",
"default": 10,
"supported_environment_variables": [
"PREFECT_WORKER_QUERY_SECONDS"
]
},
"prefetch_seconds": {
"type": "number",
"title": "Prefetch Seconds",
"description": "The number of seconds into the future a worker should query for scheduled work.",
"default": 10,
"supported_environment_variables": [
"PREFECT_WORKER_PREFETCH_SECONDS"
]
},
"enable_cancellation": {
"type": "boolean",
"title": "Enable Cancellation",
"description": "Enable worker-side flow run cancellation for pending flow runs. When enabled, the worker will terminate infrastructure for flow runs that are cancelled while still in PENDING state (before the runner starts).",
"default": false,
"supported_environment_variables": [
"PREFECT_WORKER_ENABLE_CANCELLATION"
]
},
"cancellation_poll_seconds": {
"type": "number",
"title": "Cancellation Poll Seconds",
"description": "Number of seconds between polls for cancelling flow runs. Used as a fallback when the WebSocket connection for real-time cancellation events is unavailable.",
"default": 120,
"supported_environment_variables": [
"PREFECT_WORKER_CANCELLATION_POLL_SECONDS"
]
},
"webserver": {
"$ref": "#/components/schemas/WorkerWebserverSettings",
"description": "Settings for a worker's webserver",
"supported_environment_variables": []
}
},
"type": "object",
"title": "WorkerSettings"
},
"WorkerStatus": {
"type": "string",
"enum": [
"ONLINE",
"OFFLINE"
],
"title": "WorkerStatus",
"description": "Enumeration of worker statuses."
},
"WorkerWebserverSettings": {
"properties": {
"host": {
"type": "string",
"title": "Host",
"description": "The host address the worker's webserver should bind to.",
"default": "0.0.0.0",
"supported_environment_variables": [
"PREFECT_WORKER_WEBSERVER_HOST"
]
},
"port": {
"type": "integer",
"title": "Port",
"description": "The port the worker's webserver should bind to.",
"default": 8080,
"supported_environment_variables": [
"PREFECT_WORKER_WEBSERVER_PORT"
]
}
},
"type": "object",
"title": "WorkerWebserverSettings"
}
}
}
}
Reference in New Issue View Git Blame Copy Permalink