MetriBeacon
Menu

GET Read your saved setup and accepted telemetry

/api/v1/onboarding

Progress contains resource IDs and accepted-data timestamps, never stored device-key secrets. A running local process alone does not complete setup.

On this page

Access and permissions

Progress contains resource IDs and accepted-data timestamps, never stored device-key secrets. A running local process alone does not complete setup.

Browser session: __Host-mb_session cookie.

Parameters and headers

No path, query or additional request-header parameters.

Request body

No request body.

Responses

HeaderType and limitsMeaning
Cache-Controlstring; {"pattern":"(?:^|,\\s*)no-store(?:,|$)"}Private API responses prohibit storage. Public OAuth metadata is cached for 300 seconds; live streams additionally prohibit transformation.
Content-Languagestring; {"enum":["en","de"]}Language of human-readable response text, resolved from Accept-Language or the documented browser preference. Technical codes and identifiers remain stable.
Referrer-PolicyJSON; {"enum":["strict-origin-when-cross-origin","no-referrer"]}The default referrer policy is strict-origin-when-cross-origin. Provider-login responses use no-referrer to protect login parameters.
VarystringResponses vary by Accept-Language; browser-rendered responses can also vary by the preference cookie.
X-Content-Type-OptionsJSON; {"const":"nosniff"}The browser must use the declared content type.
X-Frame-OptionsJSON; {"const":"DENY"}The response must not be embedded in a frame.
X-Request-IDstringServer-generated request identifier. Include this when reporting an error; inbound values are not trusted.

application/json

