Read Automation

Headers

x-prefect-api-version

string

Path Parameters

string<uuid>

required

Response

Successful Response

name

string

required

The name of this automation

trigger

EventTrigger · object

required

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

EventTrigger
CompoundTrigger
SequenceTrigger

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

string

default:event

Allowed value: "event"

trigger.id

string<uuid>

The unique ID of this trigger

trigger.match

ResourceSpecification · object

Labels for resources which this trigger will match.

Show child attributes

trigger.match.{key}

Labels for related resources which this trigger will match.

ResourceSpecification · object
ResourceSpecification · object[]

Show child attributes

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

actions

required

The actions to perform when this Automation triggers

Do nothing when an Automation is triggered

Show child attributes

actions.type

string

default:do-nothing

Allowed value: "do-nothing"

string<uuid>

required

created

string<date-time> | null

required

updated

string<date-time> | null

required

description

string

default:""

A longer description of this automation

enabled

boolean

default:true

Whether this automation will be evaluated

API Reference

Headers

Path Parameters

Response