Skip to main content
POST
/
api
/
automations
/
filter
Read Automations
curl --request POST \
  --url https://api.example.com/api/automations/filter \
  --header 'Content-Type: application/json' \
  --data '
{
  "sort": "NAME_ASC",
  "offset": 0,
  "automations": {
    "operator": "and_",
    "name": {
      "any_": [
        "<string>"
      ]
    },
    "created": {
      "before_": "2023-11-07T05:31:56Z"
    },
    "tags": {
      "operator": "and_",
      "all_": [
        "tag-1",
        "tag-2"
      ],
      "any_": [
        "tag-1",
        "tag-2"
      ],
      "is_null_": true
    }
  },
  "limit": 123
}
'
[
  {
    "name": "<string>",
    "trigger": {
      "posture": "Reactive",
      "type": "event",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "match": {},
      "match_related": {},
      "after": [
        "<string>"
      ],
      "expect": [
        "<string>"
      ],
      "for_each": [
        "<string>"
      ],
      "threshold": 1,
      "within": 0
    },
    "actions": [
      {
        "type": "do-nothing"
      }
    ],
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "created": "2023-11-07T05:31:56Z",
    "updated": "2023-11-07T05:31:56Z",
    "description": "",
    "enabled": true,
    "tags": [
      "<string>"
    ],
    "actions_on_trigger": [
      {
        "type": "do-nothing"
      }
    ],
    "actions_on_resolve": [
      {
        "type": "do-nothing"
      }
    ]
  }
]

Headers

​
x-prefect-api-version
string

Body

application/json
​
sort
enum<string>
default:NAME_ASC

Defines automations sorting options.

Available options:
CREATED_DESC,
UPDATED_DESC,
NAME_ASC,
NAME_DESC
​
offset
integer
default:0
Required range: x >= 0
​
automations
AutomationFilter · object
​
limit
integer

Defaults to PREFECT_API_DEFAULT_LIMIT if not provided.

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

​
actions
(DoNothing · object | RunDeployment · object | PauseDeployment · object | ResumeDeployment · object | CancelFlowRun · object | ChangeFlowRunState · object | PauseWorkQueue · object | ResumeWorkQueue · object | SendNotification · object | CallWebhook · object | PauseAutomation · object | ResumeAutomation · object | SuspendFlowRun · object | ResumeFlowRun · object | PauseWorkPool · object | ResumeWorkPool · object)[]
required

The actions to perform when this Automation triggers

Do nothing when an Automation is triggered

​
id
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

​
tags
string[]

A list of tags associated with this automation

​
actions_on_trigger
(DoNothing · object | RunDeployment · object | PauseDeployment · object | ResumeDeployment · object | CancelFlowRun · object | ChangeFlowRunState · object | PauseWorkQueue · object | ResumeWorkQueue · object | SendNotification · object | CallWebhook · object | PauseAutomation · object | ResumeAutomation · object | SuspendFlowRun · object | ResumeFlowRun · object | PauseWorkPool · object | ResumeWorkPool · object)[]

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

Do nothing when an Automation is triggered

​
actions_on_resolve
(DoNothing · object | RunDeployment · object | PauseDeployment · object | ResumeDeployment · object | CancelFlowRun · object | ChangeFlowRunState · object | PauseWorkQueue · object | ResumeWorkQueue · object | SendNotification · object | CallWebhook · object | PauseAutomation · object | ResumeAutomation · object | SuspendFlowRun · object | ResumeFlowRun · object | PauseWorkPool · object | ResumeWorkPool · object)[]

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

Do nothing when an Automation is triggered