FieldType and limitsRequiredMeaning
$object | objectYes—
$ (anyOf 1)objectNo—
$ (anyOf 1).flownullYes—
$ (anyOf 2)objectNo—
$ (anyOf 2).flowobjectYes—
$ (anyOf 2).flow.alarm_idstring | nullYes—
$ (anyOf 2).flow.alarm_id (anyOf 1)stringNo—
$ (anyOf 2).flow.alarm_id (anyOf 2)nullNo—
$ (anyOf 2).flow.completed_atstring; {"format":"date-time"} | nullYesCompletion timestamp; null while completion has not been recorded.
$ (anyOf 2).flow.completed_at (anyOf 1)string; {"format":"date-time"}No—
$ (anyOf 2).flow.completed_at (anyOf 2)nullNo—
$ (anyOf 2).flow.created_atstring; {"format":"date-time"}YesCreation timestamp in RFC 3339 UTC.
$ (anyOf 2).flow.device_idstringYesUUID of the target device or monitor. The ingestion key must allow this device.
$ (anyOf 2).flow.heartbeat_confirmed_atstring; {"format":"date-time"} | nullYes—
$ (anyOf 2).flow.heartbeat_confirmed_at (anyOf 1)string; {"format":"date-time"}No—
$ (anyOf 2).flow.heartbeat_confirmed_at (anyOf 2)nullNo—
$ (anyOf 2).flow.integrationstringYes—
$ (anyOf 2).flow.key_idstring | nullYes—
$ (anyOf 2).flow.key_id (anyOf 1)stringNo—
$ (anyOf 2).flow.key_id (anyOf 2)nullNo—
$ (anyOf 2).flow.measurement_confirmed_atstring; {"format":"date-time"} | nullYesTime when a selected numeric or state value was actually received and saved after setup began. Agent series bindings may appear after profile provisioning. An installer result, process flag or unselected value does not confirm receipt.
$ (anyOf 2).flow.measurement_confirmed_at (anyOf 1)string; {"format":"date-time"}No—
$ (anyOf 2).flow.measurement_confirmed_at (anyOf 2)nullNo—
$ (anyOf 2).flow.seriesobjectYes—
$ (anyOf 2).flow.updated_atstring; {"format":"date-time"}YesRevision of the saved setup, used to confirm a selection change.
$ (anyOf 2).flow.workspace_idstringYesUUID of the owning workspace. Access is checked against the authenticated account.
$ (anyOf 2).flow.server_profileServerProfileRequestNo—
$ (anyOf 2).flow.server_profile.componentsarray<object>; {"maxItems":200} | nullNoDiscovered or explicitly selected server components.
$ (anyOf 2).flow.server_profile.components (anyOf 1)array<object>; {"maxItems":200}No—
$ (anyOf 2).flow.server_profile.components (anyOf 1)[]objectYes—
$ (anyOf 2).flow.server_profile.components (anyOf 1)[].addressstringNo—
$ (anyOf 2).flow.server_profile.components (anyOf 1)[].familystringNo—
$ (anyOf 2).flow.server_profile.components (anyOf 1)[].idstringYesUUID of this resource. Keep the returned identifier for subsequent operations.
$ (anyOf 2).flow.server_profile.components (anyOf 1)[].kindstringYesResource kind or measurement type selected from the listed values.
$ (anyOf 2).flow.server_profile.components (anyOf 1)[].labelstring; {"maxLength":128,"minLength":1}YesDisplay name for the component.
$ (anyOf 2).flow.server_profile.components (anyOf 1)[].local_refstringNo—
$ (anyOf 2).flow.server_profile.components (anyOf 1)[].namestringNoHuman-readable resource name. Follow the listed length limit.
$ (anyOf 2).flow.server_profile.components (anyOf 1)[].pathstring; {"maxLength":1024}No—
$ (anyOf 2).flow.server_profile.components (anyOf 1)[].portintegerNo—
$ (anyOf 2).flow.server_profile.components (anyOf 1)[].projectstringNo—
$ (anyOf 2).flow.server_profile.components (anyOf 1)[].protocolstringNo—
$ (anyOf 2).flow.server_profile.components (anyOf 1)[].text_languagesobjectNo—
$ (anyOf 2).flow.server_profile.components (anyOf 1)[].timeout_secondsintegerNo—
$ (anyOf 2).flow.server_profile.components (anyOf 1)[].translationsobject; {"additionalProperties":false}No—
$ (anyOf 2).flow.server_profile.components (anyOf 1)[].translations.deobjectNo—
$ (anyOf 2).flow.server_profile.components (anyOf 1)[].translations.enobjectNo—
$ (anyOf 2).flow.server_profile.components (anyOf 1)[].transportstringNo—
$ (anyOf 2).flow.server_profile.components (anyOf 1)[].filesystem_identitystring; {"maxLength":256}NoAgent-reported volume identity. Keep it unchanged to prevent a replacement volume from continuing another volume’s history.
$ (anyOf 2).flow.server_profile.components (anyOf 1)[].disk_identitystring; {"maxLength":256}No—
$ (anyOf 2).flow.server_profile.components (anyOf 2)nullNo—
$ (anyOf 2).flow.server_profile.selectionsarray<object>; {"maxItems":200} | nullNoSelected component/parameter pairs and sampling intervals.
$ (anyOf 2).flow.server_profile.selections (anyOf 1)array<object>; {"maxItems":200}No—
$ (anyOf 2).flow.server_profile.selections (anyOf 1)[]objectYes—
$ (anyOf 2).flow.server_profile.selections (anyOf 1)[].component_idstringYesStable identifier of the selected or discovered component.
$ (anyOf 2).flow.server_profile.selections (anyOf 1)[].interval_secondsinteger; {"maximum":86400,"minimum":0}NoSampling or check interval in seconds within the stated bounds.
$ (anyOf 2).flow.server_profile.selections (anyOf 1)[].parameter_keystringYesStable parameter identifier from the server catalog.
$ (anyOf 2).flow.server_profile.selections (anyOf 2)nullNo—
$ (anyOf 2).flow.server_profile.versionJSON; {"const":2}Yes—
$ (anyOf 2).flow.server_profile.overviewobject; {"additionalProperties":false}NoExplicit targets for the six-chart server overview; select all required readings.
$ (anyOf 2).flow.server_profile.overview.system_idstring; {"maxLength":128}Yes—
$ (anyOf 2).flow.server_profile.overview.filesystem_idstring; {"maxLength":128}Yes—
$ (anyOf 2).flow.server_profile.overview.disk_idstring; {"maxLength":128}Yes—
$ (anyOf 2).flow.server_profile.overview.network_idstring; {"maxLength":128}Yes—
$ (anyOf 2).flow.server_profile.filesystem_discoveryobject; {"additionalProperties":false}NoOptional local filesystem discovery with a base interval of at least 10 seconds. New Server/NAS setups enable it. Existing profiles require explicit activation. Manually disabled measurements are preserved.
$ (anyOf 2).flow.server_profile.filesystem_discovery.modestring; {"enum":["off","local"]}Yes—
$ (anyOf 2).flow.server_profile.filesystem_discovery.interval_secondsinteger; {"minimum":10,"maximum":86400}Yes—
$ (anyOf 2).flow.server_profile.system_discoveryobject; {"additionalProperties":false}No—
$ (anyOf 2).flow.server_profile.system_discovery.modestring; {"enum":["off","local"]}Yes—
$ (anyOf 2).flow.server_profile.system_discovery.interval_secondsinteger; {"minimum":10,"maximum":86400}Yes—
$ (anyOf 2).flow.server_profile.global_interval_secondsinteger; {"minimum":1,"maximum":86400}NoExplicit global sampling choice. Each source still applies its platform minimum; individual fast rows never imply this choice.
$ (anyOf 2).flow.profile_revisioninteger; {"minimum":0}No—
$ (anyOf 2).flow.platformstring; {"enum":["linux","darwin","windows"]}NoExpected operating system for a new agent profile. This does not establish the actual device platform. Browser approval uses the agent’s own platform, architecture and system drive report. Existing profiles are kept unchanged; an explicitly different profile is rejected, not silently ignored.
json
{
  "flow": null
}
Stable error codes
invalid_credential
unauthorized
HeaderType and limitsMeaning
Cache-Controlstring; {"pattern":"(?:^|,\\s*)no-store(?:,|$)"}Private API responses prohibit storage. Public OAuth metadata is cached for 300 seconds; live streams additionally prohibit transformation.
Content-Languagestring; {"enum":["en","de"]}Language of human-readable response text, resolved from Accept-Language or the documented browser preference. Technical codes and identifiers remain stable.
Referrer-PolicyJSON; {"enum":["strict-origin-when-cross-origin","no-referrer"]}The default referrer policy is strict-origin-when-cross-origin. Provider-login responses use no-referrer to protect login parameters.
VarystringResponses vary by Accept-Language; browser-rendered responses can also vary by the preference cookie.
X-Content-Type-OptionsJSON; {"const":"nosniff"}The browser must use the declared content type.
X-Frame-OptionsJSON; {"const":"DENY"}The response must not be embedded in a frame.
X-Request-IDstringServer-generated request identifier. Include this when reporting an error; inbound values are not trusted.

