---
title: "Service health"
method: GET
path: "/v1/health"
tags: ["platform"]
---

# Service health

`GET /v1/health`

## Request

- Base URL: `https://api.bigballsdata.com`
- URL: `https://api.bigballsdata.com/v1/health`
- Auth: one of:
  - API key in header `x-api-key`
  - HTTP bearer

Liveness probe. NOTE the non-standard shape: this returns a bare object, NOT the standard Envelope (no data/meta/error wrapper). `sha` reports the deployed commit, and is the literal string "unknown" when neither COMMIT_SHA nor RAILWAY_GIT_COMMIT_SHA is set in the environment (which is the case today, so hash-based deploy verification is unavailable until that build arg is wired). `deployed_at` is derived from process uptime, not from the build.

## Response `200`

ok. Bare object, not the standard Envelope.

- object
  - `status` string, required
  - `sha` string, required: Deployed commit, or "unknown" when the build arg is unset.
  - `deployed_at` string, date-time, required: Derived from process uptime.
  - `uptime_seconds` integer, required

---

[API](https://skmtc.dev/bigballsdata/apis/big-ball-sports-api.md) · [All operations](https://skmtc.dev/bigballsdata/apis/big-ball-sports-api/llms.txt) · [OpenAPI document](https://skmtc.dev/bigballsdata/apis/big-ball-sports-api/revisions/31fb54ac414e?raw)