Media Library Scanning on OpenSubsonic

getScanStatus

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

http://your-server/rest/getScanStatus Since 1.15.0

Returns the current status for media library scanning. Takes no extra parameters.

Parameters

Takes no extra parameters.

Example

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

Result

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

{
 "subsonic-response": {
 "status": "ok",
 "version": "1.16.1",
 "type": "AwesomeServerName",
 "serverVersion": "0.1.3 (tag)",
 "openSubsonic": true,
 "scanStatus": {
 "scanning": true,
 "count": 1
 }
 }
}

{
 "subsonic-response": {
 "status": "ok",
 "version": "1.16.1",
 "scanStatus": {
 "scanning": true,
 "count": 0
 }
 }
}

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

startScan

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

http://your-server/rest/startScan Since 1.15.0

Initiates a rescan of the media libraries. Takes no extra parameters.

Parameters

Takes no extra parameters.

Example

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

Result

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

{
 "subsonic-response": {
 "status": "ok",
 "version": "1.16.1",
 "type": "AwesomeServerName",
 "serverVersion": "0.1.3 (tag)",
 "openSubsonic": true
 "scanStatus": {
 "scanning": true,
 "count": 1
 }
 }
}

{
 "subsonic-response": {
 "status": "ok",
 "version": "1.16.1",
 "scanStatus": {
 "scanning": true,
 "count": 0
 }
 }
}

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