---
title: "Liveness and build capabilities"
method: GET
path: "/v1/health"
tags: ["Meta"]
---

# Liveness and build capabilities

`GET /v1/health`

## Request

- Base URL: `https://api.attestwire.com`
- URL: `https://api.attestwire.com/v1/health`
- Auth: none required

## Response `200`

Service is up.

- object
  - `ok` boolean, required
  - `runtime` string, required
  - `generation` boolean, required
  - `billing` union, required: Whether card payment is live. `true` means a real card will be charged; `"test-mode"` means checkout works but against the provider's sandbox; `false` means POST /v1/billing/checkout answers 503. UNCHANGED, including the name: it is what it has always been, and the two fields below are additions rather than a rename. What it does NOT mean is that the provider is answering — see `billing_reachable`.
    - boolean
    - 'test-mode' | 'misconfigured'
  - `billing_configured` boolean, required: Whether the billing credentials are present on this deployment. This is the question `billing` has always actually answered, said plainly.
  - `billing_reachable` boolean, nullable, required: Whether the payment provider answered a cheap, read-only, side-effect-free call. `null` means unconfigured, or not yet checked on this instance — which is not the same as unreachable and is never reported as `false`. Cached for five minutes and refreshed in the background, so this endpoint never waits on it. `billing_configured: true` with `billing_reachable: false` is a revoked key or a provider outage: the state in which checkout answers 502 and nobody can buy anything.
  - `engine_version` string, required: The version of @attestwire/en16931 this deployment runs — the same string every `provenance` block and GET /v1/versions report, from the same source.
  - `deploy_tag` string, nullable, required: The git short sha this Worker version was deployed from. `null` on an untagged upload. Lets an operator answer "is production behind main" from the health probe alone.
  - `metering` string, required: How the document counter is kept. Operational detail, not a contract.
  - `period` string, required: The billing period this request fell in, YYYY-MM. Matches `X-RateLimit-Period` on a metered call, and is the cheapest way to confirm the reset has happened.

---

[API](https://skmtc.dev/attestwire/apis/attestwire-api.md) · [All operations](https://skmtc.dev/attestwire/apis/attestwire-api/llms.txt) · [OpenAPI document](https://skmtc.dev/attestwire/apis/attestwire-api/revisions/0036f8e043b2?raw)