MetriBeacon
Menü
Deutsch

GET Eigenen Monitor und Konfiguration lesen

/api/v1/monitors/{id}

Eigenen Monitor und Konfiguration lesen.

Auf dieser Seite

Zugriff und Rechte

Eigenen Monitor und Konfiguration lesen.

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
idPfadstring; {"format":"uuid"}JaRessourcen-UUID aus dem Pfad. Sie muss existieren und für die handelnde Identität zugänglich sein.
include_data_flowURL-Parameterboolean; {"default":false}NeinDatenflussdiagnose für diesen Monitor ergänzen. Es werden keine Messwerte, anderen Monitore oder Speicherpfade zurückgegeben.

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
$objectJa—
$.configMonitorConfigJa—
$.config (anyOf 1)HTTPMonitorConfigNeinTypfunktion nur bei Freigabe verfügbar. Zugangsdaten-Header werden über diesen Pfad nicht angenommen.
$.config (anyOf 1).expected_statusJSON; {"const":0} | JSON; {"minimum":100,"maximum":599}Nein—
$.config (anyOf 1).expected_status (anyOf 1)JSON; {"const":0}Nein—
$.config (anyOf 1).expected_status (anyOf 2)JSON; {"minimum":100,"maximum":599}Nein—
$.config (anyOf 1).expected_textstring; {"maxLength":256}Nein—
$.config (anyOf 1).interval_secondsinteger; {"default":300,"maximum":86400,"minimum":10}NeinAbtast- oder Prüfintervall in Sekunden innerhalb der angegebenen Grenzen.
$.config (anyOf 1).json_fieldstring; {"maxLength":64}NeinEin JSON-Feld auf oberster Ebene; alternativ zu expected_text.
$.config (anyOf 1).json_valuestring; {"maxLength":256}Nein—
$.config (anyOf 1).methodstring; {"default":"GET","enum":["GET","HEAD","OPTIONS","POST","PUT","PATCH","DELETE"]}Nein—
$.config (anyOf 1).urlstring; {"format":"uri","maxLength":2048}JaHTTP/HTTPS, nur Port 80/443; DNS und Ziel-IP werden bei jeder Prüfung kontrolliert.
$.config (anyOf 1).location_idsarray<string; {"format":"uuid"}>; {"maxItems":4096,"minItems":1}Ja—
$.config (anyOf 1).location_ids[]string; {"format":"uuid"}Ja—
$.config (anyOf 1).policyJSON; {"enum":["any","all","quorum"],"default":"quorum"}NeinStandard ist Quorum mit zwei unterschiedlichen Standorten. Wählen Sie mindestens zwei geeignete Standorte. Explizite any/all-Regeln bleiben verfügbar; standardmäßig sind zwei Fehlbestätigungen je Standort erforderlich. Bei Ping mit N Standorten und Ausfallquorum Q bestätigen N−Q+1 frisch bestätigte gesunde Standorte die Verfügbarkeit; Q bestätigt ausgefallene Standorte bestätigen einen Ausfall. Andere Ergebnisse bleiben unbestätigt oder unbekannt. Unklare Ping-Ergebnisse können eine schnelle Nachprüfung am selben Standort auslösen, begrenzt auf zwei je Monitor und eine je Standort und Minute innerhalb des bestehenden Prüfkontingents. Manuelle Tests beeinflussen die Verfügbarkeit nicht. Frühere Abdeckungslücken bleiben unverändert.
$.config (anyOf 1).quoruminteger; {"maximum":4096,"minimum":1,"default":2}Nein—
$.config (anyOf 1).confirm_failuresinteger; {"maximum":10,"minimum":1}Nein—
$.config (anyOf 1).confirm_successesinteger; {"maximum":10,"minimum":1}Nein—
$.config (anyOf 1).familystring; {"enum":["ipv4","ipv6","dual"],"default":"dual"}Nein—
$.config (anyOf 1).timeout_secondsinteger; {"minimum":1,"maximum":30,"default":8}Nein—
$.config (anyOf 1).expected_status_mininteger; {"minimum":100,"maximum":599}Nein—
$.config (anyOf 1).expected_status_maxinteger; {"minimum":100,"maximum":599}Nein—
$.config (anyOf 1).follow_redirectsboolean; {"default":true}Nein—
$.config (anyOf 1).content_as_downbooleanNein—
$.config (anyOf 1).actions_confirmedbooleanNein—
$.config (anyOf 1).request_body_presentbooleanNein—
$.config (anyOf 2)JobMonitorConfigNeinWählen Sie ein festes UTC-Intervall oder einen Cronausdruck mit fünf Feldern und IANA-Zeitzone. signal=heartbeat verwendet angenommene Lebenszeichen, signal=run Laufereignisse. Ohne Zeitplan werden nur gemeldete Läufe angezeigt. Pause und Konfigurationsänderungen setzen künftige Erwartungen zurück.
$.config (anyOf 2).cronstringNeinFünf Cronfelder mit Listen, Bereichen, Schritten und unterstützten Monats-/Wochentagsnamen.
$.config (anyOf 2).max_runtime_secondsinteger; {"maximum":604800,"minimum":60}NeinOptional; ohne Wert keine Laufzeitgrenze
$.config (anyOf 2).timezonestringNeinIANA-Zeitzone; bei cron verpflichtend
$.config (anyOf 2).tolerance_secondsinteger; {"maximum":86400,"minimum":5}NeinErlaubte Verspätung in Sekunden. Cron verlangt mindestens 30 Sekunden, feste Intervalle mindestens fünf. Standard: 300 beziehungsweise das halbe Intervall bei Intervallen unter 600 Sekunden.
$.config (anyOf 2).interval_secondsinteger; {"minimum":30,"maximum":604800}NeinFestes Intervall in Sekunden (30 bis 604800), unabhängig von Sommerzeit. Nicht mit cron oder timezone kombinierbar.
$.config (anyOf 2).signalstring; {"enum":["run","heartbeat"],"default":"run"}Neinrun erwartet Start- und Abschlussereignisse mit stabilen Laufkennungen. heartbeat nimmt Anfragen ohne Body über seine individuelle geheime URL oder den authentifizierten Telemetrie-Endpunkt an; ein erfolgreicher Programmlauf wird dadurch nicht bestätigt.
$.config (anyOf 2) (allOf 1)JSONNein—
$.config (anyOf 2) (allOf 2)JSONNein—
$.config (anyOf 2) (allOf 3)JSONNein—
$.config (anyOf 2) (allOf 4)JSONNein—
$.config (anyOf 2) (allOf 5)JSONNein—
$.config (anyOf 3)objectNein—
$.config_revisionintegerJa—
$.config_versionintegerJa—
$.external_idstring | nullJa—
$.external_id (anyOf 1)stringNein—
$.external_id (anyOf 2)nullNein—
$.group_idsarray<string; {"format":"uuid"}>JaIDs der aktiven Gruppen dieses Geräts oder ein leeres Array.
$.group_ids[]string; {"format":"uuid"}Ja—
$.http_checkobjectNein—
$.http_check.attemptsinteger | nullJaAnzahl erfasster Verarbeitungs- oder Zustellversuche.
$.http_check.attempts (anyOf 1)integerNein—
$.http_check.attempts (anyOf 2)nullNein—
$.http_check.checked_atstring; {"format":"date-time"} | nullJa—
$.http_check.checked_at (anyOf 1)string; {"format":"date-time"}Nein—
$.http_check.checked_at (anyOf 2)nullNein—
$.http_check.codestring | nullJa—
$.http_check.code (anyOf 1)stringNein—
$.http_check.code (anyOf 2)nullNein—
$.http_check.confirm_statusinteger | nullJa—
$.http_check.confirm_status (anyOf 1)integerNein—
$.http_check.confirm_status (anyOf 2)nullNein—
$.http_check.initial_statusinteger | nullJa—
$.http_check.initial_status (anyOf 1)integerNein—
$.http_check.initial_status (anyOf 2)nullNein—
$.http_check.maintenance_untilstring; {"format":"date-time"} | nullJa—
$.http_check.maintenance_until (anyOf 1)string; {"format":"date-time"}Nein—
$.http_check.maintenance_until (anyOf 2)nullNein—
$.http_check.statusstring | nullJa—
$.http_check.status (anyOf 1)stringNein—
$.http_check.status (anyOf 2)nullNein—
$.http_check.next_check_atstring; {"format":"date-time"} | nullJa—
$.http_check.next_check_at (anyOf 1)string; {"format":"date-time"}Nein—
$.http_check.next_check_at (anyOf 2)nullNein—
$.http_check.quota_detailsQuotaPause | nullJa—
$.http_check.quota_details (anyOf 1)QuotaPauseNeinAlle Budgets, die für die tatsächliche nächste HTTP-Beobachtung nicht ausreichen. Bei Minutenbudgets ist used die Bucket-Kapazität abzüglich der aufgefüllten verfügbaren Tokens. required ist der Bedarf dieser Beobachtung. retry_at ist der späteste benötigte Auffüll- oder Tageswechselzeitpunkt, keine zugesicherte Fortsetzung. never_fits bedeutet, dass bereits eine Beobachtung das gesamte Budget überschreitet und Zurücksetzen nicht hilft.
$.http_check.quota_details (anyOf 1).blockedarray<object>Ja—
$.http_check.quota_details (anyOf 1).blocked[]objectJa—
$.http_check.quota_details (anyOf 1).blocked[].keystring; {"enum":["items_per_day","events_per_day","bytes_per_day","event_bytes_per_day","items_per_minute","points_per_minute","events_per_minute","requests_per_minute","bytes_per_minute"]}Ja—
$.http_check.quota_details (anyOf 1).blocked[].limitnumber; {"minimum":0}Ja—
$.http_check.quota_details (anyOf 1).blocked[].requirednumber; {"minimum":0}Ja—
$.http_check.quota_details (anyOf 1).blocked[].usednumber; {"minimum":0}Ja—
$.http_check.quota_details (anyOf 1).never_fitsbooleanJa—
$.http_check.quota_details (anyOf 1).retry_atstring; {"format":"date-time"} | nullJa—
$.http_check.quota_details (anyOf 1).retry_at (anyOf 1)string; {"format":"date-time"}Nein—
$.http_check.quota_details (anyOf 1).retry_at (anyOf 2)nullNein—
$.http_check.quota_details (anyOf 2)nullNein—
$.http_check.recent_checksarray<object>; {"maxItems":20}JaDie letzten 20 Prüfungen mit Bestätigungsversuchen, Phasenzeiten und sicheren Fehlercodes. Header, Antwortinhalte und URL-Parameter des Ziels sind nicht enthalten.
$.http_check.recent_checks[]objectJa—
$.http_check.recent_checks[].attemptsarray<object>; {"maxItems":2}Ja—
$.http_check.recent_checks[].attempts[]objectJaReine Statusprüfungen enden nach Empfang der Antwortheader, ohne den Inhalt herunterzuladen. Text- und JSON-Prüfungen lesen bis zu 1 MiB (1.048.576 Byte). Größere Antworten erzeugen response_body_too_large und content_match unknown; nur bei content_as_down false richtet sich die Verfügbarkeit weiter allein nach dem HTTP-Status. Andernfalls bleibt ein erwarteter HTTP-Status mit nicht prüfbarem Inhalt unbekannt. Ein unerwarteter HTTP-Status gilt weiterhin als Fehler. Lesefehler verwenden response_body_read_error. Historische response_body-Diagnosen behalten ihre ursprüngliche Bedeutung. Der empfangene HTTP-Status bleibt in allen Fällen erhalten.
$.http_check.recent_checks[].attempts[].body_matchedbooleanNein—
$.http_check.recent_checks[].attempts[].certificate_daysintegerNein—
$.http_check.recent_checks[].attempts[].checked_atstring; {"format":"date-time"}Nein—
$.http_check.recent_checks[].attempts[].duration_msintegerJaMillisekunden bis zum Empfang der Antwortheader bei reinen Statusprüfungen beziehungsweise bis zum begrenzten Einlesen des Inhalts bei Text- und JSON-Prüfungen.
$.http_check.recent_checks[].attempts[].failure_codestring; {"enum":["","dns","target_denied","connection","tls","timeout","response_body","response_body_too_large","response_body_read_error","redirect","http_status","body_mismatch"]}Nein—
$.http_check.recent_checks[].attempts[].healthybooleanNein—
$.http_check.recent_checks[].attempts[].hopsarray<object>; {"maxItems":4}Nein—
$.http_check.recent_checks[].attempts[].hops[]objectJa—
$.http_check.recent_checks[].attempts[].hops[].connect_msnumberNein—
$.http_check.recent_checks[].attempts[].hops[].dns_msnumberJa—
$.http_check.recent_checks[].attempts[].hops[].duration_msnumberJa—
$.http_check.recent_checks[].attempts[].hops[].familystring; {"enum":["ipv4","ipv6"]}Nein—
$.http_check.recent_checks[].attempts[].hops[].statusintegerNein—
$.http_check.recent_checks[].attempts[].hops[].tls_msnumberNein—
$.http_check.recent_checks[].attempts[].hops[].ttfb_msnumberNein—
$.http_check.recent_checks[].attempts[].initial_statusintegerNein—
$.http_check.recent_checks[].attempts[].redirectsintegerJa—
$.http_check.recent_checks[].attempts[].statusintegerJa—
$.http_check.recent_checks[].checked_atstring; {"format":"date-time"}Ja—
$.http_check.recent_checks[].codestringJa—
$.http_check.recent_checks[].statestringJa—
$.idstringJaUUID dieser Ressource. Bewahren Sie die zurückgegebene Kennung für weitere Operationen auf.
$.last_heartbeat_atstring; {"format":"date-time"} | nullJaZeitpunkt des letzten angenommenen Gerätekontakts; null vor dem ersten Kontakt.
$.last_heartbeat_at (anyOf 1)string; {"format":"date-time"}Nein—
$.last_heartbeat_at (anyOf 2)nullNein—
$.namestringJaLesbarer Ressourcenname. Beachten Sie die angegebene Längengrenze.
$.pausedbooleanJaOb automatische Monitorarbeit pausiert ist. Vorhandene Messdaten und Historien bleiben erhalten.
$.typestringJa—
$.workspace_idstringJaUUID des zugehörigen Arbeitsbereichs. Zugriff wird gegen das angemeldete Konto geprüft.
$.data_flowMonitorDataFlowNeinBestätigter Übertragungszeitpunkt, erwartete Messintervalle und Verarbeitung dieses Monitors. Tageskontingent-Hinweise beschreiben die aktuelle Kapazität des Kontos, keine erfasste Ablehnung. Die Anzahl der Historienabfragen gehört ausschließlich dem anfragenden Nutzer.
$.data_flow.active_seriesinteger; {"minimum":0}Ja—
$.data_flow.archive_pendingbooleanJa—
$.data_flow.archive_queriesinteger; {"minimum":0}Ja—
$.data_flow.checked_atstring; {"format":"date-time"}Ja—
$.data_flow.interval_max_secondsinteger | nullJa—
$.data_flow.interval_min_secondsinteger | nullJa—
$.data_flow.last_received_atstring; {"format":"date-time"} | nullJa—
$.data_flow.last_received_at (anyOf 1)string; {"format":"date-time"}Nein—
$.data_flow.last_received_at (anyOf 2)nullNein—
$.data_flow.quota_exhaustedarray<string; {"enum":["items","events","bytes","event_bytes"]}>Ja—
$.data_flow.quota_exhausted[]string; {"enum":["items","events","bytes","event_bytes"]}Ja—
$.data_flow.rate_limitsarray<object>Ja—
$.data_flow.rate_limits[]objectJa—
$.data_flow.rate_limits[].resourcestring; {"enum":["items","events","requests","bytes"]}Ja—
$.data_flow.rate_limits[].retry_secondsinteger; {"minimum":1}Ja—
$.data_flow.rollup_pendingbooleanJa—
$.data_flow.deliveryobject | nullNein—
$.data_flow.delivery (anyOf 1)objectNein—
$.data_flow.delivery (anyOf 1).reportAgentDeliveryReportJa—
$.data_flow.delivery (anyOf 1).report.observed_atstring; {"format":"date-time"}Ja—
$.data_flow.delivery (anyOf 1).report.pending_objectsinteger; {"minimum":0,"maximum":10000000}Ja—
$.data_flow.delivery (anyOf 1).report.pending_bytesinteger; {"minimum":0,"maximum":1073741824}Ja—
$.data_flow.delivery (anyOf 1).report.oldest_measured_atstring; {"format":"date-time"}Nein—
$.data_flow.delivery (anyOf 1).report.last_acknowledged_atstring; {"format":"date-time"}Nein—
$.data_flow.delivery (anyOf 1).report.retry_atstring; {"format":"date-time"}Nein—
$.data_flow.delivery (anyOf 1).report.lost_objectsinteger; {"minimum":0}Ja—
$.data_flow.delivery (anyOf 1).report.last_errorobject; {"additionalProperties":false}Nein—
$.data_flow.delivery (anyOf 1).report.last_error.atstring; {"format":"date-time"}Ja—
$.data_flow.delivery (anyOf 1).report.last_error.kindstring; {"enum":["timeout","connection","tls","http","ack","storage"]}Ja—
$.data_flow.delivery (anyOf 1).report.last_error.statusinteger; {"minimum":0,"maximum":599}Nein—
$.data_flow.delivery (anyOf 1).report.last_error.codestring; {"enum":["","quota_exceeded","global_capacity","unavailable","http_error"]}Nein—
$.data_flow.delivery (anyOf 1).report.last_error.limitstring; {"enum":["","point_per_minute","point_per_day","event_per_minute","event_per_day","event_bytes_per_day","request_per_minute","bytes_per_minute","bytes_per_day","global_items"]}Nein—
$.data_flow.delivery (anyOf 1).reported_atstring; {"format":"date-time"}Ja—
$.data_flow.delivery (anyOf 1).freshbooleanJa—
$.data_flow.delivery (anyOf 2)nullNein—
$.maintenance_pendingbooleanJaWahr, solange der aufbereitete Wartungsstand noch nicht aktuell ist. Dies bestätigt nicht, dass keine Wartung aktiv ist.
json
{
  "config": {
    "url": "https://example.com/callback",
    "location_ids": [
      "00000000-0000-4000-8000-000000000001"
    ],
    "family": "dual",
    "policy": "any",
    "confirm_failures": 2,
    "confirm_successes": 2,
    "timeout_seconds": 8
  },
  "config_revision": 0,
  "config_version": 0,
  "external_id": "demo",
  "group_ids": [],
  "id": "demo",
  "last_heartbeat_at": "2026-09-30T12:00:00Z",
  "name": "demo",
  "paused": false,
  "type": "demo",
  "workspace_id": "demo",
  "maintenance_pending": false
}
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
not_found
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": 404,
  "title": "Demo error",
  "type": "about:blank"
}
Stabile Fehlercodes
invalid_monitor
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": 422,
  "title": "Demo error",
  "type": "about:blank"
}
Stabile Fehlercodes
unavailable
account_busy
database_lock_timeout
database_timeout
database_unavailable
database_error
request_cancelled
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/monitors/00000000-0000-4000-8000-000000000001"
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/monitors/00000000-0000-4000-8000-000000000001", 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/monitors/00000000-0000-4000-8000-000000000001", {
  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/monitors/00000000-0000-4000-8000-000000000001", 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)
}
  • HTTP-API, OAuth und MCP

    Finden Sie die Nutzer-API-Endpunkte mit Rechten, Feldern, Beispielen und Antwortformaten.

  • DELETE Einen Monitor endgültig löschen

    Nur der Eigentümer des Arbeitsbereichs darf einen Monitor endgültig löschen. Zuerst eine fünf Minuten gültige, an die Konfiguration gebundene Vorschau anfordern; danach preview_id, confirm_deletion: true und einen Idempotency-Key senden. Unbestätigte alte Archivierungsaufrufe werden abgewiesen. Der Monitor wird sofort gesperrt; ein dauerhafter Auftrag entfernt seine Datenbank-, Archiv- und Cachedaten und bereinigt verknüpfte Anzeigen. Den Auftrag bis zum Abschluss abfragen; pausierte Aufträge zeigen einen technischen Fehler und werden automatisch wiederholt. Tageskontingente und Sicherheitszähler bleiben unverändert. Bereits zugestellte Nachrichten und heruntergeladene Dateien können nicht zurückgeholt werden.

  • PATCH Monitor mit Revisionsprüfung aktualisieren

    Monitor mit Revisionsprüfung aktualisieren.

  • POST HTTP-Erreichbarkeits- und Zertifikatsalarme ausdrücklich speichern

    Legen Sie nur gewählte Alarmvorschläge innerhalb der Kontolimits an. Die Wiederverwendung eines Vorschlags erhält spätere Bearbeitungen.