MetriBeacon
Menu

GET Read a server profile and provisioning status

/api/v1/monitors/{id}/server-profile

The versioned catalog describes supported Linux components. Discovery does not activate selections. Provisioning reserves account-wide series places and retains existing history.

On this page

Access and permissions

The versioned catalog describes supported Linux components. Discovery does not activate selections. Provisioning reserves account-wide series places and retains existing history.

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.
viewURL querystring; {"enum":["setup","overview","status"]}NoUse setup for saved installation metadata, overview for overview configuration and current metadata, or status for current values and provisioning progress. These views exclude account-wide capacity and alarm configuration. Only the full view may reconstruct a missing legacy failure confirmation once; a pending reconstruction is reported as confirmation_ready=false.
include_seriesURL queryboolean; {"default":false}NoInclude metadata and retained latest values of additional series on this monitor. Profile-bound series remain in parameter_rows. No history is queried.

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—
$.agentobjectNo—
$.agent.architecturestring | nullNo—
$.agent.capabilitiesarray<string>No—
$.agent.capabilities[]stringYes—
$.agent.platformstring | nullNo—
$.agent.versionstring | nullNo—
$.agent.system_infoSystemInformationNo—
$.agent.system_info.versionJSON; {"const":1}Yes—
$.agent.system_info.operating_systemstring; {"maxLength":256}No—
$.agent.system_info.kernel_versionstring; {"maxLength":256}No—
$.agent.system_info.cpu_modelstring; {"maxLength":256}No—
$.agent.system_info.logical_cpu_coresinteger; {"minimum":0,"maximum":65536}No—
$.agent.system_info.memory_total_bytesinteger; {"minimum":0,"maximum":1152921504606846976}No—
$.agent.system_info.booted_atstring; {"format":"date-time"}No—
$.agent.system_info_reported_atstring | null; {"format":"date-time"}No—
$.agent_statusstringNo—
$.alarm_requestsarray<object>No—
$.alarm_requests[]objectYes—
$.alarm_requests[].rule_idstring | nullNo—
$.alarm_requests[].settingsTemplateAlarmActivationNo—
$.alarm_requests[].settings.clearAlarmConditionNo—
$.alarm_requests[].settings.clear.operatorstring; {"enum":["gt","lt","eq","ne","outside","inside"]}Yes—
$.alarm_requests[].settings.clear.valuenumberYes—
$.alarm_requests[].settings.clear.value_highnumberNoRequired for inside and outside; must be greater than value
$.alarm_requests[].settings.clear (allOf 1)JSONNo—
$.alarm_requests[].settings.clear_duration_secondsinteger; {"maximum":86400,"minimum":0}No—
$.alarm_requests[].settings.kindstring; {"enum":["numeric","state","no_data","heartbeat","run"]}YesMust match exactly one suggestion of the selected template version.
$.alarm_requests[].settings.namestring; {"maxLength":128,"minLength":1}YesHuman-readable resource name. Follow the listed length limit.
$.alarm_requests[].settings.no_data_secondsinteger; {"maximum":604800,"minimum":30}No—
$.alarm_requests[].settings.severitystring; {"enum":["info","warning","critical"]}YesSeverity value from the listed vocabulary.
$.alarm_requests[].settings.state_clear_samplesinteger; {"default":2,"maximum":2,"minimum":1}NoNumber of distinct valid consecutive checks required for this state transition.
$.alarm_requests[].settings.state_trigger_samplesinteger; {"default":2,"maximum":2,"minimum":1}NoNumber of distinct valid consecutive checks required for this state transition.
$.alarm_requests[].settings.suggestion_idstring; {"maxLength":256}YesStable suggestion ID from the current template or server profile; distinct rules may share the same kind.
$.alarm_requests[].settings.target_statestring; {"maxLength":128}No—
$.alarm_requests[].settings.triggerAlarmConditionNo—
$.alarm_requests[].settings.trigger.operatorstring; {"enum":["gt","lt","eq","ne","outside","inside"]}Yes—
$.alarm_requests[].settings.trigger.valuenumberYes—
$.alarm_requests[].settings.trigger.value_highnumberNoRequired for inside and outside; must be greater than value
$.alarm_requests[].settings.trigger (allOf 1)JSONNo—
$.alarm_requests[].settings.trigger_duration_secondsinteger; {"maximum":86400,"minimum":0}No—
$.alarm_requests[].statusstring; {"enum":["pending","active","canceled"]}No—
$.alarm_requests[].suggestion_idstringNo—
$.alarm_suggestionsarray<object; {"additionalProperties":true}>No—
$.alarm_suggestions[]object; {"additionalProperties":true}Yes—
$.alarm_suggestions[].idstringYes—
$.alarm_suggestions[].kindstringYes—
$.alarm_suggestions[].series_keystringNo—
$.alarm_suggestions[].state_clear_samplesinteger; {"maximum":2,"minimum":1}No—
$.alarm_suggestions[].state_trigger_samplesinteger; {"maximum":2,"minimum":1}No—
$.alarm_suggestions[].summarystringYes—
$.alarm_suggestions[].summary_keystringNo—
$.alarm_suggestions[].summary_paramsobjectNo—
$.alarmsarray<object>No—
$.alarms[]objectYes—
$.alarms[].idstringNo—
$.alarms[].kindstringNo—
$.alarms[].namestringNo—
$.alarms[].profile_pausedbooleanNo—
$.alarms[].series_idstring | nullNo—
$.applied_revisionintegerNo—
$.bindingsarray<object>No—
$.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.
$.capacityobjectNo—
$.capacity.alarm_limitintegerNo—
$.capacity.alarm_slotsintegerNo—
$.capacity.bytes_per_dayintegerNo—
$.capacity.new_series_per_minuteintegerYes—
$.capacity.points_per_dayintegerNo—
$.capacity.points_per_minuteintegerNo—
$.capacity.series_limitintegerYes—
$.capacity.series_slotsintegerYes—
$.capacity.states_per_dayintegerNo—
$.capacity.states_per_minuteintegerYes—
$.catalogarray<object>No—
$.catalog[]objectYes—
$.catalog[].categorystringYes—
$.catalog[].component_kindstringYes—
$.catalog[].defaultbooleanYes—
$.catalog[].descriptionstringYesOptional explanatory resource text.
$.catalog[].description_keystringYes—
$.catalog[].interval_secondsintegerYesSampling or check interval in seconds within the stated bounds.
$.catalog[].keystringYes—
$.catalog[].kindstringYesResource kind or measurement type selected from the listed values.
$.catalog[].titlestringYesShort human-readable label for the response or widget.
$.catalog[].title_keystringYes—
$.catalog[].unitstringYesDisplay unit for a numeric series; it does not automatically convert submitted values.
$.categoriesarray<object>No—
$.categories[]objectYes—
$.categories[].idstringYesUUID of this resource. Keep the returned identifier for subsequent operations.
$.categories[].titlestringYesShort human-readable label for the response or widget.
$.categories[].title_keystringYes—
$.collector_statusarray<CollectorStatus>NoPer-collector availability and diagnostics reported by the agent.
$.collector_status[]CollectorStatusYes—
$.collector_status[].component_idstringYes—
$.collector_status[].counter_epochstringNo—
$.collector_status[].parameter_keystringYes—
$.collector_status[].sourcestringNo—
$.collector_status[].statusstring; {"enum":["ready","warming_up","permission_denied","unsupported","failed"]}Yes—
$.estimateobjectNo—
$.estimate.estimated_bytes_per_dayintegerNo—
$.estimate.points_per_minutenumberNo—
$.estimate.required_seriesintegerNo—
$.estimate.states_per_minutenumberNo—
$.inventoryarray<ServerComponent>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—
$.inventory_atstring; {"format":"date-time"} | nullNo—
$.inventory_at (anyOf 1)string; {"format":"date-time"}No—
$.inventory_at (anyOf 2)nullNo—
$.jobobject | nullNo—
$.job (anyOf 1)objectNo—
$.job (anyOf 1).error_codestring | nullYes—
$.job (anyOf 1).error_code (anyOf 1)stringNo—
$.job (anyOf 1).error_code (anyOf 2)nullNo—
$.job (anyOf 1).idstringYesUUID of this resource. Keep the returned identifier for subsequent operations.
$.job (anyOf 1).statusstringYes—
$.job (anyOf 2)nullNo—
$.parameter_rowsarray<object>NoSelected and deselected retained series, batched latest values, actual sample interval and freshness. confirmed_failure requires two distinct fresh negative checks; missing values remain null.
$.parameter_rows[]objectYes—
$.parameter_rows[].component_idstringNo—
$.parameter_rows[].confirmed_failureboolean | nullNo—
$.parameter_rows[].enabledbooleanNo—
$.parameter_rows[].freshboolean | nullNo—
$.parameter_rows[].interval_secondsintegerNo—
$.parameter_rows[].kindstring | nullNo—
$.parameter_rows[].measured_atstring | nullNo—
$.parameter_rows[].namestring | nullNo—
$.parameter_rows[].parameter_keystringNo—
$.parameter_rows[].sample_interval_secondsinteger | nullNo—
$.parameter_rows[].series_idstring | nullNo—
$.parameter_rows[].unitstring | nullNo—
$.parameter_rows[].valuenumber | string | nullNo—
$.parameter_rows[].confirmation_readybooleanNo—
$.parameter_rows[].descriptionstring | nullNo—
$.parameter_rows[].custom_namebooleanNo—
$.profileServerProfileNo—
$.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.
$.protocolsarray<string>No—
$.protocols[]stringYes—
$.reported_atstring; {"format":"date-time"} | nullNo—
$.reported_at (anyOf 1)string; {"format":"date-time"}No—
$.reported_at (anyOf 2)nullNo—
$.revisionintegerNoResource revision for optimistic concurrency. Read the current revision before changing configuration.
$.chart_presetsChartPresetRegistryNo—
$.chart_presets.presetsarray<object>Yes—
$.chart_presets.presets[]objectYes—
$.chart_presets.presets[].comparisonbooleanNo—
$.chart_presets.presets[].component_kindstringYes—
$.chart_presets.presets[].groupstringYes—
$.chart_presets.presets[].idstring; {"enum":["server-overview-cpu","server-overview-memory","server-overview-load","server-disk-total","server-overview-disk","server-overview-network","server-overview-filesystem","cpu-total","cpu-parts","cpu-guest","load","load-core","memory","swap","paging","swap-traffic","filesystem-capacity","filesystem-inodes","filesystem-bytes","filesystem-operations","filesystem-service_time","filesystem-time","disk-bytes","disk-operations","disk-service_time","disk-time","filesystem-states","disk-busy","disk-states","network-traffic","network-packets","network-errors","network-states","container-status","container-restarts","descriptors","uptime","server-overview-swap","server-overview-processes","filesystem-inode-usage","disk-weighted-latency","resource-pressure","oom-killed","storage-pool-health","storage-pool-progress"]}Yes—
$.chart_presets.presets[].membersarray<object>Yes—
$.chart_presets.presets[].members[]objectYes—
$.chart_presets.presets[].members[].axisstring; {"enum":["left","right"]}Yes—
$.chart_presets.presets[].members[].keystringYes—
$.chart_presets.presets[].members[].modestring; {"enum":["value","rate","increase"]}Yes—
$.chart_presets.presets[].members[].rolestring; {"enum":["plot","limit","context"]}Yes—
$.chart_presets.presets[].members[].transformstring; {"enum":["busy_percent","pressure_percent","operations_mean"]}No—
$.chart_presets.presets[].members[].label_keystringNo—
$.chart_presets.presets[].members[].optionalbooleanNo—
$.chart_presets.presets[].members[].denominatorstringNo—
$.chart_presets.presets[].presentationstring; {"enum":["line","area","bar","capacity","stack","state","duration"]}Yes—
$.chart_presets.presets[].stack_keysarray<string>No—
$.chart_presets.presets[].stack_keys[]stringYes—
$.chart_presets.presets[].title_keystringYes—
$.chart_presets.presets[].setup_presetstring; {"enum":["server-overview","server-overview-optional"]}No—
$.chart_presets.presets[].display_unitstring; {"enum":["auto","bits"]}No—
$.chart_presets.versioninteger; {"minimum":1}Yes—
$.filesystem_discovery_statearray<object>; {"maxItems":200}No—
$.filesystem_discovery_state[]objectYes—
$.filesystem_discovery_state[].component_idstringNo—
$.filesystem_discovery_state[].pathstringNo—
$.filesystem_discovery_state[].identitystring; {"maxLength":256}NoAgent-reported volume identity. Keep it unchanged to prevent a replacement volume from continuing another volume’s history.
$.filesystem_discovery_state[].typestringNo—
$.filesystem_discovery_state[].statusstring; {"enum":["ready","missing","manual","identity_changed","waiting_quota","unsupported","permission_denied","failed"]}No—
$.setup_platformstring | null; {"enum":["linux","darwin","windows",null]}No—
$.update_jobstringNo—
$.system_discovery_statearray<object>; {"maxItems":600}No—
$.system_discovery_state[]objectYes—
$.system_discovery_state[].component_idstringYes—
$.system_discovery_state[].kindstring; {"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[].statusstring; {"enum":["ready","missing","inactive","manual","identity_changed","waiting_quota","unknown","unsupported","permission_denied","failed"]}Yes—
$.disk_ioLogicalDiskIOInventory | nullNo—
$.disk_io (anyOf 1)LogicalDiskIOInventoryNo—
$.disk_io (anyOf 1).completebooleanYes—
$.disk_io (anyOf 1).disk_count_knownbooleanYes—
$.disk_io (anyOf 1).disk_countinteger; {"minimum":0,"maximum":200}Yes—
$.disk_io (anyOf 1).source_countinteger; {"minimum":0,"maximum":1024}Yes—
$.disk_io (anyOf 1).source_setstring; {"maxLength":64}Yes—
$.disk_io (anyOf 2)nullNo—
$.additional_seriesarray<object>NoInclude metadata and retained latest values of additional series on this monitor. Profile-bound series remain in parameter_rows. No history is queried.
$.additional_series[]objectYes—
$.additional_series[].idstringNo—
$.additional_series[].device_idstringNo—
$.additional_series[].namestringNo—
$.additional_series[].descriptionstringNo—
$.additional_series[].kindstringNo—
$.additional_series[].unitstringNo—
$.additional_series[].expected_interval_secondsintegerNo—
$.additional_series[].labelsobjectNo—
$.additional_series[].created_atstring; {"format":"date-time"}No—
$.additional_series[].derivedbooleanNo—
$.additional_series[].derived_enabledboolean | nullNo—
$.additional_series[].valuenumber | string | nullNo—
$.additional_series[].measured_atstring | null; {"format":"date-time"}No—
$.additional_series[].freshboolean | nullNo—
$.delivery_diagnosticsbooleanNo—
$.resource_inventorybooleanNo—
json
{}
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_monitor
invalid_view
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/monitors/00000000-0000-4000-8000-000000000001/server-profile"
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/monitors/00000000-0000-4000-8000-000000000001/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()
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/monitors/00000000-0000-4000-8000-000000000001/server-profile", {
  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/monitors/00000000-0000-4000-8000-000000000001/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)
}
  • HTTP API, OAuth and MCP

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

  • PUT Update a server profile with a revision check

    The expected revision prevents lost updates. Existing components cannot silently change identity. Explicit reuse mapping preserves known history; newly selected parameters are provisioned asynchronously within account limits.

  • POST Preview a server profile change

    Preview a server profile change without saving it. Returns new and retained series, required capacity, expected data volume and alarm suggestions. Use the current revision and review the preview before saving.

  • DELETE Permanently delete a monitor

    Only the workspace owner may permanently delete a monitor. First request a five-minute configuration-bound preview, then send preview_id, confirm_deletion: true and an Idempotency-Key. Unconfirmed legacy archive requests are rejected. The monitor is immediately blocked; a durable job removes all its database, archive and cache data and cleans linked displays. Read the job until complete; paused jobs show a technical error and retry automatically. Daily quotas and security counters remain unchanged. Previously delivered messages and downloaded files cannot be recalled.