GET Read the profile assigned to the device key
/api/v1/agent/server-profile
The device-bound key can read only its active server monitor profile and assigned series. Capability and account admission limits still apply.
On this page
Access and permissions
The device-bound key can read only its active server monitor profile and assigned series. Capability and account admission limits still apply.
API write key in Authorization: Bearer. It allows data submission for the selected devices or all devices in its workspace.
Parameters and headers
| Field | Location | Type and limits | Required | Meaning |
|---|---|---|---|---|
| X-MetriBeacon-Device-ID | Header | string; {"format":"uuid"} | No | Target device UUID. Required for shared keys, implicit for one selected device. Header and body targets must match. |
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 | Yes | — |
| $.agent | object | No | — |
| $.agent.architecture | string | null | No | — |
| $.agent.capabilities | array<string> | No | — |
| $.agent.capabilities[] | string | Yes | — |
| $.agent.platform | string | null | No | — |
| $.agent.version | string | null | No | — |
| $.agent.system_info | SystemInformation | No | — |
| $.agent.system_info.version | JSON; {"const":1} | Yes | — |
| $.agent.system_info.operating_system | string; {"maxLength":256} | No | — |
| $.agent.system_info.kernel_version | string; {"maxLength":256} | No | — |
| $.agent.system_info.cpu_model | string; {"maxLength":256} | No | — |
| $.agent.system_info.logical_cpu_cores | integer; {"minimum":0,"maximum":65536} | No | — |
| $.agent.system_info.memory_total_bytes | integer; {"minimum":0,"maximum":1152921504606846976} | No | — |
| $.agent.system_info.booted_at | string; {"format":"date-time"} | No | — |
| $.agent.system_info_reported_at | string | null; {"format":"date-time"} | No | — |
| $.agent_status | string | No | — |
| $.applied_revision | integer | No | — |
| $.bindings | array<object> | No | — |
| $.bindings[] | object | Yes | — |
| $.bindings[].component_id | string | Yes | Stable identifier of the selected or discovered component. |
| $.bindings[].interval_seconds | integer | Yes | Sampling or check interval in seconds within the stated bounds. |
| $.bindings[].parameter_key | string | Yes | Stable parameter identifier from the server catalog. |
| $.bindings[].series_id | string | Yes | UUID of the measurement series belonging to the authorized device. |
| $.collector_status | array<CollectorStatus> | No | Per-collector availability and diagnostics reported by the agent. |
| $.collector_status[] | CollectorStatus | Yes | — |
| $.collector_status[].component_id | string | Yes | — |
| $.collector_status[].counter_epoch | string | No | — |
| $.collector_status[].parameter_key | string | Yes | — |
| $.collector_status[].source | string | No | — |
| $.collector_status[].status | string; {"enum":["ready","warming_up","permission_denied","unsupported","failed"]} | Yes | — |
| $.inventory | array<ServerComponent> | No | Bounded discovered server components; this does not execute arbitrary server commands. |
| $.inventory[] | ServerComponent | Yes | — |
| $.inventory[].address | string | No | — |
| $.inventory[].family | string | No | — |
| $.inventory[].id | string | Yes | UUID of this resource. Keep the returned identifier for subsequent operations. |
| $.inventory[].kind | string | Yes | Resource kind or measurement type selected from the listed values. |
| $.inventory[].label | string | Yes | Display name for the component. |
| $.inventory[].local_ref | string | No | — |
| $.inventory[].name | string | No | Human-readable resource name. Follow the listed length limit. |
| $.inventory[].path | string | No | — |
| $.inventory[].port | integer | No | — |
| $.inventory[].project | string | No | — |
| $.inventory[].protocol | string | No | — |
| $.inventory[].text_languages | object | No | — |
| $.inventory[].timeout_seconds | integer | No | — |
| $.inventory[].translations | object; {"additionalProperties":false} | No | — |
| $.inventory[].translations.de | object | No | — |
| $.inventory[].translations.en | object | No | — |
| $.inventory[].transport | string | No | — |
| $.inventory[].filesystem_identity | string; {"maxLength":256} | No | Agent-reported volume identity. Keep it unchanged to prevent a replacement volume from continuing another volume’s history. |
| $.inventory[].disk_identity | string; {"maxLength":256} | No | — |
| $.inventory_at | string; {"format":"date-time"} | null | No | — |
| $.inventory_at (anyOf 1) | string; {"format":"date-time"} | No | — |
| $.inventory_at (anyOf 2) | null | No | — |
| $.job | object | null | No | — |
| $.job (anyOf 1) | object | No | — |
| $.job (anyOf 1).error_code | string | null | Yes | — |
| $.job (anyOf 1).error_code (anyOf 1) | string | No | — |
| $.job (anyOf 1).error_code (anyOf 2) | null | No | — |
| $.job (anyOf 1).id | string | Yes | UUID of this resource. Keep the returned identifier for subsequent operations. |
| $.job (anyOf 1).status | string | Yes | — |
| $.job (anyOf 2) | null | No | — |
| $.profile | ServerProfile | No | — |
| $.profile.components | array<object>; {"maxItems":200} | null | Yes | Discovered or explicitly selected server components. |
| $.profile.components (anyOf 1) | array<object>; {"maxItems":200} | No | — |
| $.profile.components (anyOf 1)[] | object | Yes | — |
| $.profile.components (anyOf 1)[].address | string | No | — |
| $.profile.components (anyOf 1)[].family | string | No | — |
| $.profile.components (anyOf 1)[].id | string | Yes | UUID of this resource. Keep the returned identifier for subsequent operations. |
| $.profile.components (anyOf 1)[].kind | string | Yes | Resource kind or measurement type selected from the listed values. |
| $.profile.components (anyOf 1)[].label | string; {"maxLength":128,"minLength":1} | Yes | Display name for the component. |
| $.profile.components (anyOf 1)[].local_ref | string | No | — |
| $.profile.components (anyOf 1)[].name | string | No | Human-readable resource name. Follow the listed length limit. |
| $.profile.components (anyOf 1)[].path | string; {"maxLength":1024} | No | — |
| $.profile.components (anyOf 1)[].port | integer | No | — |
| $.profile.components (anyOf 1)[].project | string | No | — |
| $.profile.components (anyOf 1)[].protocol | string | No | — |
| $.profile.components (anyOf 1)[].text_languages | object | No | — |
| $.profile.components (anyOf 1)[].timeout_seconds | integer | No | — |
| $.profile.components (anyOf 1)[].translations | object; {"additionalProperties":false} | No | — |
| $.profile.components (anyOf 1)[].translations.de | object | No | — |
| $.profile.components (anyOf 1)[].translations.en | object | No | — |
| $.profile.components (anyOf 1)[].transport | string | No | — |
| $.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. |
| $.profile.components (anyOf 1)[].disk_identity | string; {"maxLength":256} | No | — |
| $.profile.components (anyOf 2) | null | No | — |
| $.profile.selections | array<object>; {"maxItems":200} | null | Yes | Selected component/parameter pairs and sampling intervals. |
| $.profile.selections (anyOf 1) | array<object>; {"maxItems":200} | No | — |
| $.profile.selections (anyOf 1)[] | object | Yes | — |
| $.profile.selections (anyOf 1)[].component_id | string | Yes | Stable identifier of the selected or discovered component. |
| $.profile.selections (anyOf 1)[].interval_seconds | integer; {"maximum":86400,"minimum":0} | Yes | Sampling or check interval in seconds within the stated bounds. |
| $.profile.selections (anyOf 1)[].parameter_key | string | Yes | Stable parameter identifier from the server catalog. |
| $.profile.selections (anyOf 2) | null | No | — |
| $.profile.version | JSON; {"const":2} | Yes | — |
| $.profile.overview | object; {"additionalProperties":false} | No | Explicit targets for the six-chart server overview; select all required readings. |
| $.profile.overview.system_id | string; {"maxLength":128} | Yes | — |
| $.profile.overview.filesystem_id | string; {"maxLength":128} | Yes | — |
| $.profile.overview.disk_id | string; {"maxLength":128} | Yes | — |
| $.profile.overview.network_id | string; {"maxLength":128} | Yes | — |
| $.profile.overview.platform | string; {"enum":["linux","darwin","windows"]} | No | Platform of the automatic overview. Only supported metrics are selected; undetected disk or network targets stay empty. |
| $.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. |
| $.profile.filesystem_discovery.mode | string; {"enum":["off","local"]} | Yes | — |
| $.profile.filesystem_discovery.interval_seconds | integer; {"minimum":10,"maximum":86400} | Yes | — |
| $.profile.system_discovery | object; {"additionalProperties":false} | No | — |
| $.profile.system_discovery.mode | string; {"enum":["off","local"]} | Yes | — |
| $.profile.system_discovery.interval_seconds | integer; {"minimum":10,"maximum":86400} | Yes | — |
| $.profile.disk_io_interval_seconds | integer; {"minimum":1,"maximum":86400} | No | — |
| $.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. |
| $.reported_at | string; {"format":"date-time"} | null | No | — |
| $.reported_at (anyOf 1) | string; {"format":"date-time"} | No | — |
| $.reported_at (anyOf 2) | null | No | — |
| $.revision | integer | No | Resource revision for optimistic concurrency. Read the current revision before changing configuration. |
| $.filesystem_discovery_state | array<object>; {"maxItems":200} | No | — |
| $.filesystem_discovery_state[] | object | Yes | — |
| $.filesystem_discovery_state[].component_id | string | No | — |
| $.filesystem_discovery_state[].path | string | No | — |
| $.filesystem_discovery_state[].identity | string; {"maxLength":256} | No | Agent-reported volume identity. Keep it unchanged to prevent a replacement volume from continuing another volume’s history. |
| $.filesystem_discovery_state[].type | string | No | — |
| $.filesystem_discovery_state[].status | string; {"enum":["ready","missing","manual","identity_changed","waiting_quota","unsupported","permission_denied","failed"]} | No | — |
| $.update_job | string | No | — |
| $.system_discovery_state | array<object>; {"maxItems":600} | No | — |
| $.system_discovery_state[] | object | Yes | — |
| $.system_discovery_state[].component_id | string | Yes | — |
| $.system_discovery_state[].kind | string; {"enum":["disk","swap","processes","disk_total","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_discovery_state[].status | string; {"enum":["ready","missing","inactive","manual","identity_changed","waiting_quota","unknown","unsupported","permission_denied","failed"]} | Yes | — |
| $.disk_io | LogicalDiskIOInventory | null | No | — |
| $.disk_io (anyOf 1) | LogicalDiskIOInventory | No | — |
| $.disk_io (anyOf 1).complete | boolean | Yes | — |
| $.disk_io (anyOf 1).disk_count_known | boolean | Yes | — |
| $.disk_io (anyOf 1).disk_count | integer; {"minimum":0,"maximum":200} | Yes | — |
| $.disk_io (anyOf 1).source_count | integer; {"minimum":0,"maximum":1024} | Yes | — |
| $.disk_io (anyOf 1).source_set | string; {"maxLength":64} | Yes | — |
| $.disk_io (anyOf 2) | null | No | — |
| $.delivery_diagnostics | boolean | No | — |
| $.resource_inventory | boolean | No | — |
{}| Stable error codes |
|---|
| device_scope |
| 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": 422,
"title": "Demo error",
"type": "about:blank"
}| Stable error codes |
|---|
| device_required |
| device_scope |
| invalid_device |
| 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": 422,
"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
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.
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/server-profile"
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/server-profile", 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/agent/server-profile", {
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/agent/server-profile", 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.
- POST Report discovered server components and collection status
Discovery and unsupported/permission-denied reports do not count as measurement values or enable selections. Accepted reports update only the key’s server monitor.
- GET Read a server-profile provisioning job
Read a server-profile provisioning job.
- POST Cancel a server-profile provisioning job
Cancels pending provisioning. Already created series and their history remain; unused pending selections release reservations.