PlexPHP

declare(strict_types=1);

require 'vendor/autoload.php';

use LukeHagar\Plex_API;

$sdk = Plex_API\PlexAPI::builder()
    ->setSecurity(
        '<YOUR_API_KEY_HERE>'
    )
    ->build();



$response = $sdk->butler->startAllTasks(

);

if ($response->statusCode === 200) {
    // handle response
}

Butler

Start all Butler tasks

This endpoint will attempt to start all Butler tasks that are 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

PlexPHP

declare(strict_types=1);

require 'vendor/autoload.php';

use LukeHagar\Plex_API;

$sdk = Plex_API\PlexAPI::builder()
    ->setSecurity(
        '<YOUR_API_KEY_HERE>'
    )
    ->build();



$response = $sdk->butler->startAllTasks(

);

if ($response->statusCode === 200) {
    // handle response
}

Authorizations

X-Plex-Token

string

header

required

The token which identifies the user accessing the PMS. This can be either:

A traditional access token obtained from plex.tv
A JWT token obtained through the JWT authentication flow

JWT tokens provide better security with:

Short-lived tokens (7 days expiration)
Public-key cryptography (ED25519)
Better clock synchronization
Individual device revocation capability

Response

200 - text/html

Get all Butler tasks Stop all Butler tasks

Documentation Index

Authorizations

Response