Server Capabilities

This API command is used to get the capabilities of the Plex Media server. The capabilities returned include such items as the settings of the Plex server, the operating system, and the version of Plex that is installed.

URL

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

Parameters

Return Status

Response

XML string value that lists the capabilities and settings of the server. An example of the XML returned from the request is shown below:

<?xml version="1.0" encoding="UTF-8"?>
<MediaContainer size="25" allowCameraUpload="1" allowChannelAccess="1" allowMediaDeletion="1" allowSharing="1" allowSync="1" allowTuners="1" backgroundProcessing="1" companionProxy="1" countryCode="can" diagnostics="logs,databases,streaminglogs" eventStream="1" friendlyName="PlexServer" hubSearch="1" itemClusters="1" livetv="7" machineIdentifier="3a646027a56abd6dbdf72484464db8567c737430" mediaProviders="1" multiuser="1" musicAnalysis="2" myPlex="1" myPlexMappingState="mapped" myPlexSigninState="ok" myPlexSubscription="1" myPlexUsername="PlexUsername" offlineTranscode="1" ownerFeatures="" photoAutoTag="1" platform="Windows" platformVersion="10.0 (Build 19042)" pluginHost="1" pushNotifications="0" readOnlyLibraries="0" streamingBrainABRVersion="3" streamingBrainVersion="2" sync="1" transcoderActiveVideoSessions="0" transcoderAudio="1" transcoderLyrics="1" transcoderPhoto="1" transcoderSubtitles="1" transcoderVideo="1" transcoderVideoBitrates="64,96,208,320,720,1500,2000,3000,4000,8000,10000,12000,20000" transcoderVideoQualities="0,1,2,3,4,5,6,7,8,9,10,11,12" transcoderVideoResolutions="128,128,160,240,320,480,768,720,720,1080,1080,1080,1080" updatedAt="1640814847" updater="1" version="1.25.2.5319-c43dc0277" voiceSearch="1">
    <Directory count="1" key="actions" title="actions" />
    <Directory count="1" key="activities" title="activities" />
    <Directory count="1" key="butler" title="butler" />
    <Directory count="1" key="channels" title="channels" />
    <Directory count="1" key="clients" title="clients" />
    <Directory count="1" key="devices" title="devices" />
    <Directory count="1" key="diagnostics" title="diagnostics" />
    <Directory count="1" key="hubs" title="hubs" />
    <Directory count="3" key="library" title="library" />
    <Directory count="3" key="livetv" title="livetv" />
    <Directory count="3" key="media" title="media" />
    <Directory count="3" key="metadata" title="metadata" />
    <Directory count="1" key="neighborhood" title="neighborhood" />
    <Directory count="1" key="playQueues" title="playQueues" />
    <Directory count="1" key="player" title="player" />
    <Directory count="1" key="playlists" title="playlists" />
    <Directory count="1" key="resources" title="resources" />
    <Directory count="1" key="search" title="search" />
    <Directory count="1" key="server" title="server" />
    <Directory count="1" key="servers" title="servers" />
    <Directory count="1" key="statistics" title="statistics" />
    <Directory count="1" key="system" title="system" />
    <Directory count="1" key="transcode" title="transcode" />
    <Directory count="1" key="updater" title="updater" />
    <Directory count="1" key="user" title="user" />
</MediaContainer>

The XML returned lists the capabilities of the server in the attributes of the MediaContainer element. Each attribute corresponds to a specific capability, and the status of that capability. There isn't actual documentation on each attribute, so the list below is a best-guess at what the values represent.

The attribute values correspond to the following:

Within the MediaContainer element there are multiple additional child elements that provide more details about the functions of the server. These child elements are listed using multiple Directory elements.

Remarks

The values returned in the XML is dependent on the Plex token used to make the request. Using an administrative token may return values that are different when using a managed user token. Using a device token will return the same XML response as the administrative token.

Examples

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

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

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