System on OpenSubsonic

getLicense

Mon, 01 Jan 0001 00:00:00 +0000

http://your-server/rest/getLicense Since 1.0.0

Get details about the software license.

Parameters

Takes no extra parameters.

Example

http://your-server/rest/getLicense.view?u=demo&p=demo&v=1.13.0&c=AwesomeClientName&f=json

Result

A subsonic-response element with a nested license element on success.

{
 "subsonic-response": {
 "status": "ok",
 "version": "1.16.1",
 "type": "AwesomeServerName",
 "serverVersion": "0.1.3 (tag)",
 "openSubsonic": true,
 "license": {
 "valid": true,
 "email": "demo@demo.org",
 "licenseExpires": "2017-04-11T10:42:50.842Z",
 "trialExpires": "2017-04-11T10:42:50.842Z"
 }
 }
}

{
 "subsonic-response": {
 "status": "ok",
 "version": "1.16.1",
 "license": {
 "valid": true,
 "email": "demo@demo.org",
 "licenseExpires": "2017-04-11T10:42:50.842Z",
 "trialExpires": "2017-04-11T10:42:50.842Z"
 }
 }
}

Field	Type	Req.	OpenS.	Details
`license`	`license`	Yes		The status of the license

getOpenSubsonicExtensions

Mon, 01 Jan 0001 00:00:00 +0000

http://your-server/rest/getOpenSubsonicExtensions OpenSubsonic version 1

List the OpenSubsonic extensions supported by this server.

Parameters

Takes no extra parameters.

Note: Unlike all other APIs getOpenSubsonicExtensions must be publicly accessible.

Example

http://your-server/rest/getOpenSubsonicExtensions.view?u=demo&p=demo&v=1.13.0&c=AwesomeClientName&f=json

Result

A subsonic-response element with a nested openSubsonicExtensions element on success.

{
 "subsonic-response": {
 "status": "ok",
 "version": "1.16.1",
 "type": "AwesomeServerName",
 "serverVersion": "0.1.3 (tag)",
 "openSubsonic": true,
 "openSubsonicExtensions": [
 {
 "name": "template",
 "versions": [
 1,
 2
 ]
 },
 {
 "name": "transcodeOffset",
 "versions": [
 1
 ]
 },
 {
 "name": "sonicSimilarity",
 "versions": [
 1
 ]
 }
 ]
 }
}

Does not exist.

Field	Type	Req.	OpenS.	Details
`openSubsonicExtensions`	An array of `openSubsonicExtension`	Yes		The list of supported extensions

OpenSubsonic

This is a new endpoint.

ping

Mon, 01 Jan 0001 00:00:00 +0000

http://your-server/rest/ping Since 1.0.0

Test connectivity with the server.

Parameters

Takes no extra parameters.

Example

http://your-server/rest/ping.view?u=demo&p=demo&v=1.13.0&c=AwesomeClientName&f=json

Result

An empty subsonic-response element on success.

{
 "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"
 }
}

tokenInfo

Mon, 01 Jan 0001 00:00:00 +0000

OpenSubsonic version: 1

OpenSubsonic extension name apiKeyAuthentication (As returned by getOpenSubsonicExtensions)

Returns data about an API key.

http://your-server/rest/tokenInfo

Parameters

None

Example

http://your-server/rest/tokenInfo.view?apiKey=1234&v=1.13.0&c=AwesomeClientName&f=json

Result

A subsonic-response element with a nested tokenInfo on success, or error 44 on invalid token.

{
"subsonic-response": {
 "status": "ok",
 "version": "1.16.1",
 "type": "AwesomeServerName",
 "serverVersion": "0.1.3 (tag)",
 "openSubsonic": true,
 "tokenInfo": {
 "username": "token username"
 }
 }
}

<subsonic-response status="ok" version="1.16.1" type="AwesomeServerName" serverVersion="0.1.3 (tag)" openSubsonic="true">
 <tokenInfo username="token username"></tokenInfo>
</subsonic-response>

Does not exist.

Field	Type	Req.	OpenS.	Details
`tokenInfo`	`tokenInfo`	Yes	Yes	Information about the token