CIcinepro
Health

Health status endpoint

Returns health status of the backend.

get/v1/health

Request

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

Response

Backend is operational

namestring required

Human-readable name of the backend

versionstring required

Backend version (semantic versioning)

status'operational' | 'degraded' | 'maintenance' | 'offline' required

Current operational status

spec'omss' required

Standard name (always "omss")

notestring

Optional note about the backend or recommended frontend

Example response

{
  "name": "My OMSS Backend",
  "version": "1.0.0",
  "endpoints": {
    "movie": "/v1/movies/{id}",
    "tv": "/v1/tv/{id}/seasons/{s}/episodes/{e}",
    "proxy": "/v1/proxy/?data={encoded_data}"
  },
  "note": "Community-powered streaming backend. Visit https://github.com/mybackend for more info."
}

Changes

No recorded changes to this operation across all 3 revisions of this API.