Health check

Returns server status and verifies database connectivity. Returns 503 if the database is unreachable.

Request

Method: GET
Path: /health

Authentication: Not required

Responses

200 - Server healthy

503 - Database unreachable

Examples

cURL

curl -X GET \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  http://localhost:3000/health

JavaScript

const response = await fetch('http://localhost:3000/health', {
  method: 'GET',
  headers: {
    'Content-Type': 'application/json',
    'Authorization': 'Bearer ' + token,
  },
});

const data = await response.json();
console.log(data);

This documentation is automatically generated from the OpenAPI specification.

Request​

Responses​

200 - Server healthy​

503 - Database unreachable​

Examples​

cURL​

JavaScript​