Skip to main content
PUT
/
automations
/
{id}
Update Automation
curl --request PUT \
  --url https://api.example.com/automations/{id} \
  --header 'Content-Type: application/json' \
  --data '
{
  "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"
    }
  ],
  "description": "",
  "enabled": true,
  "tags": [
    "<string>"
  ],
  "actions_on_trigger": [
    {
      "type": "do-nothing"
    }
  ],
  "actions_on_resolve": [
    {
      "type": "do-nothing"
    }
  ]
}
'
import requests

url = "https://api.example.com/automations/{id}"

payload = {
    "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" }],
    "description": "",
    "enabled": True,
    "tags": ["<string>"],
    "actions_on_trigger": [{ "type": "do-nothing" }],
    "actions_on_resolve": [{ "type": "do-nothing" }]
}
headers = {"Content-Type": "application/json"}

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

print(response.text)
const options = {
  method: 'PUT',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    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'}],
    description: '',
    enabled: true,
    tags: ['<string>'],
    actions_on_trigger: [{type: 'do-nothing'}],
    actions_on_resolve: [{type: 'do-nothing'}]
  })
};

fetch('https://api.example.com/automations/{id}', 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/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    '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'
        ]
    ],
    'description' => '',
    'enabled' => true,
    'tags' => [
        '<string>'
    ],
    'actions_on_trigger' => [
        [
                'type' => 'do-nothing'
        ]
    ],
    'actions_on_resolve' => [
        [
                'type' => 'do-nothing'
        ]
    ]
  ]),
  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/{id}"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"trigger\": {\n    \"type\": \"event\",\n    \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"match\": {},\n    \"match_related\": {},\n    \"after\": [\n      \"<string>\"\n    ],\n    \"expect\": [\n      \"<string>\"\n    ],\n    \"for_each\": [\n      \"<string>\"\n    ],\n    \"threshold\": 1,\n    \"within\": 0\n  },\n  \"actions\": [\n    {\n      \"type\": \"do-nothing\"\n    }\n  ],\n  \"description\": \"\",\n  \"enabled\": true,\n  \"tags\": [\n    \"<string>\"\n  ],\n  \"actions_on_trigger\": [\n    {\n      \"type\": \"do-nothing\"\n    }\n  ],\n  \"actions_on_resolve\": [\n    {\n      \"type\": \"do-nothing\"\n    }\n  ]\n}")

	req, _ := http.NewRequest("PUT", 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.put("https://api.example.com/automations/{id}")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"trigger\": {\n    \"type\": \"event\",\n    \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"match\": {},\n    \"match_related\": {},\n    \"after\": [\n      \"<string>\"\n    ],\n    \"expect\": [\n      \"<string>\"\n    ],\n    \"for_each\": [\n      \"<string>\"\n    ],\n    \"threshold\": 1,\n    \"within\": 0\n  },\n  \"actions\": [\n    {\n      \"type\": \"do-nothing\"\n    }\n  ],\n  \"description\": \"\",\n  \"enabled\": true,\n  \"tags\": [\n    \"<string>\"\n  ],\n  \"actions_on_trigger\": [\n    {\n      \"type\": \"do-nothing\"\n    }\n  ],\n  \"actions_on_resolve\": [\n    {\n      \"type\": \"do-nothing\"\n    }\n  ]\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/automations/{id}")

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

request = Net::HTTP::Put.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"trigger\": {\n    \"type\": \"event\",\n    \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"match\": {},\n    \"match_related\": {},\n    \"after\": [\n      \"<string>\"\n    ],\n    \"expect\": [\n      \"<string>\"\n    ],\n    \"for_each\": [\n      \"<string>\"\n    ],\n    \"threshold\": 1,\n    \"within\": 0\n  },\n  \"actions\": [\n    {\n      \"type\": \"do-nothing\"\n    }\n  ],\n  \"description\": \"\",\n  \"enabled\": true,\n  \"tags\": [\n    \"<string>\"\n  ],\n  \"actions_on_trigger\": [\n    {\n      \"type\": \"do-nothing\"\n    }\n  ],\n  \"actions_on_resolve\": [\n    {\n      \"type\": \"do-nothing\"\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Headers

​
x-prefect-api-version
string

Path Parameters

​
id
string<uuid>
required

Body

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

​
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

Response

Successful Response