Skip to main content
POST
/
automations
/
filter
Read Automations
curl --request POST \
  --url https://api.example.com/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
}
'
import requests

url = "https://api.example.com/automations/filter"

payload = {
    "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
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    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
  })
};

fetch('https://api.example.com/automations/filter', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/automations/filter",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    '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
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/automations/filter"

	payload := strings.NewReader("{\n  \"sort\": \"NAME_ASC\",\n  \"offset\": 0,\n  \"automations\": {\n    \"operator\": \"and_\",\n    \"name\": {\n      \"any_\": [\n        \"<string>\"\n      ]\n    },\n    \"created\": {\n      \"before_\": \"2023-11-07T05:31:56Z\"\n    },\n    \"tags\": {\n      \"operator\": \"and_\",\n      \"all_\": [\n        \"tag-1\",\n        \"tag-2\"\n      ],\n      \"any_\": [\n        \"tag-1\",\n        \"tag-2\"\n      ],\n      \"is_null_\": true\n    }\n  },\n  \"limit\": 123\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.example.com/automations/filter")
  .header("Content-Type", "application/json")
  .body("{\n  \"sort\": \"NAME_ASC\",\n  \"offset\": 0,\n  \"automations\": {\n    \"operator\": \"and_\",\n    \"name\": {\n      \"any_\": [\n        \"<string>\"\n      ]\n    },\n    \"created\": {\n      \"before_\": \"2023-11-07T05:31:56Z\"\n    },\n    \"tags\": {\n      \"operator\": \"and_\",\n      \"all_\": [\n        \"tag-1\",\n        \"tag-2\"\n      ],\n      \"any_\": [\n        \"tag-1\",\n        \"tag-2\"\n      ],\n      \"is_null_\": true\n    }\n  },\n  \"limit\": 123\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/automations/filter")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"sort\": \"NAME_ASC\",\n  \"offset\": 0,\n  \"automations\": {\n    \"operator\": \"and_\",\n    \"name\": {\n      \"any_\": [\n        \"<string>\"\n      ]\n    },\n    \"created\": {\n      \"before_\": \"2023-11-07T05:31:56Z\"\n    },\n    \"tags\": {\n      \"operator\": \"and_\",\n      \"all_\": [\n        \"tag-1\",\n        \"tag-2\"\n      ],\n      \"any_\": [\n        \"tag-1\",\n        \"tag-2\"\n      ],\n      \"is_null_\": true\n    }\n  },\n  \"limit\": 123\n}"

response = http.request(request)
puts response.read_body
[
  {
    "name": "<string>",
    "trigger": {
      "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"
      }
    ]
  }
]
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

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

A trigger that fires based on the presence or absence of events within a given period of time.

​
actions
(DoNothing · object | RunDeployment · object | PauseDeployment · object | ResumeDeployment · object | CancelFlowRun · object | DeleteFlowRun · 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 | DeleteFlowRun · 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 | DeleteFlowRun · 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