Health check / Home endpoint

Returns basic information about the backend and available endpoints.

GET /

Root OMSS backend information

JavaScript

const options = {method: 'GET'};

fetch('http://localhost:{port}/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

curl --request GET \
  --url http://localhost:{port}/

import requests

url = "http://localhost:{port}/"

response = requests.get(url)

print(response.text)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "62437",
  CURLOPT_URL => "http://localhost:{port}/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "http://localhost:{port}/"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("http://localhost:{port}/")
  .asString();

200

{
  "name": "<string>",
  "version": "<string>",
  "spec": "omss",
  "endpoints": {
    "movie": "<string>",
    "tv": "<string>"
  },
  "media": {
    "movies": [
      123
    ],
    "tv": [
      {
        "id": 123,
        "seasons": [
          {
            "season": 123,
            "episodes": [
              123
            ]
          }
        ]
      }
    ]
  },
  "providers": [
    {
      "id": "<string>",
      "name": "<string>",
      "capabilities": []
    }
  ],
  "note": "<string>"
}

{
  "error": {
    "message": "<string>",
    "details": "<unknown>"
  },
  "traceId": "<string>"
}

{
  "error": {
    "message": "<string>",
    "details": "<unknown>"
  },
  "traceId": "<string>"
}

{
  "error": {
    "message": "<string>",
    "details": "<unknown>"
  },
  "traceId": "<string>"
}

Response

200

application/json

Root backend information.

Root information about the OMSS backend and available media.

name · string · required

Implementation name.

version · string · required

Semantic version of the OMSS implementation.

status · enum<string> · required

API status.

Available options: operational, degraded, down

spec · enum<string> · required

Specification identifier; MUST be "omss" for OMSS implementations.

Available options: omss

endpoints · object · required

Functions mapped to paths.

Show child attributes

media · object · required

Overview of media availability.

Show child attributes

providers · object[] · required

List of providers this backend exposes.

Show child attributes

note · string

Optional message, description, or disclaimer provided by the backend.