跳转到主要内容
POST
/
safari
/
automation
/
rule
/
update
更新自动化规则
curl --request POST \
  --url 'https://api.flashcat.cloud/safari/automation/rule/update?app_key=' \
  --header 'Content-Type: application/json' \
  --data '
{
  "rule_id": "auto_7NnLzY2Qp8xS4kUaV3mR6b",
  "enabled": true,
  "cron_expr": "15 9 * * 1",
  "rotate_http_post_trigger_token": true,
  "oncall_incident_trigger_enabled": true,
  "oncall_incident_severities": [
    "Critical",
    "Warning"
  ],
  "oncall_incident_channel_ids": [
    456
  ]
}
'
{
  "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
  "data": {
    "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,
    "http_post_token": "sat_yQ9p8V7n6M5k4J3h2G1f0E9d8C7b6A5z4Y3x2W1v0U",
    "schedule_next_fire_at_ms": 1780630800000,
    "oncall_incident_trigger_id": "autotrg_9cVb2mN7qKs4dEa8T1rY5p",
    "oncall_incident_trigger_enabled": true,
    "oncall_incident_channel_ids": [
      456
    ],
    "oncall_incident_severities": [
      "Critical",
      "Warning"
    ]
  }
}

​
调用限制

项值
速率限制1,000 次/分钟；50 次/秒 每账户
权限有效 app_key；管理操作要求调用者可管理目标规则

​
使用说明

  • 可以创建个人规则，也可以创建当前 account 下任意团队规则；team_id 创建后不可修改。
  • 列表可见性与 Session 列表对齐：Owner / 管理员可见全部；普通成员可见自己创建的规则和自己团队的规则。
  • http_post_token 只在创建或轮换 token 的响应中返回，请立即保存。
  • 如需由 On-call 故障触发，传入 oncall_incident_trigger_enabled、oncall_incident_channel_ids 与 oncall_incident_severities；匹配事件会以 oncall_incident 运行。

授权

​
app_key
string
query
必填

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.

请求体

application/json

更新自动化规则。省略字段表示不修改。

​
rule_id
string
必填

目标规则 ID。

​
name
string

新规则名称。

Maximum string length: 255
​
team_id
integer<int64>

只允许传当前值；创建后 personal / team scope 不可修改。

必填范围: x >= 0
​
enabled
boolean

是否启用规则。

​
cron_expr
string

运行周期。支持 4 段 hour day month weekday，会补 minute=0；也支持 5 段 minute hour day month weekday。分钟必须是固定整数，秒级 6 段不支持。创建 API 当前要求该字段，即使只启用 HTTP POST trigger，也要提供一个有效 cron 并把 schedule_trigger_enabled 设为 false。

示例:

"15 9 * * *"

​
schedule_trigger_enabled
boolean

是否启用 schedule trigger。

​
prompt
string

新的任务提示词。

​
environment_kind
enum<string>

运行环境类型。省略或空字符串表示自动选择。

可用选项:
,
cloud,
byoc
​
environment_id
string

BYOC Runner ID。

​
http_post_trigger_enabled
boolean

是否启用 HTTP POST trigger。不存在时设为 true 会创建。

​
oncall_incident_trigger_enabled
boolean

是否启用 On-call 故障触发器。

​
oncall_incident_channel_ids
integer<int64>[]

监听的 On-call 集成 ID 列表；创建或启用该触发器时至少需要一个有效 ID。

必填范围: x >= 1
​
oncall_incident_severities
enum<string>[]

监听的故障严重程度，支持 Critical、Warning 和 Info；创建或启用该触发器时至少需要一个值。

可用选项:
Critical,
Warning,
Info
​
rotate_http_post_trigger_token
boolean

是否轮换 HTTP POST trigger token。新 token 只会在本次响应中返回。

响应

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
必填

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

示例:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

​
error
object

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

​
data
object

自动化规则。