Request Livestack status

View as Markdown
GET /livestack/status

Requests the current status of the Livestack, requires Livestack >= v1.0.1.7. Note that this method cannot fail, even if the livestack plugin is not installed or something went wrong. Livestack status is tracked by the server and we can get always the last status reported by nina.plugin.livestack.

Responses

  • 200 application/json

    Successful response

    Hide response attributes Show response attributes object
    • Response string

      Values are running or stopped.

    • Error string
    • StatusCode integer
    • Success boolean
    • Type string
  • 500 application/json

    Internal server error, Unknown error

    Hide response attributes Show response attributes object
    • Response string
    • Error string
    • StatusCode integer
    • Success boolean
    • Type string
GET /livestack/status
curl \
 --request GET 'http://localhost:1888/v2/api/livestack/status'
Response examples (200)
{
  "Response": "running",
  "Error": "string",
  "StatusCode": 200,
  "Success": true,
  "Type": "API"
}
Response examples (500)
{
  "Response": "string",
  "Error": "Unknown error",
  "StatusCode": 500,
  "Success": false,
  "Type": "API"
}