Get the health of the service

Check the health of the service.

GET /v2/health-check

JavaScript

JavaScript

import { Avalanche } from "@avalanche-sdk/chainkit";

const avalanche = new Avalanche();

async function run() {
  const result = await avalanche.metrics.healthCheck();

  console.log(result);
}

run();

200

{
  "status": "error",
  "info": {},
  "error": {},
  "details": {}
}

Response

200

application/json

The health of the service

status · enum<string>

Available options: error, ok, shutting_down

info · object

Show child attributes

Example:

{ "database": { "status": "up" } }

error · object

Show child attributes

Example:

{}

details · object

Show child attributes

Example:

{ "database": { "status": "up" } }