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

Service is up.

okboolean required
runtimestring required
generationboolean required
billing_configuredboolean required

Whether the billing credentials are present on this deployment. This is the question billing has always actually answered, said plainly.

billing_reachableboolean 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_versionstring 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_tagstring 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.

meteringstring required

How the document counter is kept. Operational detail, not a contract.

periodstring 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.

Example response

{
  "runtime": "cloudflare-workers",
  "engine_version": "0.14.1",
  "deploy_tag": "cce4396",
  "metering": "durable-object-sqlite",
  "period": "2026-08"
}

Changes

No recorded changes to this operation across all 1 revision of this API.