MetriBeacon
Menu

GET Read your active device

/api/v1/devices/{id}

Read your active device.

On this page

Access and permissions

Read your active device.

Browser session: __Host-mb_session cookie.

Machine management credentials in Authorization: Bearer. Check the permissions (scopes) required by the operation.

Parameters and headers

FieldLocationType and limitsRequiredMeaning
idPathstring; {"format":"uuid"}YesResource UUID from the path. It must exist and be accessible to the acting identity.
include_data_flowURL queryboolean; {"default":false}NoInclude the monitor’s data flow diagnostics. No measurement values, other monitors or storage paths are returned.

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
$objectYes—
$.expected_heartbeat_secondsinteger; {"minimum":5}YesExpected device-contact interval in seconds.
$.group_idsarray<string; {"format":"uuid"}>YesIDs of active groups containing this device, or an empty array.
$.group_ids[]string; {"format":"uuid"}Yes—
$.heartbeat_statusstring; {"enum":["fresh","stale","missing"]}YesCurrent device-contact freshness status.
$.heartbeat_valid_untilstring; {"format":"date-time"} | nullYesDeadline until which the recorded contact is considered current.
$.heartbeat_valid_until (anyOf 1)string; {"format":"date-time"}No—
$.heartbeat_valid_until (anyOf 2)nullNo—
$.idstringYesUUID of this resource. Keep the returned identifier for subsequent operations.
$.last_heartbeat_atstring; {"format":"date-time"} | nullYesLast accepted device contact timestamp; null before the first contact.
$.last_heartbeat_at (anyOf 1)string; {"format":"date-time"}No—
$.last_heartbeat_at (anyOf 2)nullNo—
$.monitor_typestringYes—
$.namestringYesHuman-readable resource name. Follow the listed length limit.
$.observed_atstring; {"format":"date-time"}YesServer timestamp used to evaluate freshness for this response.
$.pausedbooleanYesWhether automatic monitor work is paused. Existing telemetry and historical data remain.
$.template_idstring | nullYes—
$.template_id (anyOf 1)stringNo—
$.template_id (anyOf 2)nullNo—
$.template_versioninteger | nullYes—
$.template_version (anyOf 1)integerNo—
$.template_version (anyOf 2)nullNo—
$.workspace_idstringYesUUID of the owning workspace. Access is checked against the authenticated account.
$.check_resultobject; {"additionalProperties":false}NoOptional evaluated check result or latest retained run. Checks use the configured location policy, current node capability and valid observations. Unknown or stale evidence is not a passed check. Run outcomes describe the latest retained execution, not a service health guarantee.
$.check_result.statusstring; {"enum":["up","down","unknown","paused","succeeded","failed","running","missing","overdue","cancelled"]}Yes—
$.check_result.checked_atstring; {"format":"date-time"} | nullYes—
$.check_result.checked_at (anyOf 1)string; {"format":"date-time"}No—
$.check_result.checked_at (anyOf 2)nullNo—
$.check_result.freshnessstring; {"enum":["current","stale","missing"]}Yes—
$.check_result.valid_untilstring; {"format":"date-time"} | nullYes—
$.check_result.valid_until (anyOf 1)string; {"format":"date-time"}No—
$.check_result.valid_until (anyOf 2)nullNo—
$.list_groupstring; {"enum":["monitors","servers"]}YesEffective list: server profiles always use servers; checks and scheduled runs use monitors. Other data sources use the explicit choice or confirmed native-agent detection.
$.list_assignmentstring; {"enum":["auto","monitors","servers"]}YesPresentation only: auto, monitors or servers. Editable for custom, sensor, application and industrial sources; server profiles and check/run monitors have fixed lists. Copying preserves the choice, not agent detection.
$.agent_source_detectedbooleanYesSystem-managed, durable proof of a confirmed pairing or successful authenticated native-agent report for this source. Read requests, CLI, npm and AI plugins do not set it. Offline status and credential revocation do not clear it.
$.data_flowMonitorDataFlowNoConfirmed transfer time, expected series intervals and monitor-specific processing. Daily allowance flags describe current account capacity, not a recorded rejection. History query counts belong to the requesting user only.
$.data_flow.active_seriesinteger; {"minimum":0}Yes—
$.data_flow.archive_pendingbooleanYes—
$.data_flow.archive_queriesinteger; {"minimum":0}Yes—
$.data_flow.checked_atstring; {"format":"date-time"}Yes—
$.data_flow.interval_max_secondsinteger | nullYes—
$.data_flow.interval_min_secondsinteger | nullYes—
$.data_flow.last_received_atstring; {"format":"date-time"} | nullYes—
$.data_flow.last_received_at (anyOf 1)string; {"format":"date-time"}No—
$.data_flow.last_received_at (anyOf 2)nullNo—
$.data_flow.quota_exhaustedarray<string; {"enum":["items","events","bytes","event_bytes"]}>Yes—
$.data_flow.quota_exhausted[]string; {"enum":["items","events","bytes","event_bytes"]}Yes—
$.data_flow.rate_limitsarray<object>Yes—
$.data_flow.rate_limits[]objectYes—
$.data_flow.rate_limits[].resourcestring; {"enum":["items","events","requests","bytes"]}Yes—
$.data_flow.rate_limits[].retry_secondsinteger; {"minimum":1}Yes—
$.data_flow.rollup_pendingbooleanYes—
$.data_flow.deliveryobject | nullNo—
$.data_flow.delivery (anyOf 1)objectNo—
$.data_flow.delivery (anyOf 1).reportAgentDeliveryReportYes—
$.data_flow.delivery (anyOf 1).report.observed_atstring; {"format":"date-time"}Yes—
$.data_flow.delivery (anyOf 1).report.pending_objectsinteger; {"minimum":0,"maximum":10000000}Yes—
$.data_flow.delivery (anyOf 1).report.pending_bytesinteger; {"minimum":0,"maximum":1073741824}Yes—
$.data_flow.delivery (anyOf 1).report.oldest_measured_atstring; {"format":"date-time"}No—
$.data_flow.delivery (anyOf 1).report.last_acknowledged_atstring; {"format":"date-time"}No—
$.data_flow.delivery (anyOf 1).report.retry_atstring; {"format":"date-time"}No—
$.data_flow.delivery (anyOf 1).report.lost_objectsinteger; {"minimum":0}Yes—
$.data_flow.delivery (anyOf 1).report.last_errorobject; {"additionalProperties":false}No—
$.data_flow.delivery (anyOf 1).report.last_error.atstring; {"format":"date-time"}Yes—
$.data_flow.delivery (anyOf 1).report.last_error.kindstring; {"enum":["timeout","connection","tls","http","ack","storage"]}Yes—
$.data_flow.delivery (anyOf 1).report.last_error.statusinteger; {"minimum":0,"maximum":599}No—
$.data_flow.delivery (anyOf 1).report.last_error.codestring; {"enum":["","quota_exceeded","global_capacity","unavailable","http_error"]}No—
$.data_flow.delivery (anyOf 1).report.last_error.limitstring; {"enum":["","point_per_minute","point_per_day","event_per_minute","event_per_day","event_bytes_per_day","request_per_minute","bytes_per_minute","bytes_per_day","global_items"]}No—
$.data_flow.delivery (anyOf 1).reported_atstring; {"format":"date-time"}Yes—
$.data_flow.delivery (anyOf 1).freshbooleanYes—
$.data_flow.delivery (anyOf 2)nullNo—
$.has_eventsbooleanYesWhether this monitor has retained event messages or counts available to view, independently of the current table filters.
json
{
  "expected_heartbeat_seconds": 5,
  "group_ids": [],
  "heartbeat_status": "fresh",
  "heartbeat_valid_until": "2026-09-30T12:00:00Z",
  "id": "demo",
  "last_heartbeat_at": "2026-09-30T12:00:00Z",
  "monitor_type": "demo",
  "name": "demo",
  "observed_at": "2026-09-30T12:00:00Z",
  "paused": false,
  "template_id": "demo",
  "template_version": 0,
  "workspace_id": "demo",
  "list_group": "monitors",
  "list_assignment": "auto",
  "agent_source_detected": false,
  "has_events": false
}
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
not_found
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": 404,
  "title": "Demo error",
  "type": "about:blank"
}
Stable error codes
invalid_device
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": 422,
  "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

This operation reads or validates without applying a resource mutation. Respect rate limits and credential lifetime.

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/devices/00000000-0000-4000-8000-000000000001"
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/devices/00000000-0000-4000-8000-000000000001", 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/devices/00000000-0000-4000-8000-000000000001", {
  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/devices/00000000-0000-4000-8000-000000000001", 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)
}