GET
/
v1
/
health-check
import { AvaCloudSDK } from "@avalabs/avacloud-sdk";

const avaCloudSDK = new AvaCloudSDK({
  serverURL: "https://api.example.com",
  chainId: "43114",
  network: "mainnet",
});

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

  // Handle the result
  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://avacloud.io/.

Response

200
application/json
The health of the service
​
status
enum<string>
Available options:
error,
ok,
shutting_down
​
info
object | null
Example:
{ "database": { "status": "up" } }
​
error
object | null
Example:
{}
​
details
object
Example:
{ "database": { "status": "up" } }

Was this page helpful?