GET Aktuelle autorisierte Serverübersichten und entfernte Kennungen.
/api/v1/devices/summaries
Lesen Sie aktuelle Werte und Kontaktstatus für bis zu 50 Server eines Arbeitsbereichs. Nur Browsersitzungen. Unbekannte, entfernte oder verschobene Kennungen stehen in removed_ids, ohne andere Arbeitsbereiche offenzulegen.
Auf dieser Seite
Zugriff und Rechte
Lesen Sie aktuelle Werte und Kontaktstatus für bis zu 50 Server eines Arbeitsbereichs. Nur Browsersitzungen. Unbekannte, entfernte oder verschobene Kennungen stehen in removed_ids, ohne andere Arbeitsbereiche offenzulegen.
Browsersitzung: Cookie __Host-mb_session.
Parameter und Header
| Feld | Position | Typ und Grenzen | Erforderlich | Bedeutung |
|---|---|---|---|---|
| workspace_id | URL-Parameter | string; {"format":"uuid"} | Ja | UUID eines eigenen Arbeitsbereichs. Ist sie optional, wählt Weglassen den dokumentierten Standard oder alle eigenen Arbeitsbereiche. |
| device_ids | URL-Parameter | array<string; {"format":"uuid"}>; {"minItems":1,"maxItems":50} | Ja | Kommagetrennte, eindeutige Serverkennungen; mindestens eine, höchstens 50. |
Anfragekörper
Kein Anfragekörper.
Antworten
| Stabile Fehlercodes |
|---|
| unauthorized |
| invalid_credential |
| session_revoked |
| 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 |
|---|
| workspace_scope |
| browser_session_required |
| invalid_origin |
| insufficient_scope |
| csrf |
| 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 |
|---|
| not_found |
| 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": 404,
"title": "Demo error",
"type": "about:blank"
}| Stabile Fehlercodes |
|---|
| invalid_live |
| live_limit |
| invalid_selection |
| 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": 422,
"title": "Demo error",
"type": "about:blank"
}| Stabile Fehlercodes |
|---|
| feature_unavailable |
| stream_unavailable |
| 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 |
|---|
| feature_unavailable |
| unavailable |
| live_capacity |
| 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"
}application/json
| Feld | Typ und Grenzen | Erforderlich | Bedeutung |
|---|---|---|---|
| $ | ServerSummarySnapshot | Ja | — |
| $.workspace_id | string; {"format":"uuid"} | Ja | — |
| $.observed_at | string; {"format":"date-time"} | Ja | — |
| $.devices | array<object>; {"maxItems":50} | Ja | — |
| $.devices[] | object | Ja | — |
| $.devices[].id | string | Ja | UUID dieser Ressource. Bewahren Sie die zurückgegebene Kennung für weitere Operationen auf. |
| $.devices[].workspace_id | string | Ja | UUID des zugehörigen Arbeitsbereichs. Zugriff wird gegen das angemeldete Konto geprüft. |
| $.devices[].paused | boolean | Ja | Ob automatische Monitorarbeit pausiert ist. Vorhandene Messdaten und Historien bleiben erhalten. |
| $.devices[].attention | boolean | Ja | — |
| $.devices[].last_heartbeat_at | string; {"format":"date-time"} | null | Ja | Zeitpunkt des letzten angenommenen Gerätekontakts; null vor dem ersten Kontakt. |
| $.devices[].last_heartbeat_at (anyOf 1) | string; {"format":"date-time"} | Nein | — |
| $.devices[].last_heartbeat_at (anyOf 2) | null | Nein | — |
| $.devices[].summary | MonitorListSummary | Ja | Optionale Kennzahlen ausschließlich für diese Seite: stabile Kennungen, Werte, Einheiten, Aktualität und Quellenzeitpunkte. Fehlende bevorzugte Kennzahlen werden durch aktuelle erfasste Alternativen ersetzt; vorhandene veraltete Werte bleiben sichtbar. Zustandsgruppen unterscheiden bestätigt Ja, bestätigt Nein und Quellen ohne aktuellen Wert. Ersatzkennzahlen nennen die fehlende Messgröße und deren Grund. Es wird keine zusätzliche Erfassung aktiviert. |
| $.devices[].summary.attention_reasons | array<string; {"maxLength":128}>; {"maxItems":8} | Nein | Bezeichnungen von bis zu acht nicht entwarnten Alarmen, kritische zuerst. Bestätigte Alarme sind enthalten, archivierte Regeln ausgeschlossen. |
| $.devices[].summary.attention_reasons[] | string; {"maxLength":128} | Ja | — |
| $.devices[].summary.attention_count | integer; {"minimum":0} | Nein | Gesamtzahl der nicht entwarnten Alarme, auf die der Monitorhinweis verweist. |
| $.devices[].summary.status | string; {"enum":["available","unavailable"]} | Ja | — |
| $.devices[].summary.target | string | Ja | — |
| $.devices[].summary.system | string | Ja | — |
| $.devices[].summary.interval_seconds | integer; {"minimum":0} | Ja | — |
| $.devices[].summary.metrics | array<object; {"additionalProperties":false}>; {"maxItems":3} | Ja | — |
| $.devices[].summary.metrics[] | object; {"additionalProperties":false} | Ja | — |
| $.devices[].summary.metrics[].key | string | Ja | — |
| $.devices[].summary.metrics[].value | number | string | null | Ja | — |
| $.devices[].summary.metrics[].unit | string | Ja | — |
| $.devices[].summary.metrics[].freshness | string; {"enum":["fresh","stale","missing","reported","scheduled"]} | Ja | — |
| $.devices[].summary.metrics[].reason | string | Nein | — |
| $.devices[].summary.metrics[].measured_at | string; {"format":"date-time"} | null | Ja | — |
| $.devices[].summary.metrics[].measured_at (anyOf 1) | string; {"format":"date-time"} | Nein | — |
| $.devices[].summary.metrics[].measured_at (anyOf 2) | null | Nein | — |
| $.devices[].summary.metrics[].valid_until | string; {"format":"date-time"} | null | Ja | — |
| $.devices[].summary.metrics[].valid_until (anyOf 1) | string; {"format":"date-time"} | Nein | — |
| $.devices[].summary.metrics[].valid_until (anyOf 2) | null | Nein | — |
| $.devices[].summary.metrics[].sources | array<object; {"additionalProperties":false}> | Ja | — |
| $.devices[].summary.metrics[].sources[] | object; {"additionalProperties":false} | Ja | — |
| $.devices[].summary.metrics[].sources[].series_id | string; {"format":"uuid"} | Nein | — |
| $.devices[].summary.metrics[].sources[].name | string | Ja | — |
| $.devices[].summary.metrics[].sources[].measured_at | string; {"format":"date-time"} | null | Ja | — |
| $.devices[].summary.metrics[].sources[].valid_until | string; {"format":"date-time"} | null | Ja | — |
| $.devices[].summary.metrics[].sources[].value | number | string | null | Nein | — |
| $.devices[].summary.metrics[].sources[].label_key | string | Nein | — |
| $.devices[].summary.metrics[].sources[].component | string | Nein | — |
| $.devices[].summary.metrics[].sources[].freshness | string; {"enum":["fresh","stale","missing"]} | Nein | — |
| $.devices[].summary.metrics[].sources[].unit | string | Nein | Originaleinheit des einzelnen Quellenwerts; eine leere Zeichenfolge bezeichnet einen Wert ohne Einheit. |
| $.devices[].summary.metrics[].used | number | Nein | — |
| $.devices[].summary.metrics[].total | number | Nein | — |
| $.devices[].summary.metrics[].cores | number | Nein | — |
| $.devices[].summary.metrics[].path | string | Nein | — |
| $.devices[].summary.metrics[].engine | string | Nein | — |
| $.devices[].summary.metrics[].configured | integer; {"minimum":0} | Nein | — |
| $.devices[].summary.metrics[].id | string | Ja | — |
| $.devices[].summary.metrics[].label_key | string | Nein | — |
| $.devices[].summary.metrics[].name | string | Nein | — |
| $.devices[].summary.metrics[].component | string | Nein | — |
| $.devices[].summary.metrics[].kind | string; {"enum":["gauge","counter","boolean","enum"]} | Nein | — |
| $.devices[].summary.metrics[].aggregation | string; {"enum":["mean","min"]} | Nein | — |
| $.devices[].summary.metrics[].replaces | object; {"additionalProperties":false} | Nein | — |
| $.devices[].summary.metrics[].replaces.key | string | Ja | — |
| $.devices[].summary.metrics[].replaces.reason | string | Ja | — |
| $.devices[].summary.metrics[].group | object; {"additionalProperties":false} | Nein | — |
| $.devices[].summary.metrics[].group.total | integer; {"minimum":0} | Ja | — |
| $.devices[].summary.metrics[].group.positive | integer; {"minimum":0} | Ja | — |
| $.devices[].summary.metrics[].group.negative | integer; {"minimum":0} | Ja | — |
| $.devices[].summary.metrics[].group.unknown | integer; {"minimum":0} | Ja | — |
| $.devices[].summary.favicon_url | string | Nein | Relative, authentifizierte Bild-URL für das Favicon eines HTTP- oder Browser-Monitors. |
| $.devices[].summary.location_count | integer; {"minimum":0} | Ja | — |
| $.devices[].summary.platform | string; {"enum":["linux","darwin","windows"]} | Nein | Vom Agenten gemeldetes Betriebssystem. Fehlt, wenn es unbekannt ist. |
| $.devices[].summary.last_value_received_at | string; {"format":"date-time"} | null | Nein | Empfangszeit des neuesten aufbewahrten originalen Zahlen- oder Zustandswerts aller aktiven Messreihen. Lebenszeichen, Textmeldungen, deaktivierte Reihen und berechnete Werte zählen nicht. Null, wenn kein solcher Wert vorliegt. |
| $.devices[].summary.last_value_received_at (anyOf 1) | string; {"format":"date-time"} | Nein | — |
| $.devices[].summary.last_value_received_at (anyOf 2) | null | Nein | — |
| $.devices[].summary.agent_update | AgentUpdateInfo | Nein | — |
| $.devices[].summary.agent_update.operating_system | string | Ja | — |
| $.devices[].summary.agent_update.installed_version | string | Ja | — |
| $.devices[].summary.agent_update.latest_version | string | Ja | — |
| $.devices[].summary.agent_update.state | string; {"enum":["unknown","current","update_available"]} | Ja | — |
| $.devices[].summary.agent_update.reason | string | Ja | — |
| $.devices[].summary.agent_update.can_update | boolean | Ja | — |
| $.devices[].summary.agent_update.target_id | string | Ja | — |
| $.devices[].summary.agent_update.job | AgentUpdateJob | Nein | — |
| $.devices[].summary.agent_update.job.id | string; {"format":"uuid"} | Ja | — |
| $.devices[].summary.agent_update.job.installation_id | string; {"pattern":"^[0-9a-f]{32}$"} | Ja | — |
| $.devices[].summary.agent_update.job.state | string; {"enum":["pending","running","succeeded","failed","expired","unconfirmed"]} | Ja | — |
| $.devices[].summary.agent_update.job.phase | string; {"enum":["downloading","installing","restarting","completed"]} | Ja | — |
| $.devices[].summary.agent_update.job.target | AgentUpdateTarget | Ja | — |
| $.devices[].summary.agent_update.job.target.commit | string; {"pattern":"^[0-9a-f]{40}$"} | Ja | — |
| $.devices[].summary.agent_update.job.target.version | string | Ja | — |
| $.devices[].summary.agent_update.job.target.created_at | string; {"format":"date-time"} | Ja | — |
| $.devices[].summary.agent_update.job.target.file | object; {"additionalProperties":false} | Ja | — |
| $.devices[].summary.agent_update.job.target.file.name | string | Ja | — |
| $.devices[].summary.agent_update.job.target.file.platform | string; {"enum":["linux","darwin","windows"]} | Ja | — |
| $.devices[].summary.agent_update.job.target.file.architecture | string; {"enum":["amd64","arm64"]} | Ja | — |
| $.devices[].summary.agent_update.job.target.file.kind | string; {"const":"binary"} | Ja | — |
| $.devices[].summary.agent_update.job.target.file.sha256 | string; {"pattern":"^[0-9a-f]{64}$"} | Ja | — |
| $.devices[].summary.agent_update.job.target.file.size | integer; {"minimum":1,"maximum":268435456} | Ja | — |
| $.devices[].summary.agent_update.job.requested_at | string; {"format":"date-time"} | Ja | — |
| $.devices[].summary.agent_update.job.updated_at | string; {"format":"date-time"} | Ja | — |
| $.devices[].summary.agent_update.job.claimed_at | string; {"format":"date-time"} | null | Ja | — |
| $.devices[].summary.agent_update.job.claimed_at (anyOf 1) | string; {"format":"date-time"} | Nein | — |
| $.devices[].summary.agent_update.job.claimed_at (anyOf 2) | null | Nein | — |
| $.devices[].summary.agent_update.job.finished_at | string; {"format":"date-time"} | null | Ja | — |
| $.devices[].summary.agent_update.job.finished_at (anyOf 1) | string; {"format":"date-time"} | Nein | — |
| $.devices[].summary.agent_update.job.finished_at (anyOf 2) | null | Nein | — |
| $.devices[].summary.agent_update.job.error_code | string | Ja | — |
| $.devices[].summary.agent_update.job.monitor_id | string; {"format":"uuid"} | Ja | — |
| $.devices[].summary.agent_update.job.operation_id | string; {"format":"uuid"} | Ja | — |
| $.devices[].summary.agent_update.job.source_version | string; {"maxLength":128} | Ja | — |
| $.devices[].summary.agent_update.job.source_sha256 | string; {"pattern":"^[0-9a-f]{64}$"} | Ja | — |
| $.devices[].expected_heartbeat_seconds | integer; {"minimum":1} | Ja | — |
| $.devices[].heartbeat_status | string; {"enum":["fresh","stale","missing"]} | Ja | — |
| $.devices[].heartbeat_valid_until | string; {"format":"date-time"} | null | Ja | — |
| $.devices[].heartbeat_valid_until (anyOf 1) | string; {"format":"date-time"} | Nein | — |
| $.devices[].heartbeat_valid_until (anyOf 2) | null | Nein | — |
| $.removed_ids | array<string; {"format":"uuid"}>; {"maxItems":50} | Ja | — |
| $.removed_ids[] | string; {"format":"uuid"} | Ja | — |
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/devices/summaries?workspace_id=00000000-0000-4000-8000-000000000001&device_ids=00000000-0000-4000-8000-000000000002"
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/devices/summaries?workspace_id=00000000-0000-4000-8000-000000000001&device_ids=00000000-0000-4000-8000-000000000002", 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/devices/summaries?workspace_id=00000000-0000-4000-8000-000000000001&device_ids=00000000-0000-4000-8000-000000000002", {
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/devices/summaries?workspace_id=00000000-0000-4000-8000-000000000001&device_ids=00000000-0000-4000-8000-000000000002", 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.
- GET Empfangen Sie vollständige summaries-Ereignisse für die ausgewählten Server, auch zu Beginn und nach Wiederverbindung. Neu gespeicherte Werte erscheinen bei gesunder Verbindung innerhalb von fünf Sekunden. Ein Kontrollabgleich erfolgt alle vier Sekunden; Sitzung und Bereichszugriff werden vor jeder Ausgabe geprüft. access_revoked entfernt private Werte und beendet die Verbindung. Hintergrundtabs sollen die Verbindung schließen.
Empfangen Sie vollständige summaries-Ereignisse für die ausgewählten Server, auch zu Beginn und nach Wiederverbindung. Neu gespeicherte Werte erscheinen bei gesunder Verbindung innerhalb von fünf Sekunden. Ein Kontrollabgleich erfolgt alle vier Sekunden; Sitzung und Bereichszugriff werden vor jeder Ausgabe geprüft. access_revoked entfernt private Werte und beendet die Verbindung. Hintergrundtabs sollen die Verbindung schließen.
- GET Geräte im Arbeitsbereich suchen und seitenweise lesen
Geräte im Arbeitsbereich suchen und seitenweise lesen.
- POST Gerät erstellen
Gerät erstellen.