MetriBeacon
Menu

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

FieldLocationType and limitsRequiredMeaning
idPathstring; {"format":"uuid"}YesResource UUID from the path. It must exist and be accessible to the acting identity.
include_data_flowURL queryboolean; {"default":false}NoInclude the monitor’s data flow diagnostics. No measurement values, other monitors or storage paths are returned.

Request body

No request body.

Responses

HeaderType and limitsMeaning
Cache-Controlstring; {"pattern":"(?:^|,\\s*)no-store(?:,|$)"}Private API responses prohibit storage. Public OAuth metadata is cached for 300 seconds; live streams additionally prohibit transformation.
Content-Languagestring; {"enum":["en","de"]}Language of human-readable response text, resolved from Accept-Language or the documented browser preference. Technical codes and identifiers remain stable.
Referrer-PolicyJSON; {"enum":["strict-origin-when-cross-origin","no-referrer"]}The default referrer policy is strict-origin-when-cross-origin. Provider-login responses use no-referrer to protect login parameters.
VarystringResponses vary by Accept-Language; browser-rendered responses can also vary by the preference cookie.
X-Content-Type-OptionsJSON; {"const":"nosniff"}The browser must use the declared content type.
X-Frame-OptionsJSON; {"const":"DENY"}The response must not be embedded in a frame.
X-Request-IDstringServer-generated request identifier. Include this when reporting an error; inbound values are not trusted.

application/json

