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

butler

{taskName}

using LukeHagar.PlexAPI.SDK;
using LukeHagar.PlexAPI.SDK.Models.Components;
using LukeHagar.PlexAPI.SDK.Models.Requests;

var sdk = new PlexAPI(accessToken: "<YOUR_API_KEY_HERE>");

var res = await sdk.Butler.StartTaskAsync(taskName: TaskName.CleanOldBundles);

// handle response

This response does not have an example.

Authorizations

X-Plex-Token

string

header

required

Plex Authentication Token

Path Parameters

taskName

enum<string>

required

the name of the task to be started.

Available options:

BackupDatabase,

BuildGracenoteCollections,

CheckForUpdates,

CleanOldBundles,

CleanOldCacheFiles,

DeepMediaAnalysis,

GenerateAutoTags,

GenerateChapterThumbs,

GenerateMediaIndexFiles,

OptimizeDatabase,

RefreshLibraries,

RefreshLocalMedia,

RefreshPeriodicMetadata,

UpgradeMediaAnalysis

Response

200

The task was started successfully

Stop all Butler tasks Stop a single Butler task

using LukeHagar.PlexAPI.SDK;
using LukeHagar.PlexAPI.SDK.Models.Components;
using LukeHagar.PlexAPI.SDK.Models.Requests;

var sdk = new PlexAPI(accessToken: "<YOUR_API_KEY_HERE>");

var res = await sdk.Butler.StartTaskAsync(taskName: TaskName.CleanOldBundles);

// handle response

This response does not have an example.

Server

Media

Video

Activities

Butler

Plex

Hubs

Search

Library

Watchlist

Log

Playlists

Authentication

Statistics

Sessions

Updater

Users

Start a single Butler task

Authorizations

Path Parameters

Response