POST Preview a server profile change
/api/v1/monitors/{id}/server-profile/plan
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.
On this page
Access and permissions
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.
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
| Field | Location | Type and limits | Required | Meaning |
|---|---|---|---|---|
| id | Path | string; {"format":"uuid"} | Yes | Resource UUID from the path. It must exist and be accessible to the acting identity. |
| Origin | Header | string; {"format":"uri"} | No | If present, must match the canonical HTTPS origin. Sec-Fetch-Site cross-site is rejected. |
| X-CSRF-Token | Header | string | No | Browser CSRF cookie value. Not required when an allowed machine management credential is used. |
Request body
| Field | Type and limits | Required | Meaning |
|---|---|---|---|
| $ | object; {"additionalProperties":false} | Yes | — |
| $.activate_alarms | array<TemplateAlarmActivation>; {"maxItems":200} | No | Explicit alarm choices reserve slots atomically with the profile and are provisioned after series binding. |
| $.activate_alarms[] | TemplateAlarmActivation | Yes | — |
| $.activate_alarms[].clear | AlarmCondition | No | — |
| $.activate_alarms[].clear.operator | string; {"enum":["gt","lt","eq","ne","outside","inside"]} | Yes | — |
| $.activate_alarms[].clear.value | number | Yes | — |
| $.activate_alarms[].clear.value_high | number | No | Required for inside and outside; must be greater than value |
| $.activate_alarms[].clear (allOf 1) | JSON | No | — |
| $.activate_alarms[].clear_duration_seconds | integer; {"maximum":86400,"minimum":0} | No | — |
| $.activate_alarms[].kind | string; {"enum":["numeric","state","no_data","heartbeat","run"]} | Yes | Must match exactly one suggestion of the selected template version. |
| $.activate_alarms[].name | string; {"maxLength":128,"minLength":1} | Yes | Human-readable resource name. Follow the listed length limit. |
| $.activate_alarms[].no_data_seconds | integer; {"maximum":604800,"minimum":30} | No | — |
| $.activate_alarms[].severity | string; {"enum":["info","warning","critical"]} | Yes | Severity value from the listed vocabulary. |
| $.activate_alarms[].state_clear_samples | integer; {"default":2,"maximum":2,"minimum":1} | No | Number of distinct valid consecutive checks required for this state transition. |
| $.activate_alarms[].state_trigger_samples | integer; {"default":2,"maximum":2,"minimum":1} | No | Number of distinct valid consecutive checks required for this state transition. |
| $.activate_alarms[].suggestion_id | string; {"maxLength":256} | Yes | Stable suggestion ID from the current template or server profile; distinct rules may share the same kind. |
| $.activate_alarms[].target_state | string; {"maxLength":128} | No | — |
| $.activate_alarms[].trigger | AlarmCondition | No | — |
| $.activate_alarms[].trigger.operator | string; {"enum":["gt","lt","eq","ne","outside","inside"]} | Yes | — |
| $.activate_alarms[].trigger.value | number | Yes | — |
| $.activate_alarms[].trigger.value_high | number | No | Required for inside and outside; must be greater than value |
| $.activate_alarms[].trigger (allOf 1) | JSON | No | — |
| $.activate_alarms[].trigger_duration_seconds | integer; {"maximum":86400,"minimum":0} | No | — |
| $.cancel_alarm_suggestion_ids | array<string>; {"maxItems":200} | No | Cancel pending suggestions explicitly; existing active rules are paused by deselection and are not deleted. |
| $.cancel_alarm_suggestion_ids[] | string | Yes | — |
| $.profile | ServerProfileRequest | Yes | — |
| $.profile.components | array<object>; {"maxItems":200} | null | No | 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 | No | 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} | No | 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.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.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. |
| $.reactivate_alarm_ids | array<string>; {"maxItems":200} | No | — |
| $.reactivate_alarm_ids[] | string | Yes | — |
| $.reuse_series | array<object; {"additionalProperties":false}>; {"maxItems":200} | No | — |
| $.reuse_series[] | object; {"additionalProperties":false} | Yes | — |
| $.reuse_series[].component_id | string | Yes | Stable identifier of the selected or discovered component. |
| $.reuse_series[].interval_seconds | integer | Yes | Sampling or check interval in seconds within the stated bounds. |
| $.reuse_series[].parameter_key | string | Yes | Stable parameter identifier from the server catalog. |
| $.reuse_series[].series_id | string | Yes | UUID of the measurement series belonging to the authorized device. |
| $.revision | integer; {"default":0,"minimum":0} | No | Resource revision for optimistic concurrency. Read the current revision before changing configuration. |
Responses
application/json
| Field | Type and limits | Required | Meaning |
|---|---|---|---|
| $ | object; {"additionalProperties":true} | Yes | — |
| $.estimate | object; {"additionalProperties":true} | Yes | — |
| $.fits | boolean | Yes | — |
| $.new_series | integer; {"minimum":0} | Yes | — |
| $.reason | string; {"enum":["","series_limit","alarm_limit"]} | Yes | — |
| $.retained_history_series | integer; {"minimum":0} | Yes | — |
| 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_status | string | Yes | — |
| $.job_id | string | Yes | UUID used to poll the asynchronous job. Acceptance is not completion. |
| $.revision | integer | Yes | Resource revision for optimistic concurrency. Read the current revision before changing configuration. |
| $.status | string | Yes | — |
{
"agent_status": "demo",
"job_id": "demo",
"revision": 0,
"status": "demo"
}| Stable error codes |
|---|
| invalid_credential |
| unauthorized |
| 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": 401,
"title": "Demo error",
"type": "about:blank"
}| Stable error codes |
|---|
| csrf |
| insufficient_scope |
| invalid_origin |
| 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": 403,
"title": "Demo error",
"type": "about:blank"
}| Stable error codes |
|---|
| not_found |
| 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": 404,
"title": "Demo error",
"type": "about:blank"
}| Stable error codes |
|---|
| revision_conflict |
| 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": 409,
"title": "Demo error",
"type": "about:blank"
}| Stable error codes |
|---|
| invalid_alarm_selection |
| invalid_profile |
| invalid_selection |
| invalid_series_mapping |
| unsupported_parameter |
| 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 |
|---|
| series_limit |
| 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": 429,
"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 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.
curl --silent --show-error --outpost /dev/null --write-out "%{http_code}\n" \
--request POST \
--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/plan"
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/plan", data="{\"profile\":{\"version\":2}}".encode("utf-8"), headers=headers, method="POST")
class NoRedirect(HTTPRedirectHandler):
def redirect_request(self, request, fp, code, message, headers, target):
return None
opener = build_opener(NoRedirect())
try:
with opener.open(request, timeout=10) as response:
print(response.status)
except HTTPError as error:
print(error.code)
error.close()
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/plan", {
method: "POST", headers, redirect: "manual",
signal: AbortSignal.timeout(10000), body: "{\"profile\":{\"version\":2}}",
});
console.log(response.status);
await response.body?.cancel();
package main
import (
"fmt"
"net/http"
"time"
"encoding/json"
"os"
"path/filepath"
"strings"
)
func main() {
home, err := os.UserHomeDir(); if err != nil { panic("request failed; credentials and response omitted") }
raw, err := os.ReadFile(filepath.Join(home, ".config/metribeacon/headers.json")); if err != nil { panic("request failed; credentials and response omitted") }
var headers map[string]string
if json.Unmarshal(raw, &headers) != nil { panic("invalid local headers") }
request, err := http.NewRequest("POST", "https://metribeacon.com/api/v1/monitors/00000000-0000-4000-8000-000000000001/server-profile/plan", 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)
}
Related guides
- 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.
- 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.
- 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.