GET
/
health
JavaScript
import Worqhat from 'worqhat';

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

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

console.log(response.status);
{
  "status": "ok",
  "uptime": 123.45,
  "version": "1.0.0",
  "environment": "production",
  "timestamp": "2025-07-24T17:00:00Z",
  "services": {
    "database": "ok"
  }
}

Response

Server is healthy

status
enum<string>
required

Current health status of the API

Available options:
ok,
degraded,
maintenance,
down
Example:

"ok"

uptime
number
required

Server uptime in seconds

Example:

123.45

version
string

Current API version

Example:

"1.0.0"

environment
enum<string>

Current environment

Available options:
development,
staging,
production
Example:

"production"

timestamp
string<date-time>

Current server time

Example:

"2025-07-24T17:00:00Z"

services
object

Status of dependent services