plexphp/docs/sdks/updater/README.md

Updater

(updater)

Overview

This describes the API for searching and applying updates to the Plex Media Server. Updates to the status can be observed via the Event API.

Available Operations

• applyUpdates - Apply Updates
• checkForUpdates - Checking for updates
• getUpdateStatus - Querying status of updates

applyUpdates

Note that these two parameters are effectively mutually exclusive. The tonight parameter takes precedence and skip will be ignored if tonight is also passed

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

use LukeHagar\Plex_API;
use LukeHagar\Plex_API\Models\Operations;

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



$response = $sdk->updater->applyUpdates(
    tonight: Operations\Tonight::One,
    skip: Operations\Skip::One

);

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

Parameters

Parameter	Type	Required	Description	Example
tonight	?Operations\Tonight	➖	Indicate that you want the update to run during the next Butler execution. Omitting this or setting it to false indicates that the update should install	1
skip	?Operations\Skip	➖	Indicate that the latest version should be marked as skipped. The [Release] entry for this version will have the state set to skipped.	1

Response

?Operations\ApplyUpdatesResponse

Errors

Error Type	Status Code	Content Type
Errors\ApplyUpdatesBadRequest	400	application/json
Errors\ApplyUpdatesUnauthorized	401	application/json
Errors\SDKException	4XX, 5XX	*/*

checkForUpdates

Checking for updates

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

use LukeHagar\Plex_API;
use LukeHagar\Plex_API\Models\Operations;

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



$response = $sdk->updater->checkForUpdates(
    download: Operations\Download::One
);

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

Parameters

Parameter	Type	Required	Description	Example
download	?Operations\Download	➖	Indicate that you want to start download any updates found.	1

Response

?Operations\CheckForUpdatesResponse

Errors

Error Type	Status Code	Content Type
Errors\CheckForUpdatesBadRequest	400	application/json
Errors\CheckForUpdatesUnauthorized	401	application/json
Errors\SDKException	4XX, 5XX	*/*

getUpdateStatus

Querying status of updates

Example Usage

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->updater->getUpdateStatus(

);

if ($response->object !== null) {
    // handle response
}

Response

?Operations\GetUpdateStatusResponse

Errors

Error Type	Status Code	Content Type
Errors\GetUpdateStatusBadRequest	400	application/json
Errors\GetUpdateStatusUnauthorized	401	application/json
Errors\SDKException	4XX, 5XX	*/*