application/problem+json

FieldType and limitsRequiredMeaning
$ProblemYes—
$.codestringYesStable machine-readable error code
$.detailstringYesShort localized explanation without internal error details
$.instancestringYesUnique relative identifier /api/v1/requests/{request_id}; not a retrievable resource
$.messagestringYesTemporarily identical to detail for existing clients
$.message_keystringYesStable translation key for changing the displayed language without another request
$.message_paramsobject; {"additionalProperties":true}YesNamed, safely rendered message parameters; never arbitrary HTML
$.request_idstring; {"pattern":"^[0-9a-f]{32}$"}YesServer-generated diagnostic identifier. It contains no login token or credential.
$.statusinteger; {"maximum":599,"minimum":400}Yes—
$.titlestringYesLocalized HTTP status title
$.typestring; {"const":"about:blank"}Yes—
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"
}
Stable error codes
csrf
insufficient_scope
invalid_origin
HeaderType and limitsMeaning
Cache-Controlstring; {"pattern":"(?:^|,\\s*)no-store(?:,|$)"}Private API responses prohibit storage. Public OAuth metadata is cached for 300 seconds; live streams additionally prohibit transformation.
Content-Languagestring; {"enum":["en","de"]}Language of human-readable response text, resolved from Accept-Language or the documented browser preference. Technical codes and identifiers remain stable.
Referrer-PolicyJSON; {"enum":["strict-origin-when-cross-origin","no-referrer"]}The default referrer policy is strict-origin-when-cross-origin. Provider-login responses use no-referrer to protect login parameters.
VarystringResponses vary by Accept-Language; browser-rendered responses can also vary by the preference cookie.
X-Content-Type-OptionsJSON; {"const":"nosniff"}The browser must use the declared content type.
X-Frame-OptionsJSON; {"const":"DENY"}The response must not be embedded in a frame.
X-Request-IDstringServer-generated request identifier. Include this when reporting an error; inbound values are not trusted.

