Skip to content

Latest commit

 

History

History
140 lines (89 loc) · 9.61 KB

README.md

File metadata and controls

140 lines (89 loc) · 9.61 KB

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

get_update_status

Querying status of updates

Example Usage

from plex_api_client import PlexAPI

with PlexAPI(
    access_token="<YOUR_API_KEY_HERE>",
) as plex_api:

    res = plex_api.updater.get_update_status()

    assert res.object is not None

    # Handle response
    print(res.object)

Parameters

Parameter Type Required Description
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

operations.GetUpdateStatusResponse

Errors

Error Type Status Code Content Type
errors.GetUpdateStatusBadRequest 400 application/json
errors.GetUpdateStatusUnauthorized 401 application/json
errors.SDKError 4XX, 5XX */*

check_for_updates

Checking for updates

Example Usage

from plex_api_client import PlexAPI
from plex_api_client.models import operations

with PlexAPI(
    access_token="<YOUR_API_KEY_HERE>",
) as plex_api:

    res = plex_api.updater.check_for_updates(download=operations.Download.ONE)

    assert res is not None

    # Handle response
    print(res)

Parameters

Parameter Type Required Description Example
download Optional[operations.Download] ➖ Indicate that you want to start download any updates found. 1
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

operations.CheckForUpdatesResponse

Errors

Error Type Status Code Content Type
errors.CheckForUpdatesBadRequest 400 application/json
errors.CheckForUpdatesUnauthorized 401 application/json
errors.SDKError 4XX, 5XX */*

apply_updates

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

from plex_api_client import PlexAPI
from plex_api_client.models import operations

with PlexAPI(
    access_token="<YOUR_API_KEY_HERE>",
) as plex_api:

    res = plex_api.updater.apply_updates(tonight=operations.Tonight.ONE, skip=operations.Skip.ONE)

    assert res is not None

    # Handle response
    print(res)

Parameters

Parameter Type Required Description Example
tonight Optional[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 Optional[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
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

operations.ApplyUpdatesResponse

Errors

Error Type Status Code Content Type
errors.ApplyUpdatesBadRequest 400 application/json
errors.ApplyUpdatesUnauthorized 401 application/json
errors.SDKError 4XX, 5XX */*