Home

Returns basic information about the backend and available endpoints.

GET

Health check / Home endpoint

JavaScript

const options = {method: 'GET'};

fetch('https://api.example.com/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

200

{
  "name": "My OMSS Backend",
  "version": "1.0.0",
  "status": "operational",
  "endpoints": {
    "movie": "/v1/movies/{id}",
    "tv": "/v1/tv/{id}/seasons/{s}/episodes/{e}",
    "proxy": "/v1/proxy/?data={encoded_data}"
  },
  "spec": "omss",
  "note": "Community-powered streaming backend"
}

Response

200 - application/json

Backend is operational

name · string · required

Human-readable name of the backend

Example:

"My OMSS Backend"

version · string · required

Backend version (semantic versioning)

Example:

"1.0.0"

status · enum<string> · required

Current operational status

Available options: operational, degraded, maintenance, offline

spec · enum<string> · required

Standard name (always "omss")

Available options: omss

endpoints · object

Available endpoint paths

Show child attributes

note · string

Optional note about the backend or recommended frontend

Example:

"Community-powered streaming backend. Visit https://github.com/mybackend for more info."