POST Measure a job run using its heartbeat URL
/hb/{token}
Empty-body GET, HEAD or POST. /start begins a run; the base URL succeeds; /fail fails; /abort aborts. Only success confirms a scheduled heartbeat. Optional UUID run_id pairs parallel runs and makes repeated identical phases idempotent; conflicting endings return 409. Without an ID only one measurement may be open. A base heartbeat without an open measurement keeps its original behavior. Duration measures server receipt times; missing starts produce no duration. Each new phase consumes one ordinary event; retries do not double charge. Never put secrets in logs or automatically retry uncertain calls without a run ID.
On this page
Access and permissions
Empty-body GET, HEAD or POST. /start begins a run; the base URL succeeds; /fail fails; /abort aborts. Only success confirms a scheduled heartbeat. Optional UUID run_id pairs parallel runs and makes repeated identical phases idempotent; conflicting endings return 409. Without an ID only one measurement may be open. A base heartbeat without an open measurement keeps its original behavior. Duration measures server receipt times; missing starts produce no duration. Each new phase consumes one ordinary event; retries do not double charge. Never put secrets in logs or automatically retry uncertain calls without a run ID.
No account sign-in is required. Any listed browser-origin checks and rate limits still apply.
Parameters and headers
| Field | Location | Type and limits | Required | Meaning |
|---|---|---|---|---|
| token | Path | string; {"pattern":"^mbh_[A-Za-z0-9_-]{43}$"} | Yes | Secret token copied from this heartbeat monitor. |
| run_id | URL query | string; {"format":"uuid"} | No | Optional stable UUID shared by start and completion. |
Request body
No request body.
Responses
text/plain
| Field | Type and limits | Required | Meaning |
|---|---|---|---|
| $ | string | Yes | — |
| Stable error codes |
|---|
| unauthorized |
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 |
|---|
| browser_required |
| csrf |
| invalid_origin |
| workspace_scope |
| access_denied |
| forbidden |
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 |
|---|
| not_found |
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 | — |
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 |
|---|
| run_conflict |
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 |
|---|
| body_not_allowed |
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_request |
| invalid_run |
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 |
|---|
| quota_exceeded |
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 |
| feature_unavailable |
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 | — |
Retries and asynchronous work
This change does not have a general retry guarantee. If the response is unclear, read the affected resource before trying again. Follow Retry-After waiting times and request new sign-in or action codes when they expire.
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 --fail --silent --show-error --request POST "https://metribeacon.com/hb/YOUR_HEARTBEAT_TOKEN"
import json, urllib.request
request = urllib.request.Request('https://metribeacon.com/hb/YOUR_HEARTBEAT_TOKEN', method='POST', headers={})
with urllib.request.urlopen(request) as response:
print(response.status)
const response = await fetch("https://metribeacon.com/hb/YOUR_HEARTBEAT_TOKEN",{method:"POST"});
if (!response.ok) throw new Error("HTTP " + response.status);
package main
import("net/http";"fmt")
func main(){r,_:=http.NewRequest("POST","https://metribeacon.com/hb/YOUR_HEARTBEAT_TOKEN",nil);response,err:=http.DefaultClient.Do(r);if err!=nil{panic("request failed")};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 Measure a job run using its heartbeat URL
Empty-body GET, HEAD or POST. /start begins a run; the base URL succeeds; /fail fails; /abort aborts. Only success confirms a scheduled heartbeat. Optional UUID run_id pairs parallel runs and makes repeated identical phases idempotent; conflicting endings return 409. Without an ID only one measurement may be open. A base heartbeat without an open measurement keeps its original behavior. Duration measures server receipt times; missing starts produce no duration. Each new phase consumes one ordinary event; retries do not double charge. Never put secrets in logs or automatically retry uncertain calls without a run ID.
- HEAD Measure a job run using its heartbeat URL
Empty-body GET, HEAD or POST. /start begins a run; the base URL succeeds; /fail fails; /abort aborts. Only success confirms a scheduled heartbeat. Optional UUID run_id pairs parallel runs and makes repeated identical phases idempotent; conflicting endings return 409. Without an ID only one measurement may be open. A base heartbeat without an open measurement keeps its original behavior. Duration measures server receipt times; missing starts produce no duration. Each new phase consumes one ordinary event; retries do not double charge. Never put secrets in logs or automatically retry uncertain calls without a run ID.
- GET Measure a job run using its heartbeat URL
Empty-body GET, HEAD or POST. /start begins a run; the base URL succeeds; /fail fails; /abort aborts. Only success confirms a scheduled heartbeat. Optional UUID run_id pairs parallel runs and makes repeated identical phases idempotent; conflicting endings return 409. Without an ID only one measurement may be open. A base heartbeat without an open measurement keeps its original behavior. Duration measures server receipt times; missing starts produce no duration. Each new phase consumes one ordinary event; retries do not double charge. Never put secrets in logs or automatically retry uncertain calls without a run ID.