There are a number of tasks that can be scheduled to run on a Plex server. This API command will run the refresh libraries task.
POST http://[IP address]:32400/butler/RefreshLibraries?X-Plex-Token=[PlexToken]
|IP address||The IP address of the Plex Media server.|
|PlexToken||The authentication Plex token.|
|200||Success - The task has started successfully.|
|202||Accepted - The task is currently running.|
|401||Unauthorized - The Plex token provided was not valid.|
No response is returned by the command. The status code will indicate whether the refresh libraries task was started successfully.
The scheduled tasks are defined in the Plex settings, and will run during a specified time window. This API command will run manually start the task.
When starting a task, Plex will use the following criteria:
- If a task is not scheduled to run on the current day, it will be skipped.
- The task will start immediately if it is to run at a random time during a configured window, and this command is not run within that window.
- The task will be scheduled to run if it is to run at a random time during a configured window, and this command is run within that window.
- The task will run immediately if it is outside the configured window.
Runs the refresh libraries scheduled task on the Plex Media Server located at the IP address of 192.168.1.4: