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

# Readiness check

`GET /ready`

## Request

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

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.

## Response `200`

The database answered the probe query

- object
  - `status` 'ready', required: Always `ready` on a 200.
  - `database` 'connected', required: The database answered the probe query.

## Other responses

- `503`: The database did not answer the probe query

---

[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)