Sign in
settings

Start full Plex library scan

Runs a full Plex library scan and returns the progress in a JSON array.

post/settings/plex/sync

Request

  • Base URL: http://localhost:5055/api/v1
  • URL: http://localhost:5055/api/v1/settings/plex/sync
  • Auth: one of:
    • API key in cookie connect.sid
    • API key in header X-Api-Key

Request body

cancelboolean
startboolean

Response

Status of Plex scan

runningboolean
progressnumber
totalnumber

Example response

{
  "total": 100,
  "currentLibrary": {
    "name": "Movies"
  },
  "libraries": [
    {
      "name": "Movies"
    }
  ]
}

Changes

No recorded changes to this operation across all 21 revisions of this API.