Health

Health check

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.

get/health

Request

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

Response

The API worker is running

status'ok' required

Always ok. Getting an answer at all is the signal; there is no degraded value.

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

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

Example response

{
  "status": "ok",
  "timestamp": "2026-09-11T07:35:44.688Z",
  "version": "v1",
  "environment": "production"
}

Changes

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