← Back to schema index

BanxicoPublicStatusResponse

Response from `GET /v1/status/banxico`. Public reduced view of the Banxico validation 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 status of the Banxico validation service, as returned by `GET /v1/status/banxico`. It 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 or intermittent errors); `down`: service unreachable; `unknown`: no current health data, because no check has run yet or because the last one is more than three times `check_interval_seconds` old (the automated check stopped running).
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` when no check has been run yet. When `status` is `unknown` because the last check is too old, it keeps that check's date: it says since when there is no data.
estimated_recovery_atTimestampUTC | nullEstimated service recovery time. Only set for a specific kind of transient degradation with a known recovery window; `null` in every other case, including other kinds of `degraded`.
check_interval_secondsintegerCadence (in seconds) of the automated health check that feeds this status. It is read live from the configured schedule, so a change takes effect without a deploy; when no cadence is configured, it is `300`.
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 the `meta` block of every response (and in the `meta` of outgoing webhook bodies). 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