Liveness check | SupDesk API

2 status codes

200API is healthy.

statusstringoptional

503Database connection is unhealthy.

statusstringoptional

Error handling

A 503 is returned: Database connection is unhealthy.

import { Client } from "supdesk-api-sdk";

const client = new Client({
  baseUrl: "https://api.supdesk.app",
});

const result = await client.health.list();

{
  "status": "ok"
}

Response

Errors