Skip to main content

Monitoring API

Health and metrics endpoints for TMA Cloud.

Health Check​

GET /health​

Get application health status. No authentication required.

Response:

{
  "status": "ok",
  "timestamp": "2024-01-01T00:00:00.000Z",
  "uptime": 12345.67
}

Metrics​

GET /metrics​

Get application health and performance metrics. Restricted to IPs in METRICS_ALLOWED_IPS.

Response: Prometheus metrics format

Example:

http_requests_total{method="GET",status="200"} 1234
http_request_duration_seconds{method="GET"} 0.05

Version​

GET /api/version​

Get currently deployed backend version. Requires authentication.

Rate limiting: General API limit (1000 per 15 minutes per IP).

Response:

{
  "backend": "2.0.5"
}
  • backend: Backend version from backend package.json

GET /api/version/latest​

Fetch latest versions from update feed. Admin only (first user).

Rate limiting: General API limit (1000 per 15 minutes per IP).

Response:

The response format depends on the external update feed. Example:

{
  "frontend": "2.0.5",
  "backend": "2.0.5",
  "electron": "1.0.0"
}
  • frontend: Latest frontend version from the update feed
  • backend: Latest backend version from the update feed
  • electron: Latest Windows Electron app version from the update feed

Note: This endpoint proxies the response directly from the update feed. If the request fails, returns an error response.