Health

Readiness check

Readiness probe. Runs one query against the database: 200 ready when it answers, 503 not_ready when it does not, so a load balancer or status page can tell "the API is up" from "the API can serve data". No authentication, no rate limit, and a flat body rather than the { success, data } envelope.

get/ready

Request

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

Response

The database answered the probe query

status'ready' required

Always ready on a 200.

database'connected' required

The database answered the probe query.

Example response

{
  "status": "ready",
  "database": "connected"
}

Changes

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