Skip to main content
GET
/
v1
/
health-check
JavaScript
import { Avalanche } from "@avalanche-sdk/chainkit";

const avalanche = new Avalanche();

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

  console.log(result);
}

run();
{
  "status": "error",
  "info": {
    "database": {
      "status": "up"
    }
  },
  "error": {},
  "details": {
    "database": {
      "status": "up"
    }
  }
}

Authorizations

​
x-glacier-api-key
string
header
required

Api keys provide higher access to rate limits. To obtain an api key, sign up for an account at https://build.avax.network/console/utilities/data-api-keys.

Response

The health of the service

​
status
enum<string>
Available options:
error,
ok,
shutting_down
​
info
object | null
Examples:
{ "database": { "status": "up" } }
​
error
object | null
Examples:
{}
​
details
object
Examples:
{ "database": { "status": "up" } }