Preview alert pipeline processing
curl --request POST \
--url 'https://api.flashcat.cloud/alert/pipeline/preview?app_key=' \
--header 'Content-Type: application/json' \
--data '
{
"integration_id": 6113996590131,
"rules": [
{
"kind": "severity_reset",
"if": [
{
"key": "labels.env",
"oper": "IN",
"vals": [
"test"
]
}
],
"settings": {
"severity": "Info"
}
},
{
"kind": "alert_drop",
"if": [
{
"key": "title",
"oper": "IN",
"vals": [
"/.*noise.*/"
]
}
],
"settings": {}
}
],
"event": {
"title": "Disk usage 95% on db-3",
"description": "Root filesystem is 95% full on db-3.",
"event_status": "Warning",
"labels": {
"service": "mysql",
"env": "prod",
"host": "db-3"
}
}
}
'import requests
url = "https://api.flashcat.cloud/alert/pipeline/preview?app_key="
payload = {
"integration_id": 6113996590131,
"rules": [
{
"kind": "severity_reset",
"if": [
{
"key": "labels.env",
"oper": "IN",
"vals": ["test"]
}
],
"settings": { "severity": "Info" }
},
{
"kind": "alert_drop",
"if": [
{
"key": "title",
"oper": "IN",
"vals": ["/.*noise.*/"]
}
],
"settings": {}
}
],
"event": {
"title": "Disk usage 95% on db-3",
"description": "Root filesystem is 95% full on db-3.",
"event_status": "Warning",
"labels": {
"service": "mysql",
"env": "prod",
"host": "db-3"
}
}
}
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({
integration_id: 6113996590131,
rules: [
{
kind: 'severity_reset',
if: [{key: 'labels.env', oper: 'IN', vals: ['test']}],
settings: {severity: 'Info'}
},
{
kind: 'alert_drop',
if: [{key: 'title', oper: 'IN', vals: ['/.*noise.*/']}],
settings: {}
}
],
event: {
title: 'Disk usage 95% on db-3',
description: 'Root filesystem is 95% full on db-3.',
event_status: 'Warning',
labels: {service: 'mysql', env: 'prod', host: 'db-3'}
}
})
};
fetch('https://api.flashcat.cloud/alert/pipeline/preview?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/pipeline/preview?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([
'integration_id' => 6113996590131,
'rules' => [
[
'kind' => 'severity_reset',
'if' => [
[
'key' => 'labels.env',
'oper' => 'IN',
'vals' => [
'test'
]
]
],
'settings' => [
'severity' => 'Info'
]
],
[
'kind' => 'alert_drop',
'if' => [
[
'key' => 'title',
'oper' => 'IN',
'vals' => [
'/.*noise.*/'
]
]
],
'settings' => [
]
]
],
'event' => [
'title' => 'Disk usage 95% on db-3',
'description' => 'Root filesystem is 95% full on db-3.',
'event_status' => 'Warning',
'labels' => [
'service' => 'mysql',
'env' => 'prod',
'host' => 'db-3'
]
]
]),
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/pipeline/preview?app_key="
payload := strings.NewReader("{\n \"integration_id\": 6113996590131,\n \"rules\": [\n {\n \"kind\": \"severity_reset\",\n \"if\": [\n {\n \"key\": \"labels.env\",\n \"oper\": \"IN\",\n \"vals\": [\n \"test\"\n ]\n }\n ],\n \"settings\": {\n \"severity\": \"Info\"\n }\n },\n {\n \"kind\": \"alert_drop\",\n \"if\": [\n {\n \"key\": \"title\",\n \"oper\": \"IN\",\n \"vals\": [\n \"/.*noise.*/\"\n ]\n }\n ],\n \"settings\": {}\n }\n ],\n \"event\": {\n \"title\": \"Disk usage 95% on db-3\",\n \"description\": \"Root filesystem is 95% full on db-3.\",\n \"event_status\": \"Warning\",\n \"labels\": {\n \"service\": \"mysql\",\n \"env\": \"prod\",\n \"host\": \"db-3\"\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/alert/pipeline/preview?app_key=")
.header("Content-Type", "application/json")
.body("{\n \"integration_id\": 6113996590131,\n \"rules\": [\n {\n \"kind\": \"severity_reset\",\n \"if\": [\n {\n \"key\": \"labels.env\",\n \"oper\": \"IN\",\n \"vals\": [\n \"test\"\n ]\n }\n ],\n \"settings\": {\n \"severity\": \"Info\"\n }\n },\n {\n \"kind\": \"alert_drop\",\n \"if\": [\n {\n \"key\": \"title\",\n \"oper\": \"IN\",\n \"vals\": [\n \"/.*noise.*/\"\n ]\n }\n ],\n \"settings\": {}\n }\n ],\n \"event\": {\n \"title\": \"Disk usage 95% on db-3\",\n \"description\": \"Root filesystem is 95% full on db-3.\",\n \"event_status\": \"Warning\",\n \"labels\": {\n \"service\": \"mysql\",\n \"env\": \"prod\",\n \"host\": \"db-3\"\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.flashcat.cloud/alert/pipeline/preview?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 \"integration_id\": 6113996590131,\n \"rules\": [\n {\n \"kind\": \"severity_reset\",\n \"if\": [\n {\n \"key\": \"labels.env\",\n \"oper\": \"IN\",\n \"vals\": [\n \"test\"\n ]\n }\n ],\n \"settings\": {\n \"severity\": \"Info\"\n }\n },\n {\n \"kind\": \"alert_drop\",\n \"if\": [\n {\n \"key\": \"title\",\n \"oper\": \"IN\",\n \"vals\": [\n \"/.*noise.*/\"\n ]\n }\n ],\n \"settings\": {}\n }\n ],\n \"event\": {\n \"title\": \"Disk usage 95% on db-3\",\n \"description\": \"Root filesystem is 95% full on db-3.\",\n \"event_status\": \"Warning\",\n \"labels\": {\n \"service\": \"mysql\",\n \"env\": \"prod\",\n \"host\": \"db-3\"\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
"data": {
"is_recovery": false,
"before": {
"title": "Disk usage 95% on db-3",
"description": "Root filesystem is 95% full on db-3.",
"severity": "Warning",
"labels": {
"service": "mysql",
"env": "prod",
"host": "db-3"
}
},
"after": {
"title": "Disk usage 95% on db-3",
"description": "Root filesystem is 95% full on db-3.",
"severity": "Warning",
"labels": {
"service": "mysql",
"env": "prod",
"host": "db-3"
}
},
"dropped": false,
"inhibited": false,
"steps": [
{
"index": 0,
"kind": "severity_reset",
"result": "not_matched",
"detail": "condition_not_met"
},
{
"index": 1,
"kind": "alert_drop",
"result": "not_matched",
"detail": "condition_not_met"
}
]
}
}{
"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
Preview alert pipeline processing
Run unsaved alert processing rules over one event, the way ingestion would.
POST
/
alert
/
pipeline
/
preview
Preview alert pipeline processing
curl --request POST \
--url 'https://api.flashcat.cloud/alert/pipeline/preview?app_key=' \
--header 'Content-Type: application/json' \
--data '
{
"integration_id": 6113996590131,
"rules": [
{
"kind": "severity_reset",
"if": [
{
"key": "labels.env",
"oper": "IN",
"vals": [
"test"
]
}
],
"settings": {
"severity": "Info"
}
},
{
"kind": "alert_drop",
"if": [
{
"key": "title",
"oper": "IN",
"vals": [
"/.*noise.*/"
]
}
],
"settings": {}
}
],
"event": {
"title": "Disk usage 95% on db-3",
"description": "Root filesystem is 95% full on db-3.",
"event_status": "Warning",
"labels": {
"service": "mysql",
"env": "prod",
"host": "db-3"
}
}
}
'import requests
url = "https://api.flashcat.cloud/alert/pipeline/preview?app_key="
payload = {
"integration_id": 6113996590131,
"rules": [
{
"kind": "severity_reset",
"if": [
{
"key": "labels.env",
"oper": "IN",
"vals": ["test"]
}
],
"settings": { "severity": "Info" }
},
{
"kind": "alert_drop",
"if": [
{
"key": "title",
"oper": "IN",
"vals": ["/.*noise.*/"]
}
],
"settings": {}
}
],
"event": {
"title": "Disk usage 95% on db-3",
"description": "Root filesystem is 95% full on db-3.",
"event_status": "Warning",
"labels": {
"service": "mysql",
"env": "prod",
"host": "db-3"
}
}
}
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({
integration_id: 6113996590131,
rules: [
{
kind: 'severity_reset',
if: [{key: 'labels.env', oper: 'IN', vals: ['test']}],
settings: {severity: 'Info'}
},
{
kind: 'alert_drop',
if: [{key: 'title', oper: 'IN', vals: ['/.*noise.*/']}],
settings: {}
}
],
event: {
title: 'Disk usage 95% on db-3',
description: 'Root filesystem is 95% full on db-3.',
event_status: 'Warning',
labels: {service: 'mysql', env: 'prod', host: 'db-3'}
}
})
};
fetch('https://api.flashcat.cloud/alert/pipeline/preview?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/pipeline/preview?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([
'integration_id' => 6113996590131,
'rules' => [
[
'kind' => 'severity_reset',
'if' => [
[
'key' => 'labels.env',
'oper' => 'IN',
'vals' => [
'test'
]
]
],
'settings' => [
'severity' => 'Info'
]
],
[
'kind' => 'alert_drop',
'if' => [
[
'key' => 'title',
'oper' => 'IN',
'vals' => [
'/.*noise.*/'
]
]
],
'settings' => [
]
]
],
'event' => [
'title' => 'Disk usage 95% on db-3',
'description' => 'Root filesystem is 95% full on db-3.',
'event_status' => 'Warning',
'labels' => [
'service' => 'mysql',
'env' => 'prod',
'host' => 'db-3'
]
]
]),
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/pipeline/preview?app_key="
payload := strings.NewReader("{\n \"integration_id\": 6113996590131,\n \"rules\": [\n {\n \"kind\": \"severity_reset\",\n \"if\": [\n {\n \"key\": \"labels.env\",\n \"oper\": \"IN\",\n \"vals\": [\n \"test\"\n ]\n }\n ],\n \"settings\": {\n \"severity\": \"Info\"\n }\n },\n {\n \"kind\": \"alert_drop\",\n \"if\": [\n {\n \"key\": \"title\",\n \"oper\": \"IN\",\n \"vals\": [\n \"/.*noise.*/\"\n ]\n }\n ],\n \"settings\": {}\n }\n ],\n \"event\": {\n \"title\": \"Disk usage 95% on db-3\",\n \"description\": \"Root filesystem is 95% full on db-3.\",\n \"event_status\": \"Warning\",\n \"labels\": {\n \"service\": \"mysql\",\n \"env\": \"prod\",\n \"host\": \"db-3\"\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/alert/pipeline/preview?app_key=")
.header("Content-Type", "application/json")
.body("{\n \"integration_id\": 6113996590131,\n \"rules\": [\n {\n \"kind\": \"severity_reset\",\n \"if\": [\n {\n \"key\": \"labels.env\",\n \"oper\": \"IN\",\n \"vals\": [\n \"test\"\n ]\n }\n ],\n \"settings\": {\n \"severity\": \"Info\"\n }\n },\n {\n \"kind\": \"alert_drop\",\n \"if\": [\n {\n \"key\": \"title\",\n \"oper\": \"IN\",\n \"vals\": [\n \"/.*noise.*/\"\n ]\n }\n ],\n \"settings\": {}\n }\n ],\n \"event\": {\n \"title\": \"Disk usage 95% on db-3\",\n \"description\": \"Root filesystem is 95% full on db-3.\",\n \"event_status\": \"Warning\",\n \"labels\": {\n \"service\": \"mysql\",\n \"env\": \"prod\",\n \"host\": \"db-3\"\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.flashcat.cloud/alert/pipeline/preview?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 \"integration_id\": 6113996590131,\n \"rules\": [\n {\n \"kind\": \"severity_reset\",\n \"if\": [\n {\n \"key\": \"labels.env\",\n \"oper\": \"IN\",\n \"vals\": [\n \"test\"\n ]\n }\n ],\n \"settings\": {\n \"severity\": \"Info\"\n }\n },\n {\n \"kind\": \"alert_drop\",\n \"if\": [\n {\n \"key\": \"title\",\n \"oper\": \"IN\",\n \"vals\": [\n \"/.*noise.*/\"\n ]\n }\n ],\n \"settings\": {}\n }\n ],\n \"event\": {\n \"title\": \"Disk usage 95% on db-3\",\n \"description\": \"Root filesystem is 95% full on db-3.\",\n \"event_status\": \"Warning\",\n \"labels\": {\n \"service\": \"mysql\",\n \"env\": \"prod\",\n \"host\": \"db-3\"\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
"data": {
"is_recovery": false,
"before": {
"title": "Disk usage 95% on db-3",
"description": "Root filesystem is 95% full on db-3.",
"severity": "Warning",
"labels": {
"service": "mysql",
"env": "prod",
"host": "db-3"
}
},
"after": {
"title": "Disk usage 95% on db-3",
"description": "Root filesystem is 95% full on db-3.",
"severity": "Warning",
"labels": {
"service": "mysql",
"env": "prod",
"host": "db-3"
}
},
"dropped": false,
"inhibited": false,
"steps": [
{
"index": 0,
"kind": "severity_reset",
"result": "not_matched",
"detail": "condition_not_met"
},
{
"index": 1,
"kind": "alert_drop",
"result": "not_matched",
"detail": "condition_not_met"
}
]
}
}{
"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 Manage (on-call) or Integrations Read (on-call) or Integrations Manage (on-call) |
Usage
- Nothing is saved and no alert or event is created.
- The integration’s saved enrichment rules run first, then your
rulesin order, against the enriched event. - A recovery (
Ok) event closes the alert without running the pipeline:is_recoveryistrueand every step comes backnot_executedwith detailrecovery_event. droppedandinhibitedreport which rule stopped the event:alert_dropdiscards it,alert_inhibitdiscards it while a matching source alert is active. Rules after that one arenot_executed.- When no rule matches,
afteris the event as the notification templates render it, so the preview shows what the channel would deliver.
Authorizations
APP Key created in the Flashduty console under My → APP Key. Send it as the app_key query parameter or in the Fd-App-Key request header. Its effective access is the intersection of the key's permission scope and the creator's current role permissions. Keep it secret.
Body
application/json
Request body of POST /alert/pipeline/preview.
Integration whose saved enrichment runs first and whose pipeline context the preview uses.
Required range:
x >= 1The event to run the rules over.
Show child attributes
Show child attributes
Alert processing rules to try, in order. At most 50. The integration's stored pipeline is not used.
Maximum array length:
50Show child attributes
Show child attributes
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?