MetriBeacon
Menü
Deutsch

GET Gespeicherte Einrichtung und angenommene Messdaten lesen

/api/v1/onboarding

Der Fortschritt enthält Ressourcenkennungen und Zeitpunkte angenommener Daten, niemals gespeicherte Geräteschlüssel. Ein laufender lokaler Prozess allein schließt die Einrichtung nicht ab.

Auf dieser Seite

Zugriff und Rechte

Der Fortschritt enthält Ressourcenkennungen und Zeitpunkte angenommener Daten, niemals gespeicherte Geräteschlüssel. Ein laufender lokaler Prozess allein schließt die Einrichtung nicht ab.

Browsersitzung: Cookie __Host-mb_session.

Parameter und Header

Keine Pfad-, Query- oder zusätzlichen Anfrageheader-Parameter.

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).flownullJa—
$ (anyOf 2)objectNein—
$ (anyOf 2).flowobjectJa—
$ (anyOf 2).flow.alarm_idstring | nullJa—
$ (anyOf 2).flow.alarm_id (anyOf 1)stringNein—
$ (anyOf 2).flow.alarm_id (anyOf 2)nullNein—
$ (anyOf 2).flow.completed_atstring; {"format":"date-time"} | nullJaAbschlusszeitpunkt; null solange kein Abschluss erfasst ist.
$ (anyOf 2).flow.completed_at (anyOf 1)string; {"format":"date-time"}Nein—
$ (anyOf 2).flow.completed_at (anyOf 2)nullNein—
$ (anyOf 2).flow.created_atstring; {"format":"date-time"}JaErstellungszeitpunkt in RFC 3339 UTC.
$ (anyOf 2).flow.device_idstringJaUUID des Zielgeräts oder Monitors. Der Schreibschlüssel muss dieses Gerät erlauben.
$ (anyOf 2).flow.heartbeat_confirmed_atstring; {"format":"date-time"} | nullJa—
$ (anyOf 2).flow.heartbeat_confirmed_at (anyOf 1)string; {"format":"date-time"}Nein—
$ (anyOf 2).flow.heartbeat_confirmed_at (anyOf 2)nullNein—
$ (anyOf 2).flow.integrationstringJa—
$ (anyOf 2).flow.key_idstring | nullJa—
$ (anyOf 2).flow.key_id (anyOf 1)stringNein—
$ (anyOf 2).flow.key_id (anyOf 2)nullNein—
$ (anyOf 2).flow.measurement_confirmed_atstring; {"format":"date-time"} | nullJaZeitpunkt, an dem ein ausgewählter Zahlen- oder Zustandswert nach Beginn der Einrichtung tatsächlich empfangen und gespeichert wurde. Die Agent-Messreihen können erst nach der Profilbereitstellung zugeordnet werden. Ein Installer-Ergebnis, Prozessstatus oder nicht ausgewählter Wert bestätigt den Empfang nicht.
$ (anyOf 2).flow.measurement_confirmed_at (anyOf 1)string; {"format":"date-time"}Nein—
$ (anyOf 2).flow.measurement_confirmed_at (anyOf 2)nullNein—
$ (anyOf 2).flow.seriesobjectJa—
$ (anyOf 2).flow.updated_atstring; {"format":"date-time"}JaVersion der gespeicherten Einrichtung zur Bestätigung einer Auswahländerung.
$ (anyOf 2).flow.workspace_idstringJaUUID des zugehörigen Arbeitsbereichs. Zugriff wird gegen das angemeldete Konto geprüft.
$ (anyOf 2).flow.server_profileServerProfileRequestNein—
$ (anyOf 2).flow.server_profile.componentsarray<object>; {"maxItems":200} | nullNeinErkannte oder ausdrücklich ausgewählte Serverkomponenten.
$ (anyOf 2).flow.server_profile.components (anyOf 1)array<object>; {"maxItems":200}Nein—
$ (anyOf 2).flow.server_profile.components (anyOf 1)[]objectJa—
$ (anyOf 2).flow.server_profile.components (anyOf 1)[].addressstringNein—
$ (anyOf 2).flow.server_profile.components (anyOf 1)[].familystringNein—
$ (anyOf 2).flow.server_profile.components (anyOf 1)[].idstringJaUUID dieser Ressource. Bewahren Sie die zurückgegebene Kennung für weitere Operationen auf.
$ (anyOf 2).flow.server_profile.components (anyOf 1)[].kindstringJaRessourcenart oder Messwerttyp aus den angegebenen Werten.
$ (anyOf 2).flow.server_profile.components (anyOf 1)[].labelstring; {"maxLength":128,"minLength":1}JaAnzeigename der Komponente.
$ (anyOf 2).flow.server_profile.components (anyOf 1)[].local_refstringNein—
$ (anyOf 2).flow.server_profile.components (anyOf 1)[].namestringNeinLesbarer Ressourcenname. Beachten Sie die angegebene Längengrenze.
$ (anyOf 2).flow.server_profile.components (anyOf 1)[].pathstring; {"maxLength":1024}Nein—
$ (anyOf 2).flow.server_profile.components (anyOf 1)[].portintegerNein—
$ (anyOf 2).flow.server_profile.components (anyOf 1)[].projectstringNein—
$ (anyOf 2).flow.server_profile.components (anyOf 1)[].protocolstringNein—
$ (anyOf 2).flow.server_profile.components (anyOf 1)[].text_languagesobjectNein—
$ (anyOf 2).flow.server_profile.components (anyOf 1)[].timeout_secondsintegerNein—
$ (anyOf 2).flow.server_profile.components (anyOf 1)[].translationsobject; {"additionalProperties":false}Nein—
$ (anyOf 2).flow.server_profile.components (anyOf 1)[].translations.deobjectNein—
$ (anyOf 2).flow.server_profile.components (anyOf 1)[].translations.enobjectNein—
$ (anyOf 2).flow.server_profile.components (anyOf 1)[].transportstringNein—
$ (anyOf 2).flow.server_profile.components (anyOf 1)[].filesystem_identitystring; {"maxLength":256}NeinVom Agenten gemeldete Volumeidentität. Unverändert beibehalten, damit ein Ersatzvolume nicht die Historie eines anderen Volumes fortsetzt.
$ (anyOf 2).flow.server_profile.components (anyOf 1)[].disk_identitystring; {"maxLength":256}Nein—
$ (anyOf 2).flow.server_profile.components (anyOf 2)nullNein—
$ (anyOf 2).flow.server_profile.selectionsarray<object>; {"maxItems":200} | nullNeinGewählte Komponenten-/Parameterpaare mit Abtastintervallen.
$ (anyOf 2).flow.server_profile.selections (anyOf 1)array<object>; {"maxItems":200}Nein—
$ (anyOf 2).flow.server_profile.selections (anyOf 1)[]objectJa—
$ (anyOf 2).flow.server_profile.selections (anyOf 1)[].component_idstringJaStabile Kennung der gewählten oder erkannten Komponente.
$ (anyOf 2).flow.server_profile.selections (anyOf 1)[].interval_secondsinteger; {"maximum":86400,"minimum":0}NeinAbtast- oder Prüfintervall in Sekunden innerhalb der angegebenen Grenzen.
$ (anyOf 2).flow.server_profile.selections (anyOf 1)[].parameter_keystringJaStabile Parameterkennung aus dem Serverkatalog.
$ (anyOf 2).flow.server_profile.selections (anyOf 2)nullNein—
$ (anyOf 2).flow.server_profile.versionJSON; {"const":2}Ja—
$ (anyOf 2).flow.server_profile.overviewobject; {"additionalProperties":false}NeinAusdrückliche Ziele für die Serverübersicht mit sechs Diagrammen; wählen Sie alle benötigten Messwerte aus.
$ (anyOf 2).flow.server_profile.overview.system_idstring; {"maxLength":128}Ja—
$ (anyOf 2).flow.server_profile.overview.filesystem_idstring; {"maxLength":128}Ja—
$ (anyOf 2).flow.server_profile.overview.disk_idstring; {"maxLength":128}Ja—
$ (anyOf 2).flow.server_profile.overview.network_idstring; {"maxLength":128}Ja—
$ (anyOf 2).flow.server_profile.filesystem_discoveryobject; {"additionalProperties":false}NeinOptionale Erkennung lokaler Dateisysteme mit einem Grundintervall von mindestens 10 Sekunden. Neue Server/NAS-Einrichtungen aktivieren sie. Bestehende Profile benötigen eine ausdrückliche Aktivierung. Manuell deaktivierte Messreihen bleiben erhalten.
$ (anyOf 2).flow.server_profile.filesystem_discovery.modestring; {"enum":["off","local"]}Ja—
$ (anyOf 2).flow.server_profile.filesystem_discovery.interval_secondsinteger; {"minimum":10,"maximum":86400}Ja—
$ (anyOf 2).flow.server_profile.system_discoveryobject; {"additionalProperties":false}Nein—
$ (anyOf 2).flow.server_profile.system_discovery.modestring; {"enum":["off","local"]}Ja—
$ (anyOf 2).flow.server_profile.system_discovery.interval_secondsinteger; {"minimum":10,"maximum":86400}Ja—
$ (anyOf 2).flow.server_profile.global_interval_secondsinteger; {"minimum":1,"maximum":86400}NeinAusdrückliche globale Intervallauswahl. Jede Quelle behält ihr Plattformminimum; einzelne schnelle Reihen gelten nicht als globale Auswahl.
$ (anyOf 2).flow.profile_revisioninteger; {"minimum":0}Nein—
$ (anyOf 2).flow.platformstring; {"enum":["linux","darwin","windows"]}NeinErwartetes Betriebssystem für ein neues Agent-Profil. Es bestätigt nicht die tatsächliche Geräteplattform. Die Bestätigung im Browser verwendet das vom Agenten gemeldete Betriebssystem, die Architektur und das Systemlaufwerk. Bestehende Profile bleiben unverändert; ein ausdrücklich abweichendes Profil wird abgewiesen und nicht still ignoriert.
json
{
  "flow": null
}
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"
}

Wiederholungen und asynchrone Aufträge

Behalten Sie die dokumentierten Kennungen bei Wiederholungen. Ersetzen Sie sie nach einer unklaren Antwort nicht durch neue Kennungen, die eine weitere Ressource oder Messung erzeugen könnten.

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/onboarding"
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/onboarding", 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/onboarding", {
  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/onboarding", 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)
}