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.
GET http://[IP address]:32400/identity/?X-Plex-Token=[PlexToken]
|IP address||The IP address of the Plex Media server.|
|PlexToken||The temporary authentication Plex token.|
|200||Success - The request was successful.|
XML string value that shows basic information of the server. An example of the XML returned from the request is shown below:
<?xml version="1.0" encoding="UTF-8"?> <MediaContainer size="0" claimed="1" machineIdentifier="6a646027a56abb6dbdf72484564db8567c737430" version="184.108.40.20616-f4cdfea9c"> </MediaContainer>
The XML returned contains basic information of the server in the attributes of the
MediaContainer element. Each attribute corresponds to some data point, and the status of that data. There isn't actual documentation on each attribute, so the list below is a best-guess at what the values represent.
Unlike other Plex API requests, the identity request does not require a Plex token and can be run from any machine that can access the Plex server from a Web browser.
Since this request returns a small XML string, this request can be used to quickly determine if a server has been claimed, or the Plex version installed.
The attribute values correspond to the the following:
|size||Number of child items in the MediaContainer item.|
|claimed||1 - server is claimed.|
0 - server is not claimed.
|machineIdentifier||Unique identifier for the server.|
|version||Current installed version of Plex for the server.|
Return basic information of a Plex Media Server located at the IP address of 192.168.1.4.
If a reverse proxy is used with a subdomain, then it can be used in place of the IP address.