How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Prefect

Prefect Automations API

The Automations API from Prefect — 7 operation(s) for automations.

Documentation Provider Profile APIs.io OpenAPI GitHub

Prefect Automations API is one of 63 APIs that Prefect publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

Tagged areas include Automations. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, authentication docs, a getting-started guide, and an AsyncAPI specification.

This API exposes 10 operations across 7 paths, and defines 48 schemas. It is described by OpenAPI 3.2.0, at version 0.8.4.

10 operations 7 paths 48 schemas 2 DELETE2 GET1 PATCH4 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
0.8.4
Resource Areas
1

Paths & Operations 10

Across 7 paths, the API surfaces 10 operations — 2 DELETE, 2 GET, 1 PATCH, 4 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Automations 10
POST
/api/accounts/{account_id}/workspaces/{workspace_id}/automations/
Create Automation
create_automation_api_accounts__account_id__workspaces__workspace_id__automations__post 2 params body → 201422
PUT
/api/accounts/{account_id}/workspaces/{workspace_id}/automations/{id}
Update Automation
update_automation_api_accounts__account_id__workspaces__workspace_id__automations__id__put 3 params body → 204422
PATCH
/api/accounts/{account_id}/workspaces/{workspace_id}/automations/{id}
Patch Automation
patch_automation_api_accounts__account_id__workspaces__workspace_id__automations__id__patch 3 params body → 204422
DELETE
/api/accounts/{account_id}/workspaces/{workspace_id}/automations/{id}
Delete Automation
delete_automation_api_accounts__account_id__workspaces__workspace_id__automations__id__delete 3 params → 204422
GET
/api/accounts/{account_id}/workspaces/{workspace_id}/automations/{id}
Read Automation
read_automation_api_accounts__account_id__workspaces__workspace_id__automations__id__get 3 params → 200422
POST
/api/accounts/{account_id}/workspaces/{workspace_id}/automations/filter
Read Automations
read_automations_api_accounts__account_id__workspaces__workspace_id__automations_filter_post 2 params body → 200422
POST
/api/accounts/{account_id}/workspaces/{workspace_id}/automations/count
Count Automations
count_automations_api_accounts__account_id__workspaces__workspace_id__automations_count_post 2 params → 200422
GET
/api/accounts/{account_id}/workspaces/{workspace_id}/automations/related-to/{resource_id}
Read Automations Related To Resource
read_automations_related_to_resource_api_accounts__account_id__workspaces__workspace_id__automations_related_to__resource_id__get 3 params → 200422
DELETE
/api/accounts/{account_id}/workspaces/{workspace_id}/automations/owned-by/{resource_id}
Delete Automations Owned By Resource
delete_automations_owned_by_resource_api_accounts__account_id__workspaces__workspace_id__automations_owned_by__resource_id__delete 3 params → 202422
POST
/api/accounts/{account_id}/workspaces/{workspace_id}/automations/templates/validate
Validate Template
validate_template_api_accounts__account_id__workspaces__workspace_id__automations_templates_validate_post 1 param body → 200422

Schemas 48

The contract defines 48 schemas that model the data the API accepts and returns. The most detailed are Automation (15 properties), AutomationCreate (10 properties), EventTrigger (10 properties), AutomationUpdate (9 properties). Each schema is shown below with its type and property counts.

