v41

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-011035599.5 KB
General

Know if your Media Server is online.

<h3>🛡️ Requires Capabilities: None</h3>
get/api/v1/health

Response

Returns the state of the server. If the server responds, then it's online. Responses will always have a 200 status. Possible states are: normal, not_setup.

{"stackTrail":"paths:/api/v1/health:get:responses:200:content:application/json:schema","oasType":"schema","type":"unknown","example":{"state":"normal"}}

Example response

{
  "state": "normal"
}