GET Read your monitor and configuration
/api/v1/monitors/{id}
Read your monitor and configuration.
On this page
Access and permissions
Read your monitor and configuration.
Browser session: __Host-mb_session cookie.
Machine management credentials in Authorization: Bearer. Check the permissions (scopes) required by the operation.
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. |
| include_data_flow | URL query | boolean; {"default":false} | No | Include the monitor’s data flow diagnostics. No measurement values, other monitors or storage paths are returned. |
Request body
No request body.
Responses
| Header | Type and limits | Meaning |
|---|---|---|
| Cache-Control | string; {"pattern":"(?:^|,\\s*)no-store(?:,|$)"} | Private API responses prohibit storage. Public OAuth metadata is cached for 300 seconds; live streams additionally prohibit transformation. |
| Content-Language | string; {"enum":["en","de"]} | Language of human-readable response text, resolved from Accept-Language or the documented browser preference. Technical codes and identifiers remain stable. |
| Referrer-Policy | JSON; {"enum":["strict-origin-when-cross-origin","no-referrer"]} | The default referrer policy is strict-origin-when-cross-origin. Provider-login responses use no-referrer to protect login parameters. |
| Vary | string | Responses vary by Accept-Language; browser-rendered responses can also vary by the preference cookie. |
| X-Content-Type-Options | JSON; {"const":"nosniff"} | The browser must use the declared content type. |
| X-Frame-Options | JSON; {"const":"DENY"} | The response must not be embedded in a frame. |
| X-Request-ID | string | Server-generated request identifier. Include this when reporting an error; inbound values are not trusted. |
application/json
| Field | Type and limits | Required | Meaning |
|---|---|---|---|
| $ | object | Yes | — |
| $.config | MonitorConfig | Yes | — |
| $.config (anyOf 1) | HTTPMonitorConfig | No | The type feature is available only when enabled. Credential headers are not accepted through this path. |
| $.config (anyOf 1).expected_status | JSON; {"const":0} | JSON; {"minimum":100,"maximum":599} | No | — |
| $.config (anyOf 1).expected_status (anyOf 1) | JSON; {"const":0} | No | — |
| $.config (anyOf 1).expected_status (anyOf 2) | JSON; {"minimum":100,"maximum":599} | No | — |
| $.config (anyOf 1).expected_text | string; {"maxLength":256} | No | — |
| $.config (anyOf 1).interval_seconds | integer; {"default":300,"maximum":86400,"minimum":10} | No | Sampling or check interval in seconds within the stated bounds. |
| $.config (anyOf 1).json_field | string; {"maxLength":64} | No | A top-level JSON field; alternative to expected_text. |
| $.config (anyOf 1).json_value | string; {"maxLength":256} | No | — |
| $.config (anyOf 1).method | string; {"default":"GET","enum":["GET","HEAD","OPTIONS","POST","PUT","PATCH","DELETE"]} | No | — |
| $.config (anyOf 1).url | string; {"format":"uri","maxLength":2048} | Yes | HTTP/HTTPS, ports 80/443 only; DNS and destination IP are checked on every attempt. |
| $.config (anyOf 1).location_ids | array<string; {"format":"uuid"}>; {"maxItems":4096,"minItems":1} | Yes | — |
| $.config (anyOf 1).location_ids[] | string; {"format":"uuid"} | Yes | — |
| $.config (anyOf 1).policy | JSON; {"enum":["any","all","quorum"],"default":"quorum"} | No | Defaults to quorum with two distinct locations. Select at least two compatible locations. Explicit any/all policies remain available; two failed confirmations per location are required by default. For Ping quorum checks with N locations and failure quorum Q, N−Q+1 freshly confirmed healthy locations establish availability; Q confirmed failed locations establish an outage. Other results remain unconfirmed or unknown. Ambiguous Ping results can trigger a fast follow-up at the same location, limited to two per monitor and one per location per minute, within the existing check budget. Manual tests never affect availability. Earlier coverage gaps remain unchanged. |
| $.config (anyOf 1).quorum | integer; {"maximum":4096,"minimum":1,"default":2} | No | — |
| $.config (anyOf 1).confirm_failures | integer; {"maximum":10,"minimum":1} | No | — |
| $.config (anyOf 1).confirm_successes | integer; {"maximum":10,"minimum":1} | No | — |
| $.config (anyOf 1).family | string; {"enum":["ipv4","ipv6","dual"],"default":"dual"} | No | — |
| $.config (anyOf 1).timeout_seconds | integer; {"minimum":1,"maximum":30,"default":8} | No | — |
| $.config (anyOf 1).expected_status_min | integer; {"minimum":100,"maximum":599} | No | — |
| $.config (anyOf 1).expected_status_max | integer; {"minimum":100,"maximum":599} | No | — |
| $.config (anyOf 1).follow_redirects | boolean; {"default":true} | No | — |
| $.config (anyOf 1).content_as_down | boolean | No | — |
| $.config (anyOf 1).actions_confirmed | boolean | No | — |
| $.config (anyOf 1).request_body_present | boolean | No | — |
| $.config (anyOf 2) | JobMonitorConfig | No | Choose a fixed UTC interval or a five-field cron expression with an IANA time zone. Use signal=heartbeat for simple accepted heartbeats, or signal=run for execution events. Without a schedule, runs are event-driven. Pause and configuration changes reset future expectations. |
| $.config (anyOf 2).cron | string | No | Five cron fields with lists, ranges, steps and supported month/weekday names. |
| $.config (anyOf 2).max_runtime_seconds | integer; {"maximum":604800,"minimum":60} | No | Optional; no runtime limit when omitted |
| $.config (anyOf 2).timezone | string | No | IANA time zone; required with cron |
| $.config (anyOf 2).tolerance_seconds | integer; {"maximum":86400,"minimum":5} | No | Allowed delay in seconds. Cron requires at least 30 seconds; fixed intervals allow at least five. Default: 300, or half the interval for intervals shorter than 600 seconds. |
| $.config (anyOf 2).interval_seconds | integer; {"minimum":30,"maximum":604800} | No | Fixed interval in seconds (30 to 604800), independent of daylight saving. Cannot be combined with cron or timezone. |
| $.config (anyOf 2).signal | string; {"enum":["run","heartbeat"],"default":"run"} | No | run expects start and completion events with stable run IDs. heartbeat accepts a bodyless request to its individual secret URL or the authenticated telemetry endpoint; it does not verify job completion. |
| $.config (anyOf 2) (allOf 1) | JSON | No | — |
| $.config (anyOf 2) (allOf 2) | JSON | No | — |
| $.config (anyOf 2) (allOf 3) | JSON | No | — |
| $.config (anyOf 2) (allOf 4) | JSON | No | — |
| $.config (anyOf 2) (allOf 5) | JSON | No | — |
| $.config (anyOf 3) | object | No | — |
| $.config_revision | integer | Yes | — |
| $.config_version | integer | Yes | — |
| $.external_id | string | null | Yes | — |
| $.external_id (anyOf 1) | string | No | — |
| $.external_id (anyOf 2) | null | No | — |
| $.group_ids | array<string; {"format":"uuid"}> | Yes | IDs of active groups containing this device, or an empty array. |
| $.group_ids[] | string; {"format":"uuid"} | Yes | — |
| $.http_check | object | No | — |
| $.http_check.attempts | integer | null | Yes | Number of recorded processing or delivery attempts. |
| $.http_check.attempts (anyOf 1) | integer | No | — |
| $.http_check.attempts (anyOf 2) | null | No | — |
| $.http_check.checked_at | string; {"format":"date-time"} | null | Yes | — |
| $.http_check.checked_at (anyOf 1) | string; {"format":"date-time"} | No | — |
| $.http_check.checked_at (anyOf 2) | null | No | — |
| $.http_check.code | string | null | Yes | — |
| $.http_check.code (anyOf 1) | string | No | — |
| $.http_check.code (anyOf 2) | null | No | — |
| $.http_check.confirm_status | integer | null | Yes | — |
| $.http_check.confirm_status (anyOf 1) | integer | No | — |
| $.http_check.confirm_status (anyOf 2) | null | No | — |
| $.http_check.initial_status | integer | null | Yes | — |
| $.http_check.initial_status (anyOf 1) | integer | No | — |
| $.http_check.initial_status (anyOf 2) | null | No | — |
| $.http_check.maintenance_until | string; {"format":"date-time"} | null | Yes | — |
| $.http_check.maintenance_until (anyOf 1) | string; {"format":"date-time"} | No | — |
| $.http_check.maintenance_until (anyOf 2) | null | No | — |
| $.http_check.status | string | null | Yes | — |
| $.http_check.status (anyOf 1) | string | No | — |
| $.http_check.status (anyOf 2) | null | No | — |
| $.http_check.next_check_at | string; {"format":"date-time"} | null | Yes | — |
| $.http_check.next_check_at (anyOf 1) | string; {"format":"date-time"} | No | — |
| $.http_check.next_check_at (anyOf 2) | null | No | — |
| $.http_check.quota_details | QuotaPause | null | Yes | — |
| $.http_check.quota_details (anyOf 1) | QuotaPause | No | All budgets insufficient for the actual next HTTP observation. Minute used is bucket capacity minus currently refilled tokens. required is the cost of this observation. retry_at is the latest required refill/day reset, not a guaranteed resumption. never_fits means one observation exceeds a full budget and no reset can help. |
| $.http_check.quota_details (anyOf 1).blocked | array<object> | Yes | — |
| $.http_check.quota_details (anyOf 1).blocked[] | object | Yes | — |
| $.http_check.quota_details (anyOf 1).blocked[].key | string; {"enum":["items_per_day","events_per_day","bytes_per_day","event_bytes_per_day","items_per_minute","points_per_minute","events_per_minute","requests_per_minute","bytes_per_minute"]} | Yes | — |
| $.http_check.quota_details (anyOf 1).blocked[].limit | number; {"minimum":0} | Yes | — |
| $.http_check.quota_details (anyOf 1).blocked[].required | number; {"minimum":0} | Yes | — |
| $.http_check.quota_details (anyOf 1).blocked[].used | number; {"minimum":0} | Yes | — |
| $.http_check.quota_details (anyOf 1).never_fits | boolean | Yes | — |
| $.http_check.quota_details (anyOf 1).retry_at | string; {"format":"date-time"} | null | Yes | — |
| $.http_check.quota_details (anyOf 1).retry_at (anyOf 1) | string; {"format":"date-time"} | No | — |
| $.http_check.quota_details (anyOf 1).retry_at (anyOf 2) | null | No | — |
| $.http_check.quota_details (anyOf 2) | null | No | — |
| $.http_check.recent_checks | array<object>; {"maxItems":20} | Yes | The most recent 20 checks, with confirmation attempts, phase timings and safe failure codes. No headers, response bodies or target URL parameters are included. |
| $.http_check.recent_checks[] | object | Yes | — |
| $.http_check.recent_checks[].attempts | array<object>; {"maxItems":2} | Yes | — |
| $.http_check.recent_checks[].attempts[] | object | Yes | Status-only checks finish at the response headers without downloading the body. Text and JSON checks read up to 1 MiB (1,048,576 bytes). A larger response produces response_body_too_large and an unknown content_match; availability remains based on HTTP status only when content_as_down is false. Otherwise, an expected HTTP status with unverifiable content is unknown. An unexpected HTTP status still fails. Response-body read errors use response_body_read_error. Historical response_body diagnoses retain their original meaning. The received HTTP status is preserved in all cases. |
| $.http_check.recent_checks[].attempts[].body_matched | boolean | No | — |
| $.http_check.recent_checks[].attempts[].certificate_days | integer | No | — |
| $.http_check.recent_checks[].attempts[].checked_at | string; {"format":"date-time"} | No | — |
| $.http_check.recent_checks[].attempts[].duration_ms | integer | Yes | Milliseconds through the response headers for status-only checks, or through the bounded body read for text and JSON checks. |
| $.http_check.recent_checks[].attempts[].failure_code | string; {"enum":["","dns","target_denied","connection","tls","timeout","response_body","response_body_too_large","response_body_read_error","redirect","http_status","body_mismatch"]} | No | — |
| $.http_check.recent_checks[].attempts[].healthy | boolean | No | — |
| $.http_check.recent_checks[].attempts[].hops | array<object>; {"maxItems":4} | No | — |
| $.http_check.recent_checks[].attempts[].hops[] | object | Yes | — |
| $.http_check.recent_checks[].attempts[].hops[].connect_ms | number | No | — |
| $.http_check.recent_checks[].attempts[].hops[].dns_ms | number | Yes | — |
| $.http_check.recent_checks[].attempts[].hops[].duration_ms | number | Yes | — |
| $.http_check.recent_checks[].attempts[].hops[].family | string; {"enum":["ipv4","ipv6"]} | No | — |
| $.http_check.recent_checks[].attempts[].hops[].status | integer | No | — |
| $.http_check.recent_checks[].attempts[].hops[].tls_ms | number | No | — |
| $.http_check.recent_checks[].attempts[].hops[].ttfb_ms | number | No | — |
| $.http_check.recent_checks[].attempts[].initial_status | integer | No | — |
| $.http_check.recent_checks[].attempts[].redirects | integer | Yes | — |
| $.http_check.recent_checks[].attempts[].status | integer | Yes | — |
| $.http_check.recent_checks[].checked_at | string; {"format":"date-time"} | Yes | — |
| $.http_check.recent_checks[].code | string | Yes | — |
| $.http_check.recent_checks[].state | string | Yes | — |
| $.id | string | Yes | UUID of this resource. Keep the returned identifier for subsequent operations. |
| $.last_heartbeat_at | string; {"format":"date-time"} | null | Yes | Last accepted device contact timestamp; null before the first contact. |
| $.last_heartbeat_at (anyOf 1) | string; {"format":"date-time"} | No | — |
| $.last_heartbeat_at (anyOf 2) | null | No | — |
| $.name | string | Yes | Human-readable resource name. Follow the listed length limit. |
| $.paused | boolean | Yes | Whether automatic monitor work is paused. Existing telemetry and historical data remain. |
| $.type | string | Yes | — |
| $.workspace_id | string | Yes | UUID of the owning workspace. Access is checked against the authenticated account. |
| $.data_flow | MonitorDataFlow | No | Confirmed transfer time, expected series intervals and monitor-specific processing. Daily allowance flags describe current account capacity, not a recorded rejection. History query counts belong to the requesting user only. |
| $.data_flow.active_series | integer; {"minimum":0} | Yes | — |
| $.data_flow.archive_pending | boolean | Yes | — |
| $.data_flow.archive_queries | integer; {"minimum":0} | Yes | — |
| $.data_flow.checked_at | string; {"format":"date-time"} | Yes | — |
| $.data_flow.interval_max_seconds | integer | null | Yes | — |
| $.data_flow.interval_min_seconds | integer | null | Yes | — |
| $.data_flow.last_received_at | string; {"format":"date-time"} | null | Yes | — |
| $.data_flow.last_received_at (anyOf 1) | string; {"format":"date-time"} | No | — |
| $.data_flow.last_received_at (anyOf 2) | null | No | — |
| $.data_flow.quota_exhausted | array<string; {"enum":["items","events","bytes","event_bytes"]}> | Yes | — |
| $.data_flow.quota_exhausted[] | string; {"enum":["items","events","bytes","event_bytes"]} | Yes | — |
| $.data_flow.rate_limits | array<object> | Yes | — |
| $.data_flow.rate_limits[] | object | Yes | — |
| $.data_flow.rate_limits[].resource | string; {"enum":["items","events","requests","bytes"]} | Yes | — |
| $.data_flow.rate_limits[].retry_seconds | integer; {"minimum":1} | Yes | — |
| $.data_flow.rollup_pending | boolean | Yes | — |
| $.data_flow.delivery | object | null | No | — |
| $.data_flow.delivery (anyOf 1) | object | No | — |
| $.data_flow.delivery (anyOf 1).report | AgentDeliveryReport | Yes | — |
| $.data_flow.delivery (anyOf 1).report.observed_at | string; {"format":"date-time"} | Yes | — |
| $.data_flow.delivery (anyOf 1).report.pending_objects | integer; {"minimum":0,"maximum":10000000} | Yes | — |
| $.data_flow.delivery (anyOf 1).report.pending_bytes | integer; {"minimum":0,"maximum":1073741824} | Yes | — |
| $.data_flow.delivery (anyOf 1).report.oldest_measured_at | string; {"format":"date-time"} | No | — |
| $.data_flow.delivery (anyOf 1).report.last_acknowledged_at | string; {"format":"date-time"} | No | — |
| $.data_flow.delivery (anyOf 1).report.retry_at | string; {"format":"date-time"} | No | — |
| $.data_flow.delivery (anyOf 1).report.lost_objects | integer; {"minimum":0} | Yes | — |
| $.data_flow.delivery (anyOf 1).report.last_error | object; {"additionalProperties":false} | No | — |
| $.data_flow.delivery (anyOf 1).report.last_error.at | string; {"format":"date-time"} | Yes | — |
| $.data_flow.delivery (anyOf 1).report.last_error.kind | string; {"enum":["timeout","connection","tls","http","ack","storage"]} | Yes | — |
| $.data_flow.delivery (anyOf 1).report.last_error.status | integer; {"minimum":0,"maximum":599} | No | — |
| $.data_flow.delivery (anyOf 1).report.last_error.code | string; {"enum":["","quota_exceeded","global_capacity","unavailable","http_error"]} | No | — |
| $.data_flow.delivery (anyOf 1).report.last_error.limit | string; {"enum":["","point_per_minute","point_per_day","event_per_minute","event_per_day","event_bytes_per_day","request_per_minute","bytes_per_minute","bytes_per_day","global_items"]} | No | — |
| $.data_flow.delivery (anyOf 1).reported_at | string; {"format":"date-time"} | Yes | — |
| $.data_flow.delivery (anyOf 1).fresh | boolean | Yes | — |
| $.data_flow.delivery (anyOf 2) | null | No | — |
| $.maintenance_pending | boolean | Yes | True while the maintenance projection is not yet current. Do not interpret this as confirmation that no maintenance is active. |
{
"config": {
"url": "https://example.com/callback",
"location_ids": [
"00000000-0000-4000-8000-000000000001"
],
"family": "dual",
"policy": "any",
"confirm_failures": 2,
"confirm_successes": 2,
"timeout_seconds": 8
},
"config_revision": 0,
"config_version": 0,
"external_id": "demo",
"group_ids": [],
"id": "demo",
"last_heartbeat_at": "2026-09-30T12:00:00Z",
"name": "demo",
"paused": false,
"type": "demo",
"workspace_id": "demo",
"maintenance_pending": false
}| 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 |
|---|
| invalid_monitor |
| Header | Type and limits | Meaning |
|---|---|---|
| Cache-Control | string; {"pattern":"(?:^|,\\s*)no-store(?:,|$)"} | Private API responses prohibit storage. Public OAuth metadata is cached for 300 seconds; live streams additionally prohibit transformation. |
| Content-Language | string; {"enum":["en","de"]} | Language of human-readable response text, resolved from Accept-Language or the documented browser preference. Technical codes and identifiers remain stable. |
| Referrer-Policy | JSON; {"enum":["strict-origin-when-cross-origin","no-referrer"]} | The default referrer policy is strict-origin-when-cross-origin. Provider-login responses use no-referrer to protect login parameters. |
| Vary | string | Responses vary by Accept-Language; browser-rendered responses can also vary by the preference cookie. |
| X-Content-Type-Options | JSON; {"const":"nosniff"} | The browser must use the declared content type. |
| X-Frame-Options | JSON; {"const":"DENY"} | The response must not be embedded in a frame. |
| X-Request-ID | string | Server-generated request identifier. Include this when reporting an error; inbound values are not trusted. |
application/problem+json
| Field | Type and limits | Required | Meaning |
|---|---|---|---|
| $ | Problem | Yes | — |
| $.code | string | Yes | Stable machine-readable error code |
| $.detail | string | Yes | Short localized explanation without internal error details |
| $.instance | string | Yes | Unique relative identifier /api/v1/requests/{request_id}; not a retrievable resource |
| $.message | string | Yes | Temporarily identical to detail for existing clients |
| $.message_key | string | Yes | Stable translation key for changing the displayed language without another request |
| $.message_params | object; {"additionalProperties":true} | Yes | Named, safely rendered message parameters; never arbitrary HTML |
| $.request_id | string; {"pattern":"^[0-9a-f]{32}$"} | Yes | Server-generated diagnostic identifier. It contains no login token or credential. |
| $.status | integer; {"maximum":599,"minimum":400} | Yes | — |
| $.title | string | Yes | Localized HTTP status title |
| $.type | string; {"const":"about:blank"} | Yes | — |
{
"code": "demo",
"detail": "Demo error detail; inspect the documented code.",
"instance": "demo",
"message": "Demo error detail; inspect the documented code.",
"message_key": "errors.requestFailed",
"message_params": {},
"request_id": "00000000000000000000000000000000",
"status": 422,
"title": "Demo error",
"type": "about:blank"
}| Stable error codes |
|---|
| unavailable |
| account_busy |
| database_lock_timeout |
| database_timeout |
| database_unavailable |
| database_error |
| request_cancelled |
| Header | Type and limits | Meaning |
|---|---|---|
| Cache-Control | string; {"pattern":"(?:^|,\\s*)no-store(?:,|$)"} | Private API responses prohibit storage. Public OAuth metadata is cached for 300 seconds; live streams additionally prohibit transformation. |
| Content-Language | string; {"enum":["en","de"]} | Language of human-readable response text, resolved from Accept-Language or the documented browser preference. Technical codes and identifiers remain stable. |
| Referrer-Policy | JSON; {"enum":["strict-origin-when-cross-origin","no-referrer"]} | The default referrer policy is strict-origin-when-cross-origin. Provider-login responses use no-referrer to protect login parameters. |
| Retry-After | string; {"pattern":"^[0-9]+$"} | Seconds before retry. Preserve supported idempotency identifiers and respect the operation’s mutation semantics. |
| Vary | string | Responses vary by Accept-Language; browser-rendered responses can also vary by the preference cookie. |
| X-Content-Type-Options | JSON; {"const":"nosniff"} | The browser must use the declared content type. |
| X-Frame-Options | JSON; {"const":"DENY"} | The response must not be embedded in a frame. |
| X-Request-ID | string | Server-generated request identifier. Include this when reporting an error; inbound values are not trusted. |
application/problem+json
| Field | Type and limits | Required | Meaning |
|---|---|---|---|
| $ | Problem | Yes | — |
| $.code | string | Yes | Stable machine-readable error code |
| $.detail | string | Yes | Short localized explanation without internal error details |
| $.instance | string | Yes | Unique relative identifier /api/v1/requests/{request_id}; not a retrievable resource |
| $.message | string | Yes | Temporarily identical to detail for existing clients |
| $.message_key | string | Yes | Stable translation key for changing the displayed language without another request |
| $.message_params | object; {"additionalProperties":true} | Yes | Named, safely rendered message parameters; never arbitrary HTML |
| $.request_id | string; {"pattern":"^[0-9a-f]{32}$"} | Yes | Server-generated diagnostic identifier. It contains no login token or credential. |
| $.status | integer; {"maximum":599,"minimum":400} | Yes | — |
| $.title | string | Yes | Localized HTTP status title |
| $.type | string; {"const":"about:blank"} | Yes | — |
{
"code": "demo",
"detail": "Demo error detail; inspect the documented code.",
"instance": "demo",
"message": "Demo error detail; inspect the documented code.",
"message_key": "errors.requestFailed",
"message_params": {},
"request_id": "00000000000000000000000000000000",
"status": 503,
"title": "Demo error",
"type": "about:blank"
}Retries and asynchronous work
This operation reads or validates without applying a resource mutation. Respect rate limits and credential lifetime.
Request examples
Replace demo IDs, timestamps and placeholders with your own values. For a retry, keep the same IDs, time and content. These examples do not run requests on this page.
Keep login links, codes, cookies and keys private. Do not print them in logs or share them in support requests.
curl --silent --show-error --output /dev/null --write-out "%{http_code}\n" \
--request GET \
--header @"$HOME/.config/metribeacon/headers.txt" \
"https://metribeacon.com/api/v1/monitors/00000000-0000-4000-8000-000000000001"
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", data=None, headers=headers, method="GET")
class NoRedirect(HTTPRedirectHandler):
def redirect_request(self, request, fp, code, message, headers, target):
return None
opener = build_opener(NoRedirect())
try:
with opener.open(request, timeout=10) as response:
print(response.status)
except HTTPError as error:
print(error.code)
error.close()
import { readFile } from "node:fs/promises";
import { homedir } from "node:os";
import { join } from "node:path";
const headers = JSON.parse(await readFile(join(homedir(), ".config/metribeacon/headers.json"), "utf8"));
const response = await fetch("https://metribeacon.com/api/v1/monitors/00000000-0000-4000-8000-000000000001", {
method: "GET", headers, redirect: "manual",
signal: AbortSignal.timeout(10000),
});
console.log(response.status);
await response.body?.cancel();
package main
import (
"fmt"
"net/http"
"time"
"encoding/json"
"os"
"path/filepath"
)
func main() {
home, err := os.UserHomeDir(); if err != nil { panic("request failed; credentials and response omitted") }
raw, err := os.ReadFile(filepath.Join(home, ".config/metribeacon/headers.json")); if err != nil { panic("request failed; credentials and response omitted") }
var headers map[string]string
if json.Unmarshal(raw, &headers) != nil { panic("invalid local headers") }
request, err := http.NewRequest("GET", "https://metribeacon.com/api/v1/monitors/00000000-0000-4000-8000-000000000001", nil)
if err != nil { panic("request failed; credentials and response omitted") }
for name, value := range headers { request.Header.Set(name, value) }
client := &http.Client{Timeout: 10*time.Second, CheckRedirect: func(*http.Request, []*http.Request) error { return http.ErrUseLastResponse }}
response, err := client.Do(request)
if err != nil { panic("request failed; credentials and response omitted") }
defer response.Body.Close()
fmt.Println(response.StatusCode)
}
Related guides
- HTTP API, OAuth and MCP
Find the user API endpoints, their permissions, fields, examples and response formats.
- 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.
- PATCH Update a monitor with a revision check
Update a monitor with a revision check.
- POST Explicitly save HTTP availability and certificate alarms
Create only the selected alarm suggestions within account limits. Reusing a suggestion keeps later user edits.