MetriBeacon
Menu

POST Report discovered server components and collection status

/api/v1/agent/server-report

Discovery and unsupported/permission-denied reports do not count as measurement values or enable selections. Accepted reports update only the key’s server monitor.

On this page

Access and permissions

Discovery and unsupported/permission-denied reports do not count as measurement values or enable selections. Accepted reports update only the key’s server monitor.

API write key in Authorization: Bearer. It allows data submission for the selected devices or all devices in its workspace.

Parameters and headers

FieldLocationType and limitsRequiredMeaning
X-MetriBeacon-Device-IDHeaderstring; {"format":"uuid"}NoTarget device UUID. Required for shared keys, implicit for one selected device. Header and body targets must match.

Request body

FieldType and limitsRequiredMeaning
$object; {"additionalProperties":false}Yes—
$.agent_versionstring; {"maxLength":128}No—
$.architecturestring; {"enum":["amd64","arm64"]}No—
$.capabilitiesarray<string>; {"maxItems":200}No—
$.capabilities[]stringYes—
$.inventoryarray<ServerComponent>; {"maxItems":200}NoBounded discovered server components; this does not execute arbitrary server commands.
$.inventory[]ServerComponentYes—
$.inventory[].addressstringNo—
$.inventory[].familystringNo—
$.inventory[].idstringYesUUID of this resource. Keep the returned identifier for subsequent operations.
$.inventory[].kindstringYesResource kind or measurement type selected from the listed values.
$.inventory[].labelstringYesDisplay name for the component.
$.inventory[].local_refstringNo—
$.inventory[].namestringNoHuman-readable resource name. Follow the listed length limit.
$.inventory[].pathstringNo—
$.inventory[].portintegerNo—
$.inventory[].projectstringNo—
$.inventory[].protocolstringNo—
$.inventory[].text_languagesobjectNo—
$.inventory[].timeout_secondsintegerNo—
$.inventory[].translationsobject; {"additionalProperties":false}No—
$.inventory[].translations.deobjectNo—
$.inventory[].translations.enobjectNo—
$.inventory[].transportstringNo—
$.inventory[].filesystem_identitystring; {"maxLength":256}NoAgent-reported volume identity. Keep it unchanged to prevent a replacement volume from continuing another volume’s history.
$.inventory[].disk_identitystring; {"maxLength":256}No—
$.platformstring; {"enum":["linux","darwin","windows"]}No—
$.revisioninteger; {"default":0,"minimum":0}NoResource revision for optimistic concurrency. Read the current revision before changing configuration.
$.statusesarray<CollectorStatus>; {"maxItems":200}No—
$.statuses[]CollectorStatusYes—
$.statuses[].component_idstringYes—
$.statuses[].counter_epochstringNo—
$.statuses[].parameter_keystringYes—
$.statuses[].sourcestringNo—
$.statuses[].statusstring; {"enum":["ready","warming_up","permission_denied","unsupported","failed"]}Yes—
$.system_infoSystemInformationNo—
$.system_info.versionJSON; {"const":1}Yes—
$.system_info.operating_systemstring; {"maxLength":256}No—
$.system_info.kernel_versionstring; {"maxLength":256}No—
$.system_info.cpu_modelstring; {"maxLength":256}No—
$.system_info.logical_cpu_coresinteger; {"minimum":0,"maximum":65536}No—
$.system_info.memory_total_bytesinteger; {"minimum":0,"maximum":1152921504606846976}No—
$.system_info.booted_atstring; {"format":"date-time"}No—
$.filesystemsobject; {"additionalProperties":false}No—
$.filesystems.versioninteger; {"enum":[1]}Yes—
$.filesystems.filesystemsarray<object; {"additionalProperties":false}>; {"maxItems":200}Yes—
$.filesystems.filesystems[]object; {"additionalProperties":false}Yes—
$.filesystems.filesystems[].component_idstringYes—
$.filesystems.filesystems[].pathstringYes—
$.filesystems.filesystems[].identitystring; {"maxLength":256}YesAgent-reported volume identity. Keep it unchanged to prevent a replacement volume from continuing another volume’s history.
$.filesystems.filesystems[].typestringYes—
$.filesystems.incompletebooleanNo—
$.update_runtimeAgentUpdateRuntimeNo—
$.update_runtime.protocolinteger; {"const":1}Yes—
$.update_runtime.installation_idstring; {"pattern":"^[0-9a-f]{32}$"}Yes—
$.update_runtime.versionstring; {"minLength":1,"maxLength":128}Yes—
$.update_runtime.enabledbooleanYes—
$.update_runtime.channelstring; {"enum":["download","npm"]}Yes—
$.update_runtime.running_sha256string; {"pattern":"^[0-9a-f]{64}$"}Yes—
$.update_runtime.job_idstring; {"format":"uuid"}No—
$.system_inventoryobject; {"additionalProperties":false}No—
$.system_inventory.versioninteger; {"enum":[1]}Yes—
$.system_inventory.disks_knownbooleanYes—
$.system_inventory.disksarray<object; {"additionalProperties":false}>; {"maxItems":200}Yes—
$.system_inventory.disks[]object; {"additionalProperties":false}Yes—
$.system_inventory.disks[].component_idstring; {"maxLength":192}Yes—
$.system_inventory.disks[].pathstring; {"maxLength":1024}Yes—
$.system_inventory.disks[].labelstring; {"maxLength":128}Yes—
$.system_inventory.disks[].identitystring; {"maxLength":256}Yes—
$.system_inventory.swap_activeboolean | nullYes—
$.system_inventory.process_count_availablebooleanYes—
$.system_inventory.disk_ioLogicalDiskIOInventory | nullNo—
$.system_inventory.disk_io (anyOf 1)LogicalDiskIOInventoryNo—
$.system_inventory.disk_io (anyOf 1).completebooleanYes—
$.system_inventory.disk_io (anyOf 1).disk_count_knownbooleanYes—
$.system_inventory.disk_io (anyOf 1).disk_countinteger; {"minimum":0,"maximum":200}Yes—
$.system_inventory.disk_io (anyOf 1).source_countinteger; {"minimum":0,"maximum":1024}Yes—
$.system_inventory.disk_io (anyOf 1).source_setstring; {"maxLength":64}Yes—
$.system_inventory.disk_io (anyOf 2)nullNo—
$.system_inventory.healthServerHealthInventory | nullNo—
$.system_inventory.health (anyOf 1)ServerHealthInventoryNo—
$.system_inventory.health (anyOf 1).versioninteger; {"const":1}Yes—
$.system_inventory.health (anyOf 1).sourcesarray<ServerHealthSource>; {"maxItems":1200}Yes—
$.system_inventory.health (anyOf 1).sources[]ServerHealthSourceYes—
$.system_inventory.health (anyOf 1).sources[].componentServerComponentYes—
$.system_inventory.health (anyOf 1).sources[].component.addressstringNo—
$.system_inventory.health (anyOf 1).sources[].component.familystringNo—
$.system_inventory.health (anyOf 1).sources[].component.idstringYesUUID of this resource. Keep the returned identifier for subsequent operations.
$.system_inventory.health (anyOf 1).sources[].component.kindstringYesResource kind or measurement type selected from the listed values.
$.system_inventory.health (anyOf 1).sources[].component.labelstringYesDisplay name for the component.
$.system_inventory.health (anyOf 1).sources[].component.local_refstringNo—
$.system_inventory.health (anyOf 1).sources[].component.namestringNoHuman-readable resource name. Follow the listed length limit.
$.system_inventory.health (anyOf 1).sources[].component.pathstringNo—
$.system_inventory.health (anyOf 1).sources[].component.portintegerNo—
$.system_inventory.health (anyOf 1).sources[].component.projectstringNo—
$.system_inventory.health (anyOf 1).sources[].component.protocolstringNo—
$.system_inventory.health (anyOf 1).sources[].component.text_languagesobjectNo—
$.system_inventory.health (anyOf 1).sources[].component.timeout_secondsintegerNo—
$.system_inventory.health (anyOf 1).sources[].component.translationsobject; {"additionalProperties":false}No—
$.system_inventory.health (anyOf 1).sources[].component.translations.deobjectNo—
$.system_inventory.health (anyOf 1).sources[].component.translations.enobjectNo—
$.system_inventory.health (anyOf 1).sources[].component.transportstringNo—
$.system_inventory.health (anyOf 1).sources[].component.filesystem_identitystring; {"maxLength":256}NoAgent-reported volume identity. Keep it unchanged to prevent a replacement volume from continuing another volume’s history.
$.system_inventory.health (anyOf 1).sources[].component.disk_identitystring; {"maxLength":256}No—
$.system_inventory.health (anyOf 1).sources[].groupstring; {"enum":["cpu_diagnostics_v1","disk_operations_v1","disk_latency_v1","network_errors_v1","swap_traffic_v1","psi_v1","filesystem_capacity_v1","filesystem_inodes_v1","filesystem_health_v1","oom_v1","storage_health_v1"]}Yes—
$.system_inventory.health (anyOf 1).sources[].statusstring; {"enum":["ready","unsupported","permission_denied","failed"]}Yes—
$.system_inventory.health (anyOf 1).sources[].minimum_interval_secondsinteger; {"minimum":1,"maximum":86400}Yes—
$.system_inventory.health (anyOf 2)nullNo—
$.deliveryAgentDeliveryReportNo—
$.delivery.observed_atstring; {"format":"date-time"}Yes—
$.delivery.pending_objectsinteger; {"minimum":0,"maximum":10000000}Yes—
$.delivery.pending_bytesinteger; {"minimum":0,"maximum":1073741824}Yes—
$.delivery.oldest_measured_atstring; {"format":"date-time"}No—
$.delivery.last_acknowledged_atstring; {"format":"date-time"}No—
$.delivery.retry_atstring; {"format":"date-time"}No—
$.delivery.lost_objectsinteger; {"minimum":0}Yes—
$.delivery.last_errorobject; {"additionalProperties":false}No—
$.delivery.last_error.atstring; {"format":"date-time"}Yes—
$.delivery.last_error.kindstring; {"enum":["timeout","connection","tls","http","ack","storage"]}Yes—
$.delivery.last_error.statusinteger; {"minimum":0,"maximum":599}No—
$.delivery.last_error.codestring; {"enum":["","quota_exceeded","global_capacity","unavailable","http_error"]}No—
$.delivery.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—
$.resourcesServerResourceInventoryNo—
$.resources.versioninteger; {"const":1}Yes—
$.resources.measured_atstring; {"format":"date-time"}Yes—
$.resources.completebooleanYes—
$.resources.filesystemsarray<object; {"additionalProperties":false}>; {"maxItems":200}Yes—
$.resources.filesystems[]object; {"additionalProperties":false}Yes—
$.resources.filesystems[].identitystring; {"minLength":1,"maxLength":256}Yes—
$.resources.filesystems[].capacity_idstring; {"maxLength":256}Yes—
$.resources.filesystems[].total_bytesinteger | null; {"minimum":0,"maximum":1152921504606846976}Yes—

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—
$.acceptedbooleanYesNumber of newly accepted items in this response.
$.appliedbooleanYes—
$.revisionintegerYesResource revision for optimistic concurrency. Read the current revision before changing configuration.
json
{
  "accepted": false,
  "applied": false,
  "revision": 0
}
Stable error codes
device_scope
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
profile_missing
revision_conflict
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": 409,
  "title": "Demo error",
  "type": "about:blank"
}
Stable error codes
device_required
device_scope
incomplete_report
invalid_device
invalid_report
unselected_collector
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 change does not have a general retry guarantee. If the response is unclear, read the affected resource before trying again. Follow Retry-After waiting times and request new sign-in or action codes when they expire.

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 POST \
  --header @"$HOME/.config/metribeacon/headers.txt" \
  --header "Content-Type: application/json" \
  --data-binary '{}' \
  "https://metribeacon.com/api/v1/agent/server-report"
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())
headers["Content-Type"] = "application/json"
request = Request("https://metribeacon.com/api/v1/agent/server-report", data="{}".encode("utf-8"), headers=headers, method="POST")
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"));
headers["Content-Type"] = "application/json";
const response = await fetch("https://metribeacon.com/api/v1/agent/server-report", {
  method: "POST", headers, redirect: "manual",
  signal: AbortSignal.timeout(10000), body: "{}",
});
console.log(response.status);
await response.body?.cancel();
go
package main

import (
  "fmt"
  "net/http"
  "time"
  "encoding/json"
  "os"
  "path/filepath"
  "strings"
)

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("POST", "https://metribeacon.com/api/v1/agent/server-report", strings.NewReader("{}"))
  if err != nil { panic("request failed; credentials and response omitted") }
  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; credentials and response omitted") }
  defer response.Body.Close()
  fmt.Println(response.StatusCode)
}