Dokumentation / API · Geräte / Sichtbare Server einer Live-Liste auswählen PUT Sichtbare Server einer Live-Liste auswählen/api/v1/devices/live/viewport
Wählen Sie bis zu 50 sichtbare Serverkennungen für Ihre eigene Live-Verbindung aus. Erforderlich ist eine Viewer-Sitzung mit demselben Arbeitsbereich, denselben Browser-Cookies und CSRF-Schutz. Nur Kennungen der aktuellen Seite können Live-Werte liefern. Ausgewählte Server werden mit dem nächsten Sekundentakt aktualisiert; Quelldetails bleiben in Tooltips verfügbar. Eine leere Liste pausiert Messwertaktualisierungen bei weiterhin aktiver Verbindung. Die Auswahl endet mit dem Schließen der Verbindung.
Auf dieser Seite Zugriff und Rechte Parameter und Header Anfragekörper Antworten Wiederholungen und asynchrone Aufträge Anfragebeispiele Verwandte Anleitungen Wählen Sie bis zu 50 sichtbare Serverkennungen für Ihre eigene Live-Verbindung aus. Erforderlich ist eine Viewer-Sitzung mit demselben Arbeitsbereich, denselben Browser-Cookies und CSRF-Schutz. Nur Kennungen der aktuellen Seite können Live-Werte liefern. Ausgewählte Server werden mit dem nächsten Sekundentakt aktualisiert; Quelldetails bleiben in Tooltips verfügbar. Eine leere Liste pausiert Messwertaktualisierungen bei weiterhin aktiver Verbindung. Die Auswahl endet mit dem Schließen der Verbindung.
Browsersitzung: Cookie __Host-mb_session.
Senden Sie bei einer Änderung mit Browsersitzung das aktuelle CSRF-Token in X-CSRF-Token zusammen mit dem Same-Site-Cookie. OAuth-Zustimmung verwendet ihr dokumentiertes Formularfeld.
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. X-CSRF-Token Header string Ja Wert des Browser-CSRF-Cookies. Bei einem zulässigen Maschinen-Verwaltungszugang nicht erforderlich. Origin Header string; {"format":"uri"} Nein Muss, falls vorhanden, dem kanonischen HTTPS-Origin entsprechen. Sec-Fetch-Site cross-site wird abgewiesen.
Feld Typ und Grenzen Erforderlich Bedeutung $ object; {"additionalProperties":false} Ja — $.stream_id string; {"format":"uuid"} Ja Eindeutige UUID dieser Live-Verbindung im Browser. $.device_ids array<string; {"format":"uuid"}>; {"maxItems":50} Ja Sichtbare Serverkennungen der aktuellen Seite; ein leeres Array pausiert Messwertaktualisierungen. $.device_ids[] string; {"format":"uuid"} Ja —
401 · Anfrage abgewiesen. Prüfen Sie den stabilen Fehlercode. 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 —
403 · Anfrage abgewiesen. Prüfen Sie den stabilen Fehlercode. Stabile Fehlercodes browser_session_required csrf insufficient_scope invalid_origin workspace_scope
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 —
404 · Anfrage abgewiesen. Prüfen Sie den stabilen Fehlercode. 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 —
422 · Anfrage abgewiesen. Prüfen Sie den stabilen Fehlercode. Stabile Fehlercodes invalid_cursor invalid_filters invalid_live invalid_selection live_limit
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 —
503 · Anfrage abgewiesen. Prüfen Sie den stabilen Fehlercode. 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 —
429 · Anfrage abgewiesen. Prüfen Sie den stabilen Fehlercode. 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 —
204 · Sichtbare Server einer Live-Liste auswählen Für diese Änderung gibt es keine allgemeine Wiederholungsgarantie. Prüfen Sie bei unklarer Antwort den betroffenen Eintrag, bevor Sie es erneut versuchen. Beachten Sie Wartezeiten aus Retry-After und fordern Sie abgelaufene Anmelde- oder Aktionscodes neu an.
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 Beispiel kopieren
curl --silent --show-error --output /dev/ null --write-out "%{http_code}\n" \
--request PUT --header @ "$HOME/.config/metribeacon/headers.txt" \
--header 'Content-Type: application/json' --data '{"stream_id":"00000000-0000-4000-8000-000000000002","device_ids":[]}' \
'https://metribeacon.com/api/v1/devices/live/viewport?workspace_id=00000000-0000-4000-8000-000000000001'
python Beispiel kopieren
import json
from pathlib import Path
from urllib.request import Request, urlopen
headers = json.loads((Path.home() / ".config/metribeacon/headers.json" ).read_text())
headers[ "Content-Type" ] = "application/json"
request = Request( 'https://metribeacon.com/api/v1/devices/live/viewport?workspace_id=00000000-0000-4000-8000-000000000001' , data=b '{"stream_id":"00000000-0000-4000-8000-000000000002","device_ids":[]}' , headers=headers, method= "PUT" )
with urlopen(request, timeout=10) as response:
print(response.status)
javascript Beispiel kopieren
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/live/viewport?workspace_id=00000000-0000-4000-8000-000000000001" , {method: "PUT" , headers:{...headers, "Content-Type" : "application/json" }, body: "{\"stream_id\":\"00000000-0000-4000-8000-000000000002\",\"device_ids\":[]}" , signal:AbortSignal.timeout(10000), redirect: "error" });
console.log(response.status);
await response.body?.cancel();
go Beispiel kopieren
package main
import ( "encoding/json" ; "fmt" ; "net/http" ; "os" ; "path/filepath" ; "strings" ; "time" )
func main() {
home, err := os.UserHomeDir(); if err != nil { panic( "request failed" ) }
raw, err := os.ReadFile(filepath.Join(home, ".config/metribeacon/headers.json" )); if err != nil { panic( "request failed" ) }
var headers map[string]string; if json.Unmarshal(raw,&headers) != nil { panic( "invalid headers" ) }
request, err := http.NewRequest( "PUT" , "https://metribeacon.com/api/v1/devices/live/viewport?workspace_id=00000000-0000-4000-8000-000000000001" ,strings.NewReader(`{ "stream_id" : "00000000-0000-4000-8000-000000000002" , "device_ids" :[]}`)); if err != nil { panic( "request failed" ) }
for name,value := range headers { request.Header.Set(name,value) }
request.Header.Set( "Content-Type" , "application/json" )
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" ) }
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 Live-Monitor- und ServerlistenÜberträgt die ausgewählte Monitorseite. Monitor- und Serverlisten unterstützen stream_format=patches mit einer eindeutigen stream_id: Das erste devices-Ereignis ist vollständig; folgende devices_patch-Ereignisse enthalten base, seq, observed_at und optional eine verlustfreie Änderung. Ein Array mit einem Element ersetzt einen Wert; ein leeres Array entfernt ein Objektfeld; o ändert Objektfelder; a ändert Arraypositionen mit n als neuer Länge. Fehlende Änderungen sind Live-Lebenszeichen. Eine Lücke in der Folge verlangt einen neuen vollständigen Stream. Der Viewport-Endpunkt wählt sichtbare Monitore aus; sämtliche Messwert- und Tooltipfelder bleiben erhalten. Ohne dieses Format behalten devices- und server_metrics-Ereignisse ihr bisheriges Verhalten.
GET Geräte im Arbeitsbereich suchen und seitenweise lesenGeräte im Arbeitsbereich suchen und seitenweise lesen.
POST Gerät erstellenGerät erstellen.