List alert rules
curl --request POST \
--url 'https://api.flashcat.cloud/monit/rule/list/basic?app_key=' \
--header 'Content-Type: application/json' \
--data '
{
"folder_id": 100
}
'import requests
url = "https://api.flashcat.cloud/monit/rule/list/basic?app_key="
payload = { "folder_id": 100 }
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})
};
fetch('https://api.flashcat.cloud/monit/rule/list/basic?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/list/basic?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
]),
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/list/basic?app_key="
payload := strings.NewReader("{\n \"folder_id\": 100\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/list/basic?app_key=")
.header("Content-Type", "application/json")
.body("{\n \"folder_id\": 100\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.flashcat.cloud/monit/rule/list/basic?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}"
response = http.request(request)
puts response.read_body{
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
"data": [
{
"id": 50001,
"account_id": 888,
"folder_id": 100,
"name": "CPU High",
"labels": {
"team": "sre"
},
"ds_type": "prometheus",
"enabled": true,
"debug_log_enabled": false,
"cron_pattern": "0 * * * * *",
"timezone": "Asia/Shanghai",
"delay_seconds": 0,
"creator_id": 66,
"creator_name": "zhangsan",
"updater_id": 66,
"updater_name": "zhangsan",
"created_at": 1710000000,
"updated_at": 1712000000,
"triggered": true,
"active_alert_count": 2,
"runtime_state": "normal"
}
]
}{
"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": "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."
}
}Alert rules
List alert rules
Return basic information for the alert rules in a folder; call POST /monit/rule/v2/info for full details.
POST
/
monit
/
rule
/
list
/
basic
List alert rules
curl --request POST \
--url 'https://api.flashcat.cloud/monit/rule/list/basic?app_key=' \
--header 'Content-Type: application/json' \
--data '
{
"folder_id": 100
}
'import requests
url = "https://api.flashcat.cloud/monit/rule/list/basic?app_key="
payload = { "folder_id": 100 }
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})
};
fetch('https://api.flashcat.cloud/monit/rule/list/basic?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/list/basic?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
]),
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/list/basic?app_key="
payload := strings.NewReader("{\n \"folder_id\": 100\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/list/basic?app_key=")
.header("Content-Type", "application/json")
.body("{\n \"folder_id\": 100\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.flashcat.cloud/monit/rule/list/basic?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}"
response = http.request(request)
puts response.read_body{
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
"data": [
{
"id": 50001,
"account_id": 888,
"folder_id": 100,
"name": "CPU High",
"labels": {
"team": "sre"
},
"ds_type": "prometheus",
"enabled": true,
"debug_log_enabled": false,
"cron_pattern": "0 * * * * *",
"timezone": "Asia/Shanghai",
"delay_seconds": 0,
"creator_id": 66,
"creator_name": "zhangsan",
"updater_id": 66,
"updater_name": "zhangsan",
"created_at": 1710000000,
"updated_at": 1712000000,
"triggered": true,
"active_alert_count": 2,
"runtime_state": "normal"
}
]
}{
"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": "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 | Alerting Rules Read or Alerting Rules Manage (monit) |
Usage
folder_idmust be an existing folder:0or an unknown ID returnsInvalidParameter, and a folder the caller cannot manage (account owner or admin, creator of the folder or an ancestor, or member of the team bound to it or an ancestor) returnsAccessDenied. There is no account-wide listing.- By default only the rules directly in the folder are returned, sorted by name, with
active_alert_countandruntime_statefilled. - With
include_descendants: truethe call searches the folder and all its descendant folders and returns at mostlimitrules sorted by name; onlyid,folder_idandnameare filled and the other fields carry zero values (labelsisnull,runtime_stateis omitted). triggeredistrueexactly whenactive_alert_count > 0.
Authorizations
Body
application/json
Filter parameter for listing rules in a folder.
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?