GET Read temporary diagnostic results
/api/v1/monitors/{id}/checks/diagnostic-runs/{run_id}
Read one snapshot with progress and results for each location. Only the initiating user can read the diagnostic, for at most 15 minutes after it started.
On this page
Access and permissions
Read one snapshot with progress and results for each location. Only the initiating user can read the diagnostic, for at most 15 minutes after it started.
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 | Unique resource identifier. |
| run_id | Path | string; {"format":"uuid"} | Yes | Unique resource identifier. |
Request body
No request body.
Responses
| 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. |
| 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 | — |
| Stable error codes |
|---|
| csrf |
| insufficient_scope |
| invalid_origin |
| operator_required |
| forbidden |
| 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. |
| 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 | — |
| Stable error codes |
|---|
| diagnostic_unavailable |
| invalid_workspace |
| 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. |
| 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 | — |
| Stable error codes |
|---|
| invalid_workspace |
| stale_check |
| result_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. |
| 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 | — |
| Stable error codes |
|---|
| invalid_config |
| 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. |
| 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 | — |
| Stable error codes |
|---|
| invalid_workspace |
| check_capacity |
| Header | Type and limits | Meaning |
|---|---|---|
| Retry-After | string; {"pattern":"^[0-9]+$"} | Temporary server error; retry unchanged with Retry-After and the same idempotency identifier |
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 | — |
| 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. |
| 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 | — |
| 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. |
| 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 |
|---|---|---|---|
| $ | DiagnosticRun | Yes | — |
| $.id | string; {"format":"uuid"} | Yes | — |
| $.monitor_id | string; {"format":"uuid"} | Yes | — |
| $.workspace_id | string; {"format":"uuid"} | Yes | — |
| $.config_revision | integer; {"minimum":1} | Yes | — |
| $.type | string; {"enum":["http","tcp","udp","dns","tls","ping","service","browser"]} | Yes | — |
| $.created_at | string; {"format":"date-time"} | Yes | — |
| $.expires_at | string; {"format":"date-time"} | Yes | — |
| $.status | string; {"enum":["pending","running","completed","cancelled"]} | Yes | — |
| $.completed | integer; {"minimum":0} | Yes | — |
| $.locations | array<DiagnosticLocation> | Yes | — |
| $.locations[] | DiagnosticLocation | Yes | — |
| $.locations[].location_id | string; {"format":"uuid"} | Yes | — |
| $.locations[].location_name | string | Yes | — |
| $.locations[].country_code | string | Yes | — |
| $.locations[].reason | string | null | Yes | — |
| $.locations[].run | DiagnosticChild | null | Yes | — |
| $.locations[].run (oneOf 1) | DiagnosticChild | No | — |
| $.locations[].run (oneOf 1).id | string; {"format":"uuid"} | Yes | — |
| $.locations[].run (oneOf 1).location_id | string; {"format":"uuid"} | Yes | — |
| $.locations[].run (oneOf 1).status | string; {"enum":["pending","running","completed","cancelled","expired"]} | Yes | — |
| $.locations[].run (oneOf 1).pause_reason | string | null; {"enum":["network_quota","browser_quota",null]} | Yes | — |
| $.locations[].run (oneOf 1).created_at | string; {"format":"date-time"} | Yes | — |
| $.locations[].run (oneOf 1).deadline_at | string; {"format":"date-time"} | Yes | — |
| $.locations[].run (oneOf 1).finished_at | string | null; {"format":"date-time"} | Yes | — |
| $.locations[].run (oneOf 1).result | CheckResult | null | Yes | — |
| $.locations[].run (oneOf 1).result (oneOf 1) | CheckResult | No | — |
| $.locations[].run (oneOf 1).result (oneOf 1).code | string; {"pattern":"^[a-z][a-z0-9_]{0,63}$"} | Yes | — |
| $.locations[].run (oneOf 1).result (oneOf 1).duration_ms | number; {"maximum":360000,"minimum":0} | Yes | — |
| $.locations[].run (oneOf 1).result (oneOf 1).metrics | object | null | No | — |
| $.locations[].run (oneOf 1).result (oneOf 1).status | JSON; {"enum":["up","down","unknown"]} | Yes | — |
| $.locations[].run (oneOf 1).result (oneOf 1).states | object | null | No | — |
| $.locations[].run (oneOf 1).result (oneOf 1).details | CheckPublicDiagnostics | No | — |
| $.locations[].run (oneOf 1).result (oneOf 1).details.address | string; {"maxLength":45} | No | — |
| $.locations[].run (oneOf 1).result (oneOf 1).details.certificate_sha256 | string; {"pattern":"^[a-f0-9]{64}$"} | No | — |
| $.locations[].run (oneOf 1).result (oneOf 1).details.certificate_not_before | string; {"format":"date-time"} | No | — |
| $.locations[].run (oneOf 1).result (oneOf 1).details.certificate_not_after | string; {"format":"date-time"} | No | — |
| $.locations[].run (oneOf 1).result (oneOf 1).details.response_code | string; {"pattern":"^[A-Z0-9_]{1,32}$"} | No | — |
| $.locations[].run (oneOf 1).result (oneOf 1).details.answers | array<string; {"maxLength":1024}>; {"maxItems":64} | No | — |
| $.locations[].run (oneOf 1).result (oneOf 1).details.certificate_chain | array<object; {"additionalProperties":false}>; {"maxItems":16} | No | — |
| $.locations[].run (oneOf 1).result (oneOf 1).details.ssh_host_key_sha256 | string; {"pattern":"^SHA256:[A-Za-z0-9+/]{43}$"} | No | — |
| $.locations[].run (oneOf 1).result (oneOf 1).details.domain | CheckDomainRegistration | No | — |
| $.locations[].run (oneOf 1).result (oneOf 1).details.retry_at | string; {"format":"date-time"} | No | — |
| $.locations[].run (oneOf 1).result (oneOf 1).details.certificate | TLSSnapshot | No | — |
| $.locations[].run (oneOf 1).result (oneOf 1).mail_delivery | CheckMailObservation | No | — |
| $.locations[].run (oneOf 1).result (oneOf 1).mail_delivery.phase | string; {"enum":["smtp","imap"]} | Yes | — |
| $.locations[].run (oneOf 1).result (oneOf 1).mail_delivery.accepted | boolean | Yes | — |
| $.locations[].run (oneOf 1).result (oneOf 1).mail_delivery.uncertain | boolean | Yes | — |
| $.locations[].run (oneOf 1).result (oneOf 1).mail_delivery.received | boolean | Yes | — |
| $.locations[].run (oneOf 1).result (oneOf 1).mail_delivery.removed | boolean | Yes | — |
| $.locations[].run (oneOf 1).result (oneOf 1).mail_delivery.cleanup_unavailable | boolean | Yes | — |
| $.locations[].run (oneOf 1).result (oneOf 1).mail_delivery.received_at | string; {"format":"date-time"} | No | — |
| $.locations[].run (oneOf 1).result (oneOf 1).browser | BrowserObservation | No | — |
| $.locations[].run (oneOf 1).result (oneOf 1).browser.engines | array<BrowserEngineResult>; {"maxItems":3,"minItems":1} | Yes | — |
| $.locations[].run (oneOf 1).result (oneOf 1).http | object | No | — |
| $.locations[].run (oneOf 1).result (oneOf 1).http.attempts | array<object>; {"maxItems":1} | Yes | — |
| $.locations[].run (oneOf 1).result (oneOf 2) | null | No | — |
| $.locations[].run (oneOf 1).progress | object | No | — |
| $.locations[].run (oneOf 1).workspace_id | string; {"format":"uuid"} | Yes | — |
| $.locations[].run (oneOf 1).type | string; {"enum":["http","tcp","udp","dns","tls","ping","service","browser"]} | Yes | — |
| $.locations[].run (oneOf 2) | null | No | — |
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/checks/diagnostic-runs/00000000-0000-4000-8000-000000000003"
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/checks/diagnostic-runs/00000000-0000-4000-8000-000000000003", 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/checks/diagnostic-runs/00000000-0000-4000-8000-000000000003", {
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/checks/diagnostic-runs/00000000-0000-4000-8000-000000000003", 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.
- GET Check results by location
Read seven days of HTTP, network and browser checks with stable cursor pagination and result, location and period filters. Overview and history views return compact rows without diagnostic payloads or totals; fetch counts independently using the page snapshot and full diagnostics with view=detail. Current states consider every selected location and observation freshness. summary_only=1 returns only current states. Missing historical metadata stays unknown.
- GET Read check alarm suggestions
Read available suggestions and existing rule identities for the current selected measurements. Reading creates no rules.
- GET Read a monitor test
Read the authorized test status, quota pause and private diagnostic result. A missing result does not confirm that the target is reachable.