Prefect Automations API
The Automations API from Prefect — 7 operation(s) for automations.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/prefect-automations-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: Prefect Cloud Account Billing Automations API
description: Prefect Cloud REST API documentation.
version: 0.8.4
tags:
- name: Automations
paths:
/api/accounts/{account_id}/workspaces/{workspace_id}/automations/:
post:
tags:
- Automations
summary: Create Automation
operationId: create_automation_api_accounts__account_id__workspaces__workspace_id__automations__post
parameters:
- name: account_id
in: path
required: true
schema:
type: string
format: uuid
title: Account Id
- name: workspace_id
in: path
required: true
schema:
anyOf:
- type: string
format: uuid
- type: 'null'
title: Workspace Id
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'
/api/accounts/{account_id}/workspaces/{workspace_id}/automations/{id}:
put:
tags:
- Automations
summary: Update Automation
operationId: update_automation_api_accounts__account_id__workspaces__workspace_id__automations__id__put
parameters:
- name: account_id
in: path
required: true
schema:
type: string
format: uuid
title: Account Id
- name: workspace_id
in: path
required: true
schema:
type: string
format: uuid
title: Workspace Id
- name: id
in: path
required: true
schema:
type: string
format: uuid
title: Id
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_api_accounts__account_id__workspaces__workspace_id__automations__id__patch
parameters:
- name: workspace_id
in: path
required: true
schema:
type: string
format: uuid
title: Workspace Id
- name: id
in: path
required: true
schema:
type: string
format: uuid
title: Id
- name: account_id
in: path
required: true
schema:
type: string
format: uuid
title: Account Id
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_api_accounts__account_id__workspaces__workspace_id__automations__id__delete
parameters:
- name: workspace_id
in: path
required: true
schema:
type: string
format: uuid
title: Workspace Id
- name: id
in: path
required: true
schema:
type: string
format: uuid
title: Id
- name: account_id
in: path
required: true
schema:
type: string
format: uuid
title: Account Id
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_api_accounts__account_id__workspaces__workspace_id__automations__id__get
parameters:
- name: account_id
in: path
required: true
schema:
type: string
format: uuid
title: Account Id
- name: workspace_id
in: path
required: true
schema:
anyOf:
- type: string
format: uuid
- type: 'null'
title: Workspace Id
- name: id
in: path
required: true
schema:
type: string
format: uuid
title: Id
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'
/api/accounts/{account_id}/workspaces/{workspace_id}/automations/filter:
post:
tags:
- Automations
summary: Read Automations
operationId: read_automations_api_accounts__account_id__workspaces__workspace_id__automations_filter_post
parameters:
- name: account_id
in: path
required: true
schema:
type: string
format: uuid
title: Account Id
- name: workspace_id
in: path
required: true
schema:
anyOf:
- type: string
format: uuid
- type: 'null'
title: Workspace Id
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Body_read_automations_api_accounts__account_id__workspaces__workspace_id__automations_filter_post'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Automation'
title: Response Read Automations Api Accounts Account Id Workspaces Workspace Id Automations Filter Post
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/accounts/{account_id}/workspaces/{workspace_id}/automations/count:
post:
tags:
- Automations
summary: Count Automations
operationId: count_automations_api_accounts__account_id__workspaces__workspace_id__automations_count_post
parameters:
- name: account_id
in: path
required: true
schema:
type: string
format: uuid
title: Account Id
- name: workspace_id
in: path
required: true
schema:
anyOf:
- type: string
format: uuid
- type: 'null'
title: Workspace Id
responses:
'200':
description: Successful Response
content:
application/json:
schema:
type: integer
title: Response Count Automations Api Accounts Account Id Workspaces Workspace Id Automations Count Post
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/accounts/{account_id}/workspaces/{workspace_id}/automations/related-to/{resource_id}:
get:
tags:
- Automations
summary: Read Automations Related To Resource
operationId: read_automations_related_to_resource_api_accounts__account_id__workspaces__workspace_id__automations_related_to__resource_id__get
parameters:
- name: account_id
in: path
required: true
schema:
type: string
format: uuid
title: Account Id
- name: workspace_id
in: path
required: true
schema:
anyOf:
- type: string
format: uuid
- type: 'null'
title: Workspace Id
- name: resource_id
in: path
required: true
schema:
type: string
title: Resource Id
responses:
'200':
description: Successful Response
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Automation'
title: Response Read Automations Related To Resource Api Accounts Account Id Workspaces Workspace Id Automations Related To Resource Id Get
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/accounts/{account_id}/workspaces/{workspace_id}/automations/owned-by/{resource_id}:
delete:
tags:
- Automations
summary: Delete Automations Owned By Resource
operationId: delete_automations_owned_by_resource_api_accounts__account_id__workspaces__workspace_id__automations_owned_by__resource_id__delete
parameters:
- name: account_id
in: path
required: true
schema:
type: string
format: uuid
title: Account Id
- name: workspace_id
in: path
required: true
schema:
anyOf:
- type: string
format: uuid
- type: 'null'
title: Workspace Id
- name: resource_id
in: path
required: true
schema:
type: string
title: Resource Id
responses:
'202':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/accounts/{account_id}/workspaces/{workspace_id}/automations/templates/validate:
post:
tags:
- Automations
summary: Validate Template
operationId: validate_template_api_accounts__account_id__workspaces__workspace_id__automations_templates_validate_post
parameters:
- name: workspace_id
in: path
required: true
schema:
anyOf:
- type: string
format: uuid
- type: 'null'
title: Workspace Id
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'
components:
schemas:
PauseAutomation:
properties:
type:
type: string
const: pause-automation
title: Type
default: pause-automation
source:
type: string
enum:
- selected
- inferred
title: Source
description: Whether this Action applies to a specific selected automation (given by `automation_id`), or to an automation that is inferred from the triggering event. If the source is 'inferred', the `automation_id` may not be set. If the source is 'selected', the `automation_id` must be set.
default: selected
automation_id:
anyOf:
- type: string
format: uuid
- type: 'null'
title: Automation Id
description: The identifier of the automation to act on
type: object
title: PauseAutomation
description: Pauses a Work Queue
ResumeSchedule:
properties:
type:
type: string
const: resume-schedule-for-flow-run
title: Type
default: resume-schedule-for-flow-run
deployment_id:
type: string
format: uuid
title: Deployment Id
description: The identifier of the deployment
schedule_id:
type: string
format: uuid
title: Schedule Id
description: The identifier of the schedule
type: object
required:
- deployment_id
- schedule_id
title: ResumeSchedule
description: Resumes the given schedule
AutomationFilter:
properties:
operator:
$ref: '#/components/schemas/prefect_cloud__orion__schemas__filters__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
description: 'Filter automations. Only automations that match all of the criteria will be
returned.'
MetricTrigger-Input:
properties:
type:
type: string
const: metric
title: Type
default: metric
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.
posture:
type: string
const: Metric
title: Posture
description: Periodically evaluate the configured metric query.
default: Metric
metric:
$ref: '#/components/schemas/MetricTriggerQuery'
description: 'The metric query to evaluate for this trigger. '
type: object
required:
- metric
title: MetricTrigger
description: A trigger that fires based on the results of a metric query.
ResourceSpecification:
additionalProperties:
anyOf:
- type: string
- items:
type: string
type: array
type: object
title: ResourceSpecification
description: 'A specification that may match zero, one, or many resources, used to target or
select a set of resources in a query or automation. A resource must match at least
one value of all of the provided labels'
ResumeWorkPool:
properties:
type:
type: string
const: resume-work-pool
title: Type
default: resume-work-pool
source:
type: string
enum:
- selected
- inferred
title: Source
description: Whether this Action applies to a specific selected work pool (given by `work_pool_id`), or to a work pool that is inferred from the triggering event. If the source is 'inferred', the `work_pool_id` may not be set. If the source is 'selected', the `work_pool_id` must be set.
default: selected
work_pool_id:
anyOf:
- type: string
format: uuid
- type: 'null'
title: Work Pool Id
description: The identifier of the work pool to pause
type: object
title: ResumeWorkPool
description: Resumes a Work Pool
ResumeAutomation:
properties:
type:
type: string
const: resume-automation
title: Type
default: resume-automation
source:
type: string
enum:
- selected
- inferred
title: Source
description: Whether this Action applies to a specific selected automation (given by `automation_id`), or to an automation that is inferred from the triggering event. If the source is 'inferred', the `automation_id` may not be set. If the source is 'selected', the `automation_id` must be set.
default: selected
automation_id:
anyOf:
- type: string
format: uuid
- type: 'null'
title: Automation Id
description: The identifier of the automation to act on
type: object
title: ResumeAutomation
description: Resumes a Work Queue
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/MetricTrigger-Output'
- $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
fired within the given time period'
StateType:
type: string
enum:
- SCHEDULED
- PENDING
- RUNNING
- COMPLETED
- FAILED
- CANCELLED
- CRASHED
- PAUSED
- CANCELLING
title: StateType
description: Enumeration of state types.
DeclareIncident:
properties:
type:
type: string
const: declare-incident
title: Type
default: declare-incident
type: object
title: DeclareIncident
description: Declares an incident for the triggering event
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.
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 `Automatio.created`.
ChangeFlowRunState:
properties:
type:
type: string
const: change-flow-run-state
title: Type
default: change-flow-run-state
force:
type: boolean
title: Force
description: Force the state change, bypassing orchestration rules
default: false
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
type: object
required:
- state
title: ChangeFlowRunState
description: Changes the state of a flow run associated with the trigger
MetricTriggerOperator:
type: string
enum:
- <
- <=
- '>'
- '>='
title: MetricTriggerOperator
PauseWorkQueue:
properties:
type:
type: string
const: pause-work-queue
title: Type
default: pause-work-queue
source:
type: string
enum:
- selected
- inferred
title: Source
description: Whether this Action applies to a specific selected work queue (given by `work_queue_id`), or to a work queue that is inferred from the triggering event. If the source is 'inferred', the `work_queue_id` may not be set. If the source is 'selected', the `work_queue_id` must be set.
default: selected
work_queue_id:
anyOf:
- type: string
format: uuid
- type: 'null'
title: Work Queue Id
description: The identifier of the work queue to pause
type: object
title: PauseWorkQueue
description: Pauses a Work Queue
CancelFlowRun:
properties:
type:
type: string
const: cancel-flow-run
title: Type
default: cancel-flow-run
force:
type: boolean
title: Force
description: Force the state change, bypassing orchestration rules
default: false
type: object
title: CancelFlowRun
description: Cancels a flow run associated with the trigger
PauseWorkPool:
properties:
type:
type: string
const: pause-work-pool
title: Type
default: pause-work-pool
source:
type: string
enum:
- selected
- inferred
title: Source
description: Whether this Action applies to a specific selected work pool (given by `work_pool_id`), or to a work pool that is inferred from the triggering event. If the source is 'inferred', the `work_pool_id` may not be set. If the source is 'selected', the `work_pool_id` must be set.
default: selected
work_pool_id:
anyOf:
- type: string
format: uuid
- type: 'null'
title: Work Pool Id
description: The identifier of the work pool to pause
type: object
title: PauseWorkPool
description: Pauses a Work Pool
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/MetricTrigger-Input'
- $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
fired within the given time period'
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:<role>:<label>`. This will use the value of that label for the first related resource in that role. For example, `"for_each": ["related:flow:prefect.resource.id"]` would evaluate the trigger for each flow.'
posture:
type: string
enum:
- Reactive
- Proactive
title: Posture
description: The posture of this trigger, either Reactive or Proactive. Reactive triggers respond to the _presence_ of the expected events, while Proactive triggers respond to the _absence_ of those expected events.
threshold:
type: integer
title: Threshold
description: The number of events required for this trigger to fire (for Reactive triggers), or the number of events expected (for Proactive triggers)
default: 1
within:
type: number
title: Within
description: The time period over which the events must occur. For Reactive triggers, this may be as low as 0 seconds, but must be at least 10 seconds for Proactive triggers
default: 0.0
type: object
required:
- posture
title: EventTrigger
description: 'A trigger that fires based on the presence or absence of events within a given
period of time.'
AutomationSort:
type: string
enum:
- CREATED_DESC
- UPDATED_DESC
- NAME_ASC
- NAME_DESC
title: AutomationSort
description: Defines automations sorting options.
ResumeWorkQueue:
properties:
type:
type: string
const: resume-work-queue
title: Type
default: resume-work-queue
source:
type: string
enum:
- selected
- inferred
title: Source
description: Whether this Action applies to a specific selected work queue (given by `work_queue_id`), or to a work queue that is inferred from the triggering event. If the source is 'inferred', the `work_queue_id` may not be set. If the source is 'selected', the `work_queue_id` must be set.
default: selected
work_queue_id:
anyOf:
- type: string
format: uuid
- type: 'null'
title: Work Queue Id
description: The identifier of the work queue to pause
type: object
title: ResumeWorkQueue
description: Resumes a Work Queue
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
SendPrefectNotification:
properties:
type:
type: string
const: prefect-notification
title: Type
default: prefect-notification
notification_type:
type: string
title: Notification Type
description: The type of notification to emit
message:
type: string
title: Message
description: The message to emit
type: object
required:
- notification_type
- message
title: SendPrefectNotification
AutomationUpdate:
properties:
name:
type: string
maxLength: 5000
title: Name
description: The name of this automation
description:
type: string
maxLength: 5000
title: Description
description: A longer description of this automation
default: ''
enabled:
type: boolean
title: Enabled
description: Whether this automation will be evaluated
default: true
trigger:
anyOf:
- $ref: '#/components/schemas/EventTrigger'
- $ref: '#/components/schemas/MetricTrigger-Input'
- $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/PauseDe
# --- truncated at 32 KB (67 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/prefect/refs/heads/main/openapi/prefect-automations-api-openapi.yml