创建自动化规则

创建自动化规则

curl --request POST \
  --url 'https://api.flashcat.cloud/safari/automation/rule/create?app_key=' \
  --header 'Content-Type: application/json' \
  --data @- <<EOF
{
  "name": "Weekly on-call review",
  "team_id": 123,
  "enabled": true,
  "cron_expr": "0 9 * * 1",
  "timezone": "Asia/Shanghai",
  "schedule_trigger_enabled": true,
  "prompt": "Summarize last week's alert noise and escalation load.",
  "http_post_trigger_enabled": true,
  "oncall_incident_trigger_enabled": true,
  "oncall_incident_channel_ids": [
    456
  ],
  "oncall_incident_severities": [
    "Critical",
    "Warning"
  ]
}
EOF

import requests

url = "https://api.flashcat.cloud/safari/automation/rule/create?app_key="

payload = {
    "name": "Weekly on-call review",
    "team_id": 123,
    "enabled": True,
    "cron_expr": "0 9 * * 1",
    "timezone": "Asia/Shanghai",
    "schedule_trigger_enabled": True,
    "prompt": "Summarize last week's alert noise and escalation load.",
    "http_post_trigger_enabled": True,
    "oncall_incident_trigger_enabled": True,
    "oncall_incident_channel_ids": [456],
    "oncall_incident_severities": ["Critical", "Warning"]
}
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({
    name: 'Weekly on-call review',
    team_id: 123,
    enabled: true,
    cron_expr: '0 9 * * 1',
    timezone: 'Asia/Shanghai',
    schedule_trigger_enabled: true,
    prompt: 'Summarize last week\'s alert noise and escalation load.',
    http_post_trigger_enabled: true,
    oncall_incident_trigger_enabled: true,
    oncall_incident_channel_ids: [456],
    oncall_incident_severities: ['Critical', 'Warning']
  })
};

fetch('https://api.flashcat.cloud/safari/automation/rule/create?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/create?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([
    'name' => 'Weekly on-call review',
    'team_id' => 123,
    'enabled' => true,
    'cron_expr' => '0 9 * * 1',
    'timezone' => 'Asia/Shanghai',
    'schedule_trigger_enabled' => true,
    'prompt' => 'Summarize last week\'s alert noise and escalation load.',
    'http_post_trigger_enabled' => true,
    'oncall_incident_trigger_enabled' => true,
    'oncall_incident_channel_ids' => [
        456
    ],
    'oncall_incident_severities' => [
        'Critical',
        'Warning'
    ]
  ]),
  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/create?app_key="

	payload := strings.NewReader("{\n  \"name\": \"Weekly on-call review\",\n  \"team_id\": 123,\n  \"enabled\": true,\n  \"cron_expr\": \"0 9 * * 1\",\n  \"timezone\": \"Asia/Shanghai\",\n  \"schedule_trigger_enabled\": true,\n  \"prompt\": \"Summarize last week's alert noise and escalation load.\",\n  \"http_post_trigger_enabled\": true,\n  \"oncall_incident_trigger_enabled\": true,\n  \"oncall_incident_channel_ids\": [\n    456\n  ],\n  \"oncall_incident_severities\": [\n    \"Critical\",\n    \"Warning\"\n  ]\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/create?app_key=")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Weekly on-call review\",\n  \"team_id\": 123,\n  \"enabled\": true,\n  \"cron_expr\": \"0 9 * * 1\",\n  \"timezone\": \"Asia/Shanghai\",\n  \"schedule_trigger_enabled\": true,\n  \"prompt\": \"Summarize last week's alert noise and escalation load.\",\n  \"http_post_trigger_enabled\": true,\n  \"oncall_incident_trigger_enabled\": true,\n  \"oncall_incident_channel_ids\": [\n    456\n  ],\n  \"oncall_incident_severities\": [\n    \"Critical\",\n    \"Warning\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.flashcat.cloud/safari/automation/rule/create?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  \"name\": \"Weekly on-call review\",\n  \"team_id\": 123,\n  \"enabled\": true,\n  \"cron_expr\": \"0 9 * * 1\",\n  \"timezone\": \"Asia/Shanghai\",\n  \"schedule_trigger_enabled\": true,\n  \"prompt\": \"Summarize last week's alert noise and escalation load.\",\n  \"http_post_trigger_enabled\": true,\n  \"oncall_incident_trigger_enabled\": true,\n  \"oncall_incident_channel_ids\": [\n    456\n  ],\n  \"oncall_incident_severities\": [\n    \"Critical\",\n    \"Warning\"\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
  "data": {
    "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,
    "http_post_token": "sat_yQ9p8V7n6M5k4J3h2G1f0E9d8C7b6A5z4Y3x2W1v0U",
    "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"
    ]
  }
}

