MetriBeacon
Menü
Deutsch

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

FeldPositionTyp und GrenzenErforderlichBedeutung
qURL-Parameterstring; {"maxLength":128}NeinSuche nach wörtlichem Text ohne Beachtung der Groß-/Kleinschreibung in den dokumentierten Textfeldern, vor dem Seitenlimit.
limitURL-Parameterinteger; {"default":50,"maximum":100,"minimum":1}NeinSeitengröße 1–100, standardmäßig 50. Eine Folgeseite besteht nur bei einer weiteren passenden Zeile.
cursorURL-Parameterstring; {"maxLength":4096}NeinOpaker next_cursor der vorherigen Seite. Ressource, Konto, Filter, Sortierung und Limit beibehalten; Listen-Cursor verfallen nach 15 Minuten.
sortURL-Parameterstring; {"enum":["newest","oldest","name_asc","name_desc"]}NeinStabile Sortierung mit der Datensatz-ID bei Gleichstand: newest, oldest, name_asc oder name_desc.
severityURL-ParameterstringNeinExakter Feldfilter; Parameter für alle Werte weglassen.
workspace_idURL-Parameterstring; {"format":"uuid"}NeinBegrenzen Sie die Liste auf einen zugänglichen Arbeitsbereich.
kindURL-Parameterstring; {"enum":["numeric","state","text","heartbeat","no_data","run","slo"]}NeinExakter Feldfilter; Parameter für alle Werte weglassen.
stateURL-Parameterstring; {"enum":["OK","PENDING","FIRING","NO_DATA","RESOLVED","paused","muted","maintenance","collection_paused"]}NeinExakter Feldfilter; Parameter für alle Werte weglassen.
device_idURL-Parameterstring; {"format":"uuid"}NeinNur Regeln dieses Monitors zurückgeben.
counts_onlyURL-Parameterstring; {"enum":["1"]}NeinLiefert 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_filterURL-Parameterstring; {"enum":["state","kind","severity"]}NeinDeklarierter Tabellenfilter für die Zählung. Erfordert counts_only=1.
snapshotURL-Parameterstring; {"format":"date-time"}NeinOptionaler Snapshot der zugehörigen Tabellenseite.

Anfragekörper

Kein Anfragekörper.

Antworten

HeaderTyp und GrenzenBedeutung
Cache-Controlstring; {"pattern":"(?:^|,\\s*)no-store(?:,|$)"}Private API-Antworten verbieten Speicherung. Öffentliche OAuth-Metadaten werden 300 Sekunden gecacht; Livestreams verbieten zusätzlich Transformation.
Content-Languagestring; {"enum":["en","de"]}Sprache lesbarer Antworttexte aus Accept-Language oder der dokumentierten Browserpräferenz. Technische Codes und Kennungen bleiben stabil.
Referrer-PolicyJSON; {"enum":["strict-origin-when-cross-origin","no-referrer"]}Standard-Referrerpolicy ist strict-origin-when-cross-origin. Anbieterloginantworten verwenden no-referrer zum Schutz der Loginparameter.
VarystringAntworten variieren nach Accept-Language; browsergerenderte Antworten können zusätzlich nach Präferenzcookie variieren.
X-Content-Type-OptionsJSON; {"const":"nosniff"}Der Browser muss den angegebenen Inhaltstyp verwenden.
X-Frame-OptionsJSON; {"const":"DENY"}Die Antwort darf nicht in einem Frame eingebettet werden.
X-Request-IDstringVom Server erzeugte Anfragekennung. Bei Fehlermeldungen mitgeben; eingehende Werte werden nicht als vertrauenswürdig übernommen.

application/json

