MetriBeacon
Menu

PUT Update a server profile with a revision check

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

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.

On this page

Access and permissions

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.

Browser session: __Host-mb_session cookie.

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

When using a browser session for a mutation, send the current CSRF token in X-CSRF-Token with the same-site cookie. OAuth consent uses its documented form field.

Parameters and headers

FieldLocationType and limitsRequiredMeaning
idPathstring; {"format":"uuid"}YesResource UUID from the path. It must exist and be accessible to the acting identity.
OriginHeaderstring; {"format":"uri"}NoIf present, must match the canonical HTTPS origin. Sec-Fetch-Site cross-site is rejected.
X-CSRF-TokenHeaderstringNoBrowser CSRF cookie value. Not required when an allowed machine management credential is used.

Request body

FieldType and limitsRequiredMeaning
$object; {"additionalProperties":false}Yes—
$.activate_alarmsarray<TemplateAlarmActivation>; {"maxItems":200}NoExplicit alarm choices reserve slots atomically with the profile and are provisioned after series binding.
$.activate_alarms[]TemplateAlarmActivationYes—
$.activate_alarms[].clearAlarmConditionNo—
$.activate_alarms[].clear.operatorstring; {"enum":["gt","lt","eq","ne","outside","inside"]}Yes—
$.activate_alarms[].clear.valuenumberYes—
$.activate_alarms[].clear.value_highnumberNoRequired for inside and outside; must be greater than value
$.activate_alarms[].clear (allOf 1)JSONNo—
$.activate_alarms[].clear_duration_secondsinteger; {"maximum":86400,"minimum":0}No—
$.activate_alarms[].kindstring; {"enum":["numeric","state","no_data","heartbeat","run"]}YesMust match exactly one suggestion of the selected template version.
$.activate_alarms[].namestring; {"maxLength":128,"minLength":1}YesHuman-readable resource name. Follow the listed length limit.
$.activate_alarms[].no_data_secondsinteger; {"maximum":604800,"minimum":30}No—
$.activate_alarms[].severitystring; {"enum":["info","warning","critical"]}YesSeverity value from the listed vocabulary.
$.activate_alarms[].state_clear_samplesinteger; {"default":2,"maximum":2,"minimum":1}NoNumber of distinct valid consecutive checks required for this state transition.
$.activate_alarms[].state_trigger_samplesinteger; {"default":2,"maximum":2,"minimum":1}NoNumber of distinct valid consecutive checks required for this state transition.
$.activate_alarms[].suggestion_idstring; {"maxLength":256}YesStable suggestion ID from the current template or server profile; distinct rules may share the same kind.
$.activate_alarms[].target_statestring; {"maxLength":128}No—
$.activate_alarms[].triggerAlarmConditionNo—
$.activate_alarms[].trigger.operatorstring; {"enum":["gt","lt","eq","ne","outside","inside"]}Yes—
$.activate_alarms[].trigger.valuenumberYes—
$.activate_alarms[].trigger.value_highnumberNoRequired for inside and outside; must be greater than value
$.activate_alarms[].trigger (allOf 1)JSONNo—
$.activate_alarms[].trigger_duration_secondsinteger; {"maximum":86400,"minimum":0}No—
$.cancel_alarm_suggestion_idsarray<string>; {"maxItems":200}NoCancel pending suggestions explicitly; existing active rules are paused by deselection and are not deleted.
$.cancel_alarm_suggestion_ids[]stringYes—
$.profileServerProfileRequestYes—
$.profile.componentsarray<object>; {"maxItems":200} | nullNoDiscovered 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} | nullNoSelected 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}NoSampling 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.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.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.
$.reactivate_alarm_idsarray<string>; {"maxItems":200}No—
$.reactivate_alarm_ids[]stringYes—
$.reuse_seriesarray<object; {"additionalProperties":false}>; {"maxItems":200}No—
$.reuse_series[]object; {"additionalProperties":false}Yes—
$.reuse_series[].component_idstringYesStable identifier of the selected or discovered component.
$.reuse_series[].interval_secondsintegerYesSampling or check interval in seconds within the stated bounds.
$.reuse_series[].parameter_keystringYesStable parameter identifier from the server catalog.
$.reuse_series[].series_idstringYesUUID of the measurement series belonging to the authorized device.
$.revisioninteger; {"default":0,"minimum":0}NoResource revision for optimistic concurrency. Read the current revision before changing configuration.

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—
$.agent_statusstringYes—
$.job_idstringYesUUID used to poll the asynchronous job. Acceptance is not completion.
$.revisionintegerYesResource revision for optimistic concurrency. Read the current revision before changing configuration.
$.statusstringYes—
json
{
  "agent_status": "demo",
  "job_id": "demo",
  "revision": 0,
  "status": "demo"
}
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
revision_conflict
numeric_interval_disabled
agent_upgrade_required
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_alarm_selection
invalid_profile
invalid_series_mapping
unsupported_parameter
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
alarm_limit
series_limit
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
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.

HTTP 202 means the background job was accepted. Use the returned job ID to check its status. Download results when the job is complete, or inspect its error or cancellation status.

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 PUT \
  --header @"$HOME/.config/metribeacon/headers.txt" \
  --header "Content-Type: application/json" \
  --data-binary '{"profile":{"version":2}}' \
  "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())
headers["Content-Type"] = "application/json"
request = Request("https://metribeacon.com/api/v1/monitors/00000000-0000-4000-8000-000000000001/server-profile", data="{\"profile\":{\"version\":2}}".encode("utf-8"), headers=headers, method="PUT")
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/monitors/00000000-0000-4000-8000-000000000001/server-profile", {
  method: "PUT", headers, redirect: "manual",
  signal: AbortSignal.timeout(10000), body: "{\"profile\":{\"version\":2}}",
});
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("PUT", "https://metribeacon.com/api/v1/monitors/00000000-0000-4000-8000-000000000001/server-profile", strings.NewReader("{\"profile\":{\"version\":2}}"))
  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)
}
  • HTTP API, OAuth and MCP

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

  • GET Read a server profile and provisioning status

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

  • 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.