FieldType and limitsRequiredMeaning
$objectYes—
$.configMonitorConfigYes—
$.config (anyOf 1)HTTPMonitorConfigNoThe type feature is available only when enabled. Credential headers are not accepted through this path.
$.config (anyOf 1).expected_statusJSON; {"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_textstring; {"maxLength":256}No—
$.config (anyOf 1).interval_secondsinteger; {"default":300,"maximum":86400,"minimum":10}NoSampling or check interval in seconds within the stated bounds.
$.config (anyOf 1).json_fieldstring; {"maxLength":64}NoA top-level JSON field; alternative to expected_text.
$.config (anyOf 1).json_valuestring; {"maxLength":256}No—
$.config (anyOf 1).methodstring; {"default":"GET","enum":["GET","HEAD","OPTIONS","POST","PUT","PATCH","DELETE"]}No—
$.config (anyOf 1).urlstring; {"format":"uri","maxLength":2048}YesHTTP/HTTPS, ports 80/443 only; DNS and destination IP are checked on every attempt.
$.config (anyOf 1).location_idsarray<string; {"format":"uuid"}>; {"maxItems":4096,"minItems":1}Yes—
$.config (anyOf 1).location_ids[]string; {"format":"uuid"}Yes—
$.config (anyOf 1).policyJSON; {"enum":["any","all","quorum"],"default":"quorum"}NoDefaults 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).quoruminteger; {"maximum":4096,"minimum":1,"default":2}No—
$.config (anyOf 1).confirm_failuresinteger; {"maximum":10,"minimum":1}No—
$.config (anyOf 1).confirm_successesinteger; {"maximum":10,"minimum":1}No—
$.config (anyOf 1).familystring; {"enum":["ipv4","ipv6","dual"],"default":"dual"}No—
$.config (anyOf 1).timeout_secondsinteger; {"minimum":1,"maximum":30,"default":8}No—
$.config (anyOf 1).expected_status_mininteger; {"minimum":100,"maximum":599}No—
$.config (anyOf 1).expected_status_maxinteger; {"minimum":100,"maximum":599}No—
$.config (anyOf 1).follow_redirectsboolean; {"default":true}No—
$.config (anyOf 1).content_as_downbooleanNo—
$.config (anyOf 1).actions_confirmedbooleanNo—
$.config (anyOf 1).request_body_presentbooleanNo—
$.config (anyOf 2)JobMonitorConfigNoChoose 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).cronstringNoFive cron fields with lists, ranges, steps and supported month/weekday names.
$.config (anyOf 2).max_runtime_secondsinteger; {"maximum":604800,"minimum":60}NoOptional; no runtime limit when omitted
$.config (anyOf 2).timezonestringNoIANA time zone; required with cron
$.config (anyOf 2).tolerance_secondsinteger; {"maximum":86400,"minimum":5}NoAllowed 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_secondsinteger; {"minimum":30,"maximum":604800}NoFixed interval in seconds (30 to 604800), independent of daylight saving. Cannot be combined with cron or timezone.
$.config (anyOf 2).signalstring; {"enum":["run","heartbeat"],"default":"run"}Norun 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)JSONNo—
$.config (anyOf 2) (allOf 2)JSONNo—
$.config (anyOf 2) (allOf 3)JSONNo—
$.config (anyOf 2) (allOf 4)JSONNo—
$.config (anyOf 2) (allOf 5)JSONNo—
$.config (anyOf 3)objectNo—
$.config_revisionintegerYes—
$.config_versionintegerYes—
$.external_idstring | nullYes—
$.external_id (anyOf 1)stringNo—
$.external_id (anyOf 2)nullNo—
$.group_idsarray<string; {"format":"uuid"}>YesIDs of active groups containing this device, or an empty array.
$.group_ids[]string; {"format":"uuid"}Yes—
$.http_checkobjectNo—
$.http_check.attemptsinteger | nullYesNumber of recorded processing or delivery attempts.
$.http_check.attempts (anyOf 1)integerNo—
$.http_check.attempts (anyOf 2)nullNo—
$.http_check.checked_atstring; {"format":"date-time"} | nullYes—
$.http_check.checked_at (anyOf 1)string; {"format":"date-time"}No—
$.http_check.checked_at (anyOf 2)nullNo—
$.http_check.codestring | nullYes—
$.http_check.code (anyOf 1)stringNo—
$.http_check.code (anyOf 2)nullNo—
$.http_check.confirm_statusinteger | nullYes—
$.http_check.confirm_status (anyOf 1)integerNo—
$.http_check.confirm_status (anyOf 2)nullNo—
$.http_check.initial_statusinteger | nullYes—
$.http_check.initial_status (anyOf 1)integerNo—
$.http_check.initial_status (anyOf 2)nullNo—
$.http_check.maintenance_untilstring; {"format":"date-time"} | nullYes—
$.http_check.maintenance_until (anyOf 1)string; {"format":"date-time"}No—
$.http_check.maintenance_until (anyOf 2)nullNo—
$.http_check.statusstring | nullYes—
$.http_check.status (anyOf 1)stringNo—
$.http_check.status (anyOf 2)nullNo—
$.http_check.next_check_atstring; {"format":"date-time"} | nullYes—
$.http_check.next_check_at (anyOf 1)string; {"format":"date-time"}No—
$.http_check.next_check_at (anyOf 2)nullNo—
$.http_check.quota_detailsQuotaPause | nullYes—
$.http_check.quota_details (anyOf 1)QuotaPauseNoAll 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).blockedarray<object>Yes—
$.http_check.quota_details (anyOf 1).blocked[]objectYes—
$.http_check.quota_details (anyOf 1).blocked[].keystring; {"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[].limitnumber; {"minimum":0}Yes—
$.http_check.quota_details (anyOf 1).blocked[].requirednumber; {"minimum":0}Yes—
$.http_check.quota_details (anyOf 1).blocked[].usednumber; {"minimum":0}Yes—
$.http_check.quota_details (anyOf 1).never_fitsbooleanYes—
$.http_check.quota_details (anyOf 1).retry_atstring; {"format":"date-time"} | nullYes—
$.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)nullNo—
$.http_check.quota_details (anyOf 2)nullNo—
$.http_check.recent_checksarray<object>; {"maxItems":20}YesThe 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[]objectYes—
$.http_check.recent_checks[].attemptsarray<object>; {"maxItems":2}Yes—
$.http_check.recent_checks[].attempts[]objectYesStatus-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_matchedbooleanNo—
$.http_check.recent_checks[].attempts[].certificate_daysintegerNo—
$.http_check.recent_checks[].attempts[].checked_atstring; {"format":"date-time"}No—
$.http_check.recent_checks[].attempts[].duration_msintegerYesMilliseconds 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_codestring; {"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[].healthybooleanNo—
$.http_check.recent_checks[].attempts[].hopsarray<object>; {"maxItems":4}No—
$.http_check.recent_checks[].attempts[].hops[]objectYes—
$.http_check.recent_checks[].attempts[].hops[].connect_msnumberNo—
$.http_check.recent_checks[].attempts[].hops[].dns_msnumberYes—
$.http_check.recent_checks[].attempts[].hops[].duration_msnumberYes—
$.http_check.recent_checks[].attempts[].hops[].familystring; {"enum":["ipv4","ipv6"]}No—
$.http_check.recent_checks[].attempts[].hops[].statusintegerNo—
$.http_check.recent_checks[].attempts[].hops[].tls_msnumberNo—
$.http_check.recent_checks[].attempts[].hops[].ttfb_msnumberNo—
$.http_check.recent_checks[].attempts[].initial_statusintegerNo—
$.http_check.recent_checks[].attempts[].redirectsintegerYes—
$.http_check.recent_checks[].attempts[].statusintegerYes—
$.http_check.recent_checks[].checked_atstring; {"format":"date-time"}Yes—
$.http_check.recent_checks[].codestringYes—
$.http_check.recent_checks[].statestringYes—
$.idstringYesUUID of this resource. Keep the returned identifier for subsequent operations.
$.last_heartbeat_atstring; {"format":"date-time"} | nullYesLast accepted device contact timestamp; null before the first contact.
$.last_heartbeat_at (anyOf 1)string; {"format":"date-time"}No—
$.last_heartbeat_at (anyOf 2)nullNo—
$.namestringYesHuman-readable resource name. Follow the listed length limit.
$.pausedbooleanYesWhether automatic monitor work is paused. Existing telemetry and historical data remain.
$.typestringYes—
$.workspace_idstringYesUUID of the owning workspace. Access is checked against the authenticated account.
$.data_flowMonitorDataFlowNoConfirmed 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_seriesinteger; {"minimum":0}Yes—
$.data_flow.archive_pendingbooleanYes—
$.data_flow.archive_queriesinteger; {"minimum":0}Yes—
$.data_flow.checked_atstring; {"format":"date-time"}Yes—
$.data_flow.interval_max_secondsinteger | nullYes—
$.data_flow.interval_min_secondsinteger | nullYes—
$.data_flow.last_received_atstring; {"format":"date-time"} | nullYes—
$.data_flow.last_received_at (anyOf 1)string; {"format":"date-time"}No—
$.data_flow.last_received_at (anyOf 2)nullNo—
$.data_flow.quota_exhaustedarray<string; {"enum":["items","events","bytes","event_bytes"]}>Yes—
$.data_flow.quota_exhausted[]string; {"enum":["items","events","bytes","event_bytes"]}Yes—
$.data_flow.rate_limitsarray<object>Yes—
$.data_flow.rate_limits[]objectYes—
$.data_flow.rate_limits[].resourcestring; {"enum":["items","events","requests","bytes"]}Yes—
$.data_flow.rate_limits[].retry_secondsinteger; {"minimum":1}Yes—
$.data_flow.rollup_pendingbooleanYes—
$.data_flow.deliveryobject | nullNo—
$.data_flow.delivery (anyOf 1)objectNo—
$.data_flow.delivery (anyOf 1).reportAgentDeliveryReportYes—
$.data_flow.delivery (anyOf 1).report.observed_atstring; {"format":"date-time"}Yes—
$.data_flow.delivery (anyOf 1).report.pending_objectsinteger; {"minimum":0,"maximum":10000000}Yes—
$.data_flow.delivery (anyOf 1).report.pending_bytesinteger; {"minimum":0,"maximum":1073741824}Yes—
$.data_flow.delivery (anyOf 1).report.oldest_measured_atstring; {"format":"date-time"}No—
$.data_flow.delivery (anyOf 1).report.last_acknowledged_atstring; {"format":"date-time"}No—
$.data_flow.delivery (anyOf 1).report.retry_atstring; {"format":"date-time"}No—
$.data_flow.delivery (anyOf 1).report.lost_objectsinteger; {"minimum":0}Yes—
$.data_flow.delivery (anyOf 1).report.last_errorobject; {"additionalProperties":false}No—
$.data_flow.delivery (anyOf 1).report.last_error.atstring; {"format":"date-time"}Yes—
$.data_flow.delivery (anyOf 1).report.last_error.kindstring; {"enum":["timeout","connection","tls","http","ack","storage"]}Yes—
$.data_flow.delivery (anyOf 1).report.last_error.statusinteger; {"minimum":0,"maximum":599}No—
$.data_flow.delivery (anyOf 1).report.last_error.codestring; {"enum":["","quota_exceeded","global_capacity","unavailable","http_error"]}No—
$.data_flow.delivery (anyOf 1).report.last_error.limitstring; {"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_atstring; {"format":"date-time"}Yes—
$.data_flow.delivery (anyOf 1).freshbooleanYes—
$.data_flow.delivery (anyOf 2)nullNo—
$.maintenance_pendingbooleanYesTrue while the maintenance projection is not yet current. Do not interpret this as confirmation that no maintenance is active.
json
{
  "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
HeaderType and limitsMeaning
Cache-Controlstring; {"pattern":"(?:^|,\\s*)no-store(?:,|$)"}Private API responses prohibit storage. Public OAuth metadata is cached for 300 seconds; live streams additionally prohibit transformation.
Content-Languagestring; {"enum":["en","de"]}Language of human-readable response text, resolved from Accept-Language or the documented browser preference. Technical codes and identifiers remain stable.
Referrer-PolicyJSON; {"enum":["strict-origin-when-cross-origin","no-referrer"]}The default referrer policy is strict-origin-when-cross-origin. Provider-login responses use no-referrer to protect login parameters.
VarystringResponses vary by Accept-Language; browser-rendered responses can also vary by the preference cookie.
X-Content-Type-OptionsJSON; {"const":"nosniff"}The browser must use the declared content type.
X-Frame-OptionsJSON; {"const":"DENY"}The response must not be embedded in a frame.
X-Request-IDstringServer-generated request identifier. Include this when reporting an error; inbound values are not trusted.

application/problem+json

FieldType and limitsRequiredMeaning
$ProblemYes—
$.codestringYesStable machine-readable error code
$.detailstringYesShort localized explanation without internal error details
$.instancestringYesUnique relative identifier /api/v1/requests/{request_id}; not a retrievable resource
$.messagestringYesTemporarily identical to detail for existing clients
$.message_keystringYesStable translation key for changing the displayed language without another request
$.message_paramsobject; {"additionalProperties":true}YesNamed, safely rendered message parameters; never arbitrary HTML
$.request_idstring; {"pattern":"^[0-9a-f]{32}$"}YesServer-generated diagnostic identifier. It contains no login token or credential.
$.statusinteger; {"maximum":599,"minimum":400}Yes—
$.titlestringYesLocalized HTTP status title
$.typestring; {"const":"about:blank"}Yes—
json
{
  "code": "demo",
  "detail": "Demo error detail; inspect the documented code.",
  "instance": "demo",
  "message": "Demo error detail; inspect the documented code.",
  "message_key": "errors.requestFailed",
  "message_params": {},
  "request_id": "00000000000000000000000000000000",
  "status": 401,
  "title": "Demo error",
  "type": "about:blank"
}
Stable error codes
csrf
insufficient_scope
invalid_origin
HeaderType and limitsMeaning
Cache-Controlstring; {"pattern":"(?:^|,\\s*)no-store(?:,|$)"}Private API responses prohibit storage. Public OAuth metadata is cached for 300 seconds; live streams additionally prohibit transformation.
Content-Languagestring; {"enum":["en","de"]}Language of human-readable response text, resolved from Accept-Language or the documented browser preference. Technical codes and identifiers remain stable.
Referrer-PolicyJSON; {"enum":["strict-origin-when-cross-origin","no-referrer"]}The default referrer policy is strict-origin-when-cross-origin. Provider-login responses use no-referrer to protect login parameters.
VarystringResponses vary by Accept-Language; browser-rendered responses can also vary by the preference cookie.
X-Content-Type-OptionsJSON; {"const":"nosniff"}The browser must use the declared content type.
X-Frame-OptionsJSON; {"const":"DENY"}The response must not be embedded in a frame.
X-Request-IDstringServer-generated request identifier. Include this when reporting an error; inbound values are not trusted.

application/problem+json

FieldType and limitsRequiredMeaning
$ProblemYes—
$.codestringYesStable machine-readable error code
$.detailstringYesShort localized explanation without internal error details
$.instancestringYesUnique relative identifier /api/v1/requests/{request_id}; not a retrievable resource
$.messagestringYesTemporarily identical to detail for existing clients
$.message_keystringYesStable translation key for changing the displayed language without another request
$.message_paramsobject; {"additionalProperties":true}YesNamed, safely rendered message parameters; never arbitrary HTML
$.request_idstring; {"pattern":"^[0-9a-f]{32}$"}YesServer-generated diagnostic identifier. It contains no login token or credential.
$.statusinteger; {"maximum":599,"minimum":400}Yes—
$.titlestringYesLocalized HTTP status title
$.typestring; {"const":"about:blank"}Yes—
json
{
  "code": "demo",
  "detail": "Demo error detail; inspect the documented code.",
  "instance": "demo",
  "message": "Demo error detail; inspect the documented code.",
  "message_key": "errors.requestFailed",
  "message_params": {},
  "request_id": "00000000000000000000000000000000",
  "status": 403,
  "title": "Demo error",
  "type": "about:blank"
}
Stable error codes
not_found
HeaderType and limitsMeaning
Cache-Controlstring; {"pattern":"(?:^|,\\s*)no-store(?:,|$)"}Private API responses prohibit storage. Public OAuth metadata is cached for 300 seconds; live streams additionally prohibit transformation.
Content-Languagestring; {"enum":["en","de"]}Language of human-readable response text, resolved from Accept-Language or the documented browser preference. Technical codes and identifiers remain stable.
Referrer-PolicyJSON; {"enum":["strict-origin-when-cross-origin","no-referrer"]}The default referrer policy is strict-origin-when-cross-origin. Provider-login responses use no-referrer to protect login parameters.
VarystringResponses vary by Accept-Language; browser-rendered responses can also vary by the preference cookie.
X-Content-Type-OptionsJSON; {"const":"nosniff"}The browser must use the declared content type.
X-Frame-OptionsJSON; {"const":"DENY"}The response must not be embedded in a frame.
X-Request-IDstringServer-generated request identifier. Include this when reporting an error; inbound values are not trusted.

application/problem+json

FieldType and limitsRequiredMeaning
$ProblemYes—
$.codestringYesStable machine-readable error code
$.detailstringYesShort localized explanation without internal error details
$.instancestringYesUnique relative identifier /api/v1/requests/{request_id}; not a retrievable resource
$.messagestringYesTemporarily identical to detail for existing clients
$.message_keystringYesStable translation key for changing the displayed language without another request
$.message_paramsobject; {"additionalProperties":true}YesNamed, safely rendered message parameters; never arbitrary HTML
$.request_idstring; {"pattern":"^[0-9a-f]{32}$"}YesServer-generated diagnostic identifier. It contains no login token or credential.
$.statusinteger; {"maximum":599,"minimum":400}Yes—
$.titlestringYesLocalized HTTP status title
$.typestring; {"const":"about:blank"}Yes—
json
{
  "code": "demo",
  "detail": "Demo error detail; inspect the documented code.",
  "instance": "demo",
  "message": "Demo error detail; inspect the documented code.",
  "message_key": "errors.requestFailed",
  "message_params": {},
  "request_id": "00000000000000000000000000000000",
  "status": 404,
  "title": "Demo error",
  "type": "about:blank"
}
Stable error codes
invalid_monitor
HeaderType and limitsMeaning
Cache-Controlstring; {"pattern":"(?:^|,\\s*)no-store(?:,|$)"}Private API responses prohibit storage. Public OAuth metadata is cached for 300 seconds; live streams additionally prohibit transformation.
Content-Languagestring; {"enum":["en","de"]}Language of human-readable response text, resolved from Accept-Language or the documented browser preference. Technical codes and identifiers remain stable.
Referrer-PolicyJSON; {"enum":["strict-origin-when-cross-origin","no-referrer"]}The default referrer policy is strict-origin-when-cross-origin. Provider-login responses use no-referrer to protect login parameters.
VarystringResponses vary by Accept-Language; browser-rendered responses can also vary by the preference cookie.
X-Content-Type-OptionsJSON; {"const":"nosniff"}The browser must use the declared content type.
X-Frame-OptionsJSON; {"const":"DENY"}The response must not be embedded in a frame.
X-Request-IDstringServer-generated request identifier. Include this when reporting an error; inbound values are not trusted.

application/problem+json

FieldType and limitsRequiredMeaning
$ProblemYes—
$.codestringYesStable machine-readable error code
$.detailstringYesShort localized explanation without internal error details
$.instancestringYesUnique relative identifier /api/v1/requests/{request_id}; not a retrievable resource
$.messagestringYesTemporarily identical to detail for existing clients
$.message_keystringYesStable translation key for changing the displayed language without another request
$.message_paramsobject; {"additionalProperties":true}YesNamed, safely rendered message parameters; never arbitrary HTML
$.request_idstring; {"pattern":"^[0-9a-f]{32}$"}YesServer-generated diagnostic identifier. It contains no login token or credential.
$.statusinteger; {"maximum":599,"minimum":400}Yes—
$.titlestringYesLocalized HTTP status title
$.typestring; {"const":"about:blank"}Yes—
json
{
  "code": "demo",
  "detail": "Demo error detail; inspect the documented code.",
  "instance": "demo",
  "message": "Demo error detail; inspect the documented code.",
  "message_key": "errors.requestFailed",
  "message_params": {},
  "request_id": "00000000000000000000000000000000",
  "status": 422,
  "title": "Demo error",
  "type": "about:blank"
}
Stable error codes
unavailable
account_busy
database_lock_timeout
database_timeout
database_unavailable
database_error
request_cancelled
HeaderType and limitsMeaning
Cache-Controlstring; {"pattern":"(?:^|,\\s*)no-store(?:,|$)"}Private API responses prohibit storage. Public OAuth metadata is cached for 300 seconds; live streams additionally prohibit transformation.
Content-Languagestring; {"enum":["en","de"]}Language of human-readable response text, resolved from Accept-Language or the documented browser preference. Technical codes and identifiers remain stable.
Referrer-PolicyJSON; {"enum":["strict-origin-when-cross-origin","no-referrer"]}The default referrer policy is strict-origin-when-cross-origin. Provider-login responses use no-referrer to protect login parameters.
Retry-Afterstring; {"pattern":"^[0-9]+$"}Seconds before retry. Preserve supported idempotency identifiers and respect the operation’s mutation semantics.
VarystringResponses vary by Accept-Language; browser-rendered responses can also vary by the preference cookie.
X-Content-Type-OptionsJSON; {"const":"nosniff"}The browser must use the declared content type.
X-Frame-OptionsJSON; {"const":"DENY"}The response must not be embedded in a frame.
X-Request-IDstringServer-generated request identifier. Include this when reporting an error; inbound values are not trusted.

application/problem+json

FieldType and limitsRequiredMeaning
$ProblemYes—
$.codestringYesStable machine-readable error code
$.detailstringYesShort localized explanation without internal error details
$.instancestringYesUnique relative identifier /api/v1/requests/{request_id}; not a retrievable resource
$.messagestringYesTemporarily identical to detail for existing clients
$.message_keystringYesStable translation key for changing the displayed language without another request
$.message_paramsobject; {"additionalProperties":true}YesNamed, safely rendered message parameters; never arbitrary HTML
$.request_idstring; {"pattern":"^[0-9a-f]{32}$"}YesServer-generated diagnostic identifier. It contains no login token or credential.
$.statusinteger; {"maximum":599,"minimum":400}Yes—
$.titlestringYesLocalized HTTP status title
$.typestring; {"const":"about:blank"}Yes—
json
{
  "code": "demo",
  "detail": "Demo error detail; inspect the documented code.",
  "instance": "demo",
  "message": "Demo error detail; inspect the documented code.",
  "message_key": "errors.requestFailed",
  "message_params": {},
  "request_id": "00000000000000000000000000000000",
  "status": 503,
  "title": "Demo error",
  "type": "about:blank"
}

Retries and asynchronous work

This operation reads or validates without applying a resource mutation. Respect rate limits and credential lifetime.

Request examples

Replace demo IDs, timestamps and placeholders with your own values. For a retry, keep the same IDs, time and content. These examples do not run requests on this page.

Keep login links, codes, cookies and keys private. Do not print them in logs or share them in support requests.

shell
curl --silent --show-error --output /dev/null --write-out "%{http_code}\n" \
  --request GET \
  --header @"$HOME/.config/metribeacon/headers.txt" \
  "https://metribeacon.com/api/v1/monitors/00000000-0000-4000-8000-000000000001"
python
import json
from pathlib import Path
from urllib.request import Request, HTTPRedirectHandler, build_opener
from urllib.error import HTTPError

headers = json.loads((Path.home() / ".config/metribeacon/headers.json").read_text())
request = Request("https://metribeacon.com/api/v1/monitors/00000000-0000-4000-8000-000000000001", data=None, headers=headers, method="GET")
class NoRedirect(HTTPRedirectHandler):
    def redirect_request(self, request, fp, code, message, headers, target):
        return None

opener = build_opener(NoRedirect())
try:
    with opener.open(request, timeout=10) as response:
        print(response.status)
except HTTPError as error:
    print(error.code)
    error.close()
javascript
import { readFile } from "node:fs/promises";
import { homedir } from "node:os";
import { join } from "node:path";

const headers = JSON.parse(await readFile(join(homedir(), ".config/metribeacon/headers.json"), "utf8"));
const response = await fetch("https://metribeacon.com/api/v1/monitors/00000000-0000-4000-8000-000000000001", {
  method: "GET", headers, redirect: "manual",
  signal: AbortSignal.timeout(10000),
});
console.log(response.status);
await response.body?.cancel();
go
package main

import (
  "fmt"
  "net/http"
  "time"
  "encoding/json"
  "os"
  "path/filepath"
)

func main() {
  home, err := os.UserHomeDir(); if err != nil { panic("request failed; credentials and response omitted") }
  raw, err := os.ReadFile(filepath.Join(home, ".config/metribeacon/headers.json")); if err != nil { panic("request failed; credentials and response omitted") }
  var headers map[string]string
  if json.Unmarshal(raw, &headers) != nil { panic("invalid local headers") }
  request, err := http.NewRequest("GET", "https://metribeacon.com/api/v1/monitors/00000000-0000-4000-8000-000000000001", nil)
  if err != nil { panic("request failed; credentials and response omitted") }
  for name, value := range headers { request.Header.Set(name, value) }
  client := &http.Client{Timeout: 10*time.Second, CheckRedirect: func(*http.Request, []*http.Request) error { return http.ErrUseLastResponse }}
  response, err := client.Do(request)
  if err != nil { panic("request failed; credentials and response omitted") }
  defer response.Body.Close()
  fmt.Println(response.StatusCode)
}
  • HTTP API, OAuth and MCP

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

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