LensesAtPlay API Documentation

Overview

This document describes the available API endpoints for the LensesAtPlay server.

Endpoints

GET /

API Documentation

Returns this HTML documentation page.

Response

Content-Type: text/html

GET /health/

Health Check (JSON)

Returns the health status of the server as JSON. Returns 503 Service Unavailable if any health check fails.

Response

{
  "status": "ok",
  "info": {
    "disk": {
      "status": "up"
    }
  },
  "error": {},
  "details": {
    "disk": {
      "status": "up"
    }
  }
}

GET /health/html

Health Check (HTML)

Returns the health status of the server as a formatted HTML page. Useful for browser-based monitoring.

Response

Content-Type: text/html

GET /health/info

Version Information

Returns the current version of the server.

Response

{
  "version": "0.0.1"
}

Health Checks

The server performs the following health checks:

Check	Description	Failure Condition
`disk`	Disk storage availability	Fails if disk usage exceeds 90%