plexpy/docs/sdks/server

Server

(server)

Overview

Operations against the Plex Media Server System.

Available Operations

• get_server_capabilities - 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_server_list - Get Server List

get_server_capabilities

Server Capabilities

Example Usage

import plex_api

s = plex_api.PlexAPI(
    access_token="<YOUR_API_KEY_HERE>",
    x_plex_client_identifier='Postman',
)


res = s.server.get_server_capabilities()

if res.object is not None:
    # handle response
    pass

Response

operations.GetServerCapabilitiesResponse

Errors

Error Object	Status Code	Content Type
errors.GetServerCapabilitiesResponseBody	401	application/json
errors.SDKError	4xx-5xx	/

get_server_preferences

Get Server Preferences

Example Usage

import plex_api

s = plex_api.PlexAPI(
    access_token="<YOUR_API_KEY_HERE>",
    x_plex_client_identifier='Postman',
)


res = s.server.get_server_preferences()

if res.object is not None:
    # handle response
    pass

Response

operations.GetServerPreferencesResponse

Errors

Error Object	Status Code	Content Type
errors.GetServerPreferencesResponseBody	401	application/json
errors.SDKError	4xx-5xx	/

get_available_clients

Get Available Clients

Example Usage

import plex_api

s = plex_api.PlexAPI(
    access_token="<YOUR_API_KEY_HERE>",
    x_plex_client_identifier='Postman',
)


res = s.server.get_available_clients()

if res.object is not None:
    # handle response
    pass

Response

operations.GetAvailableClientsResponse

Errors

Error Object	Status Code	Content Type
errors.GetAvailableClientsResponseBody	401	application/json
errors.SDKError	4xx-5xx	/

get_devices

Get Devices

Example Usage

import plex_api

s = plex_api.PlexAPI(
    access_token="<YOUR_API_KEY_HERE>",
    x_plex_client_identifier='Postman',
)


res = s.server.get_devices()

if res.object is not None:
    # handle response
    pass

Response

operations.GetDevicesResponse

Errors

Error Object	Status Code	Content Type
errors.GetDevicesResponseBody	401	application/json
errors.SDKError	4xx-5xx	/

get_server_identity

Get Server Identity

Example Usage

import plex_api

s = plex_api.PlexAPI(
    access_token="<YOUR_API_KEY_HERE>",
    x_plex_client_identifier='Postman',
)


res = s.server.get_server_identity()

if res.object is not None:
    # handle response
    pass

Response

operations.GetServerIdentityResponse

Errors

Error Object	Status Code	Content Type
errors.GetServerIdentityResponseBody	401	application/json
errors.SDKError	4xx-5xx	/

get_my_plex_account

Returns MyPlex Account Information

Example Usage

import plex_api

s = plex_api.PlexAPI(
    access_token="<YOUR_API_KEY_HERE>",
    x_plex_client_identifier='Postman',
)


res = s.server.get_my_plex_account()

if res.object is not None:
    # handle response
    pass

Response

operations.GetMyPlexAccountResponse

Errors

Error Object	Status Code	Content Type
errors.GetMyPlexAccountResponseBody	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

import plex_api
from plex_api.models import operations

s = plex_api.PlexAPI(
    access_token="<YOUR_API_KEY_HERE>",
    x_plex_client_identifier='Postman',
)

req = operations.GetResizedPhotoRequest(
    width=110,
    height=165,
    blur=20,
    min_size=operations.MinSize.ONE,
    upscale=operations.Upscale.ZERO,
    url='/library/metadata/49564/thumb/1654258204',
    opacity=100,
)

res = s.server.get_resized_photo(req)

if res is not None:
    # handle response
    pass

Parameters

Parameter	Type	Required	Description
request	operations.GetResizedPhotoRequest	✔️	The request object to use for the request.

Response

operations.GetResizedPhotoResponse

Errors

Error Object	Status Code	Content Type
errors.GetResizedPhotoResponseBody	401	application/json
errors.SDKError	4xx-5xx	/

get_server_list

Get Server List

Example Usage

import plex_api

s = plex_api.PlexAPI(
    access_token="<YOUR_API_KEY_HERE>",
    x_plex_client_identifier='Postman',
)


res = s.server.get_server_list()

if res.object is not None:
    # handle response
    pass

Response

operations.GetServerListResponse

Errors

Error Object	Status Code	Content Type
errors.GetServerListResponseBody	401	application/json
errors.SDKError	4xx-5xx	/