MetriBeacon
Menu

GET Read bound agent configuration

/api/v1/agent/collection

Read the current configuration and its agent acknowledgement. The collection interval is separate from the refresh interval of unchanged states. Custom definitions contain only declared field types and source identities, never commands or credentials.

On this page

Access and permissions

Read the current configuration and its agent acknowledgement. The collection interval is separate from the refresh interval of unchanged states. Custom definitions contain only declared field types and source identities, never commands or credentials.

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

No request body.

Responses

application/json

FieldType and limitsRequiredMeaning
$CollectionSnapshotYes—
$.enabledbooleanYes—
$.can_writebooleanYes—
$.revisionintegerYes—
$.applied_revisionintegerYes—
$.reported_atstring | null; {"format":"date-time"}Yes—
$.sourcesarray<CollectionSource>; {"maxItems":200}Yes—
$.sources[]CollectionSourceYes—
$.sources[].source_idstring; {"minLength":1,"maxLength":400,"pattern":"^[a-zA-Z0-9][a-zA-Z0-9_./:-]{0,399}$"}Yes—
$.sources[].component_idstringYes—
$.sources[].parameter_keystringYes—
$.sources[].kindstring; {"enum":["gauge","counter","boolean","enum"]}Yes—
$.sources[].unitstring; {"maxLength":32}Yes—
$.sources[].namestring; {"minLength":1,"maxLength":128}Yes—
$.sources[].descriptionstring; {"maxLength":512}Yes—
$.sources[].interval_secondsinteger; {"minimum":1,"maximum":86400}Yes—
$.sources[].availablebooleanYes—
$.sources[].originstring; {"enum":["catalog","custom","external"]}Yes—
$.sources[].series_idstring | null; {"format":"uuid"}Yes—
$.sources[].enabledbooleanYes—
$.sources[].revisionintegerYes—
$.sources[].changed_bystring; {"enum":["profile","website","agent","registration"]}Yes—
$.sources[].changed_atstring; {"format":"date-time"}Yes—
$.sources[].statusstring; {"enum":["pending","ready","warming_up","unsupported","permission_denied","failed","component_missing","disabled","external"]}Yes—
$.profile_revisionintegerYes—
$.profileServerProfileYes—
$.profile.componentsarray<object>; {"maxItems":200} | nullYesDiscovered or explicitly selected server components.
$.profile.components (anyOf 1)array<object>; {"maxItems":200}No—
$.profile.components (anyOf 1)[]objectYes—
$.profile.components (anyOf 1)[].addressstringNo—
$.profile.components (anyOf 1)[].familystringNo—
$.profile.components (anyOf 1)[].idstringYesUUID of this resource. Keep the returned identifier for subsequent operations.
$.profile.components (anyOf 1)[].kindstringYesResource kind or measurement type selected from the listed values.
$.profile.components (anyOf 1)[].labelstring; {"maxLength":128,"minLength":1}YesDisplay name for the component.
$.profile.components (anyOf 1)[].local_refstringNo—
$.profile.components (anyOf 1)[].namestringNoHuman-readable resource name. Follow the listed length limit.
$.profile.components (anyOf 1)[].pathstring; {"maxLength":1024}No—
$.profile.components (anyOf 1)[].portintegerNo—
$.profile.components (anyOf 1)[].projectstringNo—
$.profile.components (anyOf 1)[].protocolstringNo—
$.profile.components (anyOf 1)[].text_languagesobjectNo—
$.profile.components (anyOf 1)[].timeout_secondsintegerNo—
$.profile.components (anyOf 1)[].translationsobject; {"additionalProperties":false}No—
$.profile.components (anyOf 1)[].translations.deobjectNo—
$.profile.components (anyOf 1)[].translations.enobjectNo—
$.profile.components (anyOf 1)[].transportstringNo—
$.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.
$.profile.components (anyOf 1)[].disk_identitystring; {"maxLength":256}No—
$.profile.components (anyOf 2)nullNo—
$.profile.selectionsarray<object>; {"maxItems":200} | nullYesSelected component/parameter pairs and sampling intervals.
$.profile.selections (anyOf 1)array<object>; {"maxItems":200}No—
$.profile.selections (anyOf 1)[]objectYes—
$.profile.selections (anyOf 1)[].component_idstringYesStable identifier of the selected or discovered component.
$.profile.selections (anyOf 1)[].interval_secondsinteger; {"maximum":86400,"minimum":0}YesSampling or check interval in seconds within the stated bounds.
$.profile.selections (anyOf 1)[].parameter_keystringYesStable parameter identifier from the server catalog.
$.profile.selections (anyOf 2)nullNo—
$.profile.versionJSON; {"const":2}Yes—
$.profile.overviewobject; {"additionalProperties":false}NoExplicit targets for the six-chart server overview; select all required readings.
$.profile.overview.system_idstring; {"maxLength":128}Yes—
$.profile.overview.filesystem_idstring; {"maxLength":128}Yes—
$.profile.overview.disk_idstring; {"maxLength":128}Yes—
$.profile.overview.network_idstring; {"maxLength":128}Yes—
$.profile.overview.platformstring; {"enum":["linux","darwin","windows"]}NoPlatform of the automatic overview. Only supported metrics are selected; undetected disk or network targets stay empty.
$.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.
$.profile.filesystem_discovery.modestring; {"enum":["off","local"]}Yes—
$.profile.filesystem_discovery.interval_secondsinteger; {"minimum":10,"maximum":86400}Yes—
$.profile.system_discoveryobject; {"additionalProperties":false}No—
$.profile.system_discovery.modestring; {"enum":["off","local"]}Yes—
$.profile.system_discovery.interval_secondsinteger; {"minimum":10,"maximum":86400}Yes—
$.profile.disk_io_interval_secondsinteger; {"minimum":1,"maximum":86400}No—
$.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.
$.bindingsarray<object>; {"maxItems":200}Yes—
$.bindings[]objectYes—
$.bindings[].component_idstringYesStable identifier of the selected or discovered component.
$.bindings[].interval_secondsintegerYesSampling or check interval in seconds within the stated bounds.
$.bindings[].parameter_keystringYesStable parameter identifier from the server catalog.
$.bindings[].series_idstringYesUUID of the measurement series belonging to the authorized device.
$.update_jobstring; {"format":"uuid"}No—
$.delivery_diagnosticsbooleanNo—
$.resource_inventorybooleanNo—
Stable error codes
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
agent_config_write_required
forbidden
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
Stable error codes
operation_conflict
feature_disabled
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
invalid_collection
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
quota_exceeded
live_capacity
rate_limited
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": 429,
  "title": "Demo error",
  "type": "about:blank"
}
Stable error codes
unavailable
stream_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/agent/collection"
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/agent/collection", 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/agent/collection", {
  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/agent/collection", 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)
}
  • HTTP API, OAuth and MCP

    Find the user API endpoints, their permissions, fields, examples and response formats.

  • PATCH Synchronize local changes

    Uses stable source identities. Each changed field is applied in server acceptance order; unrelated fields and measurement history remain intact. Repeat the same operation_id and body after a lost response. Names, descriptions, activation and collection intervals synchronize. Executables and arguments remain in the locally approved policy.

  • POST Report checks and applied configuration

    Read the current configuration and its agent acknowledgement. The collection interval is separate from the refresh interval of unchanged states. Custom definitions contain only declared field types and source identities, never commands or credentials.

  • GET Receive bound agent revisions

    An outgoing HTTPS event stream signals new revisions. Fetch the current snapshot after each event or reconnect; Last-Event-ID is not a replay log. CLI and MCP credentials receive one JSON revision for bounded polling. Without events, poll every five seconds and apply error backoff.