PauseAutomation
object
Pauses a Work Queue
3 properties
ResumeSchedule
object
Resumes the given schedule
3 properties 2 required
AutomationFilter
object
Filter automations. Only automations that match all of the criteria will be returned.
4 properties
MetricTrigger-Input
object
A trigger that fires based on the results of a metric query.
6 properties 1 required
ResourceSpecification
object
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 lea…
ResumeWorkPool
object
Resumes a Work Pool
3 properties
ResumeAutomation
object
Resumes a Work Queue
3 properties
CompoundTrigger-Output
object
A composite trigger that requires some number of triggers to have fired within the given time period
5 properties 3 required
StateType
string
Enumeration of state types.
DeclareIncident
object
Declares an incident for the triggering event
1 property
CallWebhook
object
Call a webhook when an Automation is triggered.
3 properties 1 required
AutomationFilterCreated
object
Filter by Automatio.created.
1 property
ChangeFlowRunState
object
Changes the state of a flow run associated with the trigger
5 properties 1 required
MetricTriggerOperator
string
PauseWorkQueue
object
Pauses a Work Queue
3 properties
CancelFlowRun
object
Cancels a flow run associated with the trigger
2 properties
PauseWorkPool
object
Pauses a Work Pool
3 properties
CompoundTrigger-Input
object
A composite trigger that requires some number of triggers to have fired within the given time period
5 properties 3 required
EventTrigger
object
A trigger that fires based on the presence or absence of events within a given period of time.
10 properties 1 required
AutomationSort
string
Defines automations sorting options.
ResumeWorkQueue
object
Resumes a Work Queue
3 properties
DoNothing
object
Do nothing when an Automation is triggered
1 property
SendPrefectNotification
object
3 properties 2 required
AutomationUpdate
object
9 properties 3 required
SendNotification
object
Send a notification when an Automation is triggered
4 properties 2 required
ActorReference
object
4 properties 2 required
ResumeDeployment
object
Resumes the given Deployment
3 properties
Automation
object
15 properties 5 required
MetricTriggerQuery
object
Defines a subset of the Trigger subclass, which is specific to Metric automations, that specify the query configurations and breaching conditions for the Autom…
5 properties 3 required
PauseDeployment
object
Pauses the given Deployment
3 properties
SendEmailNotification
object
Send an email notification when an Automation is triggered
5 properties 2 required
Body_read_automations_api_accounts__account_id__workspaces__workspace_id__automations_filter_post
object
4 properties
AutomationCreate
object
10 properties 3 required
SequenceTrigger-Output
object
A composite trigger that requires some number of triggers to have fired within the given time period in a specific order
4 properties 2 required
PrefectMetric
string
AutomationFilterName
object
Filter by Automation.name.
1 property
HTTPValidationError
object
1 property
AutomationPartialUpdate
object
1 property
ResumeFlowRun
object
Resumes a paused or suspended flow run associated with the trigger
1 property
MetricTrigger-Output
object
A trigger that fires based on the results of a metric query.
6 properties 1 required
prefect_cloud__orion__schemas__filters__Operator
string
Operators for combining filter criteria.
AutomationFilterTags
object
Filter by Automation.tags.
4 properties
SequenceTrigger-Input
object
A composite trigger that requires some number of triggers to have fired within the given time period in a specific order
4 properties 2 required
PauseScheduleForFlowRun
object
Pauses the schedule for a flow run associated with the trigger
3 properties
RunDeployment
object
Runs the given deployment with the given parameters
6 properties
SlaViolation
object
Base class for actions that operate on SLA violations
5 properties
SuspendFlowRun
object
Suspends a flow run associated with the trigger
2 properties
ValidationError
object
3 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

prefect-automations-api-openapi.yml Raw ↑

Other APIs Prefect publishes across the network.

Prefect Server REST API
AE Profile APIs.io
Prefect Python SDK
AE Profile APIs.io
Prefect Account Billing API
AE Profile APIs.io
Prefect Account Images API
AE Profile APIs.io
Prefect Account Memberships API
AE Profile APIs.io
Prefect Account Roles API
AE Profile APIs.io
Prefect Account SSO API
AE Profile APIs.io
Prefect Accounts API
AE Profile APIs.io
Prefect AI API
AE Profile APIs.io
Prefect Artifacts API
AE Profile APIs.io
Prefect Asset Publications API
AE Profile APIs.io
Prefect Asset Subscriptions API
AE Profile APIs.io
#Automations
← Back to P APIs
API Details
ID
prefect:prefect-automations-api
Docs
https://docs.prefect.io/v3/api-ref/rest-api
Provider
Prefect
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=prefect-automations-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/prefect-automations-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Prefect Automations API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.