---
title: "Health check"
method: GET
path: "/health"
tags: ["Health"]
---

# Health check

`GET /health`

## Request

- Base URL: `https://api.gunspec.io`
- URL: `https://api.gunspec.io/health`
- Auth: none required

Liveness probe. Answers 200 whenever the API worker is running, and deliberately does not touch the database, so it stays green through a database incident. Use `/ready` to know whether requests will succeed. No authentication, no rate limit, and a flat body rather than the `{ success, data }` envelope.

## Response `200`

The API worker is running

- object
  - `status` 'ok', required: Always `ok`. Getting an answer at all is the signal; there is no degraded value.
  - `timestamp` string, date-time, required: When the probe answered, ISO 8601 UTC. A value that does not move between calls means something in between is caching the reply.
  - `version` string, required: The API version every endpoint is served under: the `v1` in `/v1/...`. Not a build number.
  - `environment` 'production' | 'staging' | 'development', required: Which deployment answered: `production` (api.gunspec.io), `staging`, or `development` for a worker running locally.

---

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