Inspect Scout alert rules
curl --request GET \
--url https://api.example.com/v1/api/servers/{serverId}/scout-alerts \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.example.com/v1/api/servers/{serverId}/scout-alerts"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.example.com/v1/api/servers/{serverId}/scout-alerts', 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.example.com/v1/api/servers/{serverId}/scout-alerts",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/v1/api/servers/{serverId}/scout-alerts"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/v1/api/servers/{serverId}/scout-alerts")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/api/servers/{serverId}/scout-alerts")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"rules": [
{
"httpCheck": {
"rule_id": "<string>",
"checked_at": "<string>",
"state": "<string>",
"status_code": 123,
"latency_ms": 123,
"reason": "<string>"
},
"id": "<string>",
"workspaceId": "<string>",
"serverId": "<string>",
"deployableId": "<string>",
"name": "<string>",
"enabled": true,
"severity": "<string>",
"environment": "<string>",
"condition": {
"metric": "cpuPercent",
"operator": "above",
"threshold": 123,
"windowSeconds": 123,
"aggregation": "average",
"http": {
"url": "<string>",
"method": "GET",
"intervalSeconds": 123,
"timeoutSeconds": 123,
"expectedStatusMin": 123,
"expectedStatusMax": 123,
"maxRedirects": 123
}
},
"evaluationState": "<string>",
"evaluatedAt": "2023-11-07T05:31:56Z",
"observedValue": 123,
"deletedAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"workloads": [
{
"id": "<string>",
"name": "<string>",
"sourceId": "<string>",
"kind": "app"
}
],
"destinations": [
{
"categories": [
"health"
],
"enabled": true,
"id": "<string>",
"provider": "discord",
"source": "environment"
}
],
"providers": {
"discord": true,
"slack": true,
"smtp": true,
"telegram": true,
"webhook": true
},
"canManage": true,
"localization": {
"dateFormat": "day-short-month-year",
"timeFormat": "24-hour",
"timeZone": "<string>",
"timestamps": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>"
}
}Inspect Scout alert rules
Inspect Scout alert rules through the Towbar REST API.
GET
/
servers
/
{serverId}
/
scout-alerts
Inspect Scout alert rules
curl --request GET \
--url https://api.example.com/v1/api/servers/{serverId}/scout-alerts \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.example.com/v1/api/servers/{serverId}/scout-alerts"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.example.com/v1/api/servers/{serverId}/scout-alerts', 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.example.com/v1/api/servers/{serverId}/scout-alerts",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/v1/api/servers/{serverId}/scout-alerts"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/v1/api/servers/{serverId}/scout-alerts")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/api/servers/{serverId}/scout-alerts")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"rules": [
{
"httpCheck": {
"rule_id": "<string>",
"checked_at": "<string>",
"state": "<string>",
"status_code": 123,
"latency_ms": 123,
"reason": "<string>"
},
"id": "<string>",
"workspaceId": "<string>",
"serverId": "<string>",
"deployableId": "<string>",
"name": "<string>",
"enabled": true,
"severity": "<string>",
"environment": "<string>",
"condition": {
"metric": "cpuPercent",
"operator": "above",
"threshold": 123,
"windowSeconds": 123,
"aggregation": "average",
"http": {
"url": "<string>",
"method": "GET",
"intervalSeconds": 123,
"timeoutSeconds": 123,
"expectedStatusMin": 123,
"expectedStatusMax": 123,
"maxRedirects": 123
}
},
"evaluationState": "<string>",
"evaluatedAt": "2023-11-07T05:31:56Z",
"observedValue": 123,
"deletedAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"workloads": [
{
"id": "<string>",
"name": "<string>",
"sourceId": "<string>",
"kind": "app"
}
],
"destinations": [
{
"categories": [
"health"
],
"enabled": true,
"id": "<string>",
"provider": "discord",
"source": "environment"
}
],
"providers": {
"discord": true,
"slack": true,
"smtp": true,
"telegram": true,
"webhook": true
},
"canManage": true,
"localization": {
"dateFormat": "day-short-month-year",
"timeFormat": "24-hour",
"timeZone": "<string>",
"timestamps": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>"
}
}Required permissions: alert.read. Personal keys are capped by their owner’s current team role.
See request conventions and automation workflows. MCP clients use the task-oriented tool catalogue.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Pattern:
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$Query Parameters
Pattern:
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$Response
Rules, evaluation status, and available destinations.
Last modified on September 6, 2026
