plexpy/docs/sdks/server/README.md

Server

(server)

Overview

Operations against the Plex Media Server System.

Available Operations

• get_server_capabilities - Get Server Capabilities
• get_server_preferences - Get Server Preferences
• get_available_clients - Get Available Clients
• get_devices - Get Devices
• get_server_identity - Get Server Identity
• get_my_plex_account - Get MyPlex Account
• get_resized_photo - Get a Resized Photo
• get_media_providers - Get Media Providers
• get_server_list - Get Server List

get_server_capabilities

Get Server Capabilities

Example Usage

from plex_api_client import PlexAPI

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

    res = plex_api.server.get_server_capabilities()

    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.GetServerCapabilitiesResponse

Errors

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

get_server_preferences

Get Server Preferences

Example Usage

from plex_api_client import PlexAPI

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

    res = plex_api.server.get_server_preferences()

    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.GetServerPreferencesResponse

Errors

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

get_available_clients

Get Available Clients

Example Usage

from plex_api_client import PlexAPI

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

    res = plex_api.server.get_available_clients()

    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.GetAvailableClientsResponse

Errors

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

get_devices

Get Devices

Example Usage

from plex_api_client import PlexAPI

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

    res = plex_api.server.get_devices()

    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.GetDevicesResponse

Errors

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

get_server_identity

This request is useful to determine if the server is online or offline

Example Usage

from plex_api_client import PlexAPI

with PlexAPI() as plex_api:

    res = plex_api.server.get_server_identity()

    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.GetServerIdentityResponse

Errors

Error Type	Status Code	Content Type
errors.GetServerIdentityRequestTimeout	408	application/json
errors.SDKError	4XX, 5XX	*/*

get_my_plex_account

Returns MyPlex Account Information

Example Usage

from plex_api_client import PlexAPI

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

    res = plex_api.server.get_my_plex_account()

    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.GetMyPlexAccountResponse

Errors

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

get_resized_photo

Plex's Photo transcoder is used throughout the service to serve images at specified sizes.

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.server.get_resized_photo(request={
        "width": 110,
        "height": 165,
        "blur": 0,
        "min_size": operations.MinSize.ONE,
        "upscale": operations.Upscale.ONE,
        "url": "/library/metadata/49564/thumb/1654258204",
        "opacity": 100,
    })

    assert res is not None

    # Handle response
    print(res)

Parameters

Parameter	Type	Required	Description
request	operations.GetResizedPhotoRequest	✔️	The request object to use for the request.
retries	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

operations.GetResizedPhotoResponse

Errors

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

get_media_providers

Retrieves media providers and their features from the Plex server.

Example Usage

from plex_api_client import PlexAPI

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

    res = plex_api.server.get_media_providers(x_plex_token="CV5xoxjTpFKUzBTShsaf")

    assert res.object is not None

    # Handle response
    print(res.object)

Parameters

Parameter	Type	Required	Description	Example
x_plex_token	str	✔️	An authentication token, obtained from plex.tv	CV5xoxjTpFKUzBTShsaf
retries	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

operations.GetMediaProvidersResponse

Errors

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

get_server_list

Get Server List

Example Usage

from plex_api_client import PlexAPI

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

    res = plex_api.server.get_server_list()

    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.GetServerListResponse

Errors

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