Read Automation
curl --request GET \
--url https://api.example.com/automations/{id}import requests
url = "https://api.example.com/automations/{id}"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
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 => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/automations/{id}"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/automations/{id}")
.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::Get.new(url)
response = http.request(request)
puts response.read_body{
"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"
}
]
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Automations
Read Automation
GET
/
automations
/
{id}
Read Automation
curl --request GET \
--url https://api.example.com/automations/{id}import requests
url = "https://api.example.com/automations/{id}"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
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 => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/automations/{id}"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/automations/{id}")
.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::Get.new(url)
response = http.request(request)
puts response.read_body{
"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"
}
]
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Headers
Path Parameters
Response
Successful Response
The name of this automation
A trigger that fires based on the presence or absence of events within a given period of time.
- EventTrigger
- CompoundTrigger
- SequenceTrigger
Show child attributes
Show child attributes
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
- DoNothing
- RunDeployment
- PauseDeployment
- ResumeDeployment
- CancelFlowRun
- DeleteFlowRun
- ChangeFlowRunState
- PauseWorkQueue
- ResumeWorkQueue
- SendNotification
- CallWebhook
- PauseAutomation
- ResumeAutomation
- SuspendFlowRun
- ResumeFlowRun
- PauseWorkPool
- ResumeWorkPool
Show child attributes
Show child attributes
A longer description of this automation
Whether this automation will be evaluated
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
- DoNothing
- RunDeployment
- PauseDeployment
- ResumeDeployment
- CancelFlowRun
- DeleteFlowRun
- ChangeFlowRunState
- PauseWorkQueue
- ResumeWorkQueue
- SendNotification
- CallWebhook
- PauseAutomation
- ResumeAutomation
- SuspendFlowRun
- ResumeFlowRun
- PauseWorkPool
- ResumeWorkPool
Show child attributes
Show child attributes
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
- DoNothing
- RunDeployment
- PauseDeployment
- ResumeDeployment
- CancelFlowRun
- DeleteFlowRun
- ChangeFlowRunState
- PauseWorkQueue
- ResumeWorkQueue
- SendNotification
- CallWebhook
- PauseAutomation
- ResumeAutomation
- SuspendFlowRun
- ResumeFlowRun
- PauseWorkPool
- ResumeWorkPool
Show child attributes
Show child attributes
Was this page helpful?