Server Preferences

Buy me a coffee

When managing a server, there are many different preferences you can set from the Settings section within the Plex Web app. This API command will return all the available preferences and information about each preference such as the current value.

URL

GET http://{ip_address}:32400/:/prefs?X-Plex-Token={plex_token}

Parameters

Name	Description
ip_address	The IP address of the Plex Media server.
plex_token	The Plex token.

Return Status

HTTP Code	Description
200	Success - The request was successful.
401	Unauthorized - The Plex token provided was not valid.

Response

XML string value that lists the preferences that are available in the Plex server. An example of the XML returned from the request is shown below:

<?xml version="1.0" encoding="UTF-8"?>
<MediaContainer size="168">
    <Setting id="FriendlyName" label="Friendly name" summary="This name will be used to identify this media server to other computers on your network. If you leave it blank, your computer's name will be used instead." type="text" default="" value="PlexServer" hidden="0" advanced="0" group="general" />
    <Setting id="sendCrashReports" label="Send crash reports to Plex" summary="This helps us improve your experience." type="bool" default="1" value="0" hidden="0" advanced="0" group="general" />
    <Setting id="CrashUploadRetries" label="" summary="" type="bool" default="0" value="0" hidden="0" advanced="0" group="" />
    <Setting id="FSEventLibraryUpdatesEnabled" label="Scan my library automatically" summary="Your library will be updated automatically when changes to library folders are detected." type="bool" default="0" value="0" hidden="0" advanced="0" group="library" />
    ...
</MediaContainer>

Remarks

The XML returned provides a list of the preferences available on the Plex server. The root is the MediaContainer element. This element contains one attribute that provide a count of the preferences available on the server.

MediaContainer Attributes for Plex Devices
Attribute	Description
size	The number of preferences available on the Plex server.

Within the MediaContainer there are one or more Setting child elements. Each Setting element represents one preference on the Plex server.

Setting Attributes
Attribute	Description
id	The unique string value used to identify the preference.
label	The label shown in the Plex Web app for the preference.
summary	A descriptive summary of the preference.
type	The value type associated with the preference.
default	The default value for the preference.
value	The current value of the preference.
hidden	Indicates if the preference is hidden.
advanced	Indicates the preference is shown when the "Show Advanced" button is clicked in the Plex settings.
group	The name of the Plex settings group where the preference can be found.
enumValues	The valid values for the preference in a key/value pair list.

Examples

curl -X GET http://{ip_address}:32400/:/prefs?X-Plex-Token={plex_token}

import requests
plex_url = http://{ip_address}:32400/:/prefs?X-Plex-Token={plex_token}
response = requests.get(plex_url)
print(response.text)

$response = Invoke-RestMethod 'http://{ip_address}:32400/:/prefs?X-Plex-Token={plex_token}' -Method 'GET'
Write-Output $response

Buy me a coffee