plexjs/docs/sdks/updater

Updater

(updater)

Overview

This describes the API for searching and applying updates to the Plex Media Server. Updates to the status can be observed via the Event API.

Available Operations

• getUpdateStatus - Querying status of updates
• checkForUpdates - Checking for updates
• applyUpdates - Apply Updates

getUpdateStatus

Querying status of updates

Example Usage

import { PlexAPI } from "@lukehagar/plexjs";

const plexAPI = new PlexAPI({
  accessToken: "<YOUR_API_KEY_HERE>",
  xPlexClientIdentifier: "Postman",
});

async function run() {
  const result = await plexAPI.updater.getUpdateStatus();

  // Handle the result
  console.log(result)
}

run();

Parameters

Parameter	Type	Required	Description
options	RequestOptions	➖	Used to set various options for making HTTP requests.
options.fetchOptions	RequestInit	➖	Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.

Response

Promise<models.GetUpdateStatusResponse>

Errors

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

checkForUpdates

Checking for updates

Example Usage

import { Download, PlexAPI } from "@lukehagar/plexjs";

const plexAPI = new PlexAPI({
  accessToken: "<YOUR_API_KEY_HERE>",
  xPlexClientIdentifier: "Postman",
});

async function run() {
  const result = await plexAPI.updater.checkForUpdates(Download.One);

  // Handle the result
  console.log(result)
}

run();

Parameters

Parameter	Type	Required	Description	Example
download	models.Download	➖	Indicate that you want to start download any updates found.	[object Object]
options	RequestOptions	➖	Used to set various options for making HTTP requests.
options.fetchOptions	RequestInit	➖	Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.

Response

Promise<models.CheckForUpdatesResponse>

Errors

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

applyUpdates

Note that these two parameters are effectively mutually exclusive. The tonight parameter takes precedence and skip will be ignored if tonight is also passed

Example Usage

import { PlexAPI, Skip, Tonight } from "@lukehagar/plexjs";

const plexAPI = new PlexAPI({
  accessToken: "<YOUR_API_KEY_HERE>",
  xPlexClientIdentifier: "Postman",
});

async function run() {
  const result = await plexAPI.updater.applyUpdates(Tonight.One, Skip.One);

  // Handle the result
  console.log(result)
}

run();

Parameters

Parameter	Type	Required	Description	Example
tonight	models.Tonight	➖	Indicate that you want the update to run during the next Butler execution. Omitting this or setting it to false indicates that the update should install	[object Object]
skip	models.Skip	➖	Indicate that the latest version should be marked as skipped. The entry for this version will have the state set to skipped.	[object Object]
options	RequestOptions	➖	Used to set various options for making HTTP requests.
options.fetchOptions	RequestInit	➖	Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.

Response

Promise<models.ApplyUpdatesResponse>

Errors

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