Service status and availability

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.

get/status

Request

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

Response

Live component checks, trailing uptime, and the target.

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.

checkedAtstring date-time required
samplesobject

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.

latencyMsobject
datasetsobject 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.

dataobject
historyobject

Changes

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