---
title: "Describes the health of Fishjam"
method: GET
path: "/health"
tags: ["health"]
---

# Describes the health of Fishjam

`GET /health`

## Response `200`

Healthy

- HealthcheckResponse — Response containing health report of Fishjam
  - `data` HealthReport, required — Describes overall Fishjam health
    - `distribution` HealthReportDistribution, required — Informs about the status of Fishjam distribution
      - `enabled` boolean — Whether distribution is enabled on this Fishjam
      - `nodeStatus` 'UP' | 'DOWN', required — Informs about the status of Fishjam or a specific service
      - `nodesInCluster` integer, required — Amount of nodes (including this Fishjam's node) in the distribution cluster
    - `gitCommit` string, required — Commit hash of the build
    - `status` 'UP' | 'DOWN', required — Informs about the status of Fishjam or a specific service
    - `uptime` integer, required — Uptime of Fishjam (in seconds)
    - `version` string, required — Version of Fishjam

## Other responses

- `401` — Unauthorized

## Changes

- **2024-03-12** `e90ff229fe07` — 2 info
  - added the required property `data/gitCommit` to the response with the `200` status
  - added the required property `data/version` to the response with the `200` status
- **2024-02-22** `4f1bea96a0f9` — 1 info
  - the endpoint scheme security `authorization` was added to the API
- **2024-02-12** `911cbd65995d` — 3 info
  - api tag `health` added
  - added the non-success response with the status `401`
  - removed the non-success response with the status `500`
- **2024-02-06** `f12ea309466f` — 1 info
  - endpoint added
- **2023-07-18** `dafa9a249254` — 1 breaking
  - api path removed without deprecation

[Change history](https://skmtc.dev/fishjam-dev/apis/fishjam-media-server/changes/health/get.md)

---

[API](https://skmtc.dev/fishjam-dev/apis/fishjam-media-server.md) · [All operations](https://skmtc.dev/fishjam-dev/apis/fishjam-media-server/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/fishjam-dev/fishjam-media-server/revisions/7227c4e436c0/schema)