Saltar al contenido principal
GET
/
health
curl -X GET "https://ryzeapi.cloud/health"

{
  "status": "ok",
  "service": "RyzeAPI",
  "uptime": "12h34m56s",
  "timestamp": "2026-04-28T14:35:21Z",
  "checks": {
    "db": "ok"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.ryzeapi.cloud/llms.txt

Use this file to discover all available pages before exploring further.

Auth: Ninguna • Rate limit: Bypass (fuera del límite global) • Idempotente: sí

​
Descripción

Endpoint abierto (sin token) que devuelve una instantánea del estado de la API basada en verificaciones de dependencias (DB siempre, además de sondeos opcionales como S3 cuando esté configurado). Omite el rate limit y CORS para que monitores externos puedan consultarlo sin credenciales.

​
Ejemplo

curl -X GET "https://ryzeapi.cloud/health"

​
Respuesta, saludable

{
  "status": "ok",
  "service": "RyzeAPI",
  "uptime": "12h34m56s",
  "timestamp": "2026-04-28T14:35:21Z",
  "checks": {
    "db": "ok"
  }
}

​
Respuesta, degradada

503 Service Unavailable
{
  "status": "degraded",
  "service": "RyzeAPI",
  "uptime": "12h34m56s",
  "timestamp": "2026-04-28T14:35:21Z",
  "checks": {
    "db": "fail: connection refused"
  }
}

​
Campos

CampoDescripción
status"ok" cuando todas las verificaciones pasan, "degraded" cuando alguna falla.
serviceSiempre "RyzeAPI".
uptimeTiempo desde que arrancó el proceso, en formato de duración de Go (p. ej., 12h34m56s, 1h2m3.456s).
timestampHora de la respuesta en RFC 3339 (UTC).
checksMapa name → "ok" | "fail: <razón>" para cada dependencia verificada.
Las entradas en checks aparecen condicionalmente: db siempre está presente; otras dependencias (p. ej., s3) solo aparecen cuando están configuradas en el servidor.

​
Uso en monitores de uptime

Apunta un servicio de monitoreo (UptimeRobot, Better Stack, Pingdom, etc.) a GET /health:
  • 200 → API saludable.
  • 503 → API degradada, dispara la alerta.

​
Notas

  • No es necesario enviar la cabecera token. Los tokens enviados se ignoran.
  • El endpoint no cuenta para el límite global de 100 req/min, y puede llamarse sin restricción por sondas externas.

​
Relacionado

Resumen

Dónde se ubica el endpoint en el ciclo de vida de la API.

Tipos de error

Tabla de estados HTTP utilizados por RyzeAPI.