subsonic-response
Common answer wrapper.
Opensubsonic:
{
"subsonic-response": {
"status": "ok",
"version": "1.16.1",
"type": "AwesomeServerName",
"serverVersion": "0.1.3 (tag)",
"openSubsonic": true
}
}
{
"subsonic-response": {
"status": "ok",
"version": "1.16.1"
}
}
Field | Type | Req. | OpenS. | Details |
---|---|---|---|---|
status |
string |
Yes | The command result. ok or failed |
|
version |
string |
Yes | The server supported Subsonic API version. | |
type |
string |
Yes | Yes | The server actual name. [Ex: Navidrome or Gonic ] |
serverVersion |
string |
Yes | Yes | The server actual version. [Ex: 1.2.3 (beta) ] |
openSubsonic |
boolean |
Yes | Yes | Must return true if the server support OpenSubsonic API v1 |
error |
error |
No | The error details when status is failed |
OpenSubsonic
New fields are added:
type
containing the server type/name (Ex: Navidrome or Gonic). Mandatory to help clients adapt to actual Subsonic API support.serverVersion
containing the server version (Ex: 1.2.3) this is different from theversion
field that expose the Subsonic API version. Mandatory for clients to be able to detect servers updates and check again supported OpenSubsonic extensions.openSubsonic
must return true if the server support OpenSubsonic API v1
OpenSubsonic server support
Server | Min vers. | Comment |
---|---|---|
Navidrome | Support type and serverVersion |
|
Gonic | Support type |
|
Ampache | 5.5.6 | Support type and serverVersion |
Funkwhale | Support type , version is exposed as funkwhaleVersion |
|
Astiga | Expose Astiga/production in serverVersion |
|
LMS | Support type |
Last modified April 15, 2023: Fix documentation error (#37) (92f02dd)