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
| Header | Type and limits | Meaning |
|---|---|---|
| Cache-Control | string; {"pattern":"(?:^|,\\s*)no-store(?:,|$)"} | Private API responses prohibit storage. Public OAuth metadata is cached for 300 seconds; live streams additionally prohibit transformation. |
| Content-Language | string; {"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-Policy | JSON; {"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. |
| Vary | string | Responses vary by Accept-Language; browser-rendered responses can also vary by the preference cookie. |
| X-Content-Type-Options | JSON; {"const":"nosniff"} | The browser must use the declared content type. |
| X-Frame-Options | JSON; {"const":"DENY"} | The response must not be embedded in a frame. |
| X-Request-ID | string | Server-generated request identifier. Include this when reporting an error; inbound values are not trusted. |
application/json
| Field | Type and limits | Required | Meaning |
|---|---|---|---|
| $ | object | object | Yes | — |
| $ (anyOf 1) | object | No | — |
| $ (anyOf 1).flow | null | Yes | — |
| $ (anyOf 2) | object | No | — |
| $ (anyOf 2).flow | object | Yes | — |
| $ (anyOf 2).flow.alarm_id | string | null | Yes | — |
| $ (anyOf 2).flow.alarm_id (anyOf 1) | string | No | — |
| $ (anyOf 2).flow.alarm_id (anyOf 2) | null | No | — |
| $ (anyOf 2).flow.completed_at | string; {"format":"date-time"} | null | Yes | Completion 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) | null | No | — |
| $ (anyOf 2).flow.created_at | string; {"format":"date-time"} | Yes | Creation timestamp in RFC 3339 UTC. |
| $ (anyOf 2).flow.device_id | string | Yes | UUID of the target device or monitor. The ingestion key must allow this device. |
| $ (anyOf 2).flow.heartbeat_confirmed_at | string; {"format":"date-time"} | null | Yes | — |
| $ (anyOf 2).flow.heartbeat_confirmed_at (anyOf 1) | string; {"format":"date-time"} | No | — |
| $ (anyOf 2).flow.heartbeat_confirmed_at (anyOf 2) | null | No | — |
| $ (anyOf 2).flow.integration | string | Yes | — |
| $ (anyOf 2).flow.key_id | string | null | Yes | — |
| $ (anyOf 2).flow.key_id (anyOf 1) | string | No | — |
| $ (anyOf 2).flow.key_id (anyOf 2) | null | No | — |
| $ (anyOf 2).flow.measurement_confirmed_at | string; {"format":"date-time"} | null | Yes | Time 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) | null | No | — |
| $ (anyOf 2).flow.series | object | Yes | — |
| $ (anyOf 2).flow.updated_at | string; {"format":"date-time"} | Yes | Revision of the saved setup, used to confirm a selection change. |
| $ (anyOf 2).flow.workspace_id | string | Yes | UUID of the owning workspace. Access is checked against the authenticated account. |
| $ (anyOf 2).flow.server_profile | ServerProfileRequest | No | — |
| $ (anyOf 2).flow.server_profile.components | array<object>; {"maxItems":200} | null | No | Discovered 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)[] | object | Yes | — |
| $ (anyOf 2).flow.server_profile.components (anyOf 1)[].address | string | No | — |
| $ (anyOf 2).flow.server_profile.components (anyOf 1)[].family | string | No | — |
| $ (anyOf 2).flow.server_profile.components (anyOf 1)[].id | string | Yes | UUID of this resource. Keep the returned identifier for subsequent operations. |
| $ (anyOf 2).flow.server_profile.components (anyOf 1)[].kind | string | Yes | Resource kind or measurement type selected from the listed values. |
| $ (anyOf 2).flow.server_profile.components (anyOf 1)[].label | string; {"maxLength":128,"minLength":1} | Yes | Display name for the component. |
| $ (anyOf 2).flow.server_profile.components (anyOf 1)[].local_ref | string | No | — |
| $ (anyOf 2).flow.server_profile.components (anyOf 1)[].name | string | No | Human-readable resource name. Follow the listed length limit. |
| $ (anyOf 2).flow.server_profile.components (anyOf 1)[].path | string; {"maxLength":1024} | No | — |
| $ (anyOf 2).flow.server_profile.components (anyOf 1)[].port | integer | No | — |
| $ (anyOf 2).flow.server_profile.components (anyOf 1)[].project | string | No | — |
| $ (anyOf 2).flow.server_profile.components (anyOf 1)[].protocol | string | No | — |
| $ (anyOf 2).flow.server_profile.components (anyOf 1)[].text_languages | object | No | — |
| $ (anyOf 2).flow.server_profile.components (anyOf 1)[].timeout_seconds | integer | No | — |
| $ (anyOf 2).flow.server_profile.components (anyOf 1)[].translations | object; {"additionalProperties":false} | No | — |
| $ (anyOf 2).flow.server_profile.components (anyOf 1)[].translations.de | object | No | — |
| $ (anyOf 2).flow.server_profile.components (anyOf 1)[].translations.en | object | No | — |
| $ (anyOf 2).flow.server_profile.components (anyOf 1)[].transport | string | No | — |
| $ (anyOf 2).flow.server_profile.components (anyOf 1)[].filesystem_identity | string; {"maxLength":256} | No | Agent-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_identity | string; {"maxLength":256} | No | — |
| $ (anyOf 2).flow.server_profile.components (anyOf 2) | null | No | — |
| $ (anyOf 2).flow.server_profile.selections | array<object>; {"maxItems":200} | null | No | Selected 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)[] | object | Yes | — |
| $ (anyOf 2).flow.server_profile.selections (anyOf 1)[].component_id | string | Yes | Stable identifier of the selected or discovered component. |
| $ (anyOf 2).flow.server_profile.selections (anyOf 1)[].interval_seconds | integer; {"maximum":86400,"minimum":0} | No | Sampling or check interval in seconds within the stated bounds. |
| $ (anyOf 2).flow.server_profile.selections (anyOf 1)[].parameter_key | string | Yes | Stable parameter identifier from the server catalog. |
| $ (anyOf 2).flow.server_profile.selections (anyOf 2) | null | No | — |
| $ (anyOf 2).flow.server_profile.version | JSON; {"const":2} | Yes | — |
| $ (anyOf 2).flow.server_profile.overview | object; {"additionalProperties":false} | No | Explicit targets for the six-chart server overview; select all required readings. |
| $ (anyOf 2).flow.server_profile.overview.system_id | string; {"maxLength":128} | Yes | — |
| $ (anyOf 2).flow.server_profile.overview.filesystem_id | string; {"maxLength":128} | Yes | — |
| $ (anyOf 2).flow.server_profile.overview.disk_id | string; {"maxLength":128} | Yes | — |
| $ (anyOf 2).flow.server_profile.overview.network_id | string; {"maxLength":128} | Yes | — |
| $ (anyOf 2).flow.server_profile.filesystem_discovery | object; {"additionalProperties":false} | No | Optional 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.mode | string; {"enum":["off","local"]} | Yes | — |
| $ (anyOf 2).flow.server_profile.filesystem_discovery.interval_seconds | integer; {"minimum":10,"maximum":86400} | Yes | — |
| $ (anyOf 2).flow.server_profile.system_discovery | object; {"additionalProperties":false} | No | — |
| $ (anyOf 2).flow.server_profile.system_discovery.mode | string; {"enum":["off","local"]} | Yes | — |
| $ (anyOf 2).flow.server_profile.system_discovery.interval_seconds | integer; {"minimum":10,"maximum":86400} | Yes | — |
| $ (anyOf 2).flow.server_profile.global_interval_seconds | integer; {"minimum":1,"maximum":86400} | No | Explicit global sampling choice. Each source still applies its platform minimum; individual fast rows never imply this choice. |
| $ (anyOf 2).flow.profile_revision | integer; {"minimum":0} | No | — |
| $ (anyOf 2).flow.platform | string; {"enum":["linux","darwin","windows"]} | No | Expected 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. |
{
"flow": null
}| Stable error codes |
|---|
| invalid_credential |
| unauthorized |
| Header | Type and limits | Meaning |
|---|---|---|
| Cache-Control | string; {"pattern":"(?:^|,\\s*)no-store(?:,|$)"} | Private API responses prohibit storage. Public OAuth metadata is cached for 300 seconds; live streams additionally prohibit transformation. |
| Content-Language | string; {"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-Policy | JSON; {"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. |
| Vary | string | Responses vary by Accept-Language; browser-rendered responses can also vary by the preference cookie. |
| X-Content-Type-Options | JSON; {"const":"nosniff"} | The browser must use the declared content type. |
| X-Frame-Options | JSON; {"const":"DENY"} | The response must not be embedded in a frame. |
| X-Request-ID | string | Server-generated request identifier. Include this when reporting an error; inbound values are not trusted. |
application/problem+json
| Field | Type and limits | Required | Meaning |
|---|---|---|---|
| $ | Problem | Yes | — |
| $.code | string | Yes | Stable machine-readable error code |
| $.detail | string | Yes | Short localized explanation without internal error details |
| $.instance | string | Yes | Unique relative identifier /api/v1/requests/{request_id}; not a retrievable resource |
| $.message | string | Yes | Temporarily identical to detail for existing clients |
| $.message_key | string | Yes | Stable translation key for changing the displayed language without another request |
| $.message_params | object; {"additionalProperties":true} | Yes | Named, safely rendered message parameters; never arbitrary HTML |
| $.request_id | string; {"pattern":"^[0-9a-f]{32}$"} | Yes | Server-generated diagnostic identifier. It contains no login token or credential. |
| $.status | integer; {"maximum":599,"minimum":400} | Yes | — |
| $.title | string | Yes | Localized HTTP status title |
| $.type | string; {"const":"about:blank"} | Yes | — |
{
"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 |
| Header | Type and limits | Meaning |
|---|---|---|
| Cache-Control | string; {"pattern":"(?:^|,\\s*)no-store(?:,|$)"} | Private API responses prohibit storage. Public OAuth metadata is cached for 300 seconds; live streams additionally prohibit transformation. |
| Content-Language | string; {"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-Policy | JSON; {"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. |
| Vary | string | Responses vary by Accept-Language; browser-rendered responses can also vary by the preference cookie. |
| X-Content-Type-Options | JSON; {"const":"nosniff"} | The browser must use the declared content type. |
| X-Frame-Options | JSON; {"const":"DENY"} | The response must not be embedded in a frame. |
| X-Request-ID | string | Server-generated request identifier. Include this when reporting an error; inbound values are not trusted. |
application/problem+json
| Field | Type and limits | Required | Meaning |
|---|---|---|---|
| $ | Problem | Yes | — |
| $.code | string | Yes | Stable machine-readable error code |
| $.detail | string | Yes | Short localized explanation without internal error details |
| $.instance | string | Yes | Unique relative identifier /api/v1/requests/{request_id}; not a retrievable resource |
| $.message | string | Yes | Temporarily identical to detail for existing clients |
| $.message_key | string | Yes | Stable translation key for changing the displayed language without another request |
| $.message_params | object; {"additionalProperties":true} | Yes | Named, safely rendered message parameters; never arbitrary HTML |
| $.request_id | string; {"pattern":"^[0-9a-f]{32}$"} | Yes | Server-generated diagnostic identifier. It contains no login token or credential. |
| $.status | integer; {"maximum":599,"minimum":400} | Yes | — |
| $.title | string | Yes | Localized HTTP status title |
| $.type | string; {"const":"about:blank"} | Yes | — |
{
"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 |
| Header | Type and limits | Meaning |
|---|---|---|
| Cache-Control | string; {"pattern":"(?:^|,\\s*)no-store(?:,|$)"} | Private API responses prohibit storage. Public OAuth metadata is cached for 300 seconds; live streams additionally prohibit transformation. |
| Content-Language | string; {"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-Policy | JSON; {"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-After | string; {"pattern":"^[0-9]+$"} | Seconds before retry. Preserve supported idempotency identifiers and respect the operation’s mutation semantics. |
| Vary | string | Responses vary by Accept-Language; browser-rendered responses can also vary by the preference cookie. |
| X-Content-Type-Options | JSON; {"const":"nosniff"} | The browser must use the declared content type. |
| X-Frame-Options | JSON; {"const":"DENY"} | The response must not be embedded in a frame. |
| X-Request-ID | string | Server-generated request identifier. Include this when reporting an error; inbound values are not trusted. |
application/problem+json
| Field | Type and limits | Required | Meaning |
|---|---|---|---|
| $ | Problem | Yes | — |
| $.code | string | Yes | Stable machine-readable error code |
| $.detail | string | Yes | Short localized explanation without internal error details |
| $.instance | string | Yes | Unique relative identifier /api/v1/requests/{request_id}; not a retrievable resource |
| $.message | string | Yes | Temporarily identical to detail for existing clients |
| $.message_key | string | Yes | Stable translation key for changing the displayed language without another request |
| $.message_params | object; {"additionalProperties":true} | Yes | Named, safely rendered message parameters; never arbitrary HTML |
| $.request_id | string; {"pattern":"^[0-9a-f]{32}$"} | Yes | Server-generated diagnostic identifier. It contains no login token or credential. |
| $.status | integer; {"maximum":599,"minimum":400} | Yes | — |
| $.title | string | Yes | Localized HTTP status title |
| $.type | string; {"const":"about:blank"} | Yes | — |
{
"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.
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"
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()
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();
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)
}
Related guides
- HTTP API, OAuth and MCP
Find the user API endpoints, their permissions, fields, examples and response formats.
- DELETE Reset setup for another device
Existing devices, telemetry, keys and rules remain. Reset explicitly before setting up a different device.
- POST Save a suggested alarm and complete setup
Actual accepted telemetry is required. Repeating the same choice does not create another rule; completing without an alarm is an explicit alternative.
- POST Complete setup after actual data acceptance
Use an alarm belonging to this setup, or explicitly set skip_alarm. Data acceptance is checked again before completion.