Skip to main content
GET
Error

Authorizations

Authorization
string
header
required

API key or access token

Path Parameters

bindingUid
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Query Parameters

windowHours
integer

Number of trailing hours to analyze for the current diagnostics window. The previous comparison window uses the same duration immediately before it.

Required range: 0 < x <= 720

Response

Get a client Source's health as its agent operator

One client source health object as the agent operator that powers the source may read it. No action is offered, seller- and Apostra-owned failure text is generic, an operation waiting on the seller does not name what the seller decides, writes are null, and attempt bodies are withheld unless the seller has granted debug access to this source.

sourceHealth
object
required

One typed answer per inventory source: identity, health by operation, writes, diagnosis, operations and attempts, and live evidence.

debugGrant
object | null
required

The seller's active debug grant for this source. While it is active, attempt bodies are visible; null when no grant is active.