List alerts
curl --request POST \
--url 'https://api.flashcat.cloud/alert/list?app_key=' \
--header 'Content-Type: application/json' \
--data '
{
"start_time": 1712620800,
"end_time": 1712707200,
"limit": 20,
"is_active": true
}
'import requests
url = "https://api.flashcat.cloud/alert/list?app_key="
payload = {
"start_time": 1712620800,
"end_time": 1712707200,
"limit": 20,
"is_active": True
}
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({start_time: 1712620800, end_time: 1712707200, limit: 20, is_active: true})
};
fetch('https://api.flashcat.cloud/alert/list?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/alert/list?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([
'start_time' => 1712620800,
'end_time' => 1712707200,
'limit' => 20,
'is_active' => true
]),
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/alert/list?app_key="
payload := strings.NewReader("{\n \"start_time\": 1712620800,\n \"end_time\": 1712707200,\n \"limit\": 20,\n \"is_active\": true\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/alert/list?app_key=")
.header("Content-Type", "application/json")
.body("{\n \"start_time\": 1712620800,\n \"end_time\": 1712707200,\n \"limit\": 20,\n \"is_active\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.flashcat.cloud/alert/list?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 \"start_time\": 1712620800,\n \"end_time\": 1712707200,\n \"limit\": 20,\n \"is_active\": true\n}"
response = http.request(request)
puts response.read_body{
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
"data": {
"total": 1,
"has_next_page": false,
"items": [
{
"alert_id": "663a1b2c3d4e5f6789abcdef",
"integration_id": 10001,
"channel_id": 20001,
"account_id": 10023,
"title": "CPU usage > 90%",
"alert_severity": "Critical",
"alert_status": "Critical",
"start_time": 1712650000,
"last_time": 1712655000,
"end_time": 0,
"labels": {
"host": "web-01"
},
"ever_muted": false,
"created_at": 1712650000,
"updated_at": 1712655000,
"integration_name": "Prometheus",
"integration_type": "prometheus",
"channel_name": "Production",
"event_cnt": 3
}
],
"search_after_ctx": "663a1b2c3d4e5f6789abcdef"
}
}{
"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."
}
}Alerts
List alerts
Return a cursor-paginated list of alerts matching the given filters.
POST
/
alert
/
list
List alerts
curl --request POST \
--url 'https://api.flashcat.cloud/alert/list?app_key=' \
--header 'Content-Type: application/json' \
--data '
{
"start_time": 1712620800,
"end_time": 1712707200,
"limit": 20,
"is_active": true
}
'import requests
url = "https://api.flashcat.cloud/alert/list?app_key="
payload = {
"start_time": 1712620800,
"end_time": 1712707200,
"limit": 20,
"is_active": True
}
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({start_time: 1712620800, end_time: 1712707200, limit: 20, is_active: true})
};
fetch('https://api.flashcat.cloud/alert/list?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/alert/list?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([
'start_time' => 1712620800,
'end_time' => 1712707200,
'limit' => 20,
'is_active' => true
]),
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/alert/list?app_key="
payload := strings.NewReader("{\n \"start_time\": 1712620800,\n \"end_time\": 1712707200,\n \"limit\": 20,\n \"is_active\": true\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/alert/list?app_key=")
.header("Content-Type", "application/json")
.body("{\n \"start_time\": 1712620800,\n \"end_time\": 1712707200,\n \"limit\": 20,\n \"is_active\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.flashcat.cloud/alert/list?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 \"start_time\": 1712620800,\n \"end_time\": 1712707200,\n \"limit\": 20,\n \"is_active\": true\n}"
response = http.request(request)
puts response.read_body{
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
"data": {
"total": 1,
"has_next_page": false,
"items": [
{
"alert_id": "663a1b2c3d4e5f6789abcdef",
"integration_id": 10001,
"channel_id": 20001,
"account_id": 10023,
"title": "CPU usage > 90%",
"alert_severity": "Critical",
"alert_status": "Critical",
"start_time": 1712650000,
"last_time": 1712655000,
"end_time": 0,
"labels": {
"host": "web-01"
},
"ever_muted": false,
"created_at": 1712650000,
"updated_at": 1712655000,
"integration_name": "Prometheus",
"integration_type": "prometheus",
"channel_name": "Production",
"event_cnt": 3
}
],
"search_after_ctx": "663a1b2c3d4e5f6789abcdef"
}
}{
"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 | Channels Read (on-call) or Channels Manage (on-call) or Incidents Read (on-call) or Incidents Manage (on-call) or Integrations Read (on-call) or Integrations Manage (on-call) |
Usage
start_timeandend_timeare required Unix seconds and filter on the alert’sstart_time; the span must not exceed 31 days.- With
by_updated_at: true, anupdated_atwindow with the same bounds is added on top of thestart_timefilter, and the span must not exceed 7 days. - A
start_timeearlier than the account’s data retention period is moved up to the retention start; anend_timebefore that start returnsInvalidParameter. - Pass
search_after_ctxfrom the previous response for the next page; without it,p/limitpage numbers apply andp * limitmust stay within 10,000. totalis capped at 1,000.has_next_pagedoes not depend ontotal: it is exact in both page-number and cursor mode, also past 1,000 alerts. Every non-empty page returnssearch_after_ctxfor its last alert; pass it back to read past the 10,000-row page-number limit.- Results are filtered by the caller’s channel data-access permissions.
- Set
is_activetotrueto retrieve only active (firing) alerts;falseto retrieve resolved alerts.
Authorizations
Body
application/json
Filter and pagination criteria for alert list queries. Time range is required.
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?