---
title: "Health status endpoint"
method: GET
path: "/v1/health"
tags: ["Health"]
---

# Health status endpoint

`GET /v1/health`

## Request

- Base URL: `https://api.example.com`
- URL: `https://api.example.com/v1/health`
- Auth: none declared

Returns health status of the backend.

## Response `200`

Backend is operational

- HealthResponse
  - `name` string, required: Human-readable name of the backend
  - `version` string, required: Backend version (semantic versioning)
  - `status` 'operational' | 'degraded' | 'maintenance' | 'offline', required: Current operational status
  - `endpoints` object: Available endpoint paths
    - `movie` string
    - `tv` string
    - `proxy` string
  - `spec` 'omss', required: Standard name (always "omss")
  - `note` string: Optional note about the backend or recommended frontend

---

[API](https://skmtc.dev/cinepro/apis/open-media-streaming-specification-omss.md) - [All operations](https://skmtc.dev/cinepro/apis/open-media-streaming-specification-omss/llms.txt) - [OpenAPI document](https://skmtc.dev/cinepro/apis/open-media-streaming-specification-omss/revisions/366afc0b096f?raw)