application/problem+json

FieldType and limitsRequiredMeaning
$ProblemYes—
$.codestringYesStable machine-readable error code
$.detailstringYesShort localized explanation without internal error details
$.instancestringYesUnique relative identifier /api/v1/requests/{request_id}; not a retrievable resource
$.messagestringYesTemporarily identical to detail for existing clients
$.message_keystringYesStable translation key for changing the displayed language without another request
$.message_paramsobject; {"additionalProperties":true}YesNamed, safely rendered message parameters; never arbitrary HTML
$.request_idstring; {"pattern":"^[0-9a-f]{32}$"}YesServer-generated diagnostic identifier. It contains no login token or credential.
$.statusinteger; {"maximum":599,"minimum":400}Yes—
$.titlestringYesLocalized HTTP status title
$.typestring; {"const":"about:blank"}Yes—
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"
}
Stable error codes
unavailable
HeaderType and limitsMeaning
Cache-Controlstring; {"pattern":"(?:^|,\\s*)no-store(?:,|$)"}Private API responses prohibit storage. Public OAuth metadata is cached for 300 seconds; live streams additionally prohibit transformation.
Content-Languagestring; {"enum":["en","de"]}Language of human-readable response text, resolved from Accept-Language or the documented browser preference. Technical codes and identifiers remain stable.
Referrer-PolicyJSON; {"enum":["strict-origin-when-cross-origin","no-referrer"]}The default referrer policy is strict-origin-when-cross-origin. Provider-login responses use no-referrer to protect login parameters.
Retry-Afterstring; {"pattern":"^[0-9]+$"}Seconds before retry. Preserve supported idempotency identifiers and respect the operation’s mutation semantics.
VarystringResponses vary by Accept-Language; browser-rendered responses can also vary by the preference cookie.
X-Content-Type-OptionsJSON; {"const":"nosniff"}The browser must use the declared content type.
X-Frame-OptionsJSON; {"const":"DENY"}The response must not be embedded in a frame.
X-Request-IDstringServer-generated request identifier. Include this when reporting an error; inbound values are not trusted.

application/problem+json

FieldType and limitsRequiredMeaning
$ProblemYes—
$.codestringYesStable machine-readable error code
$.detailstringYesShort localized explanation without internal error details
$.instancestringYesUnique relative identifier /api/v1/requests/{request_id}; not a retrievable resource
$.messagestringYesTemporarily identical to detail for existing clients
$.message_keystringYesStable translation key for changing the displayed language without another request
$.message_paramsobject; {"additionalProperties":true}YesNamed, safely rendered message parameters; never arbitrary HTML
$.request_idstring; {"pattern":"^[0-9a-f]{32}$"}YesServer-generated diagnostic identifier. It contains no login token or credential.
$.statusinteger; {"maximum":599,"minimum":400}Yes—
$.titlestringYesLocalized HTTP status title
$.typestring; {"const":"about:blank"}Yes—
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"
}

Retries and asynchronous work

Keep the documented IDs for retries. After an unclear response, do not replace them with new IDs, which could create another resource or reading.

Request examples

Replace demo IDs, timestamps and placeholders with your own values. For a retry, keep the same IDs, time and content. These examples do not run requests on this page.

Keep login links, codes, cookies and keys private. Do not print them in logs or share them in support requests.

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)
}