identifier: A unique client identifier. Default is a generated uuid v4. Note: you should really provide this rather than let it get generated. Every time your app runs, a new "device" will get registered on your Plex account, which can lead to poor performance once hundreds or thousands of them get created. Trust me!

deviceName: The "name" of the device your app is running on. For apps like Plex Home Theater and mobile apps, it's the computer or phone's name chosen by the user. Default Node.js App

platform: The platform your app is running on. The use of this is inconsistent in the official Plex apps. It is not displayed on the web interface. Official Plex examples: Chrome, Plex Home Theater, Windows. Default is Node.js.

platformVersion: The platform version. Default is the version of Node running.

device: The name of the type of computer your app is running on, usually the OS name. Official Plex examples: Windows, iPhone, Xbox One. Default is whatever os.platform() returns.

Here's an example of what an app shows up as on the Plex web interface

The rows in that example from top to bottom are deviceName, version, product, and device.

.query(options)

Retrieve content from URI

The parameter can be a string representing the URI, or an object with the following properties:

uri: the URI to query

(optional) extraHeaders: an object with extra headers to send in the HTTP request. Useful for things like X-Plex-Target-Client-Identifier

Aside from requesting the API and returning its response, an .uri property are created to easier follow the URIs available in the HTTP API. At the moment URIs are attached for Directory and Server items.

var PlexAPI =require("plex-api");

var client =newPlexAPI("192.168.0.1");

client.query("/").then(function(result){

console.log("%s running Plex Media Server v%s",

result.friendlyName,

result.version);

// array of children, such as Directory or Server items

// will have the .uri-property attached

console.log(result._children);

},function(err){

console.error("Could not connect to server", err);

});

.postQuery(options)

Send a POST request and retrieve the response

This is identical to query(), except that the request will be a POST rather than a GET. It has the same required and optional parameters as query().

Note that the parameters can only be passed as a query string as part of the uri, which is all Plex requires. (Content-Length will always be zero)

console.log("Description of video by id 123 has been set to 'updatedSummaryText'");

},function(err){

console.error("Could not connect to server", err);

});

.deleteQuery(options)

Send a DELETE request and retrieve the response

This is identical to query(), except that the request will be a DELETE rather than a GET. It has the same required and optional parameters as query(). It's is used to delete parts of your Plex library.

Note this will also delete the media files on hard disk! This can be allowed or forbidden in the plex-media-server options.
Returns status code 403 if delete is not allowed in the plex-media-server options.

var PlexAPI =require("plex-api");

var client =newPlexAPI("192.168.0.1");

client.deleteQuery("/library/metadata/10001/media/2002")

.then(function(){

console.log("Media was successfully deleted");

},function(err){

console.error("Could not connect to server", err);

});

.perform(options)

Perform an API action

When performing an "action" on the HTTP API, the response body will be empty.
As the response content itself is worthless, perform() acts on the HTTP status codes the server responds with.
It has the same required and optional parameters as query().

var PlexAPI =require("plex-api");

var client =newPlexAPI("192.168.0.1");

// update library section of key "1"

client.perform("/library/sections/1/refresh").then(function(){

// successfully started to refresh library section #1

},function(err){

console.error("Could not connect to server", err);

});

.find(options, [{criterias}])

Find matching child items on URI

Uses query() behind the scenes, giving all directories and servers the beloved .uri property. It has the same required and optional parameters as query, in addition to a second optional criterias parameter.

Response parsing

You can provide a custom function responsible for parsing all Plex Server responses if you need to, by providing it in the responseParser when instantiating a Plex API client.

The default implementation either parses the JSON in the response from the Plex Server, converts XML to a JavaScript object or returns the response as is, depending on the response Content-Type header.

A response parsing function gets two arguments provided: response, body and is expected to return a Promise.

License

Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:

The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.