Pulsarr

Get watchlist sync status

GET
/v1/plex/watchlist-sync/{type}/status

Whether a sync of one watchlist type is running and how the latest one ended. Resets when the server restarts.

Authorization

headerX-API-Key<token>

API key authentication using X-API-Key header

Path Parameters

type*string

Your own watchlist or the watchlists of your Plex friends

Value in"self-watchlist""others-watchlist"

Response Body

Default Response

application/json
  1. response

The latest sync of one watchlist type

state*BackgroundRunState

Where the latest background run stands, idle when none ran since the server started

Value in"idle""running""done""failed"
startedAt*|null
finishedAt*|null
error*|

Why the latest run failed, null unless state is failed

total*|

Items read by the latest finished sync

friends*|

Friends read by the latest finished sync, always null for your own watchlist

Example Request
curl -X GET 'http://localhost:3003/v1/plex/watchlist-sync/self-watchlist/status'
Example Response
{  "state": "idle",  "startedAt": "2019-08-24T14:15:22Z",  "finishedAt": "2019-08-24T14:15:22Z",  "error": "string",  "total": -9007199254740991,  "friends": -9007199254740991}