Automations
Read Automations
POST
/
api
/
automations
/
filter
Headers
x-prefect-api-version
string
Body
application/json
sort
enum<string>
Defines automations sorting options.
Available options:
CREATED_DESC
, UPDATED_DESC
, NAME_ASC
, NAME_DESC
offset
integer
default: 0Required range:
x > 0
automations
object | null
limit
integer
Defaults to PREFECT_API_DEFAULT_LIMIT if not provided.
Response
200 - application/json
name
string
requiredThe name of this automation
description
string
default: A longer description of this automation
enabled
boolean
default: trueWhether this automation will be evaluated
trigger
object
requiredThe criteria for which events this Automation covers and how it will respond to the presence or absence of those events
actions
object[]
requiredThe actions to perform when this Automation triggers
actions_on_trigger
object[]
The actions to perform when an Automation goes into a triggered state
actions_on_resolve
object[]
The actions to perform when an Automation goes into a resolving state
id
string
created
string | null
updated
string | null
Was this page helpful?