List Automation rules
curl --request POST \
--url 'https://api.flashcat.cloud/safari/automation/rule/list?app_key=' \
--header 'Content-Type: application/json' \
--data '
{
"scope": "all",
"limit": 20
}
'import requests
url = "https://api.flashcat.cloud/safari/automation/rule/list?app_key="
payload = {
"scope": "all",
"limit": 20
}
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({scope: 'all', limit: 20})
};
fetch('https://api.flashcat.cloud/safari/automation/rule/list?app_key=', 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.flashcat.cloud/safari/automation/rule/list?app_key=",
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([
'scope' => 'all',
'limit' => 20
]),
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.flashcat.cloud/safari/automation/rule/list?app_key="
payload := strings.NewReader("{\n \"scope\": \"all\",\n \"limit\": 20\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.flashcat.cloud/safari/automation/rule/list?app_key=")
.header("Content-Type", "application/json")
.body("{\n \"scope\": \"all\",\n \"limit\": 20\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.flashcat.cloud/safari/automation/rule/list?app_key=")
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 \"scope\": \"all\",\n \"limit\": 20\n}"
response = http.request(request)
puts response.read_body{
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
"data": {
"total": 1,
"rules": [
{
"rule_id": "arule_7NnLzY2Qp8xS4kUaV3mR6b",
"account_id": 10023,
"team_id": 123,
"owner_id": 80011,
"name": "Weekly on-call review",
"enabled": true,
"run_scope": "team",
"cron_expr": "0 9 * * 1",
"timezone": "Asia/Shanghai",
"prompt": "Summarize last week's alert noise and escalation load.",
"environment_kind": "",
"environment_id": "",
"schedule_trigger_id": "atrig_6aKp3wT9mQ2xVc8bR1nY7z",
"schedule_trigger_enabled": true,
"http_post_trigger_id": "atrig_2bLq4xT8mP1sWd9cN3rF6y",
"http_post_trigger_url": "/safari/automation/triggers/atrig_2bLq4xT8mP1sWd9cN3rF6y/fire",
"http_post_trigger_enabled": true,
"can_edit": true,
"created_at": 1780367971228,
"updated_at": 1780367971228,
"schedule_next_fire_at_ms": 1780630800000,
"oncall_incident_trigger_id": "atrig_9cVb2mN7qKs4dEa8T1rY5p",
"oncall_incident_trigger_enabled": true,
"oncall_incident_channel_ids": [
456
],
"oncall_incident_severities": [
"Critical",
"Warning"
],
"oncall_incident_merge_similar": true,
"war_room_trigger_enabled": false,
"execution_place": "web_console",
"execution_location": {
"place": "web_console",
"run_scope": "team",
"team_id": 123,
"description": "Web console"
},
"last_run": {
"run_id": "trun_5oDvqiG64uur6sBNsTc4u",
"status": "succeeded",
"started_at": 1780630800000
}
}
]
}
}{
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
"error": {
"code": "InvalidParameter",
"message": "The specified parameter skill_id is not valid."
}
}{
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
"error": {
"code": "Unauthorized",
"message": "You are unauthorized."
}
}{
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
"error": {
"code": "AccessDenied",
"message": "Access Denied."
}
}{
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
"error": {
"code": "RequestTooFrequently",
"message": "Request too frequently."
}
}{
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
"error": {
"code": "InternalError",
"message": "We encountered an internal error, and it has been reported. Please try again later."
}
}Automations
List Automation rules
List Automation rules visible to the caller, newest update first, with pagination and filters.
POST
/
safari
/
automation
/
rule
/
list
List Automation rules
curl --request POST \
--url 'https://api.flashcat.cloud/safari/automation/rule/list?app_key=' \
--header 'Content-Type: application/json' \
--data '
{
"scope": "all",
"limit": 20
}
'import requests
url = "https://api.flashcat.cloud/safari/automation/rule/list?app_key="
payload = {
"scope": "all",
"limit": 20
}
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({scope: 'all', limit: 20})
};
fetch('https://api.flashcat.cloud/safari/automation/rule/list?app_key=', 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.flashcat.cloud/safari/automation/rule/list?app_key=",
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([
'scope' => 'all',
'limit' => 20
]),
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.flashcat.cloud/safari/automation/rule/list?app_key="
payload := strings.NewReader("{\n \"scope\": \"all\",\n \"limit\": 20\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.flashcat.cloud/safari/automation/rule/list?app_key=")
.header("Content-Type", "application/json")
.body("{\n \"scope\": \"all\",\n \"limit\": 20\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.flashcat.cloud/safari/automation/rule/list?app_key=")
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 \"scope\": \"all\",\n \"limit\": 20\n}"
response = http.request(request)
puts response.read_body{
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
"data": {
"total": 1,
"rules": [
{
"rule_id": "arule_7NnLzY2Qp8xS4kUaV3mR6b",
"account_id": 10023,
"team_id": 123,
"owner_id": 80011,
"name": "Weekly on-call review",
"enabled": true,
"run_scope": "team",
"cron_expr": "0 9 * * 1",
"timezone": "Asia/Shanghai",
"prompt": "Summarize last week's alert noise and escalation load.",
"environment_kind": "",
"environment_id": "",
"schedule_trigger_id": "atrig_6aKp3wT9mQ2xVc8bR1nY7z",
"schedule_trigger_enabled": true,
"http_post_trigger_id": "atrig_2bLq4xT8mP1sWd9cN3rF6y",
"http_post_trigger_url": "/safari/automation/triggers/atrig_2bLq4xT8mP1sWd9cN3rF6y/fire",
"http_post_trigger_enabled": true,
"can_edit": true,
"created_at": 1780367971228,
"updated_at": 1780367971228,
"schedule_next_fire_at_ms": 1780630800000,
"oncall_incident_trigger_id": "atrig_9cVb2mN7qKs4dEa8T1rY5p",
"oncall_incident_trigger_enabled": true,
"oncall_incident_channel_ids": [
456
],
"oncall_incident_severities": [
"Critical",
"Warning"
],
"oncall_incident_merge_similar": true,
"war_room_trigger_enabled": false,
"execution_place": "web_console",
"execution_location": {
"place": "web_console",
"run_scope": "team",
"team_id": 123,
"description": "Web console"
},
"last_run": {
"run_id": "trun_5oDvqiG64uur6sBNsTc4u",
"status": "succeeded",
"started_at": 1780630800000
}
}
]
}
}{
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
"error": {
"code": "InvalidParameter",
"message": "The specified parameter skill_id is not valid."
}
}{
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
"error": {
"code": "Unauthorized",
"message": "You are unauthorized."
}
}{
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
"error": {
"code": "AccessDenied",
"message": "Access Denied."
}
}{
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
"error": {
"code": "RequestTooFrequently",
"message": "Request too frequently."
}
}{
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
"error": {
"code": "InternalError",
"message": "We encountered an internal error, and it has been reported. Please try again later."
}
}Restrictions
| Aspect | Value |
|---|---|
| Rate limits | 1,000 requests/minute; 50 requests/second per account |
| Permissions | Automation Read (ai-sre) |
Usage
- Visible rules: the caller’s own personal rules plus rules of teams the caller belongs to. Account owners and admins see only the teams they belong to, never other people’s personal rules.
scope=personalreturns only the caller’s personal rules;scope=teamonly rules of the caller’s teams.team_idsnarrows the result further and never expands access.- Results are sorted by
updated_atdescending. Each item carrieslast_run(the most recent run) when the rule has ever run. can_editon each item tells whether the caller can manage (get, update, delete, run) that rule.
Authorizations
Body
application/json
List Automation rules visible to the caller: their own personal rules plus rules of teams they belong to. Account owners and admins are bounded the same way.
Response
Success
Standard response envelope used by every Flashduty public API. On success data contains the endpoint-specific payload and error is absent. On failure error is present and data is absent. request_id is always present and is also mirrored in the Flashcat-Request-Id response header.
Was this page helpful?