Health check

client.health.check(?): HealthCheckResponse { status }

get/health

Health check

ReturnsExpand Collapse

HealthCheckResponse { status }

status: "ok"

Accepts one of the following:

"ok"

Health check

import Hypeman from '@onkernel/hypeman';

const client = new Hypeman({
  apiKey: 'My API Key',
});

const response = await client.health.check();

console.log(response.status);

{
  "status": "ok"
}

Returns Examples

{
  "status": "ok"
}