Butler
Start a single Butler task
This endpoint will attempt to start a single Butler task that is enabled in the settings. Butler tasks normally run automatically during a time window configured on the server’s Settings page but can be manually started using this endpoint. Tasks will run with the following criteria:
- Any tasks not scheduled to run on the current day will be skipped.
- If a task is configured to run at a random time during the configured window and we are outside that window, the task will start immediately.
- If a task is configured to run at a random time during the configured window and we are within that window, the task will be scheduled at a random time within the window.
- If we are outside the configured window, the task will start immediately.
POST
Authorizations
Plex Authentication Token
Path Parameters
the name of the task to be started.
Available options:
BackupDatabase
, BuildGracenoteCollections
, CheckForUpdates
, CleanOldBundles
, CleanOldCacheFiles
, DeepMediaAnalysis
, GenerateAutoTags
, GenerateChapterThumbs
, GenerateMediaIndexFiles
, OptimizeDatabase
, RefreshLibraries
, RefreshLocalMedia
, RefreshPeriodicMetadata
, UpgradeMediaAnalysis