GET
/
api
/
automations
/
{id}
{
  "name": "<string>",
  "description": "",
  "enabled": true,
  "trigger": {
    "type": "<string>",
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "match": {},
    "match_related": {},
    "after": [
      "<string>"
    ],
    "expect": [
      "<string>"
    ],
    "for_each": [
      "<string>"
    ],
    "posture": "Reactive",
    "threshold": 123,
    "within": 123
  },
  "actions": [
    {
      "type": "do-nothing"
    }
  ],
  "actions_on_trigger": [
    {
      "type": "<string>"
    }
  ],
  "actions_on_resolve": [
    {
      "type": "<string>"
    }
  ],
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created": "2023-11-07T05:31:56Z",
  "updated": "2023-11-07T05:31:56Z"
}

Headers

​
x-prefect-api-version
string

Path Parameters

​
id
string
required

Response

200
application/json
Successful Response
​
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

​
actions
object[]
required

The actions to perform when this Automation triggers

​
id
string
required
​
created
string | null
required
​
updated
string | null
required
​
description
string
default:

A longer description of this automation

​
enabled
boolean
default:
true

Whether this automation will be evaluated

​
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

Was this page helpful?

Create AutomationUpdate Automation