FeldTyp und GrenzenErforderlichBedeutung
$object | objectJa—
$ (anyOf 1)objectNein—
$ (anyOf 1).rulesarray<object>Ja—
$ (anyOf 1).rules[]objectJa—
$ (anyOf 1).rules[].clearobjectJa—
$ (anyOf 1).rules[].clear.operatorstring | nullJa—
$ (anyOf 1).rules[].clear.operator (anyOf 1)stringNein—
$ (anyOf 1).rules[].clear.operator (anyOf 2)nullNein—
$ (anyOf 1).rules[].clear.valuenumber | nullJa—
$ (anyOf 1).rules[].clear.value (anyOf 1)numberNein—
$ (anyOf 1).rules[].clear.value (anyOf 2)nullNein—
$ (anyOf 1).rules[].clear.value_highnumber | nullJa—
$ (anyOf 1).rules[].clear.value_high (anyOf 1)numberNein—
$ (anyOf 1).rules[].clear.value_high (anyOf 2)nullNein—
$ (anyOf 1).rules[].clear_duration_secondsintegerJa—
$ (anyOf 1).rules[].created_atstring; {"format":"date-time"}JaErstellungszeitpunkt in RFC 3339 UTC.
$ (anyOf 1).rules[].device_idstringJaUUID des Zielgeräts oder Monitors. Der Schreibschlüssel muss dieses Gerät erlauben.
$ (anyOf 1).rules[].equality_tolerancenumberJa—
$ (anyOf 1).rules[].event_case_sensitivebooleanJa—
$ (anyOf 1).rules[].event_containsstring | nullJa—
$ (anyOf 1).rules[].event_contains (anyOf 1)stringNein—
$ (anyOf 1).rules[].event_contains (anyOf 2)nullNein—
$ (anyOf 1).rules[].event_min_severitystring | nullJa—
$ (anyOf 1).rules[].event_min_severity (anyOf 1)stringNein—
$ (anyOf 1).rules[].event_min_severity (anyOf 2)nullNein—
$ (anyOf 1).rules[].event_operatorstringJa—
$ (anyOf 1).rules[].event_whole_wordbooleanJa—
$ (anyOf 1).rules[].idstringJaUUID dieser Ressource. Bewahren Sie die zurückgegebene Kennung für weitere Operationen auf.
$ (anyOf 1).rules[].kindstringJaRessourcenart oder Messwerttyp aus den angegebenen Werten.
$ (anyOf 1).rules[].maintenance_untilstring; {"format":"date-time"} | nullJa—
$ (anyOf 1).rules[].maintenance_until (anyOf 1)string; {"format":"date-time"}Nein—
$ (anyOf 1).rules[].maintenance_until (anyOf 2)nullNein—
$ (anyOf 1).rules[].muted_untilstring; {"format":"date-time"} | nullJa—
$ (anyOf 1).rules[].muted_until (anyOf 1)string; {"format":"date-time"}Nein—
$ (anyOf 1).rules[].muted_until (anyOf 2)nullNein—
$ (anyOf 1).rules[].namestringJaLesbarer Ressourcenname. Beachten Sie die angegebene Längengrenze.
$ (anyOf 1).rules[].no_data_secondsinteger | nullJa—
$ (anyOf 1).rules[].no_data_seconds (anyOf 1)integerNein—
$ (anyOf 1).rules[].no_data_seconds (anyOf 2)nullNein—
$ (anyOf 1).rules[].paused_untilstring; {"format":"date-time"} | nullJa—
$ (anyOf 1).rules[].paused_until (anyOf 1)string; {"format":"date-time"}Nein—
$ (anyOf 1).rules[].paused_until (anyOf 2)nullNein—
$ (anyOf 1).rules[].quiet_secondsinteger | nullJa—
$ (anyOf 1).rules[].quiet_seconds (anyOf 1)integerNein—
$ (anyOf 1).rules[].quiet_seconds (anyOf 2)nullNein—
$ (anyOf 1).rules[].repeat_secondsintegerJaMindestintervall vor Wiederholung einer nicht entwarnten Alarmnachricht.
$ (anyOf 1).rules[].series_idstring | nullJaUUID der Messreihe des freigegebenen Geräts.
$ (anyOf 1).rules[].series_id (anyOf 1)stringNein—
$ (anyOf 1).rules[].series_id (anyOf 2)nullNein—
$ (anyOf 1).rules[].server_profile_pausedbooleanJa—
$ (anyOf 1).rules[].severitystringJaSchweregrad aus dem angegebenen Wertebereich.
$ (anyOf 1).rules[].state_clear_samplesintegerJa—
$ (anyOf 1).rules[].state_trigger_samplesintegerJa—
$ (anyOf 1).rules[].statusstringJa—
$ (anyOf 1).rules[].target_statestring | nullJa—
$ (anyOf 1).rules[].target_state (anyOf 1)stringNein—
$ (anyOf 1).rules[].target_state (anyOf 2)nullNein—
$ (anyOf 1).rules[].triggerobjectJa—
$ (anyOf 1).rules[].trigger.operatorstring | nullJa—
$ (anyOf 1).rules[].trigger.operator (anyOf 1)stringNein—
$ (anyOf 1).rules[].trigger.operator (anyOf 2)nullNein—
$ (anyOf 1).rules[].trigger.valuenumber | nullJa—
$ (anyOf 1).rules[].trigger.value (anyOf 1)numberNein—
$ (anyOf 1).rules[].trigger.value (anyOf 2)nullNein—
$ (anyOf 1).rules[].trigger.value_highnumber | nullJa—
$ (anyOf 1).rules[].trigger.value_high (anyOf 1)numberNein—
$ (anyOf 1).rules[].trigger.value_high (anyOf 2)nullNein—
$ (anyOf 1).rules[].trigger_duration_secondsintegerJa—
$ (anyOf 1).rules[].versionintegerJa—
$ (anyOf 1).rules[].window_functionstringJa—
$ (anyOf 1).rules[].window_secondsintegerJa—
$ (anyOf 1).rules[].deployment_maintenanceobject | nullNein—
$ (anyOf 1).rules[].deployment_maintenance (anyOf 1)objectNein—
$ (anyOf 1).rules[].deployment_maintenance (anyOf 1).expires_atstring; {"format":"date-time"}Ja—
$ (anyOf 1).rules[].deployment_maintenance (anyOf 1).idstring; {"format":"uuid"}Ja—
$ (anyOf 1).rules[].deployment_maintenance (anyOf 1).manual_muted_untilstring; {"format":"date-time"} | nullJa—
$ (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)nullNein—
$ (anyOf 1).rules[].deployment_maintenance (anyOf 1).servicestringJa—
$ (anyOf 1).rules[].deployment_maintenance (anyOf 1).starts_atstring; {"format":"date-time"}Ja—
$ (anyOf 1).rules[].deployment_maintenance (anyOf 2)nullNein—
$ (anyOf 1).rules[].evaluation_statusstring; {"enum":["not_evaluated","current","stale"]}Ja—
$ (anyOf 1).rules[].last_evaluated_atstring; {"format":"date-time"} | nullJa—
$ (anyOf 1).rules[].last_evaluated_at (anyOf 1)string; {"format":"date-time"}Nein—
$ (anyOf 1).rules[].last_evaluated_at (anyOf 2)nullNein—
$ (anyOf 1).rules[].device_iconAlarmMonitorIconNeinOptionale 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_typestringJa—
$ (anyOf 1).rules[].device_icon.list_groupstring; {"enum":["monitors","servers"]}Ja—
$ (anyOf 1).rules[].device_icon.summaryobject; {"additionalProperties":false}Ja—
$ (anyOf 1).rules[].device_icon.summary.platformstring; {"enum":["linux","darwin","windows"]}Nein—
$ (anyOf 1).rules[].device_icon.summary.favicon_urlstringNein—
$ (anyOf 1).rules[].device_namestringNein—
$ (anyOf 1).limitinteger; {"maximum":100,"minimum":1}Ja—
$ (anyOf 1).next_cursorstringJaCursor zur nächsten passenden Seite; leer, wenn keine Folgeseite besteht.
$ (anyOf 1).snapshotstring; {"format":"date-time"}JaAn den Cursor gebundener UTC-Snapshot; später angelegte Zeilen gelangen nicht in diese Seitenfolge.
$ (anyOf 2)objectNein—
$ (anyOf 2).filter_countsTableFilterCountsJa—
$ (anyOf 2).filter_counts.fieldstringJa—
$ (anyOf 2).filter_counts.totalinteger; {"minimum":0}Ja—
$ (anyOf 2).filter_counts.valuesobjectJa—
$ (anyOf 2).filter_counts.completebooleanJa—
$ (anyOf 2).filter_counts.snapshotstring; {"format":"date-time"}Ja—
$ (anyOf 2).filter_counts.counted_atstring; {"format":"date-time"}Ja—
json
{
  "rules": [],
  "next_cursor": "",
  "snapshot": "2026-10-17T00:00:00Z",
  "limit": 50
}
Stabile Fehlercodes
invalid_credential
unauthorized
HeaderTyp und GrenzenBedeutung
Cache-Controlstring; {"pattern":"(?:^|,\\s*)no-store(?:,|$)"}Private API-Antworten verbieten Speicherung. Öffentliche OAuth-Metadaten werden 300 Sekunden gecacht; Livestreams verbieten zusätzlich Transformation.
Content-Languagestring; {"enum":["en","de"]}Sprache lesbarer Antworttexte aus Accept-Language oder der dokumentierten Browserpräferenz. Technische Codes und Kennungen bleiben stabil.
Referrer-PolicyJSON; {"enum":["strict-origin-when-cross-origin","no-referrer"]}Standard-Referrerpolicy ist strict-origin-when-cross-origin. Anbieterloginantworten verwenden no-referrer zum Schutz der Loginparameter.
VarystringAntworten variieren nach Accept-Language; browsergerenderte Antworten können zusätzlich nach Präferenzcookie variieren.
X-Content-Type-OptionsJSON; {"const":"nosniff"}Der Browser muss den angegebenen Inhaltstyp verwenden.
X-Frame-OptionsJSON; {"const":"DENY"}Die Antwort darf nicht in einem Frame eingebettet werden.
X-Request-IDstringVom Server erzeugte Anfragekennung. Bei Fehlermeldungen mitgeben; eingehende Werte werden nicht als vertrauenswürdig übernommen.