{
  "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."
  }
}

POST

safari

automation

rule

create

创建自动化规则

curl --request POST \
  --url 'https://api.flashcat.cloud/safari/automation/rule/create?app_key=' \
  --header 'Content-Type: application/json' \
  --data @- <<EOF
{
  "name": "Weekly on-call review",
  "team_id": 123,
  "enabled": true,
  "cron_expr": "0 9 * * 1",
  "timezone": "Asia/Shanghai",
  "schedule_trigger_enabled": true,
  "prompt": "Summarize last week's alert noise and escalation load.",
  "http_post_trigger_enabled": true,
  "oncall_incident_trigger_enabled": true,
  "oncall_incident_channel_ids": [
    456
  ],
  "oncall_incident_severities": [
    "Critical",
    "Warning"
  ]
}
EOF

import requests

url = "https://api.flashcat.cloud/safari/automation/rule/create?app_key="

payload = {
    "name": "Weekly on-call review",
    "team_id": 123,
    "enabled": True,
    "cron_expr": "0 9 * * 1",
    "timezone": "Asia/Shanghai",
    "schedule_trigger_enabled": True,
    "prompt": "Summarize last week's alert noise and escalation load.",
    "http_post_trigger_enabled": True,
    "oncall_incident_trigger_enabled": True,
    "oncall_incident_channel_ids": [456],
    "oncall_incident_severities": ["Critical", "Warning"]
}
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({
    name: 'Weekly on-call review',
    team_id: 123,
    enabled: true,
    cron_expr: '0 9 * * 1',
    timezone: 'Asia/Shanghai',
    schedule_trigger_enabled: true,
    prompt: 'Summarize last week\'s alert noise and escalation load.',
    http_post_trigger_enabled: true,
    oncall_incident_trigger_enabled: true,
    oncall_incident_channel_ids: [456],
    oncall_incident_severities: ['Critical', 'Warning']
  })
};

fetch('https://api.flashcat.cloud/safari/automation/rule/create?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/create?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([
    'name' => 'Weekly on-call review',
    'team_id' => 123,
    'enabled' => true,
    'cron_expr' => '0 9 * * 1',
    'timezone' => 'Asia/Shanghai',
    'schedule_trigger_enabled' => true,
    'prompt' => 'Summarize last week\'s alert noise and escalation load.',
    'http_post_trigger_enabled' => true,
    'oncall_incident_trigger_enabled' => true,
    'oncall_incident_channel_ids' => [
        456
    ],
    'oncall_incident_severities' => [
        'Critical',
        'Warning'
    ]
  ]),
  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/create?app_key="

	payload := strings.NewReader("{\n  \"name\": \"Weekly on-call review\",\n  \"team_id\": 123,\n  \"enabled\": true,\n  \"cron_expr\": \"0 9 * * 1\",\n  \"timezone\": \"Asia/Shanghai\",\n  \"schedule_trigger_enabled\": true,\n  \"prompt\": \"Summarize last week's alert noise and escalation load.\",\n  \"http_post_trigger_enabled\": true,\n  \"oncall_incident_trigger_enabled\": true,\n  \"oncall_incident_channel_ids\": [\n    456\n  ],\n  \"oncall_incident_severities\": [\n    \"Critical\",\n    \"Warning\"\n  ]\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/create?app_key=")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Weekly on-call review\",\n  \"team_id\": 123,\n  \"enabled\": true,\n  \"cron_expr\": \"0 9 * * 1\",\n  \"timezone\": \"Asia/Shanghai\",\n  \"schedule_trigger_enabled\": true,\n  \"prompt\": \"Summarize last week's alert noise and escalation load.\",\n  \"http_post_trigger_enabled\": true,\n  \"oncall_incident_trigger_enabled\": true,\n  \"oncall_incident_channel_ids\": [\n    456\n  ],\n  \"oncall_incident_severities\": [\n    \"Critical\",\n    \"Warning\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.flashcat.cloud/safari/automation/rule/create?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  \"name\": \"Weekly on-call review\",\n  \"team_id\": 123,\n  \"enabled\": true,\n  \"cron_expr\": \"0 9 * * 1\",\n  \"timezone\": \"Asia/Shanghai\",\n  \"schedule_trigger_enabled\": true,\n  \"prompt\": \"Summarize last week's alert noise and escalation load.\",\n  \"http_post_trigger_enabled\": true,\n  \"oncall_incident_trigger_enabled\": true,\n  \"oncall_incident_channel_ids\": [\n    456\n  ],\n  \"oncall_incident_severities\": [\n    \"Critical\",\n    \"Warning\"\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
  "data": {
    "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,
    "http_post_token": "sat_yQ9p8V7n6M5k4J3h2G1f0E9d8C7b6A5z4Y3x2W1v0U",
    "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"
    ]
  }
}

