Read Automations

Headers

x-prefect-api-version

string

Body

application/json

automations

object | null

Show child attributes

automations.created

object | null

Filter criteria for Automation.created

Show child attributes

automations.created.before_

string | null

Only include automations created before this datetime

automations.name

object | null

Filter criteria for Automation.name

Show child attributes

automations.name.any_

string[] | null

Only include automations with names that match any of these strings

automations.operator

enum<string>

Operator for combining filter criteria. Defaults to 'and_'.

Available options:

and_,

or_

limit

integer

Defaults to PREFECT_API_DEFAULT_LIMIT if not provided.

offset

integer

default:

0

Required range: x > 0

sort

enum<string>

Defines automations sorting options.

Available options:

CREATED_DESC,

UPDATED_DESC,

NAME_ASC,

NAME_DESC

Response

200 - application/json

actions

object[]

required

The actions to perform when this Automation triggers

• DoNothing
• RunDeployment
• PauseDeployment
• ResumeDeployment
• CancelFlowRun
• ChangeFlowRunState
• PauseWorkQueue
• ResumeWorkQueue
• SendNotification
• CallWebhook
• PauseAutomation
• ResumeAutomation
• SuspendFlowRun
• ResumeFlowRun
• PauseWorkPool
• ResumeWorkPool

Show child attributes

actions.type

string

default:

do-nothing

Allowed value: "do-nothing"

created

string | null

required

id

string

required

name

string

required

The name of this automation

trigger

object

required

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

• Trigger
• Trigger
• Trigger

Show child attributes

trigger.posture

enum<string>

required

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.

Available options:

Reactive,

Proactive

trigger.after

string[]

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.*

trigger.expect

string[]

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.*

trigger.for_each

string[]

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.

trigger.id

string

The unique ID of this trigger

trigger.match

object

Labels for resources which this trigger will match.

Show child attributes

trigger.match.{key}

trigger.match_related

object

Labels for related resources which this trigger will match.

Show child attributes

trigger.match_related.{key}

trigger.threshold

integer

default:

1

The number of events required for this trigger to fire (for Reactive triggers), or the number of events expected (for Proactive triggers)

trigger.type

string

default:

event

Allowed value: "event"

trigger.within

number

default:

0

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

updated

string | null

required

actions_on_resolve

object[]

The actions to perform when an Automation goes into a resolving state

• DoNothing
• RunDeployment
• PauseDeployment
• ResumeDeployment
• CancelFlowRun
• ChangeFlowRunState
• PauseWorkQueue
• ResumeWorkQueue
• SendNotification
• CallWebhook
• PauseAutomation
• ResumeAutomation
• SuspendFlowRun
• ResumeFlowRun
• PauseWorkPool
• ResumeWorkPool

Show child attributes

actions_on_resolve.type

string

default:

do-nothing

Allowed value: "do-nothing"

actions_on_trigger

object[]

The actions to perform when an Automation goes into a triggered state

• DoNothing
• RunDeployment
• PauseDeployment
• ResumeDeployment
• CancelFlowRun
• ChangeFlowRunState
• PauseWorkQueue
• ResumeWorkQueue
• SendNotification
• CallWebhook
• PauseAutomation
• ResumeAutomation
• SuspendFlowRun
• ResumeFlowRun
• PauseWorkPool
• ResumeWorkPool

Show child attributes

actions_on_trigger.type

string

default:

do-nothing

Allowed value: "do-nothing"

description

string

default:

A longer description of this automation

enabled

boolean

default:

true

Whether this automation will be evaluated