getScanStatus

Returns the current status for media library scanning.

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

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
Last modified April 8, 2023: Simplify OpenSubsonic API (#30) (616a145)