API version and available endpoints

Returns version information and available endpoints.

GET /v1

API version endpoint

JavaScript

const options = {method: 'GET'};

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

curl --request GET \
  --url https://api.example.com/v1

import requests

url = "https://api.example.com/v1"

response = requests.get(url)

print(response.text)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/v1",
  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 := "https://api.example.com/v1"

	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("https://api.example.com/v1")
  .asString();

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."