application/problem+json

FeldTyp und GrenzenErforderlichBedeutung
$ProblemJa—
$.codestringJaStabiler maschinenlesbarer Fehlercode
$.detailstringJaKurze lokalisierte Erklärung ohne interne Fehlerdaten
$.instancestringJaEinmalige relative Kennung /api/v1/requests/{request_id}; keine abrufbare Ressource
$.messagestringJaVorübergehend für bestehende Clients gleich detail
$.message_keystringJaStabiler Übersetzungsschlüssel für einen Sprachwechsel der Anzeige ohne neue Anfrage
$.message_paramsobject; {"additionalProperties":true}JaBenannte, sicher ausgegebene Meldungsparameter; kein beliebiges HTML
$.request_idstring; {"pattern":"^[0-9a-f]{32}$"}JaVom Server erzeugte Diagnosekennung. Enthält kein Logintoken und keine Zugangsdaten.
$.statusinteger; {"maximum":599,"minimum":400}Ja—
$.titlestringJaLokalisierte HTTP-Statusbezeichnung
$.typestring; {"const":"about:blank"}Ja—
json
{
  "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
HeaderTyp und GrenzenBedeutung
Cache-Controlstring; {"pattern":"(?:^|,\\s*)no-store(?:,|$)"}Private API-Antworten verbieten Speicherung. Öffentliche OAuth-Metadaten werden 300 Sekunden gecacht; Livestreams verbieten zusätzlich Transformation.
Content-Languagestring; {"enum":["en","de"]}Sprache lesbarer Antworttexte aus Accept-Language oder der dokumentierten Browserpräferenz. Technische Codes und Kennungen bleiben stabil.
Referrer-PolicyJSON; {"enum":["strict-origin-when-cross-origin","no-referrer"]}Standard-Referrerpolicy ist strict-origin-when-cross-origin. Anbieterloginantworten verwenden no-referrer zum Schutz der Loginparameter.
VarystringAntworten variieren nach Accept-Language; browsergerenderte Antworten können zusätzlich nach Präferenzcookie variieren.
X-Content-Type-OptionsJSON; {"const":"nosniff"}Der Browser muss den angegebenen Inhaltstyp verwenden.
X-Frame-OptionsJSON; {"const":"DENY"}Die Antwort darf nicht in einem Frame eingebettet werden.
X-Request-IDstringVom Server erzeugte Anfragekennung. Bei Fehlermeldungen mitgeben; eingehende Werte werden nicht als vertrauenswürdig übernommen.

application/problem+json

FeldTyp und GrenzenErforderlichBedeutung
$ProblemJa—
$.codestringJaStabiler maschinenlesbarer Fehlercode
$.detailstringJaKurze lokalisierte Erklärung ohne interne Fehlerdaten
$.instancestringJaEinmalige relative Kennung /api/v1/requests/{request_id}; keine abrufbare Ressource
$.messagestringJaVorübergehend für bestehende Clients gleich detail
$.message_keystringJaStabiler Übersetzungsschlüssel für einen Sprachwechsel der Anzeige ohne neue Anfrage
$.message_paramsobject; {"additionalProperties":true}JaBenannte, sicher ausgegebene Meldungsparameter; kein beliebiges HTML
$.request_idstring; {"pattern":"^[0-9a-f]{32}$"}JaVom Server erzeugte Diagnosekennung. Enthält kein Logintoken und keine Zugangsdaten.
$.statusinteger; {"maximum":599,"minimum":400}Ja—
$.titlestringJaLokalisierte HTTP-Statusbezeichnung
$.typestring; {"const":"about:blank"}Ja—
json
{
  "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
HeaderTyp und GrenzenBedeutung
Cache-Controlstring; {"pattern":"(?:^|,\\s*)no-store(?:,|$)"}Private API-Antworten verbieten Speicherung. Öffentliche OAuth-Metadaten werden 300 Sekunden gecacht; Livestreams verbieten zusätzlich Transformation.
Content-Languagestring; {"enum":["en","de"]}Sprache lesbarer Antworttexte aus Accept-Language oder der dokumentierten Browserpräferenz. Technische Codes und Kennungen bleiben stabil.
Referrer-PolicyJSON; {"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-Afterstring; {"pattern":"^[0-9]+$"}Sekunden bis zur Wiederholung. Bewahren Sie unterstützte Idempotenzkennungen und beachten Sie die Änderungsregeln der Operation.
VarystringAntworten variieren nach Accept-Language; browsergerenderte Antworten können zusätzlich nach Präferenzcookie variieren.
X-Content-Type-OptionsJSON; {"const":"nosniff"}Der Browser muss den angegebenen Inhaltstyp verwenden.
X-Frame-OptionsJSON; {"const":"DENY"}Die Antwort darf nicht in einem Frame eingebettet werden.
X-Request-IDstringVom Server erzeugte Anfragekennung. Bei Fehlermeldungen mitgeben; eingehende Werte werden nicht als vertrauenswürdig übernommen.

application/problem+json

FeldTyp und GrenzenErforderlichBedeutung
$ProblemJa—
$.codestringJaStabiler maschinenlesbarer Fehlercode
$.detailstringJaKurze lokalisierte Erklärung ohne interne Fehlerdaten
$.instancestringJaEinmalige relative Kennung /api/v1/requests/{request_id}; keine abrufbare Ressource
$.messagestringJaVorübergehend für bestehende Clients gleich detail
$.message_keystringJaStabiler Übersetzungsschlüssel für einen Sprachwechsel der Anzeige ohne neue Anfrage
$.message_paramsobject; {"additionalProperties":true}JaBenannte, sicher ausgegebene Meldungsparameter; kein beliebiges HTML
$.request_idstring; {"pattern":"^[0-9a-f]{32}$"}JaVom Server erzeugte Diagnosekennung. Enthält kein Logintoken und keine Zugangsdaten.
$.statusinteger; {"maximum":599,"minimum":400}Ja—
$.titlestringJaLokalisierte HTTP-Statusbezeichnung
$.typestring; {"const":"about:blank"}Ja—
json
{
  "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
HeaderTyp und GrenzenBedeutung
Cache-Controlstring; {"pattern":"(?:^|,\\s*)no-store(?:,|$)"}Private API-Antworten verbieten Speicherung. Öffentliche OAuth-Metadaten werden 300 Sekunden gecacht; Livestreams verbieten zusätzlich Transformation.
Content-Languagestring; {"enum":["en","de"]}Sprache lesbarer Antworttexte aus Accept-Language oder der dokumentierten Browserpräferenz. Technische Codes und Kennungen bleiben stabil.
Referrer-PolicyJSON; {"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-Afterstring; {"pattern":"^[0-9]+$"}Sekunden bis zur Wiederholung. Bewahren Sie unterstützte Idempotenzkennungen und beachten Sie die Änderungsregeln der Operation.
VarystringAntworten variieren nach Accept-Language; browsergerenderte Antworten können zusätzlich nach Präferenzcookie variieren.
X-Content-Type-OptionsJSON; {"const":"nosniff"}Der Browser muss den angegebenen Inhaltstyp verwenden.
X-Frame-OptionsJSON; {"const":"DENY"}Die Antwort darf nicht in einem Frame eingebettet werden.
X-Request-IDstringVom Server erzeugte Anfragekennung. Bei Fehlermeldungen mitgeben; eingehende Werte werden nicht als vertrauenswürdig übernommen.

application/problem+json

FeldTyp und GrenzenErforderlichBedeutung
$ProblemJa—
$.codestringJaStabiler maschinenlesbarer Fehlercode
$.detailstringJaKurze lokalisierte Erklärung ohne interne Fehlerdaten
$.instancestringJaEinmalige relative Kennung /api/v1/requests/{request_id}; keine abrufbare Ressource
$.messagestringJaVorübergehend für bestehende Clients gleich detail
$.message_keystringJaStabiler Übersetzungsschlüssel für einen Sprachwechsel der Anzeige ohne neue Anfrage
$.message_paramsobject; {"additionalProperties":true}JaBenannte, sicher ausgegebene Meldungsparameter; kein beliebiges HTML
$.request_idstring; {"pattern":"^[0-9a-f]{32}$"}JaVom Server erzeugte Diagnosekennung. Enthält kein Logintoken und keine Zugangsdaten.
$.statusinteger; {"maximum":599,"minimum":400}Ja—
$.titlestringJaLokalisierte HTTP-Statusbezeichnung
$.typestring; {"const":"about:blank"}Ja—
json
{
  "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
HeaderTyp und GrenzenBedeutung
Cache-Controlstring; {"pattern":"(?:^|,\\s*)no-store(?:,|$)"}Private API-Antworten verbieten Speicherung. Öffentliche OAuth-Metadaten werden 300 Sekunden gecacht; Livestreams verbieten zusätzlich Transformation.
Content-Languagestring; {"enum":["en","de"]}Sprache lesbarer Antworttexte aus Accept-Language oder der dokumentierten Browserpräferenz. Technische Codes und Kennungen bleiben stabil.
Referrer-PolicyJSON; {"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-Afterstring; {"pattern":"^[0-9]+$"}Sekunden bis zur Wiederholung. Bewahren Sie unterstützte Idempotenzkennungen und beachten Sie die Änderungsregeln der Operation.
VarystringAntworten variieren nach Accept-Language; browsergerenderte Antworten können zusätzlich nach Präferenzcookie variieren.
X-Content-Type-OptionsJSON; {"const":"nosniff"}Der Browser muss den angegebenen Inhaltstyp verwenden.
X-Frame-OptionsJSON; {"const":"DENY"}Die Antwort darf nicht in einem Frame eingebettet werden.
X-Request-IDstringVom Server erzeugte Anfragekennung. Bei Fehlermeldungen mitgeben; eingehende Werte werden nicht als vertrauenswürdig übernommen.

application/problem+json

FeldTyp und GrenzenErforderlichBedeutung
$ProblemJa—
$.codestringJaStabiler maschinenlesbarer Fehlercode
$.detailstringJaKurze lokalisierte Erklärung ohne interne Fehlerdaten
$.instancestringJaEinmalige relative Kennung /api/v1/requests/{request_id}; keine abrufbare Ressource
$.messagestringJaVorübergehend für bestehende Clients gleich detail
$.message_keystringJaStabiler Übersetzungsschlüssel für einen Sprachwechsel der Anzeige ohne neue Anfrage
$.message_paramsobject; {"additionalProperties":true}JaBenannte, sicher ausgegebene Meldungsparameter; kein beliebiges HTML
$.request_idstring; {"pattern":"^[0-9a-f]{32}$"}JaVom Server erzeugte Diagnosekennung. Enthält kein Logintoken und keine Zugangsdaten.
$.statusinteger; {"maximum":599,"minimum":400}Ja—
$.titlestringJaLokalisierte HTTP-Statusbezeichnung
$.typestring; {"const":"about:blank"}Ja—
json
{
  "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.

shell
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"
python
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()
javascript
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();
go
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)
}