Health
The 2 operations under health, as typed calls on the generated REST client.
Available from @codespar/sdk 0.12.0; the version on npm is 0.16.18. When these docs build, the examples on this page are compiled against @codespar/sdk 0.16.18, the version this site installs: a call that does not type-check against it fails the build.
Every call below is cs.api reaching one operation of the OpenAPI document this page was generated from; the REST client overview explains request, response, the option bag and the errors. The values are placeholders shaped by the document.
import { } from "@codespar/sdk";
const = new ({ : .. });GET /v1/health
Read graded dependency health, as this credential's tenant sees it
const = await ..("/v1/health");Parameters, body and every documented response: GET /v1/health in the HTTP reference.
GET /v1/health/history
Read the per-day share of ok health observations of each check, for the caller's organization
const = await ..("/v1/health/history");Parameters, body and every documented response: GET /v1/health/history in the HTTP reference.