← Volver al índice de esquemas
BanxicoPublicStatusResponse
Respuesta de `GET /v1/status/banxico`. Vista pública reducida del estado del servicio de verificación de Banxico, sin detalles internos. Cacheada 60s (por `Cache-Control` en la respuesta) — pensada para health badges en dashboards de clientes.
Propiedades
| Campo | Tipo | Descripción |
|---|---|---|
data | object | Payload principal de la respuesta. La forma varía según el endpoint (objeto, array, o envelope JSON:API con `type`, `id`, `attributes`). |
type* | string | Tipo del recurso JSON:API. Siempre `banxico_status`. |
id* | string | Identificador fijo. Siempre `current`. |
attributes* | object | Estado público del servicio de verificación de Banxico, tal como lo devuelve `GET /v1/status/banxico`. Muestra el estado operativo actual y una explicación legible. |
status* | string | Estado agregado del servicio de verificación de Banxico — `operational`: Todas las pruebas pasan y la latencia es normal; `degraded`: Problemas parciales (latencia elevada o errores intermitentes); `down`: Servicio inaccesible; `unknown`: no hay datos de salud vigentes, porque aún no se ha ejecutado ningún chequeo o porque el último tiene más de tres veces `check_interval_seconds` de antigüedad (el chequeo automático dejó de correr). |
status_label* | string | Etiqueta legible del estado actual (resuelta según idioma de la llamada). |
message* | string | Explicación corta del estado actual del servicio de verificación de Banxico (resuelta según idioma de la llamada). |
last_verified_at* | TimestampUTC | null | Timestamp del último chequeo de salud ejecutado. `null` cuando aún no se ha ejecutado ningún chequeo. Cuando `status` es `unknown` por un chequeo demasiado viejo, conserva la fecha de ese chequeo: dice desde cuándo no hay dato. |
estimated_recovery_at | TimestampUTC | null | Tiempo estimado de recuperación del servicio de verificación de Banxico. Solo se establece para cierto tipo de degradación transitoria con una ventana de recuperación conocida; `null` en cualquier otro caso, incluidos los demás tipos de `degraded`. |
check_interval_seconds | integer | Cadencia (en segundos) del chequeo de salud automático que alimenta este estado. Se lee en vivo de la tarea programada, así que un cambio surte efecto sin desplegar; cuando no hay ninguna cadencia configurada, son `300`. |
meta | object | Metadatos de la respuesta, incluyendo versión de la API, prefijo de ruta, identificador único de la petición y marca temporal del servidor en UTC. |
version | string | Versión de la API que procesó la petición. |
api_version | string | Versión del prefijo de ruta de la API (ej. `v1`). |
request_id | string | Identificador único de la petición (hex). |
datetime | object | Descriptor compañero presente en el bloque `meta` de cada respuesta (y en el `meta` del cuerpo de los webhooks salientes). Permite a los clientes afirmar el contrato de zona horaria sin releer el spec. |
timezone* | string | Siempre `UTC`: La zona canónica para cada campo datetime del cuerpo. |
format* | string | Siempre `ISO 8601`: Sufijo `Z` explícito en cada datetime. |
links | object | Enlaces de paginación o relacionados, presentes solo cuando el endpoint devuelve una colección paginada. |
Usado en operaciones
GET /v1/status/banxico