Skip to main content
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
}
'
{
  "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
  "data": {
    "total": 1,
    "rules": [
      {
        "rule_id": "auto_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",
        "prompt": "Summarize last week's alert noise and escalation load.",
        "environment_kind": "",
        "environment_id": "",
        "schedule_trigger_id": "autotrg_6aKp3wT9mQ2xVc8bR1nY7z",
        "schedule_trigger_enabled": true,
        "http_post_trigger_id": "autotrg_2bLq4xT8mP1sWd9cN3rF6y",
        "http_post_trigger_url": "/safari/automation/triggers/autotrg_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": "autotrg_9cFr2kLm8qNv5pXs4dWy7a",
        "oncall_incident_trigger_enabled": true,
        "oncall_incident_channel_ids": [
          2468013579
        ],
        "oncall_incident_severities": [
          "Critical",
          "Warning"
        ]
      }
    ]
  }
}

​
Restrictions

AspectValue
Rate limits1,000 requests/minute; 50 requests/second per account
PermissionsValid app_key; results are filtered to the caller’s visible scope

Authorizations

​
app_key
string
query
required

App key issued from the Flashduty console. Required on every public API call. Keep it secret — it grants the same access as the owning account.

Body

application/json

List Automation rules visible to the caller.

​
p
integer
default:1

Page number, 1-based.

​
limit
integer
default:20

Page size.

Required range: x <= 100
​
scope
enum<string>

Scope filter. Defaults to all.

Available options:
all,
personal,
team
​
team_ids
integer<int64>[]

Filter to these team IDs; this filters results and does not expand access.

​
include_person
boolean | null

Compatibility field; when scope is empty and this is false, behaves like team scope.

​
enabled
boolean | null

Filter by enabled status.

​
keyword
string

Filter by name keyword.

Maximum string length: 64

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.

​
request_id
string
required

Unique ID for this request. Mirrored in the Flashcat-Request-Id header. Include it when reporting issues.

Example:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

​
error
object

Error payload inside the response envelope. Present only on non-2xx responses.

​
data
object

Endpoint-specific payload. See each operation's 200 response schema.