DOCUMENTATIONv2

GET

Evidence streams

Get health

/api/v2/evidence-health

AUTHENTICATIONBearer token · evidence:readAUTHORITATIVE OWNERevidence-stream-serviceCONTRACT AUTHORITYGenerated Rust OpenAPISTATUSSource ready · production listed

PURPOSE + BUSINESS CONTEXT

Summarize owner-scoped stream, source, alert, and quarantine posture for operational monitoring.

WHEN THIS CALL IS USEFUL

Use for owner-scoped monitoring and alerting when an integration needs a compact pipeline posture before loading detailed streams, sources, alerts, or quarantine records.

OUTCOME · Evaluate readiness

What changes

Read-only projection; it grants no mutation, settlement, traffic, or authority change.

WHY IT MATTERS

Gives people and agents a contract-backed way to evaluate health.
Lets integrations follow evidence from schema and source enrollment through ordered commitments, validation posture, operational alerts, and exception review.

ISOLATION + AUTHORITY

Schema, source, signer, stream, event, payload, sequence, validation, quarantine, alert, acknowledgement, retention, and business-outcome authorities remain distinct. Evidence visibility or cryptographic validity does not by itself prove semantic truth, regulatory acceptance, settlement, or authorization for an external action.

BEFORE YOU CALL

Authenticate at the documented boundary: bearer+scope.
Use the live OpenAPI schema as the authority for the exact request shape and response model.
Resolve the owner scope, schema, source, stream, sequence or time window, validation posture, and minimum payload disclosure required by the decision.

WHAT TO DO NEXT

Correlate the schema, source, stream, sequence, commitment, validation, quarantine, and alert state for the selected evidence lineage.
Escalate or acknowledge exceptions through their separately authorized workflow; do not equate cryptographic validity with semantic or regulatory acceptance.

AGENT GUIDANCE

Use health only for the purpose and lifecycle stage described by this operation; do not treat it as authority for an adjacent action.
Use the live OpenAPI schema as the authority for the exact request shape and response model.
Distinguish schema validity, source authenticity, signature validity, sequence continuity, payload availability, quarantine status, alert acknowledgement, operational health, and business acceptance.
Use response links and canonical identifiers instead of constructing internal service URLs or scraping the website.

MACHINE CONTRACT

The exact deployed parameters, schemas, responses, security requirements, and Hybrid-Chain agent metadata are authoritative at this operation's production OpenAPI JSON Pointer. The readable tables below add integration guidance; the deployed OpenAPI controls if guidance and the machine contract ever differ.

Open the authoritative production contract ↗

EXTENDED INTEGRATION GUIDANCE

Readable request and response reference

Examples illustrate integration intent; the referenced OpenAPI operation and component schemas define the executable shape.

PARAMETERS

Headers, path, query, and body

NAMELOCATIONPRESENCETYPE / RULES / PURPOSE

AuthorizationheaderRequired

Bearer tokenCredential containing the evidence:read scope.EXAMPLEBearer hc_live_…

RESPONSES

Status and payload examples

200Aggregate stream, source, alert, and quarantine monitoring posture for the authenticated workspace.Read completed · JSON RESPONSE+

{
  "state": "DEGRADED",
  "streams": {
    "total": 4,
    "active": 3,
    "paused": 1,
    "accepted_event_count": 28419,
    "last_event_at": "2026-09-01T20:16:01Z"
  },
  "sources": {
    "total": 9,
    "active": 8,
    "accepted_event_count": 28419,
    "rejected_event_count": 17,
    "last_seen_at": "2026-09-01T20:16:01Z",
    "stale": 1
  },
  "open_alert_count": 2,
  "open_quarantine_count": 1
}

INTEGRATION DECISION

CALLER ACTION: Accept the returned representation or receipt, then correlate the schema, source, stream, sequence, commitment, validation, quarantine, and alert state for the selected evidence lineage.
RETRY SAFETY: Repeat only when the integration needs a fresher authoritative projection.
STATE RECONCILIATION: Use returned identifiers and versions as the comparison point for later reads. Refresh the stream and checkpoint, compare event commitment, sequence, retention boundary, consumer position, and latest accepted receipt.

401The bearer credential is missing, expired, or invalid.Authentication required · JSON RESPONSE+

{
  "code": "invalid_credentials",
  "message": "The bearer credential is missing, expired, or invalid."
}

INTEGRATION DECISIONinvalid_credentials

CALLER ACTION: Discard the rejected credential, complete the documented authentication or reassertion flow, and rebuild any request signature with fresh timestamps and nonces.
RETRY SAFETY: Retry only with a newly valid credential and fresh replay-protection values. Do not replay an expired signature.
STATE RECONCILIATION: Authentication failed before an authoritative read was returned for owner-scoped stream metadata, events, checkpoints, commitments, retention windows, and consumer positions.
ESCALATE WHEN: Escalate when sequence continuity, checkpoint commitment, retention, ownership, or consumer position cannot be proven.

403The credential lacks explicitly provisioned evidence:read authority.Authority or policy denied · JSON RESPONSE+

{
  "code": "insufficient_scope",
  "message": "The credential lacks explicitly provisioned evidence:read authority."
}

INTEGRATION DECISIONinsufficient_scope

CALLER ACTION: Verify the exact scope, tenant or workspace membership, owner boundary, step-up purpose, feature policy, and resource eligibility. Never broaden authority automatically.
RETRY SAFETY: Do not retry until the missing authority or policy condition has been deliberately resolved with least privilege.
STATE RECONCILIATION: Confirm the caller and resource resolve to the same authority boundary for owner-scoped stream metadata, events, checkpoints, commitments, retention windows, and consumer positions.
ESCALATE WHEN: Escalate when sequence continuity, checkpoint commitment, retention, ownership, or consumer position cannot be proven.

503The authoritative Core Evidence Streams projection is unavailable.Dependency unavailable or outcome uncertain · JSON RESPONSE+

{
  "code": "evidence_streams_unavailable",
  "message": "The authoritative Core Evidence Streams projection is unavailable."
}

INTEGRATION DECISIONevidence_streams_unavailable

CALLER ACTION: Treat the failure as transient and preserve the last known good representation without presenting it as fresh.
RETRY SAFETY: Retry with bounded exponential backoff and jitter; stop after the integration's failure budget is exhausted.
STATE RECONCILIATION: Refresh the stream and checkpoint, compare event commitment, sequence, retention boundary, consumer position, and latest accepted receipt.
ESCALATE WHEN: Escalate when sequence continuity, checkpoint commitment, retention, ownership, or consumer position cannot be proven.

OPERATIONAL NOTES

Security and lifecycle guarantees

Use this compact projection for monitoring and agent guardrails before loading detailed streams, sources, alerts, or quarantine records. The only documented state values are OPERATIONAL and DEGRADED.
state is DEGRADED when at least one active source is stale, an alert is open, or a quarantine record is open. Otherwise it is OPERATIONAL. These are monitoring classifications, not safety, regulatory, settlement, disclosure, or operational-control decisions.
Counts are current aggregates and timestamps are nullable RFC 3339 values. Re-fetch the no-store response and resolve the detailed collections before diagnosing cause or claiming recovery.
The summary excludes event payloads, source keys, actor data, attachment state, and billing detail. It accepts no query parameters or request body.

DOCUMENTATION STATUS

This route is implemented in canonical gateway source and appears in the production OpenAPI snapshot observed 2026-09-11T06:35:11.572Z. Authentication, tenant, feature, venue, and market policy still apply.

Verify the exact production OpenAPI operation ↗Return to the V2 directory ↗