---
title: "Service status and availability"
method: GET
path: "/status"
---

# Service status and availability

`GET /status`

## Request

- Base URL: `https://vineverse.bible/api/v1`
- URL: `https://vineverse.bible/api/v1/status`
- Auth: none required

Whether the service is up, measured availability over 24 hours, 30 and 90 days, the availability target those are measured against, and which optional datasets this deployment has built.

The datasets block matters most to a client: /interlinear and /connections answer 503 when their artefact is missing, and this reports that state up front.

Answers 503 itself when every component is failing, so a monitor can use the status code alone without parsing the body.

## Response `200`

Live component checks, trailing uptime, and the target.

- Status
  - `status` 'operational' | 'degraded' | 'down', required: degraded covers a failing component AND an unbuilt dataset. The second is not an outage, but it is not "everything is fine" either.
  - `checkedAt` string, date-time, required
  - `uptime` object, required: Fractions, or null. Null means no probe run covered that window. It does not mean 100%: an unmeasured window is not a perfect one.
    - `24h` number, nullable
    - `30d` number, nullable
    - `90d` number, nullable
  - `samples` object: How many probe runs each uptime window holds. Read the percentages against these: the collector runs daily, so a 24h figure rests on about one sample and a 30d figure on about thirty. A percentage without its sample count is not interpretable.
  - `latencyMs` object
  - `sla` object, required
    - `target` number: Availability target as a fraction.
    - `window` string
    - `cadence` string: How often the collector runs. Daily on the current hosting plan.
    - `credits` boolean: Always false. There is no paid tier, so there is nothing to credit. Stated here so you do not have to find out by asking.
    - `measurement` string: How the figures above are produced.
    - `meetingTarget` boolean, nullable
  - `components` object[], required
    - `name` string
    - `status` 'operational' | 'down'
    - `latencyMs` integer, nullable
    - `detail` string
  - `datasets` object, required: Which optional build artefacts this deployment has. An endpoint whose dataset is "unbuilt" answers 503 with code dataset_unavailable, so check here before calling it.
  - `data` object
  - `history` object

## Other responses

- `429`: Too many requests. Carries Retry-After. See the rate limit note in `info`.
- `503`: Every component is failing.

---

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