← Back to schema index

BanxicoPublicStatusResponse

Response from `GET /v1/status/banxico`. Public reduced view of the Banxico CEP service status, with no internal details. Cached 60s (via `Cache-Control` header in the response) — designed for health badges in customer dashboards.

Properties

FieldTypeDescription
dataobjectMain response payload. Shape varies by endpoint (object, array, or JSON:API envelope with `type`, `id`, `attributes`).
type*stringJSON:API resource type. Always `banxico_status`.
id*stringFixed `current` identifier (the current status entry).
attributes*objectPublic Banxico CEP service status. Returned by `GET /v1/banxico/status` without authentication. Shows the current operational status and a human-readable explanation.
status*stringAggregated service status: `operational` — all checks pass and latency is normal; `degraded` — partial issues (high latency, intermittent errors); `down` — service unreachable; `unknown` — no health check data available yet.
status_label*stringHuman-readable status label, resolved to the request locale.
message*stringShort explanation of the current service status, resolved to the request locale.
last_verified_at*TimestampUTC | nullTimestamp of the last health check executed. `null` if no check has been run yet.
estimated_recovery_atTimestampUTC | nullEstimated service recovery time. Only set when status is `degraded` and a known recovery window is available. `null` in all other states.
check_interval_secondsintegerCadence (in seconds) of the automated full health check — the source of truth the status page uses to render "updates every X" and the countdown to the next check. Pulled live from the editable `health-banxico-check` scheduled task, so an admin can retune it without a deploy. Falls back to 300 when the task is missing or cron-typed.
metaobjectResponse metadata including API version, route prefix, unique request identifier, and the server timestamp in UTC.
versionstringAPI version that processed the request.
api_versionstringAPI route prefix version (e.g. `v1`).
request_idstringUnique request identifier (hex).
datetimeobjectCompanion descriptor present in every response's meta block (and in outgoing webhook payloads). Lets clients assert the timezone contract without re-reading the spec.
timezone*stringAlways `UTC` — the canonical timezone for every datetime field in the body.
format*stringAlways `ISO 8601` — explicit `Z` suffix on every datetime.
linksobjectPagination or related links, present only when the endpoint returns a paginated collection.

Used in operations

  • GET /v1/status/banxico