GET Aktive Regeln und gespeicherten Alarmzustand lesen
/api/v1/alarms/rules
Zugängliche aktive Regeln seitenweise mit 50 (höchstens 100) Einträgen lesen. Regel- und Monitornamen durchsuchen und Typ, Schwere oder Zustand vor der Seiteneinteilung filtern. next_cursor mit denselben Filtern, derselben Sortierung und Seitengröße verwenden; ein leerer Cursor kennzeichnet das Ende. Cursor verfallen nach 15 Minuten. Pausierte und stummgeschaltete Regeln bleiben verfügbar.
Auf dieser Seite
Zugriff und Rechte
Zugängliche aktive Regeln seitenweise mit 50 (höchstens 100) Einträgen lesen. Regel- und Monitornamen durchsuchen und Typ, Schwere oder Zustand vor der Seiteneinteilung filtern. next_cursor mit denselben Filtern, derselben Sortierung und Seitengröße verwenden; ein leerer Cursor kennzeichnet das Ende. Cursor verfallen nach 15 Minuten. Pausierte und stummgeschaltete Regeln bleiben verfügbar.
Browsersitzung: Cookie __Host-mb_session.
Maschinen-Verwaltungszugang in Authorization: Bearer. Beachten Sie die von der Operation benötigten Berechtigungen (Scopes).
Parameter und Header
| Feld | Position | Typ und Grenzen | Erforderlich | Bedeutung |
|---|---|---|---|---|
| q | URL-Parameter | string; {"maxLength":128} | Nein | Suche nach wörtlichem Text ohne Beachtung der Groß-/Kleinschreibung in den dokumentierten Textfeldern, vor dem Seitenlimit. |
| limit | URL-Parameter | integer; {"default":50,"maximum":100,"minimum":1} | Nein | Seitengröße 1–100, standardmäßig 50. Eine Folgeseite besteht nur bei einer weiteren passenden Zeile. |
| cursor | URL-Parameter | string; {"maxLength":4096} | Nein | Opaker next_cursor der vorherigen Seite. Ressource, Konto, Filter, Sortierung und Limit beibehalten; Listen-Cursor verfallen nach 15 Minuten. |
| sort | URL-Parameter | string; {"enum":["newest","oldest","name_asc","name_desc"]} | Nein | Stabile Sortierung mit der Datensatz-ID bei Gleichstand: newest, oldest, name_asc oder name_desc. |
| severity | URL-Parameter | string | Nein | Exakter Feldfilter; Parameter für alle Werte weglassen. |
| workspace_id | URL-Parameter | string; {"format":"uuid"} | Nein | Begrenzen Sie die Liste auf einen zugänglichen Arbeitsbereich. |
| kind | URL-Parameter | string; {"enum":["numeric","state","text","heartbeat","no_data","run","slo"]} | Nein | Exakter Feldfilter; Parameter für alle Werte weglassen. |
| state | URL-Parameter | string; {"enum":["OK","PENDING","FIRING","NO_DATA","RESOLVED","paused","muted","maintenance","collection_paused"]} | Nein | Exakter Feldfilter; Parameter für alle Werte weglassen. |
| device_id | URL-Parameter | string; {"format":"uuid"} | Nein | Nur Regeln dieses Monitors zurückgeben. |
| counts_only | URL-Parameter | string; {"enum":["1"]} | Nein | Liefert Anzahlen für den angegebenen Filter statt Tabellenzeilen. Suche und weitere Filter gelten; die eigene Auswahl, Sortierung und Pagination beeinflussen die Zählung nicht. |
| count_filter | URL-Parameter | string; {"enum":["state","kind","severity"]} | Nein | Deklarierter Tabellenfilter für die Zählung. Erfordert counts_only=1. |
| snapshot | URL-Parameter | string; {"format":"date-time"} | Nein | Optionaler Snapshot der zugehörigen Tabellenseite. |
Anfragekörper
Kein Anfragekörper.
Antworten
| Header | Typ und Grenzen | Bedeutung |
|---|---|---|
| Cache-Control | string; {"pattern":"(?:^|,\\s*)no-store(?:,|$)"} | Private API-Antworten verbieten Speicherung. Öffentliche OAuth-Metadaten werden 300 Sekunden gecacht; Livestreams verbieten zusätzlich Transformation. |
| Content-Language | string; {"enum":["en","de"]} | Sprache lesbarer Antworttexte aus Accept-Language oder der dokumentierten Browserpräferenz. Technische Codes und Kennungen bleiben stabil. |
| Referrer-Policy | JSON; {"enum":["strict-origin-when-cross-origin","no-referrer"]} | Standard-Referrerpolicy ist strict-origin-when-cross-origin. Anbieterloginantworten verwenden no-referrer zum Schutz der Loginparameter. |
| Vary | string | Antworten variieren nach Accept-Language; browsergerenderte Antworten können zusätzlich nach Präferenzcookie variieren. |
| X-Content-Type-Options | JSON; {"const":"nosniff"} | Der Browser muss den angegebenen Inhaltstyp verwenden. |
| X-Frame-Options | JSON; {"const":"DENY"} | Die Antwort darf nicht in einem Frame eingebettet werden. |
| X-Request-ID | string | Vom Server erzeugte Anfragekennung. Bei Fehlermeldungen mitgeben; eingehende Werte werden nicht als vertrauenswürdig übernommen. |
application/json
| Feld | Typ und Grenzen | Erforderlich | Bedeutung |
|---|---|---|---|
| $ | object | object | Ja | — |
| $ (anyOf 1) | object | Nein | — |
| $ (anyOf 1).rules | array<object> | Ja | — |
| $ (anyOf 1).rules[] | object | Ja | — |
| $ (anyOf 1).rules[].clear | object | Ja | — |
| $ (anyOf 1).rules[].clear.operator | string | null | Ja | — |
| $ (anyOf 1).rules[].clear.operator (anyOf 1) | string | Nein | — |
| $ (anyOf 1).rules[].clear.operator (anyOf 2) | null | Nein | — |
| $ (anyOf 1).rules[].clear.value | number | null | Ja | — |
| $ (anyOf 1).rules[].clear.value (anyOf 1) | number | Nein | — |
| $ (anyOf 1).rules[].clear.value (anyOf 2) | null | Nein | — |
| $ (anyOf 1).rules[].clear.value_high | number | null | Ja | — |
| $ (anyOf 1).rules[].clear.value_high (anyOf 1) | number | Nein | — |
| $ (anyOf 1).rules[].clear.value_high (anyOf 2) | null | Nein | — |
| $ (anyOf 1).rules[].clear_duration_seconds | integer | Ja | — |
| $ (anyOf 1).rules[].created_at | string; {"format":"date-time"} | Ja | Erstellungszeitpunkt in RFC 3339 UTC. |
| $ (anyOf 1).rules[].device_id | string | Ja | UUID des Zielgeräts oder Monitors. Der Schreibschlüssel muss dieses Gerät erlauben. |
| $ (anyOf 1).rules[].equality_tolerance | number | Ja | — |
| $ (anyOf 1).rules[].event_case_sensitive | boolean | Ja | — |
| $ (anyOf 1).rules[].event_contains | string | null | Ja | — |
| $ (anyOf 1).rules[].event_contains (anyOf 1) | string | Nein | — |
| $ (anyOf 1).rules[].event_contains (anyOf 2) | null | Nein | — |
| $ (anyOf 1).rules[].event_min_severity | string | null | Ja | — |
| $ (anyOf 1).rules[].event_min_severity (anyOf 1) | string | Nein | — |
| $ (anyOf 1).rules[].event_min_severity (anyOf 2) | null | Nein | — |
| $ (anyOf 1).rules[].event_operator | string | Ja | — |
| $ (anyOf 1).rules[].event_whole_word | boolean | Ja | — |
| $ (anyOf 1).rules[].id | string | Ja | UUID dieser Ressource. Bewahren Sie die zurückgegebene Kennung für weitere Operationen auf. |
| $ (anyOf 1).rules[].kind | string | Ja | Ressourcenart oder Messwerttyp aus den angegebenen Werten. |
| $ (anyOf 1).rules[].maintenance_until | string; {"format":"date-time"} | null | Ja | — |
| $ (anyOf 1).rules[].maintenance_until (anyOf 1) | string; {"format":"date-time"} | Nein | — |
| $ (anyOf 1).rules[].maintenance_until (anyOf 2) | null | Nein | — |
| $ (anyOf 1).rules[].muted_until | string; {"format":"date-time"} | null | Ja | — |
| $ (anyOf 1).rules[].muted_until (anyOf 1) | string; {"format":"date-time"} | Nein | — |
| $ (anyOf 1).rules[].muted_until (anyOf 2) | null | Nein | — |
| $ (anyOf 1).rules[].name | string | Ja | Lesbarer Ressourcenname. Beachten Sie die angegebene Längengrenze. |
| $ (anyOf 1).rules[].no_data_seconds | integer | null | Ja | — |
| $ (anyOf 1).rules[].no_data_seconds (anyOf 1) | integer | Nein | — |
| $ (anyOf 1).rules[].no_data_seconds (anyOf 2) | null | Nein | — |
| $ (anyOf 1).rules[].paused_until | string; {"format":"date-time"} | null | Ja | — |
| $ (anyOf 1).rules[].paused_until (anyOf 1) | string; {"format":"date-time"} | Nein | — |
| $ (anyOf 1).rules[].paused_until (anyOf 2) | null | Nein | — |
| $ (anyOf 1).rules[].quiet_seconds | integer | null | Ja | — |
| $ (anyOf 1).rules[].quiet_seconds (anyOf 1) | integer | Nein | — |
| $ (anyOf 1).rules[].quiet_seconds (anyOf 2) | null | Nein | — |
| $ (anyOf 1).rules[].repeat_seconds | integer | Ja | Mindestintervall vor Wiederholung einer nicht entwarnten Alarmnachricht. |
| $ (anyOf 1).rules[].series_id | string | null | Ja | UUID der Messreihe des freigegebenen Geräts. |
| $ (anyOf 1).rules[].series_id (anyOf 1) | string | Nein | — |
| $ (anyOf 1).rules[].series_id (anyOf 2) | null | Nein | — |
| $ (anyOf 1).rules[].server_profile_paused | boolean | Ja | — |
| $ (anyOf 1).rules[].severity | string | Ja | Schweregrad aus dem angegebenen Wertebereich. |
| $ (anyOf 1).rules[].state_clear_samples | integer | Ja | — |
| $ (anyOf 1).rules[].state_trigger_samples | integer | Ja | — |
| $ (anyOf 1).rules[].status | string | Ja | — |
| $ (anyOf 1).rules[].target_state | string | null | Ja | — |
| $ (anyOf 1).rules[].target_state (anyOf 1) | string | Nein | — |
| $ (anyOf 1).rules[].target_state (anyOf 2) | null | Nein | — |
| $ (anyOf 1).rules[].trigger | object | Ja | — |
| $ (anyOf 1).rules[].trigger.operator | string | null | Ja | — |
| $ (anyOf 1).rules[].trigger.operator (anyOf 1) | string | Nein | — |
| $ (anyOf 1).rules[].trigger.operator (anyOf 2) | null | Nein | — |
| $ (anyOf 1).rules[].trigger.value | number | null | Ja | — |
| $ (anyOf 1).rules[].trigger.value (anyOf 1) | number | Nein | — |
| $ (anyOf 1).rules[].trigger.value (anyOf 2) | null | Nein | — |
| $ (anyOf 1).rules[].trigger.value_high | number | null | Ja | — |
| $ (anyOf 1).rules[].trigger.value_high (anyOf 1) | number | Nein | — |
| $ (anyOf 1).rules[].trigger.value_high (anyOf 2) | null | Nein | — |
| $ (anyOf 1).rules[].trigger_duration_seconds | integer | Ja | — |
| $ (anyOf 1).rules[].version | integer | Ja | — |
| $ (anyOf 1).rules[].window_function | string | Ja | — |
| $ (anyOf 1).rules[].window_seconds | integer | Ja | — |
| $ (anyOf 1).rules[].deployment_maintenance | object | null | Nein | — |
| $ (anyOf 1).rules[].deployment_maintenance (anyOf 1) | object | Nein | — |
| $ (anyOf 1).rules[].deployment_maintenance (anyOf 1).expires_at | string; {"format":"date-time"} | Ja | — |
| $ (anyOf 1).rules[].deployment_maintenance (anyOf 1).id | string; {"format":"uuid"} | Ja | — |
| $ (anyOf 1).rules[].deployment_maintenance (anyOf 1).manual_muted_until | string; {"format":"date-time"} | null | Ja | — |
| $ (anyOf 1).rules[].deployment_maintenance (anyOf 1).manual_muted_until (anyOf 1) | string; {"format":"date-time"} | Nein | — |
| $ (anyOf 1).rules[].deployment_maintenance (anyOf 1).manual_muted_until (anyOf 2) | null | Nein | — |
| $ (anyOf 1).rules[].deployment_maintenance (anyOf 1).service | string | Ja | — |
| $ (anyOf 1).rules[].deployment_maintenance (anyOf 1).starts_at | string; {"format":"date-time"} | Ja | — |
| $ (anyOf 1).rules[].deployment_maintenance (anyOf 2) | null | Nein | — |
| $ (anyOf 1).rules[].evaluation_status | string; {"enum":["not_evaluated","current","stale"]} | Ja | — |
| $ (anyOf 1).rules[].last_evaluated_at | string; {"format":"date-time"} | null | Ja | — |
| $ (anyOf 1).rules[].last_evaluated_at (anyOf 1) | string; {"format":"date-time"} | Nein | — |
| $ (anyOf 1).rules[].last_evaluated_at (anyOf 2) | null | Nein | — |
| $ (anyOf 1).rules[].device_icon | AlarmMonitorIcon | Nein | Optionale Monitoridentität für Listen. Enthält den Listenbereich, die Serverplattform und dieselbe authentifizierte Faviconadresse wie die Monitorlisten. Zieladressen, Zugangsdaten und Messwerte sind nicht enthalten. |
| $ (anyOf 1).rules[].device_icon.monitor_type | string | Ja | — |
| $ (anyOf 1).rules[].device_icon.list_group | string; {"enum":["monitors","servers"]} | Ja | — |
| $ (anyOf 1).rules[].device_icon.summary | object; {"additionalProperties":false} | Ja | — |
| $ (anyOf 1).rules[].device_icon.summary.platform | string; {"enum":["linux","darwin","windows"]} | Nein | — |
| $ (anyOf 1).rules[].device_icon.summary.favicon_url | string | Nein | — |
| $ (anyOf 1).rules[].device_name | string | Nein | — |
| $ (anyOf 1).limit | integer; {"maximum":100,"minimum":1} | Ja | — |
| $ (anyOf 1).next_cursor | string | Ja | Cursor zur nächsten passenden Seite; leer, wenn keine Folgeseite besteht. |
| $ (anyOf 1).snapshot | string; {"format":"date-time"} | Ja | An den Cursor gebundener UTC-Snapshot; später angelegte Zeilen gelangen nicht in diese Seitenfolge. |
| $ (anyOf 2) | object | Nein | — |
| $ (anyOf 2).filter_counts | TableFilterCounts | Ja | — |
| $ (anyOf 2).filter_counts.field | string | Ja | — |
| $ (anyOf 2).filter_counts.total | integer; {"minimum":0} | Ja | — |
| $ (anyOf 2).filter_counts.values | object | Ja | — |
| $ (anyOf 2).filter_counts.complete | boolean | Ja | — |
| $ (anyOf 2).filter_counts.snapshot | string; {"format":"date-time"} | Ja | — |
| $ (anyOf 2).filter_counts.counted_at | string; {"format":"date-time"} | Ja | — |
{
"rules": [],
"next_cursor": "",
"snapshot": "2026-10-17T00:00:00Z",
"limit": 50
}| Stabile Fehlercodes |
|---|
| invalid_credential |
| unauthorized |
| Header | Typ und Grenzen | Bedeutung |
|---|---|---|
| Cache-Control | string; {"pattern":"(?:^|,\\s*)no-store(?:,|$)"} | Private API-Antworten verbieten Speicherung. Öffentliche OAuth-Metadaten werden 300 Sekunden gecacht; Livestreams verbieten zusätzlich Transformation. |
| Content-Language | string; {"enum":["en","de"]} | Sprache lesbarer Antworttexte aus Accept-Language oder der dokumentierten Browserpräferenz. Technische Codes und Kennungen bleiben stabil. |
| Referrer-Policy | JSON; {"enum":["strict-origin-when-cross-origin","no-referrer"]} | Standard-Referrerpolicy ist strict-origin-when-cross-origin. Anbieterloginantworten verwenden no-referrer zum Schutz der Loginparameter. |
| Vary | string | Antworten variieren nach Accept-Language; browsergerenderte Antworten können zusätzlich nach Präferenzcookie variieren. |
| X-Content-Type-Options | JSON; {"const":"nosniff"} | Der Browser muss den angegebenen Inhaltstyp verwenden. |
| X-Frame-Options | JSON; {"const":"DENY"} | Die Antwort darf nicht in einem Frame eingebettet werden. |
| X-Request-ID | string | Vom Server erzeugte Anfragekennung. Bei Fehlermeldungen mitgeben; eingehende Werte werden nicht als vertrauenswürdig übernommen. |
application/problem+json
| Feld | Typ und Grenzen | Erforderlich | Bedeutung |
|---|---|---|---|
| $ | Problem | Ja | — |
| $.code | string | Ja | Stabiler maschinenlesbarer Fehlercode |
| $.detail | string | Ja | Kurze lokalisierte Erklärung ohne interne Fehlerdaten |
| $.instance | string | Ja | Einmalige relative Kennung /api/v1/requests/{request_id}; keine abrufbare Ressource |
| $.message | string | Ja | Vorübergehend für bestehende Clients gleich detail |
| $.message_key | string | Ja | Stabiler Übersetzungsschlüssel für einen Sprachwechsel der Anzeige ohne neue Anfrage |
| $.message_params | object; {"additionalProperties":true} | Ja | Benannte, sicher ausgegebene Meldungsparameter; kein beliebiges HTML |
| $.request_id | string; {"pattern":"^[0-9a-f]{32}$"} | Ja | Vom Server erzeugte Diagnosekennung. Enthält kein Logintoken und keine Zugangsdaten. |
| $.status | integer; {"maximum":599,"minimum":400} | Ja | — |
| $.title | string | Ja | Lokalisierte HTTP-Statusbezeichnung |
| $.type | string; {"const":"about:blank"} | Ja | — |
{
"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"
}| Stabile Fehlercodes |
|---|
| csrf |
| insufficient_scope |
| invalid_origin |
| Header | Typ und Grenzen | Bedeutung |
|---|---|---|
| Cache-Control | string; {"pattern":"(?:^|,\\s*)no-store(?:,|$)"} | Private API-Antworten verbieten Speicherung. Öffentliche OAuth-Metadaten werden 300 Sekunden gecacht; Livestreams verbieten zusätzlich Transformation. |
| Content-Language | string; {"enum":["en","de"]} | Sprache lesbarer Antworttexte aus Accept-Language oder der dokumentierten Browserpräferenz. Technische Codes und Kennungen bleiben stabil. |
| Referrer-Policy | JSON; {"enum":["strict-origin-when-cross-origin","no-referrer"]} | Standard-Referrerpolicy ist strict-origin-when-cross-origin. Anbieterloginantworten verwenden no-referrer zum Schutz der Loginparameter. |
| Vary | string | Antworten variieren nach Accept-Language; browsergerenderte Antworten können zusätzlich nach Präferenzcookie variieren. |
| X-Content-Type-Options | JSON; {"const":"nosniff"} | Der Browser muss den angegebenen Inhaltstyp verwenden. |
| X-Frame-Options | JSON; {"const":"DENY"} | Die Antwort darf nicht in einem Frame eingebettet werden. |
| X-Request-ID | string | Vom Server erzeugte Anfragekennung. Bei Fehlermeldungen mitgeben; eingehende Werte werden nicht als vertrauenswürdig übernommen. |
application/problem+json
| Feld | Typ und Grenzen | Erforderlich | Bedeutung |
|---|---|---|---|
| $ | Problem | Ja | — |
| $.code | string | Ja | Stabiler maschinenlesbarer Fehlercode |
| $.detail | string | Ja | Kurze lokalisierte Erklärung ohne interne Fehlerdaten |
| $.instance | string | Ja | Einmalige relative Kennung /api/v1/requests/{request_id}; keine abrufbare Ressource |
| $.message | string | Ja | Vorübergehend für bestehende Clients gleich detail |
| $.message_key | string | Ja | Stabiler Übersetzungsschlüssel für einen Sprachwechsel der Anzeige ohne neue Anfrage |
| $.message_params | object; {"additionalProperties":true} | Ja | Benannte, sicher ausgegebene Meldungsparameter; kein beliebiges HTML |
| $.request_id | string; {"pattern":"^[0-9a-f]{32}$"} | Ja | Vom Server erzeugte Diagnosekennung. Enthält kein Logintoken und keine Zugangsdaten. |
| $.status | integer; {"maximum":599,"minimum":400} | Ja | — |
| $.title | string | Ja | Lokalisierte HTTP-Statusbezeichnung |
| $.type | string; {"const":"about:blank"} | Ja | — |
{
"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"
}| Stabile Fehlercodes |
|---|
| unavailable |
| Header | Typ und Grenzen | Bedeutung |
|---|---|---|
| Cache-Control | string; {"pattern":"(?:^|,\\s*)no-store(?:,|$)"} | Private API-Antworten verbieten Speicherung. Öffentliche OAuth-Metadaten werden 300 Sekunden gecacht; Livestreams verbieten zusätzlich Transformation. |
| Content-Language | string; {"enum":["en","de"]} | Sprache lesbarer Antworttexte aus Accept-Language oder der dokumentierten Browserpräferenz. Technische Codes und Kennungen bleiben stabil. |
| Referrer-Policy | JSON; {"enum":["strict-origin-when-cross-origin","no-referrer"]} | Standard-Referrerpolicy ist strict-origin-when-cross-origin. Anbieterloginantworten verwenden no-referrer zum Schutz der Loginparameter. |
| Retry-After | string; {"pattern":"^[0-9]+$"} | Sekunden bis zur Wiederholung. Bewahren Sie unterstützte Idempotenzkennungen und beachten Sie die Änderungsregeln der Operation. |
| Vary | string | Antworten variieren nach Accept-Language; browsergerenderte Antworten können zusätzlich nach Präferenzcookie variieren. |
| X-Content-Type-Options | JSON; {"const":"nosniff"} | Der Browser muss den angegebenen Inhaltstyp verwenden. |
| X-Frame-Options | JSON; {"const":"DENY"} | Die Antwort darf nicht in einem Frame eingebettet werden. |
| X-Request-ID | string | Vom Server erzeugte Anfragekennung. Bei Fehlermeldungen mitgeben; eingehende Werte werden nicht als vertrauenswürdig übernommen. |
application/problem+json
| Feld | Typ und Grenzen | Erforderlich | Bedeutung |
|---|---|---|---|
| $ | Problem | Ja | — |
| $.code | string | Ja | Stabiler maschinenlesbarer Fehlercode |
| $.detail | string | Ja | Kurze lokalisierte Erklärung ohne interne Fehlerdaten |
| $.instance | string | Ja | Einmalige relative Kennung /api/v1/requests/{request_id}; keine abrufbare Ressource |
| $.message | string | Ja | Vorübergehend für bestehende Clients gleich detail |
| $.message_key | string | Ja | Stabiler Übersetzungsschlüssel für einen Sprachwechsel der Anzeige ohne neue Anfrage |
| $.message_params | object; {"additionalProperties":true} | Ja | Benannte, sicher ausgegebene Meldungsparameter; kein beliebiges HTML |
| $.request_id | string; {"pattern":"^[0-9a-f]{32}$"} | Ja | Vom Server erzeugte Diagnosekennung. Enthält kein Logintoken und keine Zugangsdaten. |
| $.status | integer; {"maximum":599,"minimum":400} | Ja | — |
| $.title | string | Ja | Lokalisierte HTTP-Statusbezeichnung |
| $.type | string; {"const":"about:blank"} | Ja | — |
{
"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"
}| Stabile Fehlercodes |
|---|
| not_found |
| unavailable |
| Header | Typ und Grenzen | Bedeutung |
|---|---|---|
| Cache-Control | string; {"pattern":"(?:^|,\\s*)no-store(?:,|$)"} | Private API-Antworten verbieten Speicherung. Öffentliche OAuth-Metadaten werden 300 Sekunden gecacht; Livestreams verbieten zusätzlich Transformation. |
| Content-Language | string; {"enum":["en","de"]} | Sprache lesbarer Antworttexte aus Accept-Language oder der dokumentierten Browserpräferenz. Technische Codes und Kennungen bleiben stabil. |
| Referrer-Policy | JSON; {"enum":["strict-origin-when-cross-origin","no-referrer"]} | Standard-Referrerpolicy ist strict-origin-when-cross-origin. Anbieterloginantworten verwenden no-referrer zum Schutz der Loginparameter. |
| Retry-After | string; {"pattern":"^[0-9]+$"} | Sekunden bis zur Wiederholung. Bewahren Sie unterstützte Idempotenzkennungen und beachten Sie die Änderungsregeln der Operation. |
| Vary | string | Antworten variieren nach Accept-Language; browsergerenderte Antworten können zusätzlich nach Präferenzcookie variieren. |
| X-Content-Type-Options | JSON; {"const":"nosniff"} | Der Browser muss den angegebenen Inhaltstyp verwenden. |
| X-Frame-Options | JSON; {"const":"DENY"} | Die Antwort darf nicht in einem Frame eingebettet werden. |
| X-Request-ID | string | Vom Server erzeugte Anfragekennung. Bei Fehlermeldungen mitgeben; eingehende Werte werden nicht als vertrauenswürdig übernommen. |
application/problem+json
| Feld | Typ und Grenzen | Erforderlich | Bedeutung |
|---|---|---|---|
| $ | Problem | Ja | — |
| $.code | string | Ja | Stabiler maschinenlesbarer Fehlercode |
| $.detail | string | Ja | Kurze lokalisierte Erklärung ohne interne Fehlerdaten |
| $.instance | string | Ja | Einmalige relative Kennung /api/v1/requests/{request_id}; keine abrufbare Ressource |
| $.message | string | Ja | Vorübergehend für bestehende Clients gleich detail |
| $.message_key | string | Ja | Stabiler Übersetzungsschlüssel für einen Sprachwechsel der Anzeige ohne neue Anfrage |
| $.message_params | object; {"additionalProperties":true} | Ja | Benannte, sicher ausgegebene Meldungsparameter; kein beliebiges HTML |
| $.request_id | string; {"pattern":"^[0-9a-f]{32}$"} | Ja | Vom Server erzeugte Diagnosekennung. Enthält kein Logintoken und keine Zugangsdaten. |
| $.status | integer; {"maximum":599,"minimum":400} | Ja | — |
| $.title | string | Ja | Lokalisierte HTTP-Statusbezeichnung |
| $.type | string; {"const":"about:blank"} | Ja | — |
{
"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"
}| Stabile Fehlercodes |
|---|
| invalid_reference |
| unavailable |
| Header | Typ und Grenzen | Bedeutung |
|---|---|---|
| Cache-Control | string; {"pattern":"(?:^|,\\s*)no-store(?:,|$)"} | Private API-Antworten verbieten Speicherung. Öffentliche OAuth-Metadaten werden 300 Sekunden gecacht; Livestreams verbieten zusätzlich Transformation. |
| Content-Language | string; {"enum":["en","de"]} | Sprache lesbarer Antworttexte aus Accept-Language oder der dokumentierten Browserpräferenz. Technische Codes und Kennungen bleiben stabil. |
| Referrer-Policy | JSON; {"enum":["strict-origin-when-cross-origin","no-referrer"]} | Standard-Referrerpolicy ist strict-origin-when-cross-origin. Anbieterloginantworten verwenden no-referrer zum Schutz der Loginparameter. |
| Retry-After | string; {"pattern":"^[0-9]+$"} | Sekunden bis zur Wiederholung. Bewahren Sie unterstützte Idempotenzkennungen und beachten Sie die Änderungsregeln der Operation. |
| Vary | string | Antworten variieren nach Accept-Language; browsergerenderte Antworten können zusätzlich nach Präferenzcookie variieren. |
| X-Content-Type-Options | JSON; {"const":"nosniff"} | Der Browser muss den angegebenen Inhaltstyp verwenden. |
| X-Frame-Options | JSON; {"const":"DENY"} | Die Antwort darf nicht in einem Frame eingebettet werden. |
| X-Request-ID | string | Vom Server erzeugte Anfragekennung. Bei Fehlermeldungen mitgeben; eingehende Werte werden nicht als vertrauenswürdig übernommen. |
application/problem+json
| Feld | Typ und Grenzen | Erforderlich | Bedeutung |
|---|---|---|---|
| $ | Problem | Ja | — |
| $.code | string | Ja | Stabiler maschinenlesbarer Fehlercode |
| $.detail | string | Ja | Kurze lokalisierte Erklärung ohne interne Fehlerdaten |
| $.instance | string | Ja | Einmalige relative Kennung /api/v1/requests/{request_id}; keine abrufbare Ressource |
| $.message | string | Ja | Vorübergehend für bestehende Clients gleich detail |
| $.message_key | string | Ja | Stabiler Übersetzungsschlüssel für einen Sprachwechsel der Anzeige ohne neue Anfrage |
| $.message_params | object; {"additionalProperties":true} | Ja | Benannte, sicher ausgegebene Meldungsparameter; kein beliebiges HTML |
| $.request_id | string; {"pattern":"^[0-9a-f]{32}$"} | Ja | Vom Server erzeugte Diagnosekennung. Enthält kein Logintoken und keine Zugangsdaten. |
| $.status | integer; {"maximum":599,"minimum":400} | Ja | — |
| $.title | string | Ja | Lokalisierte HTTP-Statusbezeichnung |
| $.type | string; {"const":"about:blank"} | Ja | — |
{
"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"
}Wiederholungen und asynchrone Aufträge
Diese Operation liest oder prüft, ohne eine Ressourcenänderung anzuwenden. Beachten Sie Ratenlimits und Zugangslaufzeiten.
Anfragebeispiele
Ersetzen Sie Demokennungen, Zeitstempel und Platzhalter durch eigene Werte. Behalten Sie bei Wiederholungen Kennungen, Zeit und Inhalt bei. Diese Beispiele führen auf der Seite keine Anfragen aus.
Halten Sie Anmeldelinks, Codes, Cookies und Schlüssel privat. Schreiben Sie sie nicht in Logs und teilen Sie sie nicht in Hilfeanfragen.
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)
}
Verwandte Anleitungen
- HTTP-API, OAuth und MCP
Finden Sie die Nutzer-API-Endpunkte mit Rechten, Feldern, Beispielen und Antwortformaten.
- POST Regel für Messwert, Zustand, Text, Datenlücke oder Lauf erstellen
Regel für Messwert, Zustand, Text, Datenlücke oder Lauf erstellen.
- DELETE Regel archivieren und offene Vorfälle schließen
Regel archivieren und offene Vorfälle schließen.
- GET Eine Alarmregel lesen
Öffnen Sie eine zugängliche Alarmregel über ihre Kennung, unabhängig von Listenfiltern und Seiten.