curl --request POST \
--url 'https://api.flashcat.cloud/monit/rule/create?app_key=' \
--header 'Content-Type: application/json' \
--data '
{
"folder_id": 100,
"name": "CPU High",
"ds_type": "prometheus",
"ds_list": [
"prometheus*"
],
"enabled": true,
"cron_pattern": "* * * * *",
"channel_ids": [
20001
],
"rule_configs": {
"queries": [
{
"name": "A",
"expr": "avg(cpu_usage_idle) < 10"
}
],
"check_threshold": {
"enabled": true,
"critical": "A",
"alerting_check_times": 1,
"recovery_check_times": 1,
"push_recovery_event": true,
"recovery": {
"mode": "invert"
}
}
}
}
'import requests
url = "https://api.flashcat.cloud/monit/rule/create?app_key="
payload = {
"folder_id": 100,
"name": "CPU High",
"ds_type": "prometheus",
"ds_list": ["prometheus*"],
"enabled": True,
"cron_pattern": "* * * * *",
"channel_ids": [20001],
"rule_configs": {
"queries": [
{
"name": "A",
"expr": "avg(cpu_usage_idle) < 10"
}
],
"check_threshold": {
"enabled": True,
"critical": "A",
"alerting_check_times": 1,
"recovery_check_times": 1,
"push_recovery_event": True,
"recovery": { "mode": "invert" }
}
}
}
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({
folder_id: 100,
name: 'CPU High',
ds_type: 'prometheus',
ds_list: ['prometheus*'],
enabled: true,
cron_pattern: '* * * * *',
channel_ids: [20001],
rule_configs: {
queries: [{name: 'A', expr: 'avg(cpu_usage_idle) < 10'}],
check_threshold: {
enabled: true,
critical: 'A',
alerting_check_times: 1,
recovery_check_times: 1,
push_recovery_event: true,
recovery: {mode: 'invert'}
}
}
})
};
fetch('https://api.flashcat.cloud/monit/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/monit/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([
'folder_id' => 100,
'name' => 'CPU High',
'ds_type' => 'prometheus',
'ds_list' => [
'prometheus*'
],
'enabled' => true,
'cron_pattern' => '* * * * *',
'channel_ids' => [
20001
],
'rule_configs' => [
'queries' => [
[
'name' => 'A',
'expr' => 'avg(cpu_usage_idle) < 10'
]
],
'check_threshold' => [
'enabled' => true,
'critical' => 'A',
'alerting_check_times' => 1,
'recovery_check_times' => 1,
'push_recovery_event' => true,
'recovery' => [
'mode' => 'invert'
]
]
]
]),
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/monit/rule/create?app_key="
payload := strings.NewReader("{\n \"folder_id\": 100,\n \"name\": \"CPU High\",\n \"ds_type\": \"prometheus\",\n \"ds_list\": [\n \"prometheus*\"\n ],\n \"enabled\": true,\n \"cron_pattern\": \"* * * * *\",\n \"channel_ids\": [\n 20001\n ],\n \"rule_configs\": {\n \"queries\": [\n {\n \"name\": \"A\",\n \"expr\": \"avg(cpu_usage_idle) < 10\"\n }\n ],\n \"check_threshold\": {\n \"enabled\": true,\n \"critical\": \"A\",\n \"alerting_check_times\": 1,\n \"recovery_check_times\": 1,\n \"push_recovery_event\": true,\n \"recovery\": {\n \"mode\": \"invert\"\n }\n }\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/monit/rule/create?app_key=")
.header("Content-Type", "application/json")
.body("{\n \"folder_id\": 100,\n \"name\": \"CPU High\",\n \"ds_type\": \"prometheus\",\n \"ds_list\": [\n \"prometheus*\"\n ],\n \"enabled\": true,\n \"cron_pattern\": \"* * * * *\",\n \"channel_ids\": [\n 20001\n ],\n \"rule_configs\": {\n \"queries\": [\n {\n \"name\": \"A\",\n \"expr\": \"avg(cpu_usage_idle) < 10\"\n }\n ],\n \"check_threshold\": {\n \"enabled\": true,\n \"critical\": \"A\",\n \"alerting_check_times\": 1,\n \"recovery_check_times\": 1,\n \"push_recovery_event\": true,\n \"recovery\": {\n \"mode\": \"invert\"\n }\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.flashcat.cloud/monit/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 \"folder_id\": 100,\n \"name\": \"CPU High\",\n \"ds_type\": \"prometheus\",\n \"ds_list\": [\n \"prometheus*\"\n ],\n \"enabled\": true,\n \"cron_pattern\": \"* * * * *\",\n \"channel_ids\": [\n 20001\n ],\n \"rule_configs\": {\n \"queries\": [\n {\n \"name\": \"A\",\n \"expr\": \"avg(cpu_usage_idle) < 10\"\n }\n ],\n \"check_threshold\": {\n \"enabled\": true,\n \"critical\": \"A\",\n \"alerting_check_times\": 1,\n \"recovery_check_times\": 1,\n \"push_recovery_event\": true,\n \"recovery\": {\n \"mode\": \"invert\"\n }\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
"data": {
"id": 50001,
"folder_id": 100,
"name": "CPU High",
"ds_type": "prometheus",
"created_at": 1712000000
}
}{
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
"error": {
"code": "InvalidParameter",
"message": "The specified parameter is not valid."
}
}{
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
"error": {
"code": "Unauthorized",
"message": "You are unauthorized."
}
}{
"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."
}
}Create alert rule
Create a new alert rule. Returns the created rule with its assigned ID.
curl --request POST \
--url 'https://api.flashcat.cloud/monit/rule/create?app_key=' \
--header 'Content-Type: application/json' \
--data '
{
"folder_id": 100,
"name": "CPU High",
"ds_type": "prometheus",
"ds_list": [
"prometheus*"
],
"enabled": true,
"cron_pattern": "* * * * *",
"channel_ids": [
20001
],
"rule_configs": {
"queries": [
{
"name": "A",
"expr": "avg(cpu_usage_idle) < 10"
}
],
"check_threshold": {
"enabled": true,
"critical": "A",
"alerting_check_times": 1,
"recovery_check_times": 1,
"push_recovery_event": true,
"recovery": {
"mode": "invert"
}
}
}
}
'import requests
url = "https://api.flashcat.cloud/monit/rule/create?app_key="
payload = {
"folder_id": 100,
"name": "CPU High",
"ds_type": "prometheus",
"ds_list": ["prometheus*"],
"enabled": True,
"cron_pattern": "* * * * *",
"channel_ids": [20001],
"rule_configs": {
"queries": [
{
"name": "A",
"expr": "avg(cpu_usage_idle) < 10"
}
],
"check_threshold": {
"enabled": True,
"critical": "A",
"alerting_check_times": 1,
"recovery_check_times": 1,
"push_recovery_event": True,
"recovery": { "mode": "invert" }
}
}
}
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({
folder_id: 100,
name: 'CPU High',
ds_type: 'prometheus',
ds_list: ['prometheus*'],
enabled: true,
cron_pattern: '* * * * *',
channel_ids: [20001],
rule_configs: {
queries: [{name: 'A', expr: 'avg(cpu_usage_idle) < 10'}],
check_threshold: {
enabled: true,
critical: 'A',
alerting_check_times: 1,
recovery_check_times: 1,
push_recovery_event: true,
recovery: {mode: 'invert'}
}
}
})
};
fetch('https://api.flashcat.cloud/monit/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/monit/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([
'folder_id' => 100,
'name' => 'CPU High',
'ds_type' => 'prometheus',
'ds_list' => [
'prometheus*'
],
'enabled' => true,
'cron_pattern' => '* * * * *',
'channel_ids' => [
20001
],
'rule_configs' => [
'queries' => [
[
'name' => 'A',
'expr' => 'avg(cpu_usage_idle) < 10'
]
],
'check_threshold' => [
'enabled' => true,
'critical' => 'A',
'alerting_check_times' => 1,
'recovery_check_times' => 1,
'push_recovery_event' => true,
'recovery' => [
'mode' => 'invert'
]
]
]
]),
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/monit/rule/create?app_key="
payload := strings.NewReader("{\n \"folder_id\": 100,\n \"name\": \"CPU High\",\n \"ds_type\": \"prometheus\",\n \"ds_list\": [\n \"prometheus*\"\n ],\n \"enabled\": true,\n \"cron_pattern\": \"* * * * *\",\n \"channel_ids\": [\n 20001\n ],\n \"rule_configs\": {\n \"queries\": [\n {\n \"name\": \"A\",\n \"expr\": \"avg(cpu_usage_idle) < 10\"\n }\n ],\n \"check_threshold\": {\n \"enabled\": true,\n \"critical\": \"A\",\n \"alerting_check_times\": 1,\n \"recovery_check_times\": 1,\n \"push_recovery_event\": true,\n \"recovery\": {\n \"mode\": \"invert\"\n }\n }\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/monit/rule/create?app_key=")
.header("Content-Type", "application/json")
.body("{\n \"folder_id\": 100,\n \"name\": \"CPU High\",\n \"ds_type\": \"prometheus\",\n \"ds_list\": [\n \"prometheus*\"\n ],\n \"enabled\": true,\n \"cron_pattern\": \"* * * * *\",\n \"channel_ids\": [\n 20001\n ],\n \"rule_configs\": {\n \"queries\": [\n {\n \"name\": \"A\",\n \"expr\": \"avg(cpu_usage_idle) < 10\"\n }\n ],\n \"check_threshold\": {\n \"enabled\": true,\n \"critical\": \"A\",\n \"alerting_check_times\": 1,\n \"recovery_check_times\": 1,\n \"push_recovery_event\": true,\n \"recovery\": {\n \"mode\": \"invert\"\n }\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.flashcat.cloud/monit/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 \"folder_id\": 100,\n \"name\": \"CPU High\",\n \"ds_type\": \"prometheus\",\n \"ds_list\": [\n \"prometheus*\"\n ],\n \"enabled\": true,\n \"cron_pattern\": \"* * * * *\",\n \"channel_ids\": [\n 20001\n ],\n \"rule_configs\": {\n \"queries\": [\n {\n \"name\": \"A\",\n \"expr\": \"avg(cpu_usage_idle) < 10\"\n }\n ],\n \"check_threshold\": {\n \"enabled\": true,\n \"critical\": \"A\",\n \"alerting_check_times\": 1,\n \"recovery_check_times\": 1,\n \"push_recovery_event\": true,\n \"recovery\": {\n \"mode\": \"invert\"\n }\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
"data": {
"id": 50001,
"folder_id": 100,
"name": "CPU High",
"ds_type": "prometheus",
"created_at": 1712000000
}
}{
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
"error": {
"code": "InvalidParameter",
"message": "The specified parameter is not valid."
}
}{
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
"error": {
"code": "Unauthorized",
"message": "You are unauthorized."
}
}{
"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 | Alerting Rules Manage (monit) |
Usage
name,ds_type,cron_pattern, andrule_configs.queriesare required.- Either
ds_list(supports wildcards) ords_idsmust be non-empty. cron_patternuses standard 5-field cron syntax.channel_idscan be empty; alerts will then route through the global integration.- Every call is recorded in the account audit log. Don’t put secrets in request fields.
Authorizations
App key issued from the Flashduty console under Account → APP Keys. Required on every public API call. Keep it secret — it grants the same access as the owning account.
Body
Full alert rule configuration.
Folder the rule belongs to.
Rule name.
Custom labels.
Show child attributes
Show child attributes
Data source type.
Data source name patterns (supports wildcards).
Specific data source IDs.
Rule evaluation configuration.
Show child attributes
Show child attributes
5-field cron schedule. Must not start with CRON_TZ= or TZ=; use the timezone field instead.
Timezone in which the rule executes. Determines how the cron schedule and effective time windows are interpreted. Only IANA timezone names are accepted (e.g. Asia/Shanghai, UTC, Europe/London); shortcuts and offsets such as Local, UTC+8, or CST are rejected. Treated as Asia/Shanghai if empty.
Time windows when the rule is active.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
text, markdown Channel IDs to send alerts to.
Notification repeat interval in seconds.
Max number of repeat notifications.
Response
Success
Success response envelope. On every 2xx response, request_id identifies the call (also mirrored in the Flashcat-Request-Id header) and data holds the endpoint-specific payload. Failure responses use a different shape — see ErrorResponse.
Was this page helpful?