Health
Confirm the API is reachable and your key works.
GET /v1/health
This endpoint answers one question: is the hosted API reachable, and does your key pass the checks in front of it. It carries no query parameters and touches none of the chain adapters, so it never speaks to eIDChain, Ethereum, or Hyperledger Fabric.
Parameters
None.
Request
curl https://<host>/v1/health \
-H "Authorization: Bearer idc_live_..."Response
{"status":"ok"}Status codes
| Code | Meaning |
|---|---|
| 200 | The API is reachable and the request reached the handler. |
A 401 or 402 here does not mean the oracle is down. /v1/health still
passes through key checking, the rate limiter, and the credit gate before it
returns, so a 401 reports a bad or revoked key and a 402 reports an
account with no credits remaining. This makes /v1/health the cheapest way
to confirm a key works: if it returns {"status":"ok"}, your key, your
account, and the API are all fine, and any failure on another endpoint is
about that endpoint, not about authentication.