POST
/
api
/
automations
/

Headers

x-prefect-api-version
string

Body

application/json
name
string
required

The name of this automation

description
string
default:

A longer description of this automation

enabled
boolean
default: true

Whether this automation will be evaluated

trigger
object
required

The criteria for which events this Automation covers and how it will respond to the presence or absence of those events

actions
object[]
required

The 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

owner_resource
string | null

The resource to which this automation belongs

Response

201 - application/json
name
string
required

The name of this automation

description
string
default:

A longer description of this automation

enabled
boolean
default: true

Whether this automation will be evaluated

trigger
object
required

The criteria for which events this Automation covers and how it will respond to the presence or absence of those events

actions
object[]
required

The 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