{ "openapi": "3.1.0", "info": { "title": "Prefect REST API", "version": "v3", "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/WorkPoolResponse" } } } }, "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/WorkPoolResponse" } } } }, "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/WorkPoolResponse" }, "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}/concurrency_status": { "post": { "tags": [ "Work Pools" ], "summary": "Read Work Pool Concurrency Status", "description": "Read concurrency status for a work pool, including per-queue breakdown\nwith flow run summaries. Queues are paginated; flow runs per queue are\ncapped by flow_run_limit.", "operationId": "read_work_pool_concurrency_status_work_pools__name__concurrency_status_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_read_work_pool_concurrency_status_work_pools__name__concurrency_status_post" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkPoolConcurrencyStatus" } } } }, "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}/concurrency_status": { "post": { "tags": [ "Work Queues" ], "summary": "Read Work Queue Concurrency Status", "description": "Read concurrency status for a work queue, including paginated flow run\nsummaries. active_slots always reflects the total count.", "operationId": "read_work_queue_concurrency_status_work_queues__id__concurrency_status_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-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_concurrency_status_work_queues__id__concurrency_status_post" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkQueueConcurrencyStatus" } } } }, "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" } } } } } } }, "/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" } } } } } } }, "/admin/storage": { "get": { "tags": [ "Admin" ], "summary": "Read Server Default Result Storage", "description": "Get the configured server default result storage block.", "operationId": "read_server_default_result_storage_admin_storage_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/ServerDefaultResultStorage" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "put": { "tags": [ "Admin" ], "summary": "Update Server Default Result Storage", "description": "Set the server default result storage block.", "operationId": "update_server_default_result_storage_admin_storage_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/ServerDefaultResultStorageUpdate" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServerDefaultResultStorage" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "Admin" ], "summary": "Clear Server Default Result Storage", "description": "Clear the configured server default result storage block.", "operationId": "clear_server_default_result_storage_admin_storage_delete", "parameters": [ { "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" } } } } } } }, "/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/DeleteFlowRun" }, { "$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/DeleteFlowRun" }, { "$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/DeleteFlowRun" }, { "$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/DeleteFlowRun" }, { "$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/DeleteFlowRun" }, { "$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/DeleteFlowRun" }, { "$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/DeleteFlowRun" }, { "$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/DeleteFlowRun" }, { "$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/DeleteFlowRun" }, { "$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_SERVER_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_SERVER_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_SERVER_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_SERVER_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_SERVER_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_SERVER_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_SERVER_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_SERVER_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_SERVER_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_SERVER_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_SERVER_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_SERVER_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_SERVER_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_SERVER_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_SERVER_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_SERVER_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_SERVER_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_SERVER_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_SERVER_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_SERVER_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_SERVER_API_DEFAULT_LIMIT if not provided." } }, "type": "object", "title": "Body_read_variables_variables_filter_post" }, "Body_read_work_pool_concurrency_status_work_pools__name__concurrency_status_post": { "properties": { "page": { "type": "integer", "minimum": 1.0, "title": "Page", "default": 1 }, "flow_run_limit": { "type": "integer", "maximum": 200.0, "minimum": 0.0, "title": "Flow Run Limit", "description": "Max flow runs per queue", "default": 10 }, "limit": { "type": "integer", "title": "Limit", "description": "Defaults to PREFECT_SERVER_API_DEFAULT_LIMIT if not provided." } }, "type": "object", "title": "Body_read_work_pool_concurrency_status_work_pools__name__concurrency_status_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_SERVER_API_DEFAULT_LIMIT if not provided." } }, "type": "object", "title": "Body_read_work_pools_work_pools_filter_post" }, "Body_read_work_queue_concurrency_status_work_queues__id__concurrency_status_post": { "properties": { "page": { "type": "integer", "minimum": 1.0, "title": "Page", "default": 1 }, "limit": { "type": "integer", "title": "Limit", "description": "Defaults to PREFECT_SERVER_API_DEFAULT_LIMIT if not provided." } }, "type": "object", "title": "Body_read_work_queue_concurrency_status_work_queues__id__concurrency_status_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_SERVER_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_SERVER_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_SERVER_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_SERVER_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" ] }, "server_version_check_enabled": { "type": "boolean", "title": "Server Version Check Enabled", "description": "\n Whether the client should check the server's API version on startup.\n When disabled, the client will skip the call to /admin/version that\n normally runs once per client context entry. This is useful for worker\n subprocesses that inherit a known-compatible server configuration and\n do not need to repeat the version handshake.\n ", "default": true, "supported_environment_variables": [ "PREFECT_CLIENT_SERVER_VERSION_CHECK_ENABLED" ] }, "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" }, "DeleteFlowRun": { "properties": { "type": { "type": "string", "const": "delete-flow-run", "title": "Type", "default": "delete-flow-run" } }, "type": "object", "title": "DeleteFlowRun", "description": "Deletes a flow run associated with the trigger" }, "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": { "anyOf": [ { "$ref": "#/components/schemas/ResourceSpecification" }, { "additionalProperties": { "anyOf": [ { "type": "string" }, { "items": { "type": "string" }, "type": "array" } ] }, "type": "object" } ], "title": "Match", "description": "Labels for resources which this trigger will match." }, "match_related": { "anyOf": [ { "$ref": "#/components/schemas/ResourceSpecification" }, { "additionalProperties": { "anyOf": [ { "type": "string" }, { "items": { "type": "string" }, "type": "array" } ] }, "type": "object" }, { "items": { "anyOf": [ { "$ref": "#/components/schemas/ResourceSpecification" }, { "additionalProperties": { "anyOf": [ { "type": "string" }, { "items": { "type": "string" }, "type": "array" } ] }, "type": "object" } ] }, "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::