POST Cancel a draft test
/api/v1/monitors/checks/test-runs/{run_id}/cancel
Cancel your own active draft test. Repeating cancellation is safe. Running browser time remains charged and late results are rejected.
On this page
Access and permissions
Cancel your own active draft test. Repeating cancellation is safe. Running browser time remains charged and late results are rejected.
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 |
|---|---|---|---|---|
| run_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. |
| workspace_id | URL query | 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. |
| 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_selection |
| 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 |
|---|
| creation_quota |
| rule_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 |
|---|
| feature_unavailable |
| 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"
}| Stable error codes |
|---|
| 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 | — |
| 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 |
|---|---|---|---|
| $ | CheckDraftRun | Yes | — |
| $.id | string; {"format":"uuid"} | Yes | — |
| $.location_id | string; {"format":"uuid"} | Yes | — |
| $.status | string; {"enum":["pending","running","completed","cancelled","expired"]} | Yes | — |
| $.pause_reason | string | null; {"enum":["network_quota","browser_quota",null]} | Yes | — |
| $.created_at | string; {"format":"date-time"} | Yes | — |
| $.deadline_at | string; {"format":"date-time"} | Yes | — |
| $.finished_at | string | null; {"format":"date-time"} | Yes | — |
| $.result | CheckResult | null | Yes | — |
| $.result (oneOf 1) | CheckResult | No | — |
| $.result (oneOf 1).code | string; {"pattern":"^[a-z][a-z0-9_]{0,63}$"} | Yes | — |
| $.result (oneOf 1).duration_ms | number; {"maximum":360000,"minimum":0} | Yes | — |
| $.result (oneOf 1).metrics | object | null | No | — |
| $.result (oneOf 1).status | JSON; {"enum":["up","down","unknown"]} | Yes | — |
| $.result (oneOf 1).states | object | null | No | — |
| $.result (oneOf 1).details | CheckPublicDiagnostics | No | — |
| $.result (oneOf 1).details.address | string; {"maxLength":45} | No | — |
| $.result (oneOf 1).details.certificate_sha256 | string; {"pattern":"^[a-f0-9]{64}$"} | No | — |
| $.result (oneOf 1).details.certificate_not_before | string; {"format":"date-time"} | No | — |
| $.result (oneOf 1).details.certificate_not_after | string; {"format":"date-time"} | No | — |
| $.result (oneOf 1).details.response_code | string; {"pattern":"^[A-Z0-9_]{1,32}$"} | No | — |
| $.result (oneOf 1).details.answers | array<string; {"maxLength":1024}>; {"maxItems":64} | No | — |
| $.result (oneOf 1).details.answers[] | string; {"maxLength":1024} | Yes | — |
| $.result (oneOf 1).details.certificate_chain | array<object; {"additionalProperties":false}>; {"maxItems":16} | No | — |
| $.result (oneOf 1).details.certificate_chain[] | object; {"additionalProperties":false} | Yes | — |
| $.result (oneOf 1).details.certificate_chain[].sha256 | string; {"pattern":"^[a-f0-9]{64}$"} | Yes | — |
| $.result (oneOf 1).details.certificate_chain[].not_before | string; {"format":"date-time"} | Yes | — |
| $.result (oneOf 1).details.certificate_chain[].not_after | string; {"format":"date-time"} | Yes | — |
| $.result (oneOf 1).details.certificate_chain[].is_ca | boolean | Yes | — |
| $.result (oneOf 1).details.ssh_host_key_sha256 | string; {"pattern":"^SHA256:[A-Za-z0-9+/]{43}$"} | No | — |
| $.result (oneOf 1).details.domain | CheckDomainRegistration | No | — |
| $.result (oneOf 1).details.domain.domain | string; {"maxLength":253} | Yes | — |
| $.result (oneOf 1).details.domain.expires_at | string; {"format":"date-time"} | null | Yes | — |
| $.result (oneOf 1).details.domain.expires_at (anyOf 1) | string; {"format":"date-time"} | No | — |
| $.result (oneOf 1).details.domain.expires_at (anyOf 2) | null | No | — |
| $.result (oneOf 1).details.domain.registrar | string; {"maxLength":256} | null | Yes | — |
| $.result (oneOf 1).details.domain.registrar (anyOf 1) | string; {"maxLength":256} | No | — |
| $.result (oneOf 1).details.domain.registrar (anyOf 2) | null | No | — |
| $.result (oneOf 1).details.domain.nameservers | array | null; {"maxItems":32} | Yes | — |
| $.result (oneOf 1).details.domain.nameservers[] | string; {"maxLength":253} | Yes | — |
| $.result (oneOf 1).details.domain.nameservers_known | boolean | Yes | — |
| $.result (oneOf 1).details.domain.status | array | null; {"maxItems":32} | Yes | — |
| $.result (oneOf 1).details.domain.status[] | string; {"maxLength":128} | Yes | — |
| $.result (oneOf 1).details.domain.status_known | boolean | Yes | — |
| $.result (oneOf 1).details.domain.source | string; {"enum":["rdap","whois"]} | Yes | — |
| $.result (oneOf 1).details.domain.observed_at | string; {"format":"date-time"} | Yes | — |
| $.result (oneOf 1).details.domain.registry_updated_at | string; {"format":"date-time"} | null | Yes | — |
| $.result (oneOf 1).details.domain.registry_updated_at (anyOf 1) | string; {"format":"date-time"} | No | — |
| $.result (oneOf 1).details.domain.registry_updated_at (anyOf 2) | null | No | — |
| $.result (oneOf 1).details.domain.expiration_conflict | boolean | Yes | — |
| $.result (oneOf 1).details.retry_at | string; {"format":"date-time"} | No | — |
| $.result (oneOf 1).details.certificate | TLSSnapshot | No | — |
| $.result (oneOf 1).details.certificate.host | string; {"maxLength":253} | Yes | — |
| $.result (oneOf 1).details.certificate.tls_version | string | Yes | — |
| $.result (oneOf 1).details.certificate.chain | array<TLSCertificate>; {"minItems":1,"maxItems":16} | Yes | — |
| $.result (oneOf 1).details.certificate.chain[] | TLSCertificate | Yes | — |
| $.result (oneOf 1).details.certificate.chain[].sha256 | string; {"pattern":"^[a-f0-9]{64}$"} | Yes | — |
| $.result (oneOf 1).details.certificate.chain[].common_name | string; {"maxLength":256} | Yes | — |
| $.result (oneOf 1).details.certificate.chain[].issuer | string; {"maxLength":256} | Yes | — |
| $.result (oneOf 1).details.certificate.chain[].serial | string; {"maxLength":128} | Yes | — |
| $.result (oneOf 1).details.certificate.chain[].not_before | string; {"format":"date-time"} | Yes | — |
| $.result (oneOf 1).details.certificate.chain[].not_after | string; {"format":"date-time"} | Yes | — |
| $.result (oneOf 1).details.certificate.chain[].names | array<string; {"maxLength":253}>; {"maxItems":128} | Yes | — |
| $.result (oneOf 1).details.certificate.chain[].names[] | string; {"maxLength":253} | Yes | — |
| $.result (oneOf 1).details.certificate.chain[].is_ca | boolean | Yes | — |
| $.result (oneOf 1).details.certificate.chain[].sent | boolean | Yes | — |
| $.result (oneOf 1).details.certificate.chain[].signature | string | Yes | — |
| $.result (oneOf 1).details.certificate.chain[].key | string | Yes | — |
| $.result (oneOf 1).details.certificate.checks | array<object; {"additionalProperties":false}>; {"minItems":7,"maxItems":7} | Yes | — |
| $.result (oneOf 1).details.certificate.checks[] | object; {"additionalProperties":false} | Yes | — |
| $.result (oneOf 1).details.certificate.checks[].key | string; {"enum":["validity","hostname","authority","chain","revocation","tls","strength"]} | Yes | — |
| $.result (oneOf 1).details.certificate.checks[].status | string; {"enum":["passed","failed","unknown"]} | Yes | — |
| $.result (oneOf 1).details.certificate.checks[].reason | string; {"maxLength":64} | Yes | — |
| $.result (oneOf 1).details.certificate.revocation_valid_until | string; {"format":"date-time"} | No | — |
| $.result (oneOf 1).details.certificate.truncated | boolean | No | — |
| $.result (oneOf 1).details.certificate.port | integer; {"minimum":1,"maximum":65535} | No | — |
| $.result (oneOf 1).mail_delivery | CheckMailObservation | No | — |
| $.result (oneOf 1).mail_delivery.phase | string; {"enum":["smtp","imap"]} | Yes | — |
| $.result (oneOf 1).mail_delivery.accepted | boolean | Yes | — |
| $.result (oneOf 1).mail_delivery.uncertain | boolean | Yes | — |
| $.result (oneOf 1).mail_delivery.received | boolean | Yes | — |
| $.result (oneOf 1).mail_delivery.removed | boolean | Yes | — |
| $.result (oneOf 1).mail_delivery.cleanup_unavailable | boolean | Yes | — |
| $.result (oneOf 1).mail_delivery.received_at | string; {"format":"date-time"} | No | — |
| $.result (oneOf 1).browser | BrowserObservation | No | — |
| $.result (oneOf 1).browser.engines | array<BrowserEngineResult>; {"maxItems":3,"minItems":1} | Yes | — |
| $.result (oneOf 1).browser.engines[] | BrowserEngineResult | Yes | — |
| $.result (oneOf 1).browser.engines[].engine | string; {"enum":["chromium","firefox","webkit"]} | Yes | — |
| $.result (oneOf 1).browser.engines[].status | string; {"enum":["up","down","unknown"]} | Yes | — |
| $.result (oneOf 1).browser.engines[].code | string; {"pattern":"^[a-z][a-z0-9_]{0,63}$"} | Yes | — |
| $.result (oneOf 1).browser.engines[].duration_ms | number; {"minimum":0,"maximum":120000} | Yes | — |
| $.result (oneOf 1).browser.engines[].wall_ms | number; {"minimum":0,"maximum":120000} | Yes | — |
| $.result (oneOf 1).browser.engines[].steps | array<BrowserStepResult>; {"maxItems":128,"minItems":0} | Yes | — |
| $.result (oneOf 1).browser.engines[].steps[] | BrowserStepResult | Yes | — |
| $.result (oneOf 1).browser.engines[].steps[].index | integer; {"minimum":0,"maximum":127} | Yes | — |
| $.result (oneOf 1).browser.engines[].steps[].status | string; {"enum":["up","down","skipped"]} | Yes | — |
| $.result (oneOf 1).browser.engines[].steps[].code | string; {"pattern":"^[a-z][a-z0-9_]{0,63}$"} | Yes | — |
| $.result (oneOf 1).browser.engines[].steps[].duration_ms | number; {"minimum":0,"maximum":120000} | Yes | — |
| $.result (oneOf 1).browser.engines[].steps[].parent | integer; {"minimum":0,"maximum":126} | No | — |
| $.result (oneOf 1).browser.engines[].steps[].name | string; {"maxLength":160} | No | — |
| $.result (oneOf 1).browser.engines[].steps[].kind | string; {"enum":["test","step","hook"]} | No | — |
| $.result (oneOf 1).browser.engines[].steps[].source | object; {"additionalProperties":false} | No | — |
| $.result (oneOf 1).browser.engines[].metrics | object; {"additionalProperties":false} | null | Yes | — |
| $.result (oneOf 1).browser.engines[].metrics (anyOf 1) | object; {"additionalProperties":false} | No | — |
| $.result (oneOf 1).browser.engines[].metrics (anyOf 1).network_errors | number; {"minimum":0,"maximum":1000000000.0} | No | — |
| $.result (oneOf 1).browser.engines[].metrics (anyOf 1).javascript_errors | number; {"minimum":0,"maximum":1000000000.0} | No | — |
| $.result (oneOf 1).browser.engines[].metrics (anyOf 1).requests | number; {"minimum":0,"maximum":1000000000.0} | No | — |
| $.result (oneOf 1).browser.engines[].metrics (anyOf 1).page_load_ms | number; {"minimum":0,"maximum":1000000000.0} | No | — |
| $.result (oneOf 1).browser.engines[].metrics (anyOf 1).visual_diff_ratio | number; {"minimum":0,"maximum":1} | No | — |
| $.result (oneOf 1).browser.engines[].metrics (anyOf 1).lcp_ms | number; {"minimum":0,"maximum":1000000000.0} | No | — |
| $.result (oneOf 1).browser.engines[].metrics (anyOf 1).fcp_ms | number; {"minimum":0,"maximum":1000000000.0} | No | — |
| $.result (oneOf 1).browser.engines[].metrics (anyOf 1).tbt_ms | number; {"minimum":0,"maximum":1000000000.0} | No | — |
| $.result (oneOf 1).browser.engines[].metrics (anyOf 1).ttfb_ms | number; {"minimum":0,"maximum":1000000000.0} | No | — |
| $.result (oneOf 1).browser.engines[].metrics (anyOf 1).cls | number; {"minimum":0,"maximum":1000000000.0} | No | — |
| $.result (oneOf 1).browser.engines[].metrics (anyOf 2) | null | No | — |
| $.result (oneOf 1).browser.engines[].artifact_code | string; {"enum":["","recording_unavailable"]} | No | — |
| $.result (oneOf 1).browser.engines[].runtime | string; {"enum":["journey-2"]} | No | — |
| $.result (oneOf 1).browser.engines[].navigations | array<BrowserNavigation>; {"maxItems":64} | No | — |
| $.result (oneOf 1).browser.engines[].navigations[] | BrowserNavigation | Yes | — |
| $.result (oneOf 1).browser.engines[].navigations[].page | integer; {"minimum":1,"maximum":16} | Yes | — |
| $.result (oneOf 1).browser.engines[].navigations[].index | integer; {"minimum":1,"maximum":64} | Yes | — |
| $.result (oneOf 1).browser.engines[].navigations[].started_ms | number; {"minimum":0,"maximum":120000} | Yes | — |
| $.result (oneOf 1).browser.engines[].navigations[].complete | boolean | Yes | — |
| $.result (oneOf 1).browser.engines[].navigations[].vitals | object; {"additionalProperties":false} | Yes | — |
| $.result (oneOf 1).http | object | No | — |
| $.result (oneOf 1).http.attempts | array<object>; {"maxItems":1} | Yes | — |
| $.result (oneOf 1).http.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. |
| $.result (oneOf 1).http.attempts[].body_matched | boolean | No | — |
| $.result (oneOf 1).http.attempts[].certificate_days | integer | No | — |
| $.result (oneOf 1).http.attempts[].checked_at | string; {"format":"date-time"} | No | — |
| $.result (oneOf 1).http.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. |
| $.result (oneOf 1).http.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 | — |
| $.result (oneOf 1).http.attempts[].healthy | boolean | No | — |
| $.result (oneOf 1).http.attempts[].hops | array<object>; {"maxItems":4} | No | — |
| $.result (oneOf 1).http.attempts[].hops[] | object | Yes | — |
| $.result (oneOf 1).http.attempts[].hops[].connect_ms | number | No | — |
| $.result (oneOf 1).http.attempts[].hops[].dns_ms | number | Yes | — |
| $.result (oneOf 1).http.attempts[].hops[].duration_ms | number | Yes | — |
| $.result (oneOf 1).http.attempts[].hops[].family | string; {"enum":["ipv4","ipv6"]} | No | — |
| $.result (oneOf 1).http.attempts[].hops[].status | integer | No | — |
| $.result (oneOf 1).http.attempts[].hops[].tls_ms | number | No | — |
| $.result (oneOf 1).http.attempts[].hops[].ttfb_ms | number | No | — |
| $.result (oneOf 1).http.attempts[].initial_status | integer | No | — |
| $.result (oneOf 1).http.attempts[].redirects | integer | Yes | — |
| $.result (oneOf 1).http.attempts[].status | integer | Yes | — |
| $.result (oneOf 1).http.attempts[].method | string; {"enum":["GET","HEAD"]} | No | — |
| $.result (oneOf 1).http.attempts[].certificate | TLSSnapshot | No | — |
| $.result (oneOf 1).http.attempts[].certificate.host | string; {"maxLength":253} | Yes | — |
| $.result (oneOf 1).http.attempts[].certificate.tls_version | string | Yes | — |
| $.result (oneOf 1).http.attempts[].certificate.chain | array<TLSCertificate>; {"minItems":1,"maxItems":16} | Yes | — |
| $.result (oneOf 1).http.attempts[].certificate.chain[] | TLSCertificate | Yes | — |
| $.result (oneOf 1).http.attempts[].certificate.checks | array<object; {"additionalProperties":false}>; {"minItems":7,"maxItems":7} | Yes | — |
| $.result (oneOf 1).http.attempts[].certificate.checks[] | object; {"additionalProperties":false} | Yes | — |
| $.result (oneOf 1).http.attempts[].certificate.revocation_valid_until | string; {"format":"date-time"} | No | — |
| $.result (oneOf 1).http.attempts[].certificate.truncated | boolean | No | — |
| $.result (oneOf 1).http.attempts[].certificate.port | integer; {"minimum":1,"maximum":65535} | No | — |
| $.result (oneOf 2) | null | No | — |
| $.workspace_id | string; {"format":"uuid"} | Yes | — |
| $.type | JSON; {"enum":["http","tcp","udp","dns","tls","ping","service","browser"]} | Yes | — |
| $.progress | object | No | — |
Retries and asynchronous work
Keep the documented IDs for retries. After an unclear response, do not replace them with new IDs, which could create another resource or reading.
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 POST \
--header @"$HOME/.config/metribeacon/headers.txt" \
--header "Content-Type: application/json" \
--data-binary '{}' \
"https://metribeacon.com/api/v1/monitors/checks/test-runs/00000000-0000-4000-8000-000000000003/cancel?workspace_id=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())
headers["Content-Type"] = "application/json"
request = Request("https://metribeacon.com/api/v1/monitors/checks/test-runs/00000000-0000-4000-8000-000000000003/cancel?workspace_id=00000000-0000-4000-8000-000000000001", data="{}".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/checks/test-runs/00000000-0000-4000-8000-000000000003/cancel?workspace_id=00000000-0000-4000-8000-000000000001", {
method: "POST", headers, redirect: "manual",
signal: AbortSignal.timeout(10000), body: "{}",
});
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/checks/test-runs/00000000-0000-4000-8000-000000000003/cancel?workspace_id=00000000-0000-4000-8000-000000000001", strings.NewReader("{}"))
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.
- POST Test a monitor draft
Run the configured check once at a selected authorized location without creating a monitor, series or alerts. Reuse the same request_id after an uncertain response. Protected credentials and private results expire after 15 minutes. Browser and mail actions require actions_confirmed; browser recordings are disabled and visual baselines require a saved monitor. Executions share regular network/browser budgets.
- GET Read your monitors
Read your monitors.
- POST Create a monitor with its enabled type
Create a monitor with its enabled type.