Heartbeat
Authorizations
Section titled “Authorizations”Request Bodyrequired
Section titled “Request Bodyrequired”At most 8 KiB, also subject to the configured global limit. No query parameters or unknown fields. Capabilities are at most 32 unique lowercase identifiers (1–64 ASCII bytes); wrapper versions are at most 16 unique positive u32 values. Unknown capability names and wrapper versions are observations, not execution permission.
Declared support is observational. Only authorized publications and pinned assignment requirements can authorize later execution.
object
Embedded build observed in the reporting process, not the current file at its path.
object
Exact build inputs; dirty builds retain an immutable content fingerprint.
object
Unique identifiers; future names are retained without granting support.
Software build label, not a wrapper or connector wire-protocol version.
Unique positive version numbers. Empty means no wrapper support reported.
Responses
Section titled “Responses”The authenticated connector’s report was committed. Retries may advance receipt time without affecting runs.
object
Server time of the serialized write, returned only after commit.
Headers
Section titled “Headers”No-store
Always present. A fresh server-generated UUID for this request; incoming IDs are ignored. On errors, this equals the response body’s request_id.
Malformed JSON or query parameters. Code bad_request.
The common JSON body for errors returned by the HTTP application.
object
Stable machine-readable error code.
Bounded corrections for authorized scientific-schema failures only. Absent on other failures. The complete validation error body is <=4608 bytes.
object
More violations exist than fit in this response.
At most eight violations, in validator traversal order.
A schema failure without submitted values or arbitrary property names.
object
Fixed guidance; actual bounds and allowed values remain in the publication schema.
JSON Pointer relative to inputs; the empty string denotes its root.
Only ordinary, explicitly declared property names and array indices appear.
Example
/valueThe position stops at a safe ancestor instead of naming the exact field.
Stable categories independent of the validator’s free-form diagnostics.
Safe explanation without internal errors or submitted input values.
Matches the response’s x-request-id header.
Headers
Section titled “Headers”No-store
Always present. A fresh server-generated UUID for this request; incoming IDs are ignored. On errors, this equals the response body’s request_id.
Missing, invalid, wrong-kind, or revoked connector credential. Code unauthenticated.
The common JSON body for errors returned by the HTTP application.
object
Stable machine-readable error code.
Bounded corrections for authorized scientific-schema failures only. Absent on other failures. The complete validation error body is <=4608 bytes.
object
More violations exist than fit in this response.
At most eight violations, in validator traversal order.
A schema failure without submitted values or arbitrary property names.
object
Fixed guidance; actual bounds and allowed values remain in the publication schema.
JSON Pointer relative to inputs; the empty string denotes its root.
Only ordinary, explicitly declared property names and array indices appear.
Example
/valueThe position stops at a safe ancestor instead of naming the exact field.
Stable categories independent of the validator’s free-form diagnostics.
Safe explanation without internal errors or submitted input values.
Matches the response’s x-request-id header.
Headers
Section titled “Headers”No-store
Bearer
Always present. A fresh server-generated UUID for this request; incoming IDs are ignored. On errors, this equals the response body’s request_id.
Heartbeat body exceeds its route or configured request limit. Code payload_too_large.
The common JSON body for errors returned by the HTTP application.
object
Stable machine-readable error code.
Bounded corrections for authorized scientific-schema failures only. Absent on other failures. The complete validation error body is <=4608 bytes.
object
More violations exist than fit in this response.
At most eight violations, in validator traversal order.
A schema failure without submitted values or arbitrary property names.
object
Fixed guidance; actual bounds and allowed values remain in the publication schema.
JSON Pointer relative to inputs; the empty string denotes its root.
Only ordinary, explicitly declared property names and array indices appear.
Example
/valueThe position stops at a safe ancestor instead of naming the exact field.
Stable categories independent of the validator’s free-form diagnostics.
Safe explanation without internal errors or submitted input values.
Matches the response’s x-request-id header.
Headers
Section titled “Headers”No-store
Always present. A fresh server-generated UUID for this request; incoming IDs are ignored. On errors, this equals the response body’s request_id.
A JSON content type is required. Code unsupported_media_type.
The common JSON body for errors returned by the HTTP application.
object
Stable machine-readable error code.
Bounded corrections for authorized scientific-schema failures only. Absent on other failures. The complete validation error body is <=4608 bytes.
object
More violations exist than fit in this response.
At most eight violations, in validator traversal order.
A schema failure without submitted values or arbitrary property names.
object
Fixed guidance; actual bounds and allowed values remain in the publication schema.
JSON Pointer relative to inputs; the empty string denotes its root.
Only ordinary, explicitly declared property names and array indices appear.
Example
/valueThe position stops at a safe ancestor instead of naming the exact field.
Stable categories independent of the validator’s free-form diagnostics.
Safe explanation without internal errors or submitted input values.
Matches the response’s x-request-id header.
Headers
Section titled “Headers”No-store
Always present. A fresh server-generated UUID for this request; incoming IDs are ignored. On errors, this equals the response body’s request_id.
Invalid JSON structure (invalid_request) or report values (invalid_heartbeat).
The common JSON body for errors returned by the HTTP application.
object
Stable machine-readable error code.
Bounded corrections for authorized scientific-schema failures only. Absent on other failures. The complete validation error body is <=4608 bytes.
object
More violations exist than fit in this response.
At most eight violations, in validator traversal order.
A schema failure without submitted values or arbitrary property names.
object
Fixed guidance; actual bounds and allowed values remain in the publication schema.
JSON Pointer relative to inputs; the empty string denotes its root.
Only ordinary, explicitly declared property names and array indices appear.
Example
/valueThe position stops at a safe ancestor instead of naming the exact field.
Stable categories independent of the validator’s free-form diagnostics.
Safe explanation without internal errors or submitted input values.
Matches the response’s x-request-id header.
Headers
Section titled “Headers”No-store
Always present. A fresh server-generated UUID for this request; incoming IDs are ignored. On errors, this equals the response body’s request_id.
Authentication or heartbeat persistence unavailable. Codes authentication_unavailable and heartbeat_unavailable. Retry the current report; an uncertain acknowledgement may already have committed.
The common JSON body for errors returned by the HTTP application.
object
Stable machine-readable error code.
Bounded corrections for authorized scientific-schema failures only. Absent on other failures. The complete validation error body is <=4608 bytes.
object
More violations exist than fit in this response.
At most eight violations, in validator traversal order.
A schema failure without submitted values or arbitrary property names.
object
Fixed guidance; actual bounds and allowed values remain in the publication schema.
JSON Pointer relative to inputs; the empty string denotes its root.
Only ordinary, explicitly declared property names and array indices appear.
Example
/valueThe position stops at a safe ancestor instead of naming the exact field.
Stable categories independent of the validator’s free-form diagnostics.
Safe explanation without internal errors or submitted input values.
Matches the response’s x-request-id header.
Headers
Section titled “Headers”No-store
Always present. A fresh server-generated UUID for this request; incoming IDs are ignored. On errors, this equals the response body’s request_id.
default
Section titled “default”An HTTP request failed; inspect the stable error code and request ID.
The common JSON body for errors returned by the HTTP application.
object
Stable machine-readable error code.
Bounded corrections for authorized scientific-schema failures only. Absent on other failures. The complete validation error body is <=4608 bytes.
object
More violations exist than fit in this response.
At most eight violations, in validator traversal order.
A schema failure without submitted values or arbitrary property names.
object
Fixed guidance; actual bounds and allowed values remain in the publication schema.
JSON Pointer relative to inputs; the empty string denotes its root.
Only ordinary, explicitly declared property names and array indices appear.
Example
/valueThe position stops at a safe ancestor instead of naming the exact field.
Stable categories independent of the validator’s free-form diagnostics.
Safe explanation without internal errors or submitted input values.
Matches the response’s x-request-id header.
Headers
Section titled “Headers”No-store
Always present. A fresh server-generated UUID for this request; incoming IDs are ignored. On errors, this equals the response body’s request_id.
Documentation 205dcb3116ea · public sources 8c70356d340f · built .Download documentation identity.