Skip to main content
GET
/
health
Typescript (SDK)
import { Screenshothis } from "@screenshothis/sdk";

const screenshothis = new Screenshothis();

async function run() {
  const result = await screenshothis.health.get();

  console.log(result);
}

run();
{
  "status": "healthy",
  "timestamp": "2024-01-01T00:00:00.000Z",
  "uptime": 3600,
  "checks": [
    {
      "name": "database",
      "status": "pass",
      "duration": 12
    },
    {
      "name": "storage",
      "status": "pass",
      "duration": 25
    },
    {
      "name": "queue",
      "status": "pass",
      "duration": 8,
      "details": {
        "waiting": 2,
        "active": 1,
        "completed": 1543,
        "failed": 0,
        "workerRunning": true
      }
    },
    {
      "name": "s3",
      "status": "pass",
      "duration": 156
    }
  ],
  "version": "1.0.0"
}

Response

Health check passed

Performs a comprehensive health check of all critical system components including database connectivity, storage availability, job queue status, and S3 functionality. Returns detailed status information for monitoring and alerting systems.

​
status
enum<string>
required

Overall health status of the system

Available options:
healthy,
degraded,
unhealthy
​
timestamp
string
required

Timestamp of the health check

​
uptime
number
required

Uptime of the service in seconds

​
checks
object[]
required

Array of health check results

​
version
string

Application version or commit hash

Example:

"1.0.0"