GET Read your active rules and persistent alarm state
/api/v1/alarms/rules
Read accessible active rules in pages of 50 (at most 100). Search rule and monitor names and filter type, severity or state before pagination. Follow next_cursor with the same filters, sort and limit; an empty cursor marks the end. Cursors expire after 15 minutes. Paused and muted rules remain available.
On this page
Access and permissions
Read accessible active rules in pages of 50 (at most 100). Search rule and monitor names and filter type, severity or state before pagination. Follow next_cursor with the same filters, sort and limit; an empty cursor marks the end. Cursors expire after 15 minutes. Paused and muted rules remain available.
Browser session: __Host-mb_session cookie.
Machine management credentials in Authorization: Bearer. Check the permissions (scopes) required by the operation.
Parameters and headers
| Field | Location | Type and limits | Required | Meaning |
|---|---|---|---|---|
| q | URL query | string; {"maxLength":128} | No | Case-insensitive literal search in the documented text fields, applied before the page limit. |
| limit | URL query | integer; {"default":50,"maximum":100,"minimum":1} | No | Page size, 1–100; default 50. A following page exists only when another matching row is available. |
| cursor | URL query | string; {"maxLength":4096} | No | Opaque next_cursor from the preceding page. Keep resource, account, filters, sort and limit unchanged; collection cursors expire after 15 minutes. |
| sort | URL query | string; {"enum":["newest","oldest","name_asc","name_desc"]} | No | Stable order with the record ID as a tie breaker: newest, oldest, name_asc or name_desc. |
| severity | URL query | string | No | Exact field filter; omit the parameter to include all values. |
| workspace_id | URL query | string; {"format":"uuid"} | No | Limit the list to an accessible workspace. |
| kind | URL query | string; {"enum":["numeric","state","text","heartbeat","no_data","run","slo"]} | No | Exact field filter; omit the parameter to include all values. |
| state | URL query | string; {"enum":["OK","PENDING","FIRING","NO_DATA","RESOLVED","paused","muted","maintenance","collection_paused"]} | No | Exact field filter; omit the parameter to include all values. |
| device_id | URL query | string; {"format":"uuid"} | No | Return rules belonging to this monitor. |
| counts_only | URL query | string; {"enum":["1"]} | No | Return counts for the requested filter instead of table rows. Counts include search and other filters, excluding this filter selection, sorting and pagination. |
| count_filter | URL query | string; {"enum":["state","kind","severity"]} | No | Declared table filter to count. Requires counts_only=1. |
| snapshot | URL query | string; {"format":"date-time"} | No | Optional snapshot from the corresponding table page. |
Request body
No request body.
Responses
| Header | Type and limits | Meaning |
|---|---|---|
| Cache-Control | string; {"pattern":"(?:^|,\\s*)no-store(?:,|$)"} | Private API responses prohibit storage. Public OAuth metadata is cached for 300 seconds; live streams additionally prohibit transformation. |
| Content-Language | string; {"enum":["en","de"]} | Language of human-readable response text, resolved from Accept-Language or the documented browser preference. Technical codes and identifiers remain stable. |
| Referrer-Policy | JSON; {"enum":["strict-origin-when-cross-origin","no-referrer"]} | The default referrer policy is strict-origin-when-cross-origin. Provider-login responses use no-referrer to protect login parameters. |
| Vary | string | Responses vary by Accept-Language; browser-rendered responses can also vary by the preference cookie. |
| X-Content-Type-Options | JSON; {"const":"nosniff"} | The browser must use the declared content type. |
| X-Frame-Options | JSON; {"const":"DENY"} | The response must not be embedded in a frame. |
| X-Request-ID | string | Server-generated request identifier. Include this when reporting an error; inbound values are not trusted. |
application/json
| Field | Type and limits | Required | Meaning |
|---|---|---|---|
| $ | object | object | Yes | — |
| $ (anyOf 1) | object | No | — |
| $ (anyOf 1).rules | array<object> | Yes | — |
| $ (anyOf 1).rules[] | object | Yes | — |
| $ (anyOf 1).rules[].clear | object | Yes | — |
| $ (anyOf 1).rules[].clear.operator | string | null | Yes | — |
| $ (anyOf 1).rules[].clear.operator (anyOf 1) | string | No | — |
| $ (anyOf 1).rules[].clear.operator (anyOf 2) | null | No | — |
| $ (anyOf 1).rules[].clear.value | number | null | Yes | — |
| $ (anyOf 1).rules[].clear.value (anyOf 1) | number | No | — |
| $ (anyOf 1).rules[].clear.value (anyOf 2) | null | No | — |
| $ (anyOf 1).rules[].clear.value_high | number | null | Yes | — |
| $ (anyOf 1).rules[].clear.value_high (anyOf 1) | number | No | — |
| $ (anyOf 1).rules[].clear.value_high (anyOf 2) | null | No | — |
| $ (anyOf 1).rules[].clear_duration_seconds | integer | Yes | — |
| $ (anyOf 1).rules[].created_at | string; {"format":"date-time"} | Yes | Creation timestamp in RFC 3339 UTC. |
| $ (anyOf 1).rules[].device_id | string | Yes | UUID of the target device or monitor. The ingestion key must allow this device. |
| $ (anyOf 1).rules[].equality_tolerance | number | Yes | — |
| $ (anyOf 1).rules[].event_case_sensitive | boolean | Yes | — |
| $ (anyOf 1).rules[].event_contains | string | null | Yes | — |
| $ (anyOf 1).rules[].event_contains (anyOf 1) | string | No | — |
| $ (anyOf 1).rules[].event_contains (anyOf 2) | null | No | — |
| $ (anyOf 1).rules[].event_min_severity | string | null | Yes | — |
| $ (anyOf 1).rules[].event_min_severity (anyOf 1) | string | No | — |
| $ (anyOf 1).rules[].event_min_severity (anyOf 2) | null | No | — |
| $ (anyOf 1).rules[].event_operator | string | Yes | — |
| $ (anyOf 1).rules[].event_whole_word | boolean | Yes | — |
| $ (anyOf 1).rules[].id | string | Yes | UUID of this resource. Keep the returned identifier for subsequent operations. |
| $ (anyOf 1).rules[].kind | string | Yes | Resource kind or measurement type selected from the listed values. |
| $ (anyOf 1).rules[].maintenance_until | string; {"format":"date-time"} | null | Yes | — |
| $ (anyOf 1).rules[].maintenance_until (anyOf 1) | string; {"format":"date-time"} | No | — |
| $ (anyOf 1).rules[].maintenance_until (anyOf 2) | null | No | — |
| $ (anyOf 1).rules[].muted_until | string; {"format":"date-time"} | null | Yes | — |
| $ (anyOf 1).rules[].muted_until (anyOf 1) | string; {"format":"date-time"} | No | — |
| $ (anyOf 1).rules[].muted_until (anyOf 2) | null | No | — |
| $ (anyOf 1).rules[].name | string | Yes | Human-readable resource name. Follow the listed length limit. |
| $ (anyOf 1).rules[].no_data_seconds | integer | null | Yes | — |
| $ (anyOf 1).rules[].no_data_seconds (anyOf 1) | integer | No | — |
| $ (anyOf 1).rules[].no_data_seconds (anyOf 2) | null | No | — |
| $ (anyOf 1).rules[].paused_until | string; {"format":"date-time"} | null | Yes | — |
| $ (anyOf 1).rules[].paused_until (anyOf 1) | string; {"format":"date-time"} | No | — |
| $ (anyOf 1).rules[].paused_until (anyOf 2) | null | No | — |
| $ (anyOf 1).rules[].quiet_seconds | integer | null | Yes | — |
| $ (anyOf 1).rules[].quiet_seconds (anyOf 1) | integer | No | — |
| $ (anyOf 1).rules[].quiet_seconds (anyOf 2) | null | No | — |
| $ (anyOf 1).rules[].repeat_seconds | integer | Yes | Minimum interval before repeating an unresolved alarm notification. |
| $ (anyOf 1).rules[].series_id | string | null | Yes | UUID of the measurement series belonging to the authorized device. |
| $ (anyOf 1).rules[].series_id (anyOf 1) | string | No | — |
| $ (anyOf 1).rules[].series_id (anyOf 2) | null | No | — |
| $ (anyOf 1).rules[].server_profile_paused | boolean | Yes | — |
| $ (anyOf 1).rules[].severity | string | Yes | Severity value from the listed vocabulary. |
| $ (anyOf 1).rules[].state_clear_samples | integer | Yes | — |
| $ (anyOf 1).rules[].state_trigger_samples | integer | Yes | — |
| $ (anyOf 1).rules[].status | string | Yes | — |
| $ (anyOf 1).rules[].target_state | string | null | Yes | — |
| $ (anyOf 1).rules[].target_state (anyOf 1) | string | No | — |
| $ (anyOf 1).rules[].target_state (anyOf 2) | null | No | — |
| $ (anyOf 1).rules[].trigger | object | Yes | — |
| $ (anyOf 1).rules[].trigger.operator | string | null | Yes | — |
| $ (anyOf 1).rules[].trigger.operator (anyOf 1) | string | No | — |
| $ (anyOf 1).rules[].trigger.operator (anyOf 2) | null | No | — |
| $ (anyOf 1).rules[].trigger.value | number | null | Yes | — |
| $ (anyOf 1).rules[].trigger.value (anyOf 1) | number | No | — |
| $ (anyOf 1).rules[].trigger.value (anyOf 2) | null | No | — |
| $ (anyOf 1).rules[].trigger.value_high | number | null | Yes | — |
| $ (anyOf 1).rules[].trigger.value_high (anyOf 1) | number | No | — |
| $ (anyOf 1).rules[].trigger.value_high (anyOf 2) | null | No | — |
| $ (anyOf 1).rules[].trigger_duration_seconds | integer | Yes | — |
| $ (anyOf 1).rules[].version | integer | Yes | — |
| $ (anyOf 1).rules[].window_function | string | Yes | — |
| $ (anyOf 1).rules[].window_seconds | integer | Yes | — |
| $ (anyOf 1).rules[].deployment_maintenance | object | null | No | — |
| $ (anyOf 1).rules[].deployment_maintenance (anyOf 1) | object | No | — |
| $ (anyOf 1).rules[].deployment_maintenance (anyOf 1).expires_at | string; {"format":"date-time"} | Yes | — |
| $ (anyOf 1).rules[].deployment_maintenance (anyOf 1).id | string; {"format":"uuid"} | Yes | — |
| $ (anyOf 1).rules[].deployment_maintenance (anyOf 1).manual_muted_until | string; {"format":"date-time"} | null | Yes | — |
| $ (anyOf 1).rules[].deployment_maintenance (anyOf 1).manual_muted_until (anyOf 1) | string; {"format":"date-time"} | No | — |
| $ (anyOf 1).rules[].deployment_maintenance (anyOf 1).manual_muted_until (anyOf 2) | null | No | — |
| $ (anyOf 1).rules[].deployment_maintenance (anyOf 1).service | string | Yes | — |
| $ (anyOf 1).rules[].deployment_maintenance (anyOf 1).starts_at | string; {"format":"date-time"} | Yes | — |
| $ (anyOf 1).rules[].deployment_maintenance (anyOf 2) | null | No | — |
| $ (anyOf 1).rules[].evaluation_status | string; {"enum":["not_evaluated","current","stale"]} | Yes | — |
| $ (anyOf 1).rules[].last_evaluated_at | string; {"format":"date-time"} | null | Yes | — |
| $ (anyOf 1).rules[].last_evaluated_at (anyOf 1) | string; {"format":"date-time"} | No | — |
| $ (anyOf 1).rules[].last_evaluated_at (anyOf 2) | null | No | — |
| $ (anyOf 1).rules[].device_icon | AlarmMonitorIcon | No | Optional monitor identity for lists. Includes the list area, server platform and the same authenticated favicon address used in monitor lists. Target URLs, credentials and measurements are not included. |
| $ (anyOf 1).rules[].device_icon.monitor_type | string | Yes | — |
| $ (anyOf 1).rules[].device_icon.list_group | string; {"enum":["monitors","servers"]} | Yes | — |
| $ (anyOf 1).rules[].device_icon.summary | object; {"additionalProperties":false} | Yes | — |
| $ (anyOf 1).rules[].device_icon.summary.platform | string; {"enum":["linux","darwin","windows"]} | No | — |
| $ (anyOf 1).rules[].device_icon.summary.favicon_url | string | No | — |
| $ (anyOf 1).rules[].device_name | string | No | — |
| $ (anyOf 1).limit | integer; {"maximum":100,"minimum":1} | Yes | — |
| $ (anyOf 1).next_cursor | string | Yes | Cursor for the next matching page; empty when no following page exists. |
| $ (anyOf 1).snapshot | string; {"format":"date-time"} | Yes | UTC snapshot bound to the cursor; later-created rows do not enter that page sequence. |
| $ (anyOf 2) | object | No | — |
| $ (anyOf 2).filter_counts | TableFilterCounts | Yes | — |
| $ (anyOf 2).filter_counts.field | string | Yes | — |
| $ (anyOf 2).filter_counts.total | integer; {"minimum":0} | Yes | — |
| $ (anyOf 2).filter_counts.values | object | Yes | — |
| $ (anyOf 2).filter_counts.complete | boolean | Yes | — |
| $ (anyOf 2).filter_counts.snapshot | string; {"format":"date-time"} | Yes | — |
| $ (anyOf 2).filter_counts.counted_at | string; {"format":"date-time"} | Yes | — |
{
"rules": [],
"next_cursor": "",
"snapshot": "2026-10-17T00:00:00Z",
"limit": 50
}| Stable error codes |
|---|
| invalid_credential |
| unauthorized |
| Header | Type and limits | Meaning |
|---|---|---|
| Cache-Control | string; {"pattern":"(?:^|,\\s*)no-store(?:,|$)"} | Private API responses prohibit storage. Public OAuth metadata is cached for 300 seconds; live streams additionally prohibit transformation. |
| Content-Language | string; {"enum":["en","de"]} | Language of human-readable response text, resolved from Accept-Language or the documented browser preference. Technical codes and identifiers remain stable. |
| Referrer-Policy | JSON; {"enum":["strict-origin-when-cross-origin","no-referrer"]} | The default referrer policy is strict-origin-when-cross-origin. Provider-login responses use no-referrer to protect login parameters. |
| Vary | string | Responses vary by Accept-Language; browser-rendered responses can also vary by the preference cookie. |
| X-Content-Type-Options | JSON; {"const":"nosniff"} | The browser must use the declared content type. |
| X-Frame-Options | JSON; {"const":"DENY"} | The response must not be embedded in a frame. |
| X-Request-ID | string | Server-generated request identifier. Include this when reporting an error; inbound values are not trusted. |
application/problem+json
| Field | Type and limits | Required | Meaning |
|---|---|---|---|
| $ | Problem | Yes | — |
| $.code | string | Yes | Stable machine-readable error code |
| $.detail | string | Yes | Short localized explanation without internal error details |
| $.instance | string | Yes | Unique relative identifier /api/v1/requests/{request_id}; not a retrievable resource |
| $.message | string | Yes | Temporarily identical to detail for existing clients |
| $.message_key | string | Yes | Stable translation key for changing the displayed language without another request |
| $.message_params | object; {"additionalProperties":true} | Yes | Named, safely rendered message parameters; never arbitrary HTML |
| $.request_id | string; {"pattern":"^[0-9a-f]{32}$"} | Yes | Server-generated diagnostic identifier. It contains no login token or credential. |
| $.status | integer; {"maximum":599,"minimum":400} | Yes | — |
| $.title | string | Yes | Localized HTTP status title |
| $.type | string; {"const":"about:blank"} | Yes | — |
{
"code": "demo",
"detail": "Demo error detail; inspect the documented code.",
"instance": "demo",
"message": "Demo error detail; inspect the documented code.",
"message_key": "errors.requestFailed",
"message_params": {},
"request_id": "00000000000000000000000000000000",
"status": 401,
"title": "Demo error",
"type": "about:blank"
}| Stable error codes |
|---|
| csrf |
| insufficient_scope |
| invalid_origin |
| Header | Type and limits | Meaning |
|---|---|---|
| Cache-Control | string; {"pattern":"(?:^|,\\s*)no-store(?:,|$)"} | Private API responses prohibit storage. Public OAuth metadata is cached for 300 seconds; live streams additionally prohibit transformation. |
| Content-Language | string; {"enum":["en","de"]} | Language of human-readable response text, resolved from Accept-Language or the documented browser preference. Technical codes and identifiers remain stable. |
| Referrer-Policy | JSON; {"enum":["strict-origin-when-cross-origin","no-referrer"]} | The default referrer policy is strict-origin-when-cross-origin. Provider-login responses use no-referrer to protect login parameters. |
| Vary | string | Responses vary by Accept-Language; browser-rendered responses can also vary by the preference cookie. |
| X-Content-Type-Options | JSON; {"const":"nosniff"} | The browser must use the declared content type. |
| X-Frame-Options | JSON; {"const":"DENY"} | The response must not be embedded in a frame. |
| X-Request-ID | string | Server-generated request identifier. Include this when reporting an error; inbound values are not trusted. |
application/problem+json
| Field | Type and limits | Required | Meaning |
|---|---|---|---|
| $ | Problem | Yes | — |
| $.code | string | Yes | Stable machine-readable error code |
| $.detail | string | Yes | Short localized explanation without internal error details |
| $.instance | string | Yes | Unique relative identifier /api/v1/requests/{request_id}; not a retrievable resource |
| $.message | string | Yes | Temporarily identical to detail for existing clients |
| $.message_key | string | Yes | Stable translation key for changing the displayed language without another request |
| $.message_params | object; {"additionalProperties":true} | Yes | Named, safely rendered message parameters; never arbitrary HTML |
| $.request_id | string; {"pattern":"^[0-9a-f]{32}$"} | Yes | Server-generated diagnostic identifier. It contains no login token or credential. |
| $.status | integer; {"maximum":599,"minimum":400} | Yes | — |
| $.title | string | Yes | Localized HTTP status title |
| $.type | string; {"const":"about:blank"} | Yes | — |
{
"code": "demo",
"detail": "Demo error detail; inspect the documented code.",
"instance": "demo",
"message": "Demo error detail; inspect the documented code.",
"message_key": "errors.requestFailed",
"message_params": {},
"request_id": "00000000000000000000000000000000",
"status": 403,
"title": "Demo error",
"type": "about:blank"
}| Stable error codes |
|---|
| unavailable |
| Header | Type and limits | Meaning |
|---|---|---|
| Cache-Control | string; {"pattern":"(?:^|,\\s*)no-store(?:,|$)"} | Private API responses prohibit storage. Public OAuth metadata is cached for 300 seconds; live streams additionally prohibit transformation. |
| Content-Language | string; {"enum":["en","de"]} | Language of human-readable response text, resolved from Accept-Language or the documented browser preference. Technical codes and identifiers remain stable. |
| Referrer-Policy | JSON; {"enum":["strict-origin-when-cross-origin","no-referrer"]} | The default referrer policy is strict-origin-when-cross-origin. Provider-login responses use no-referrer to protect login parameters. |
| Retry-After | string; {"pattern":"^[0-9]+$"} | Seconds before retry. Preserve supported idempotency identifiers and respect the operation’s mutation semantics. |
| Vary | string | Responses vary by Accept-Language; browser-rendered responses can also vary by the preference cookie. |
| X-Content-Type-Options | JSON; {"const":"nosniff"} | The browser must use the declared content type. |
| X-Frame-Options | JSON; {"const":"DENY"} | The response must not be embedded in a frame. |
| X-Request-ID | string | Server-generated request identifier. Include this when reporting an error; inbound values are not trusted. |
application/problem+json
| Field | Type and limits | Required | Meaning |
|---|---|---|---|
| $ | Problem | Yes | — |
| $.code | string | Yes | Stable machine-readable error code |
| $.detail | string | Yes | Short localized explanation without internal error details |
| $.instance | string | Yes | Unique relative identifier /api/v1/requests/{request_id}; not a retrievable resource |
| $.message | string | Yes | Temporarily identical to detail for existing clients |
| $.message_key | string | Yes | Stable translation key for changing the displayed language without another request |
| $.message_params | object; {"additionalProperties":true} | Yes | Named, safely rendered message parameters; never arbitrary HTML |
| $.request_id | string; {"pattern":"^[0-9a-f]{32}$"} | Yes | Server-generated diagnostic identifier. It contains no login token or credential. |
| $.status | integer; {"maximum":599,"minimum":400} | Yes | — |
| $.title | string | Yes | Localized HTTP status title |
| $.type | string; {"const":"about:blank"} | Yes | — |
{
"code": "demo",
"detail": "Demo error detail; inspect the documented code.",
"instance": "demo",
"message": "Demo error detail; inspect the documented code.",
"message_key": "errors.requestFailed",
"message_params": {},
"request_id": "00000000000000000000000000000000",
"status": 503,
"title": "Demo error",
"type": "about:blank"
}| Stable error codes |
|---|
| not_found |
| unavailable |
| Header | Type and limits | Meaning |
|---|---|---|
| Cache-Control | string; {"pattern":"(?:^|,\\s*)no-store(?:,|$)"} | Private API responses prohibit storage. Public OAuth metadata is cached for 300 seconds; live streams additionally prohibit transformation. |
| Content-Language | string; {"enum":["en","de"]} | Language of human-readable response text, resolved from Accept-Language or the documented browser preference. Technical codes and identifiers remain stable. |
| Referrer-Policy | JSON; {"enum":["strict-origin-when-cross-origin","no-referrer"]} | The default referrer policy is strict-origin-when-cross-origin. Provider-login responses use no-referrer to protect login parameters. |
| Retry-After | string; {"pattern":"^[0-9]+$"} | Seconds before retry. Preserve supported idempotency identifiers and respect the operation’s mutation semantics. |
| Vary | string | Responses vary by Accept-Language; browser-rendered responses can also vary by the preference cookie. |
| X-Content-Type-Options | JSON; {"const":"nosniff"} | The browser must use the declared content type. |
| X-Frame-Options | JSON; {"const":"DENY"} | The response must not be embedded in a frame. |
| X-Request-ID | string | Server-generated request identifier. Include this when reporting an error; inbound values are not trusted. |
application/problem+json
| Field | Type and limits | Required | Meaning |
|---|---|---|---|
| $ | Problem | Yes | — |
| $.code | string | Yes | Stable machine-readable error code |
| $.detail | string | Yes | Short localized explanation without internal error details |
| $.instance | string | Yes | Unique relative identifier /api/v1/requests/{request_id}; not a retrievable resource |
| $.message | string | Yes | Temporarily identical to detail for existing clients |
| $.message_key | string | Yes | Stable translation key for changing the displayed language without another request |
| $.message_params | object; {"additionalProperties":true} | Yes | Named, safely rendered message parameters; never arbitrary HTML |
| $.request_id | string; {"pattern":"^[0-9a-f]{32}$"} | Yes | Server-generated diagnostic identifier. It contains no login token or credential. |
| $.status | integer; {"maximum":599,"minimum":400} | Yes | — |
| $.title | string | Yes | Localized HTTP status title |
| $.type | string; {"const":"about:blank"} | Yes | — |
{
"code": "demo",
"detail": "Demo error detail; inspect the documented code.",
"instance": "demo",
"message": "Demo error detail; inspect the documented code.",
"message_key": "errors.requestFailed",
"message_params": {},
"request_id": "00000000000000000000000000000000",
"status": 503,
"title": "Demo error",
"type": "about:blank"
}| Stable error codes |
|---|
| invalid_reference |
| unavailable |
| Header | Type and limits | Meaning |
|---|---|---|
| Cache-Control | string; {"pattern":"(?:^|,\\s*)no-store(?:,|$)"} | Private API responses prohibit storage. Public OAuth metadata is cached for 300 seconds; live streams additionally prohibit transformation. |
| Content-Language | string; {"enum":["en","de"]} | Language of human-readable response text, resolved from Accept-Language or the documented browser preference. Technical codes and identifiers remain stable. |
| Referrer-Policy | JSON; {"enum":["strict-origin-when-cross-origin","no-referrer"]} | The default referrer policy is strict-origin-when-cross-origin. Provider-login responses use no-referrer to protect login parameters. |
| Retry-After | string; {"pattern":"^[0-9]+$"} | Seconds before retry. Preserve supported idempotency identifiers and respect the operation’s mutation semantics. |
| Vary | string | Responses vary by Accept-Language; browser-rendered responses can also vary by the preference cookie. |
| X-Content-Type-Options | JSON; {"const":"nosniff"} | The browser must use the declared content type. |
| X-Frame-Options | JSON; {"const":"DENY"} | The response must not be embedded in a frame. |
| X-Request-ID | string | Server-generated request identifier. Include this when reporting an error; inbound values are not trusted. |
application/problem+json
| Field | Type and limits | Required | Meaning |
|---|---|---|---|
| $ | Problem | Yes | — |
| $.code | string | Yes | Stable machine-readable error code |
| $.detail | string | Yes | Short localized explanation without internal error details |
| $.instance | string | Yes | Unique relative identifier /api/v1/requests/{request_id}; not a retrievable resource |
| $.message | string | Yes | Temporarily identical to detail for existing clients |
| $.message_key | string | Yes | Stable translation key for changing the displayed language without another request |
| $.message_params | object; {"additionalProperties":true} | Yes | Named, safely rendered message parameters; never arbitrary HTML |
| $.request_id | string; {"pattern":"^[0-9a-f]{32}$"} | Yes | Server-generated diagnostic identifier. It contains no login token or credential. |
| $.status | integer; {"maximum":599,"minimum":400} | Yes | — |
| $.title | string | Yes | Localized HTTP status title |
| $.type | string; {"const":"about:blank"} | Yes | — |
{
"code": "demo",
"detail": "Demo error detail; inspect the documented code.",
"instance": "demo",
"message": "Demo error detail; inspect the documented code.",
"message_key": "errors.requestFailed",
"message_params": {},
"request_id": "00000000000000000000000000000000",
"status": 503,
"title": "Demo error",
"type": "about:blank"
}Retries and asynchronous work
This operation reads or validates without applying a resource mutation. Respect rate limits and credential lifetime.
Request examples
Replace demo IDs, timestamps and placeholders with your own values. For a retry, keep the same IDs, time and content. These examples do not run requests on this page.
Keep login links, codes, cookies and keys private. Do not print them in logs or share them in support requests.
curl --silent --show-error --output /dev/null --write-out "%{http_code}\n" \
--request GET \
--header @"$HOME/.config/metribeacon/headers.txt" \
"https://metribeacon.com/api/v1/alarms/rules"
import json
from pathlib import Path
from urllib.request import Request, HTTPRedirectHandler, build_opener
from urllib.error import HTTPError
headers = json.loads((Path.home() / ".config/metribeacon/headers.json").read_text())
request = Request("https://metribeacon.com/api/v1/alarms/rules", data=None, headers=headers, method="GET")
class NoRedirect(HTTPRedirectHandler):
def redirect_request(self, request, fp, code, message, headers, target):
return None
opener = build_opener(NoRedirect())
try:
with opener.open(request, timeout=10) as response:
print(response.status)
except HTTPError as error:
print(error.code)
error.close()
import { readFile } from "node:fs/promises";
import { homedir } from "node:os";
import { join } from "node:path";
const headers = JSON.parse(await readFile(join(homedir(), ".config/metribeacon/headers.json"), "utf8"));
const response = await fetch("https://metribeacon.com/api/v1/alarms/rules", {
method: "GET", headers, redirect: "manual",
signal: AbortSignal.timeout(10000),
});
console.log(response.status);
await response.body?.cancel();
package main
import (
"fmt"
"net/http"
"time"
"encoding/json"
"os"
"path/filepath"
)
func main() {
home, err := os.UserHomeDir(); if err != nil { panic("request failed; credentials and response omitted") }
raw, err := os.ReadFile(filepath.Join(home, ".config/metribeacon/headers.json")); if err != nil { panic("request failed; credentials and response omitted") }
var headers map[string]string
if json.Unmarshal(raw, &headers) != nil { panic("invalid local headers") }
request, err := http.NewRequest("GET", "https://metribeacon.com/api/v1/alarms/rules", nil)
if err != nil { panic("request failed; credentials and response omitted") }
for name, value := range headers { request.Header.Set(name, value) }
client := &http.Client{Timeout: 10*time.Second, CheckRedirect: func(*http.Request, []*http.Request) error { return http.ErrUseLastResponse }}
response, err := client.Do(request)
if err != nil { panic("request failed; credentials and response omitted") }
defer response.Body.Close()
fmt.Println(response.StatusCode)
}
Related guides
- HTTP API, OAuth and MCP
Find the user API endpoints, their permissions, fields, examples and response formats.
- POST Create a numeric, state, text, missing-data or run rule
Create a numeric, state, text, missing-data or run rule.
- DELETE Archive a rule and close its open incidents
Archive a rule and close its open incidents.
- GET Read one alert rule
Open an accessible alert rule by its ID, independently of list filters or pagination.