Health

Verificar estado del servicio

Endpoint de health check que verifica el estado del servicio basándose en la última sincronización de datos y la conectividad con la base de datos.

Estados posibles:

  • ok: Sincronización reciente (≤15 minutos) y DB conectada
  • degraded: Sincronización ligeramente retrasada (15-30 min), DB desconectada, o datos de sync inválidos
  • error: Sincronización muy antigua (>30 minutos)

Este endpoint solo retorna 500 cuando la sincronización tiene más de 30 minutos de antigüedad. Los estados "degraded" retornan 200 para evitar falsos positivos en health checks.

get/health

Request

  • Base URL: https://api.cambio-uruguay.com
  • URL: https://api.cambio-uruguay.com/health
  • Auth: one of:
    • none
    • API key in header X-API-Key

Response

Servicio saludable o degradado

status'ok' | 'degraded' | 'error' required

Estado del servicio (ok, degraded, error)

messagestring required

Mensaje descriptivo del estado

timestampstring date-time required

Timestamp de la respuesta

uptimenumber

Tiempo de actividad del servidor en segundos

Example response

{
  "status": "ok",
  "message": "Sync is recent",
  "timestamp": "2024-08-09T12:00:00.000Z",
  "uptime": 3600
}

Changes

No recorded changes to this operation across all 1 revision of this API.