{
  "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."
  }
}

限制说明

项目	说明
速率限制	每个账户 300 次/分钟；20 次/秒
权限要求	有效 `app_key`；管理操作要求调用者可管理目标规则

使用说明

可以创建个人规则，也可以创建当前账户下任意团队的规则；team_id 创建后不可修改。
cron_expr 按 timezone（如提供）计算；未提供时依次回退到调用者的成员时区、账户时区，最后是服务端默认时区（Asia/Shanghai）。
http_post_trigger_enabled=true 会创建并启用 HTTP POST 触发器；响应中的 http_post_token 是仅在创建时返回的一次性值，请立即保存。
oncall_incident_trigger_enabled=true 时，oncall_incident_channel_ids 和 oncall_incident_severities 至少各需一项；匹配的故障会以 trigger_kind=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

创建自动化规则。

name

string

必填

规则名称。

Required string length: 1 - 255

cron_expr

string

必填

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

示例:

"15 9 * * *"

prompt

string

必填

每次运行发给 AI SRE Agent 的任务提示词。

Minimum string length: 1

team_id

integer<int64>

作用域团队 ID。0 或省略表示个人规则；>0 表示账户下某团队。创建后不可修改。

必填范围: x >= 0

enabled

boolean

规则创建后是否启用。API 省略时为 false；Chat/CLI 入口会默认发送 true，除非用户要求禁用。

timezone

string

cron_expr 计算所用的 IANA 时区，例如 Asia/Shanghai。必须是服务端可加载的合法时区名，非法值会被拒绝。省略时依次回退到调用者的成员时区、账户时区，最后是服务端默认时区（Asia/Shanghai）。

schedule_trigger_enabled

boolean | null

是否启用 schedule trigger。省略时为 true；HTTP-POST-only 规则应传 false。

environment_kind

enum<string>

运行环境类型。省略或空字符串表示自动选择。可选值：cloud（平台托管的云端沙箱）、byoc（账户内自托管的 BYOC 运行器，需配合 environment_id）；自动选择时优先使用在线的 BYOC 运行器，否则使用云端沙箱。

可用选项:

cloud,

byoc

environment_id

string

BYOC Runner ID。仅 environment_kind=byoc 时使用。

http_post_trigger_enabled

boolean

是否创建并启用 HTTP POST trigger。启用时响应里会返回一次性 token。

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

响应

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.

Show child attributes

data

object

自动化规则。

Show child attributes

开发指南

On-call

Monitors

RUM

AI SRE

平台

限制说明

使用说明

授权

请求体

响应

​限制说明

​使用说明

授权

请求体

响应

限制说明

使用说明