GET /health

Overview

Simple health check endpoint. Returns {"status": "ok"} if the server is running. Useful for load balancers, container orchestration, and monitoring tools.

Endpoint

GET http://your-server:8082/health

Response

Success (200 OK)

{
  "status": "ok"
}

The server always returns 200 OK with this body as long as the process is running. There is no deeper health check (e.g., database connectivity).

Examples

curl http://your-server:8082/health

HEALTHCHECK --interval=30s --timeout=5s --start-period=10s --retries=3 \
  CMD curl -f http://localhost:8082/health || exit 1

binary_sensor:
  - platform: rest
    name: "NLE Server"
    resource: http://your-server:8082/health
    value_template: "{{ value_json.status == 'ok' }}"
    device_class: connectivity
    scan_interval: 60

GET /api/stats

Detailed server statistics

GET /nest/ping

Device protocol health check (port 8000)

Overview

Self-Hosted Control API

Device Protocol API

Hosted Service API

Overview

Endpoint

Response

Success (200 OK)

Examples

GET /api/stats

GET /nest/ping

​Overview

​Endpoint

​Response

​Success (200 OK)

​Examples

​Related

GET /api/stats

GET /nest/ping

Overview

Endpoint

Response

Success (200 OK)

Examples

Related