Add to Watchlist.

POST /actions/addToWatchlist

Args: uri: The URI of the item to add or remove

Remove from Watchlist.

POST /actions/removeFromWatchlist

Args: uri: The URI of the item to add or remove

Register Device JWK.

POST /auth/jwk

Args: body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.

Exchange JWT Token.

POST /auth/token

Args: body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.

Start all Butler tasks.

POST /butler

Start a single Butler task.

POST /butler/{butlerTask}

Args: butler_task: The task name

Manually trigger a transcoder fallback.

POST /{transcodeType}/:/transcode/universal/fallback

Args: transcode_type: Path parameter.

Create download queue.

POST /downloadQueue

Add to download queue.

POST /downloadQueue/{queueId}/add

Args: queue_id: The queue id keys: Keys to add

Restart processing of items from the decision.

POST /downloadQueue/{queueId}/items/{itemId}/restart

Args: queue_id: The queue id item_id: The item ids

Create Home User.

POST /home/users

Switch Home User.

POST /home/users/{id}/switch

Args: id: The unique identifier of the item

Create a custom hub.

POST /hubs/sections/{sectionId}/manage

Args: section_id: The section ID for the hubs to reorder metadata_item_id: The metadata item on which to base this hub. This must currently be a collection promoted_to_recommended: Whether this hub should be displayed in recommended promoted_to_own_home: Whether this hub should be displayed in admin's home promoted_to_shared_home: Whether this hub should be displayed in shared user's home

Create collection.

POST /library/collections

Args: section_id: The section where this collection will be created uri: The URI for processing the smart collection. Required for a smart collection

Ingest a transient item.

POST /library/file

Args: url: The file of the file to ingest. virtual_file_path: A virtual path to use when the url is opaque. compute_hashes: Whether or not to compute Plex and OpenSubtitle hashes for the file. Defaults to 0. ingest_non_matches: Whether or not non matching media should be stored. Defaults to 0.

Upload media art Art.

POST /library/metadata/{id}/arts

Args: id: The unique identifier of the item body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.

Upload media art Poster.

POST /library/metadata/{id}/posters

Args: id: The unique identifier of the item body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.

Set an item's artwork, theme, etc.

POST /library/metadata/{ids}/{element}

Args: ids: Comma-separated list of IDs element: The type of artwork element (e.g., art, poster, thumb) url: The url of the new asset. If not provided, the binary of the asset must be provided in the post body.

Add to an item's extras.

POST /library/metadata/{ids}/extras

Args: ids: Comma-separated list of IDs extra_type: The metadata type of the extra url: The URL of the extra

Create a marker.

POST /library/metadata/{ids}/marker

Args: ids: Comma-separated list of IDs type: The type of marker to edit/create start_time_offset: The start time of the marker end_time_offset: The end time of the marker attributes: The attributes to assign to this marker

Optimize Library.

POST /library/optimize

Add a library section.

POST /library/sections/all

Args: name: The name of the new section type: The type of library section scanner: The scanner this section should use agent: The agent this section should use for metadata metadata_agent_provider_group_id: The agent group id for this section language: The language of this section locations: The locations on disk to add to this section prefs: The preferences for this section relative: If set, paths are relative to Media Upload path import_fromi_tunes: If set, import media from iTunes.

Empty Trash.

POST /library/sections/{sectionId}/emptyTrash

Args: section_id: The unique identifier of the library section

Optimize Section.

POST /library/sections/{sectionId}/optimize

Args: section_id: The unique identifier of the library section

Refresh Section.

POST /library/sections/{sectionId}/refresh

Args: section_id: Section identifier force: Whether the update of metadata and items should be performed even if modification dates indicate the items have not change path: Restrict refresh to the specified path

Refresh all sections.

POST /library/sections/refresh

Args: force: Force refresh of metadata

Create a DVR.

POST /livetv/dvrs

Args: lineup: The EPG lineup. device: The device. language: The language.

Tune a channel on a DVR.

POST /livetv/dvrs/{dvrId}/channels/{channel}/tune

Args: dvr_id: The ID of the DVR. channel: The channel ID to tune

Tell a DVR to reload program guide.

POST /livetv/dvrs/{dvrId}/reloadGuide

Args: dvr_id: The ID of the DVR.

Logging a multi-line message to the Plex Media Server log.

POST /log

Args: body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.

Enabling Papertrail.

POST /log/networked

Args: minutes: The number of minutes logging should be sent to Papertrail

Add a device.

POST /media/grabbers/devices

Args: uri: The URI of the device.

Tell a device to scan for channels.

POST /media/grabbers/devices/{deviceId}/scan

Args: device_id: The ID of the device. source: A valid source for the scan

Add a media provider.

POST /media/providers

Args: url: The URL of the media provider to add.

Refresh media providers.

POST /media/providers/refresh

Create a subscription.

POST /media/subscriptions

Args: target_library_section_id: The library section into which we'll grab the media. Not actually required when the subscription is to a playlist. target_section_location_id: The section location into which to grab. type: The type of the thing we're subscribing too (e.g. show, season). hints: Hints describing what we're looking for. Note: The hint ratingKey is required for downloading from a PMS remote. prefs: Subscription preferences. params: Subscription parameters.

• mediaProviderID: Required for downloads to indicate which MP the subscription will download into

• source: Required for downloads to indicate the source of the downloaded content.

Process all subscriptions.

POST /media/subscriptions/process

Claim Server.

POST /myplex/claim

Create OAuth PIN.

POST /pins

Create Legacy PIN.

POST /pins.xml

Create a play queue.

POST /playQueues

Args: uri: The content URI for what we're playing. playlist_id: the ID of the playlist we're playing. type: The type of play queue to create key: The key of the first item to play, defaults to the first in the play queue. shuffle: Whether to shuffle the playlist, defaults to 0. repeat: If the PQ is bigger than the window, fill any empty space with wraparound items, defaults to 0. continuous: Whether to create a continuous play queue (e.g. from an episode), defaults to 0. extras_prefix_count: Number of trailers to prepend a movie with not including the pre-roll. If omitted the pre-roll will not be returned in the play queue. When resuming a movie extrasPrefixCount should be omitted as a parameter instead of passing 0. recursive: Only applies to queues of type photo, whether to retrieve all descendent photos from an album or section, defaults to 1. on_deck: Only applies to queues of type show or seasons, whether to return a queue that is started on the On Deck episode if one exists. Otherwise begins the play queue on the beginning of the show or season.

Player Audio Stream.

POST /player/playback/audioStream

Args: stream_id: The unique identifier of the stream

Player Mute.

POST /player/playback/mute

Player Pause.

POST /player/playback/pause

Player Play.

POST /player/playback/play

Player Play Media.

POST /player/playback/playMedia

Args: key: The key of the media item to play offset: The byte offset for stream seeking machine_identifier: The machine identifier of the target device

Player Refresh Play Queue.

POST /player/playback/refreshPlayQueue

Player Seek.

POST /player/playback/seek

Args: offset: Target offset in milliseconds

Player Set Parameters.

POST /player/playback/setParameters

Args: shuffle: Whether to enable shuffle mode repeat: The repeat mode to set volume: The volume level to set

Player Set Rating.

POST /player/playback/setRating

Args: rating: The rating value to set

Player Set State.

POST /player/playback/setState

Args: state: The desired playback state

Player Set Streams.

POST /player/playback/setStreams

Args: audio_stream_id: The unique identifier of the audiostream subtitle_stream_id: The unique identifier of the subtitlestream video_stream_id: The unique identifier of the videostream

Player Set Text Stream.

POST /player/playback/setTextStream

Args: stream_id: The unique identifier of the stream

Player Set View Offset.

POST /player/playback/setViewOffset

Args: offset: The byte offset for stream seeking

Player Skip By.

POST /player/playback/skipBy

Args: offset: Number of items to skip (positive for forward, negative for backward)

Player Skip To.

POST /player/playback/skipTo

Args: key: The key of the item to skip to

Player Step Back.

POST /player/playback/stepBack

Player Step Forward.

POST /player/playback/stepForward

Player Stop.

POST /player/playback/stop

Player Subtitle Stream.

POST /player/playback/subtitleStream

Args: stream_id: The unique identifier of the stream

Player Unmute.

POST /player/playback/unmute

Player Video Stream.

POST /player/playback/videoStream

Args: stream_id: The unique identifier of the stream

Player Volume.

POST /player/playback/volume

Args: level: The level

Create a Playlist.

POST /playlists

Args: uri: The content URI for what we're playing (e.g. library://...). play_queue_id: To create a playlist from an existing play queue.

Upload media art.

POST /playlists/upload

Args: path: Absolute path to a directory on the server where m3u files are stored, or the absolute path to a playlist file on the server. If the path argument is a directory, that path will be scanned for playlist files to be processed. Each file in that directory creates a separate playlist, with a name based on the filename of the file that created it. The GUID of each playlist is based on the filename. If the path argument is a file, that file will be used to create a new playlist, with the name based on the filename of the file that created it. The GUID of each playlist is based on the filename. force: Force overwriting of duplicate playlists. By default, a playlist file uploaded with the same path will overwrite the existing playlist. The force argument is used to disable overwriting. If the force argument is set to 0, a new playlist will be created suffixed with the date and time that the duplicate was uploaded.

Get Transient Tokens.

POST /security/token

Args: type: The value delegation is the only supported type parameter. scope: The value all is the only supported scope parameter.

Share Server (Legacy v1).

POST /servers/{machineId}/shared_servers

Args: machine_id: The unique machine identifier of the server

Share Server.

POST /shared_servers

Terminate a session.

POST /status/sessions/terminate

Args: session_id: The session id (found in the Session element in /status/sessions) reason: The reason to give to the user (typically displayed in the client)

Report media timeline.

POST /:/timeline

Args: key: The details key for the item. rating_key: The rating key attribute for the item. state: The current state of the media. play_queue_item_id: If playing media from a play queue, the play queue's ID. time: The current time offset of playback in ms. duration: The total duration of the item in ms. continuing: When state is stopped, a flag indicating whether or not the client is going to continue playing anothe item. updated: Used when a sync client comes online and is syncing media timelines, holds the time at which the playback state was last updated. offline: Also used by sync clients, used to indicate that a timeline is being synced from being offline, as opposed to being "live". time_to_first_frame: Time in seconds till first frame is displayed. Sent only on the first playing timeline request. time_stalled: Time in seconds spent buffering since last request. bandwidth: Bandwidth in kbps as estimated by the client. buffered_time: Amount of time in seconds buffered by client. Omit if computed by bufferedSize below. buffered_size: Size in kilobytes of data buffered by client. Omit if computed by bufferedTime above container_key: Groups timeline reports (e.g. /playQueues/123). guid: Global unique identifier for the item. play_queue_id: Identifies the play queue itself (distinct from playQueueItemID). url: Alternative to key/ratingKey (legacy).

Change Password.

POST /users/password

Get User Sign In Data.

POST /users/signin

Args: body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.

Add User Webhook.

POST /api/v2/user/webhooks

Add Webhook.

POST /webhooks

Cancel a running activity.

DELETE /activities/{activityId}

Args: activity_id: The UUID of the activity to cancel.

Stop all Butler tasks.

DELETE /butler

Stop a single Butler task.

DELETE /butler/{butlerTask}

Args: butler_task: The task name

Delete download queue items.

DELETE /downloadQueue/{queueId}/items/{itemId}

Args: queue_id: The queue id item_id: The item id

Delete Home User.

DELETE /home/users/{userId}

Args: user_id: The unique identifier of the user

Reset hubs to defaults.

DELETE /hubs/sections/{sectionId}/manage

Args: section_id: The section ID for the hubs to reorder

Delete a custom hub.

DELETE /hubs/sections/{sectionId}/manage/{identifier}

Args: section_id: The section ID for the hubs to change identifier: The identifier of the hub to change

Delete library caches.

DELETE /library/caches

Delete a metadata item.

DELETE /library/metadata/{ids}

Args: ids: Comma-separated list of IDs proxy: Whether proxy items, such as media optimized versions, should also be deleted. Defaults to false.

Delete a marker.

DELETE /library/metadata/{ids}/marker/{marker}

Args: ids: Comma-separated list of IDs marker: The marker identifier

Delete a media item.

DELETE /library/metadata/{ids}/media/{mediaItem}

Args: ids: Comma-separated list of IDs media_item: The mediaItem proxy: Whether proxy items, such as media optimized versions, should also be deleted. Defaults to false.

Stop refresh.

DELETE /library/sections/all/refresh

Delete a library section.

DELETE /library/sections/{sectionId}

Args: section_id: The section identifier async_: If set, response will return an activity with the actual deletion process. Otherwise request will return when deletion is complete

Delete a collection.

DELETE /library/sections/{sectionId}/collection/{collectionId}

Args: section_id: Section identifier collection_id: Collection Id

Delete section indexes.

DELETE /library/sections/{sectionId}/indexes

Args: section_id: Section identifier

Delete section intro markers.

DELETE /library/sections/{sectionId}/intros

Args: section_id: Section identifier

Cancel section refresh.

DELETE /library/sections/{sectionId}/refresh

Args: section_id: Section identifier

Delete a stream.

DELETE /library/streams/{streamId}.{ext}

Args: stream_id: The id of the stream ext: This is not a part of this endpoint but documented here to satisfy OpenAPI

Delete a single DVR.

DELETE /livetv/dvrs/{dvrId}

Args: dvr_id: The ID of the DVR.

Remove a device from an existing DVR.

DELETE /livetv/dvrs/{dvrId}/devices/{deviceId}

Args: dvr_id: The ID of the DVR. device_id: The ID of the device to add.

Delete a DVR Lineup.

DELETE /livetv/dvrs/{dvrId}/lineups

Args: dvr_id: The ID of the DVR. lineup: The lineup to delete

Tell a DVR to stop reloading program guide.

DELETE /livetv/dvrs/{dvrId}/reloadGuide

Args: dvr_id: The ID of the DVR.

Delete Live TV Session.

DELETE /livetv/sessions/{sessionId}

Args: session_id: The session id

Remove a device.

DELETE /media/grabbers/devices/{deviceId}

Args: device_id: The ID of the device.

Tell a device to stop scanning for channels.

DELETE /media/grabbers/devices/{deviceId}/scan

Args: device_id: The ID of the device.

Cancel an existing grab.

DELETE /media/grabbers/operations/{operationId}

Args: operation_id: The ID of the operation.

Delete a media provider.

DELETE /media/providers/{provider}

Args: provider: The ID of the media provider to delete

Delete a subscription.

DELETE /media/subscriptions/{subscriptionId}

Args: subscription_id: The unique identifier of the subscription

Clear a play queue.

DELETE /playQueues/{playQueueId}/items

Args: play_queue_id: The ID of the play queue.

Delete an item from a play queue.

DELETE /playQueues/{playQueueId}/items/{playQueueItemId}

Args: play_queue_id: The ID of the play queue. play_queue_item_id: The play queue item ID to delete.

Delete Playlist.

DELETE /playlists

Args: rating_key: The rating key of the playlist to delete.

Delete a Playlist.

DELETE /playlists/{playlistId}

Args: playlist_id: The ID of the playlist

Clearing a playlist.

DELETE /playlists/{playlistId}/items

Args: playlist_id: The ID of the playlist

Delete a Generator.

DELETE /playlists/{playlistId}/items/{generatorId}

Args: playlist_id: The ID of the playlist generator_id: The generator item ID to delete.

Remove Share.

DELETE /sharings/{userId}

Args: user_id: The unique identifier of the user

Delete Single History Item.

DELETE /status/sessions/history/{historyId}

Args: history_id: The id of the history item (the historyKey from above)

Sign Out.

DELETE /users/signout

Make a decision on media playback.

GET /{transcodeType}/:/transcode/universal/decision

Args: transcode_type: Path parameter. platform: Client platform (some clients send this in addition to headers). audio_boost: Percentage of original audio loudness to use when transcoding (100 is equivalent to original volume, 50 is half, 200 is double, etc) audio_channel_count: Target video number of audio channels. auto_adjust_quality: Indicates the client supports ABR. auto_adjust_subtitle: Indicates if the server should adjust subtitles based on Voice Activity Data. direct_play: Indicates the client supports direct playing the indicated content. direct_stream: Indicates the client supports direct streaming the video of the indicated content. direct_stream_audio: Indicates the client supports direct streaming the audio of the indicated content. disable_resolution_rotation: Indicates if resolution should be adjusted for orientation. has_mde: Ignore client profiles when determining if direct play is possible. Only has an effect when directPlay=1 and both mediaIndex and partIndex are specified and neither are -1 location: Network type of the client, can be used to help determine target bitrate. media_buffer_size: Buffer size used in playback (in KB). Clients should specify a lower bound if not known exactly. This value could make the difference between transcoding and direct play on bandwidth constrained networks. media_index: Index of the media to transcode. -1 or not specified indicates let the server choose. music_bitrate: Target bitrate for audio only files (in kbps, used to transcode). offset: Offset from the start of the media (in seconds). part_index: Index of the part to transcode. -1 or not specified indicates the server should join parts together in a transcode path: Internal PMS path of the media to transcode. peak_bitrate: Maximum bitrate (in kbps) to use in ABR. photo_resolution: Target photo resolution. protocol: Indicates the network streaming protocol to be used for the transcode session: * 'http' - include the file in the http response such as MKV streaming * 'hls' - hls stream (RFC 8216) * 'dash' - dash stream (ISO/IEC 23009-1:2022) seconds_per_segment: Number of seconds to include in each transcoded segment subtitle_size: Percentage of original subtitle size to use when burning subtitles (100 is equivalent to original size, 50 is half, ect) subtitles: Indicates how subtitles should be included: * 'auto' - Compute the appropriate subtitle setting automatically * 'burn' - Burn the selected subtitle; auto if no selected subtitle * 'none' - Ignore all subtitle streams * 'sidecar' - The selected subtitle should be provided as a sidecar * 'embedded' - The selected subtitle should be provided as an embedded stream * 'segmented' - The selected subtitle should be provided as a segmented stream max_video_bitrate: Client-side maximum video bitrate cap in kbps video_resolution: Cap resolution string (e.g. 1920x1080) copyts: Copy timestamps instead of re-encoding them video_bitrate: Target video bitrate (in kbps). video_quality: Target photo quality.

Get DASH Segment.

GET /{transcodeType}/:/transcode/universal/session/{sessionId}/{segmentId}.m4s

Args: transcode_type: The type of transcoding (e.g., video, audio) session_id: The unique identifier of the session segment_id: The unique identifier of the media segment

Get HLS Segment.

GET /{transcodeType}/:/transcode/universal/session/{sessionId}/{segmentId}.ts

Args: transcode_type: The type of transcoding (e.g., video, audio) session_id: The unique identifier of the session segment_id: The unique identifier of the media segment

Start A Transcoding Session.

GET /{transcodeType}/:/transcode/universal/start.{extension}

Args: extension: Extension transcode_type: Path parameter. platform: Client platform (some clients send this in addition to headers). audio_boost: Percentage of original audio loudness to use when transcoding (100 is equivalent to original volume, 50 is half, 200 is double, etc) audio_channel_count: Target video number of audio channels. auto_adjust_quality: Indicates the client supports ABR. auto_adjust_subtitle: Indicates if the server should adjust subtitles based on Voice Activity Data. direct_play: Indicates the client supports direct playing the indicated content. direct_stream: Indicates the client supports direct streaming the video of the indicated content. direct_stream_audio: Indicates the client supports direct streaming the audio of the indicated content. disable_resolution_rotation: Indicates if resolution should be adjusted for orientation. has_mde: Ignore client profiles when determining if direct play is possible. Only has an effect when directPlay=1 and both mediaIndex and partIndex are specified and neither are -1 location: Network type of the client, can be used to help determine target bitrate. media_buffer_size: Buffer size used in playback (in KB). Clients should specify a lower bound if not known exactly. This value could make the difference between transcoding and direct play on bandwidth constrained networks. media_index: Index of the media to transcode. -1 or not specified indicates let the server choose. music_bitrate: Target bitrate for audio only files (in kbps, used to transcode). offset: Offset from the start of the media (in seconds). part_index: Index of the part to transcode. -1 or not specified indicates the server should join parts together in a transcode path: Internal PMS path of the media to transcode. peak_bitrate: Maximum bitrate (in kbps) to use in ABR. photo_resolution: Target photo resolution. protocol: Indicates the network streaming protocol to be used for the transcode session: * 'http' - include the file in the http response such as MKV streaming * 'hls' - hls stream (RFC 8216) * 'dash' - dash stream (ISO/IEC 23009-1:2022) seconds_per_segment: Number of seconds to include in each transcoded segment subtitle_size: Percentage of original subtitle size to use when burning subtitles (100 is equivalent to original size, 50 is half, ect) subtitles: Indicates how subtitles should be included: * 'auto' - Compute the appropriate subtitle setting automatically * 'burn' - Burn the selected subtitle; auto if no selected subtitle * 'none' - Ignore all subtitle streams * 'sidecar' - The selected subtitle should be provided as a sidecar * 'embedded' - The selected subtitle should be provided as an embedded stream * 'segmented' - The selected subtitle should be provided as a segmented stream max_video_bitrate: Client-side maximum video bitrate cap in kbps video_resolution: Cap resolution string (e.g. 1920x1080) copyts: Copy timestamps instead of re-encoding them video_bitrate: Target video bitrate (in kbps). video_quality: Target photo quality.

Transcode subtitles.

GET /{transcodeType}/:/transcode/universal/subtitles

Args: transcode_type: Path parameter. platform: Client platform (some clients send this in addition to headers). audio_boost: Percentage of original audio loudness to use when transcoding (100 is equivalent to original volume, 50 is half, 200 is double, etc) audio_channel_count: Target video number of audio channels. auto_adjust_quality: Indicates the client supports ABR. auto_adjust_subtitle: Indicates if the server should adjust subtitles based on Voice Activity Data. direct_play: Indicates the client supports direct playing the indicated content. direct_stream: Indicates the client supports direct streaming the video of the indicated content. direct_stream_audio: Indicates the client supports direct streaming the audio of the indicated content. disable_resolution_rotation: Indicates if resolution should be adjusted for orientation. has_mde: Ignore client profiles when determining if direct play is possible. Only has an effect when directPlay=1 and both mediaIndex and partIndex are specified and neither are -1 location: Network type of the client, can be used to help determine target bitrate. media_buffer_size: Buffer size used in playback (in KB). Clients should specify a lower bound if not known exactly. This value could make the difference between transcoding and direct play on bandwidth constrained networks. media_index: Index of the media to transcode. -1 or not specified indicates let the server choose. music_bitrate: Target bitrate for audio only files (in kbps, used to transcode). offset: Offset from the start of the media (in seconds). part_index: Index of the part to transcode. -1 or not specified indicates the server should join parts together in a transcode path: Internal PMS path of the media to transcode. peak_bitrate: Maximum bitrate (in kbps) to use in ABR. photo_resolution: Target photo resolution. protocol: Indicates the network streaming protocol to be used for the transcode session: * 'http' - include the file in the http response such as MKV streaming * 'hls' - hls stream (RFC 8216) * 'dash' - dash stream (ISO/IEC 23009-1:2022) seconds_per_segment: Number of seconds to include in each transcoded segment subtitle_size: Percentage of original subtitle size to use when burning subtitles (100 is equivalent to original size, 50 is half, ect) subtitles: Indicates how subtitles should be included: * 'auto' - Compute the appropriate subtitle setting automatically * 'burn' - Burn the selected subtitle; auto if no selected subtitle * 'none' - Ignore all subtitle streams * 'sidecar' - The selected subtitle should be provided as a sidecar * 'embedded' - The selected subtitle should be provided as an embedded stream * 'segmented' - The selected subtitle should be provided as a segmented stream max_video_bitrate: Client-side maximum video bitrate cap in kbps video_resolution: Cap resolution string (e.g. 1920x1080) copyts: Copy timestamps instead of re-encoding them video_bitrate: Target video bitrate (in kbps). video_quality: Target photo quality.

Get a download queue.

GET /downloadQueue/{queueId}

Args: queue_id: The queue id

Grab download queue item decision.

GET /downloadQueue/{queueId}/item/{itemId}/decision

Args: queue_id: The queue id item_id: The item ids

Grab download queue media.

GET /downloadQueue/{queueId}/item/{itemId}/media

Args: queue_id: The queue id item_id: The item ids

Get download queue items.

GET /downloadQueue/{queueId}/items

Args: queue_id: The queue id

Get download queue items.

GET /downloadQueue/{queueId}/items/{itemId}

Args: queue_id: The queue id item_id: The item ids

Get Plex Downloads.

GET /downloads/{channel}.json

Args: channel: The channel identifier

Get hubs for section by metadata item.

GET /hubs/metadata/{metadataId}

Args: metadata_id: The metadata ID for the hubs to fetch only_transient: Only return hubs which are "transient", meaning those which are prone to changing after media playback or addition (e.g. On Deck, or Recently Added)

Get postplay hubs.

GET /hubs/metadata/{metadataId}/postplay

Args: metadata_id: The metadata ID for the hubs to fetch only_transient: Only return hubs which are "transient", meaning those which are prone to changing after media playback or addition (e.g. On Deck, or Recently Added)

Get related hubs.

GET /hubs/metadata/{metadataId}/related

Args: metadata_id: The metadata ID for the hubs to fetch only_transient: Only return hubs which are "transient", meaning those which are prone to changing after media playback or addition (e.g. On Deck, or Recently Added)

Get section hubs.

GET /hubs/sections/{sectionId}

Args: section_id: The section ID for the hubs to fetch only_transient: Only return hubs which are "transient", meaning those which are prone to changing after media playback or addition (e.g. On Deck, or Recently Added)

Get hubs.

GET /hubs/sections/{sectionId}/manage

Args: section_id: The section ID for the hubs to reorder metadata_item_id: Restrict hubs to ones relevant to the provided metadata item

Get a collection's image.

GET /library/collections/{collectionId}/composite/{updatedAt}

Args: collection_id: The collection id updated_at: The update time of the image. Used for busting cache.

Get items in a collection.

GET /library/collections/{collectionId}/items

Args: collection_id: The collection id

Get a chapter image.

GET /library/media/{mediaId}/chapterImages/{chapter}

Args: media_id: The id of the media item chapter: The index of the chapter

Get augmentation status.

GET /library/metadata/augmentations/{augmentationId}

Args: augmentation_id: The id of the augmentation wait: Wait for augmentation completion before returning

Get Metadata Children.

GET /library/metadata/{id}/children

Args: id: The unique identifier of the item

Compute Sonic Path.

GET /library/metadata/{id}/computePath

Args: id: The unique identifier of the item

Get Metadata Grandchildren.

GET /library/metadata/{id}/grandchildren

Args: id: The unique identifier of the item

Get Metadata Grandparent.

GET /library/metadata/{id}/grandparent

Args: id: The unique identifier of the item

Get Nearest Metadata.

GET /library/metadata/{id}/nearest

Args: id: The unique identifier of the item exclude_parent_id: The unique identifier of the excludeparent exclude_grandparent_id: The unique identifier of the excludegrandparent limit: Maximum number of items to return max_distance: The maxDistance

Get Metadata On Deck.

GET /library/metadata/{id}/onDeck

Args: id: The unique identifier of the item

Get Metadata Parent.

GET /library/metadata/{id}/parent

Args: id: The unique identifier of the item

Get Metadata Reviews.

GET /library/metadata/{id}/reviews

Args: id: The unique identifier of the item

Get a metadata item.

GET /library/metadata/{ids}

Args: ids: Comma-separated list of IDs async_check_files: Determines if file check should be performed asynchronously. An activity is created to indicate progress. Default is false. async_refresh_local_media_agent: Determines if local media agent refresh should be performed asynchronously. An activity is created to indicate progress. Default is false. async_refresh_analysis: Determines if analysis refresh should be performed asynchronously. An activity is created to indicate progress. Default is false. check_files: Determines if file check should be performed synchronously. Specifying asyncCheckFiles will cause this option to be ignored. Default is false. skip_refresh: Determines if synchronous local media agent and analysis refresh should be skipped. Specifying async versions will cause synchronous versions to be skipped. Default is false. check_file_availability: Determines if file existence check should be performed synchronously. Specifying checkFiles will imply this option. Default is false. async_augment_metadata: Add metadata augmentations. An activity is created to indicate progress. Option will be ignored if specified by non-admin or if multiple metadata items are requested. Default is false. augment_count: Number of augmentations to add. Requires asyncAugmentMetadata to be specified. include_markers: Include intro/credits markers in the response include_guids: Include external GUIDs (e.g. TMDB, TVDB) in the response include_chapters: Include chapter data in the response include_external_media: Include external/online media in the response include_extras: Include trailers, behind-the-scenes, and other extras include_related: Include related items in the response include_on_deck: Include On Deck status in the response include_popular_leaves: Include popular episodes in the response include_reviews: Include user reviews in the response include_stations: Include radio station data in the response exclude_elements: Comma-separated list of elements to exclude from the response exclude_fields: Comma-separated list of fields to exclude from the response

Get the leaves of an item.

GET /library/metadata/{ids}/allLeaves

Args: ids: Comma-separated list of IDs

Get an item's artwork, theme, etc.

GET /library/metadata/{ids}/{element}/{timestamp}

Args: ids: Comma-separated list of IDs element: The type of artwork element (e.g., art, poster, thumb) timestamp: A timestamp on the element used for cache management in the client

Get an item's extras.

GET /library/metadata/{ids}/extras

Args: ids: Comma-separated list of IDs

Get a file from a metadata or media bundle.

GET /library/metadata/{ids}/file

Args: ids: Comma-separated list of IDs url: The bundle url, typically starting with metadata:// or media://

Get related items.

GET /library/metadata/{ids}/related

Args: ids: Comma-separated list of IDs

Get similar items.

GET /library/metadata/{ids}/similar

Args: ids: Comma-separated list of IDs

Get subtitles.

GET /library/metadata/{ids}/subtitles

Args: ids: Comma-separated list of IDs title: The title to filter by language: The language code to use media_item_id: The unique identifier of the mediaitem url: The URL of the subtitle. If not provided, the contents of the subtitle must be in the post body format: The format forced: The forced hearing_impaired: The hearingImpaired

Get metadata items as a tree.

GET /library/metadata/{ids}/tree

Args: ids: Comma-separated list of IDs

Get metadata top users.

GET /library/metadata/{ids}/users/top

Args: ids: Comma-separated list of IDs

Get a media part.

GET /library/parts/{partId}/{changestamp}/{filename}

Args: part_id: The part id who's index is to be fetched changestamp: The changestamp of the part; used for busting potential caches. Provided in the key for the part filename: A generic filename used for a client media stack which relies on the extension in the request. Provided in the key for the part download: Whether this is a file download

Get BIF index for a part.

GET /library/parts/{partId}/indexes/{index}

Args: part_id: The part id who's index is to be fetched index: The type of index to grab. interval: The interval between images to return in ms.

Get an image from part BIF.

GET /library/parts/{partId}/indexes/{index}/{offset}

Args: part_id: The part id who's index is to be fetched index: The type of index to grab. offset: The offset to seek in ms.

Get person details.

GET /library/people/{personId}

Args: person_id: Either the PMS tag id of the person or tagKey of the actor. Note the tagKey is the hex portion of the plex guid for the actor

Get media for a person.

GET /library/people/{personId}/media

Args: person_id: Either the PMS tag id of the person or tagKey of the actor. Note the tagKey is the hex portion of the plex guid for the actor

Get a library section by id.

GET /library/sections/{sectionId}

Args: section_id: The section identifier include_details: Whether or not to include details for a section (types, filters, and sorts). Only exists for backwards compatibility, media providers other than the server libraries have it on always.

Get Section Agents.

GET /library/sections/{sectionId}/agents

Args: section_id: The unique identifier of the library section

Set section albums.

GET /library/sections/{sectionId}/albums

Args: section_id: Section identifier

Get items in the section.

GET /library/sections/{sectionId}/all

Args: section_id: The id of the section include_meta: Adds the Meta object to the response include_guids: Adds the Guid object to the response include_collections: Include collection items in results include_external_media: Include external or online media include_advanced: Include advanced settings check_files: Verify file existence include_related: Include related items include_extras: Include trailers, behind-the-scenes, etc. include_popular_leaves: Include popular episodes include_concerts: Include concert items include_on_deck: Include On Deck status include_chapters: Include chapter markers include_preferences: Include user preferences include_bandwidths: Include bandwidth info include_loudness_ramps: Include loudness ramp data include_stations: Include radio station data include_external_ids: Include external GUIDs include_reviews: Include user reviews include_credits: Include full credits include_art: Force inclusion of artwork fields include_thumb: Force inclusion of thumbnail fields include_banner: Force inclusion of banner fields include_theme: Force inclusion of theme fields include_fields: Whitelist of fields to return exclude_fields: Blacklist of fields to omit async_augment_metadata: Async metadata augmentation async_refresh_local_media_agent: Async local media agent refresh nocache: Bypass cache skip_refresh: Skip synchronous refresh exclude_elements: Comma-separated list of elements to exclude from the response filters: General filtering expression. unwatched: Filter to unwatched only (1 = true). genre: Filter by genre. studio: Filter by studio. content_rating: Filter by content rating. resolution: Filter by resolution. year: Filter by year. first_character: Filter by first character of title.

Set section leaves.

GET /library/sections/{sectionId}/allLeaves

Args: section_id: Section identifier

Get Section Artists.

GET /library/sections/{sectionId}/artists

Args: section_id: The id of the section

Set section artwork.

GET /library/sections/{sectionId}/arts

Args: section_id: Section identifier

Get autocompletions for search.

GET /library/sections/{sectionId}/autocomplete

Args: section_id: Section identifier field_query: The "field" stands in for any field, the value is a partial string for matching

Get By Content Rating.

GET /library/sections/{sectionId}/byContentRating

Args: section_id: The unique identifier of the library section

Get By Decade.

GET /library/sections/{sectionId}/byDecade

Args: section_id: The unique identifier of the library section

Get By Folder.

GET /library/sections/{sectionId}/byFolder

Args: section_id: The unique identifier of the library section

Get By Resolution.

GET /library/sections/{sectionId}/byResolution

Args: section_id: The unique identifier of the library section

Get By Year.

GET /library/sections/{sectionId}/byYear

Args: section_id: The unique identifier of the library section

Set section categories.

GET /library/sections/{sectionId}/categories

Args: section_id: Section identifier

Get Section Clips.

GET /library/sections/{sectionId}/clips

Args: section_id: The id of the section

Set section clusters.

GET /library/sections/{sectionId}/cluster

Args: section_id: Section identifier

Get collections in a section.

GET /library/sections/{sectionId}/collections

Args: section_id: Section identifier

Get common fields for items.

GET /library/sections/{sectionId}/common

Args: section_id: Section identifier

Get a section composite image.

GET /library/sections/{sectionId}/composite/{updatedAt}

Args: section_id: Section identifier updated_at: The update time of the image. Used for busting cache.

Similar tracks to transition from one to another.

GET /library/sections/{sectionId}/computePath

Args: section_id: Section identifier start_id: The starting metadata item id end_id: The ending metadata item id max_distance: The maximum distance allowed along the path; defaults to 0.25

Edit Section.

GET /library/sections/{sectionId}/edit

Args: section_id: The unique identifier of the library section

Get Empty Trash.

GET /library/sections/{sectionId}/emptyTrash

Args: section_id: The unique identifier of the library section

Get Section Episodes.

GET /library/sections/{sectionId}/episodes

Args: section_id: The id of the section

Get section filters.

GET /library/sections/{sectionId}/filters

Args: section_id: Section identifier

Get list of first characters.

GET /library/sections/{sectionId}/firstCharacters

Args: section_id: Section identifier

Get Section Hubs.

GET /library/sections/{sectionId}/hubs

Args: section_id: The unique identifier of the library section

Get Section Labels.

GET /library/sections/{sectionId}/label

Args: section_id: The unique identifier of the library section

Get all folder locations.

GET /library/sections/{sectionId}/location

Args: section_id: Section identifier

Match Section Items.

GET /library/sections/{sectionId}/match

Args: section_id: The unique identifier of the library section

Set section moments.

GET /library/sections/{sectionId}/moment

Args: section_id: Section identifier

Get Section Movies.

GET /library/sections/{sectionId}/movies

Args: section_id: The id of the section

The nearest audio tracks.

GET /library/sections/{sectionId}/nearest

Args: section_id: Section identifier type: The metadata type to fetch (should be 10 for audio track) values: The music analysis to center the search. Typically obtained from the musicAnalysis of a track limit: The limit of the number of items to fetch; defaults to 50 max_distance: The maximum distance to search, defaults to 0.25

Get Newest for Section.

GET /library/sections/{sectionId}/newest

Args: section_id: The unique identifier of the library section

Get On Deck for Section.

GET /library/sections/{sectionId}/onDeck

Args: section_id: The unique identifier of the library section

Get Optimize Section.

GET /library/sections/{sectionId}/optimize

Args: section_id: The unique identifier of the library section

Get Section Photos.

GET /library/sections/{sectionId}/photos

Args: section_id: The id of the section

Get Section Playlists.

GET /library/sections/{sectionId}/playlists

Args: section_id: The unique identifier of the library section

Get section prefs.

GET /library/sections/{sectionId}/prefs

Args: section_id: Section identifier agent: The identifier of the metadata agent to use

Get Recently Added for Section.

GET /library/sections/{sectionId}/recentlyAdded

Args: section_id: The unique identifier of the library section

Get Refresh Section.

GET /library/sections/{sectionId}/refresh

Args: section_id: Section identifier

Search Section.

GET /library/sections/{sectionId}/search

Args: section_id: The unique identifier of the library section

Get Section Settings.

GET /library/sections/{sectionId}/settings

Args: section_id: The unique identifier of the library section

Get Section Shows.

GET /library/sections/{sectionId}/shows

Args: section_id: The id of the section

Get a section sorts.

GET /library/sections/{sectionId}/sorts

Args: section_id: Section identifier

Get Section Tags.

GET /library/sections/{sectionId}/tags

Args: section_id: The unique identifier of the library section

Get Section Timeline.

GET /library/sections/{sectionId}/timeline

Args: section_id: The unique identifier of the library section

Unmatch Section Items.

GET /library/sections/{sectionId}/unmatch

Args: section_id: The unique identifier of the library section

Get Unwatched for Section.

GET /library/sections/{sectionId}/unwatched

Args: section_id: The unique identifier of the library section

Get a stream.

GET /library/streams/{streamId}.{ext}

Args: stream_id: The id of the stream ext: The extension of the stream. Required to fetch the sub portion of idx/sub subtitles encoding: The requested encoding for the subtitle (only used for text subtitles) format: The requested format for the subtitle to convert the subtitles to (only used for text subtitles) auto_adjust_subtitle: Whether the server should attempt to automatically adjust the subtitle timestamps to match the media

Get loudness about a stream in json.

GET /library/streams/{streamId}/levels

Args: stream_id: The id of the stream subsample: Subsample result down to return only the provided number of samples

Get loudness about a stream.

GET /library/streams/{streamId}/loudness

Args: stream_id: The id of the stream subsample: Subsample result down to return only the provided number of samples

Get a single DVR.

GET /livetv/dvrs/{dvrId}

Args: dvr_id: The ID of the DVR.

Get DVR Channels.

GET /livetv/dvrs/{dvrId}/channels

Args: dvr_id: The ID of the DVR.

Get DVR Guide.

GET /livetv/dvrs/{dvrId}/guide

Args: dvr_id: The ID of the DVR.

Get DVR Recordings by DVR.

GET /livetv/dvrs/{dvrId}/recordings

Args: dvr_id: The ID of the DVR.

Get lineups for a country via postal code.

GET /livetv/epg/countries/{country}/{epgId}/lineups

Args: country: 3 letter country code epg_id: The providerIdentifier of the provider postal_code: The postal code for the lineups to fetch

Get regions for a country.

GET /livetv/epg/countries/{country}/{epgId}/regions

Args: country: 3 letter country code epg_id: The providerIdentifier of the provider

Get lineups for a region.

GET /livetv/epg/countries/{country}/{epgId}/regions/{region}/lineups

Args: country: 3 letter country code epg_id: The providerIdentifier of the provider region: The region for the lineup

Get a single session.

GET /livetv/sessions/{sessionId}

Args: session_id: The session id

Get a single session segment.

GET /livetv/sessions/{sessionId}/{consumerId}/{segmentId}

Args: session_id: The session id consumer_id: The consumer id segment_id: The segment id

Get a session playlist index.

GET /livetv/sessions/{sessionId}/{consumerId}/index.m3u8

Args: session_id: The session id consumer_id: The consumer id

Get device details.

GET /media/grabbers/devices/{deviceId}

Args: device_id: The ID of the device.

Get a device's channels.

GET /media/grabbers/devices/{deviceId}/channels

Args: device_id: The ID of the device.

Get device thumb.

GET /media/grabbers/devices/{deviceId}/thumb/{version}

Args: device_id: The ID of the device. version: A version number of the thumb used for busting cache

Get a single subscription.

GET /media/subscriptions/{subscriptionId}

Args: subscription_id: The unique identifier of the subscription include_grabs: Indicates whether the active grabs should be included as well include_storage: Compute the storage of recorded items desired by this subscription

Get OAuth PIN Status.

GET /pins/{pinId}

Args: pin_id: The unique identifier of the pin

Retrieve a play queue.

GET /playQueues/{playQueueId}

Args: play_queue_id: The ID of the play queue. own: If the server should transfer ownership to the requesting client (used in remote control scenarios). center: The play queue item ID for the center of the window - this doesn't change the current selected item. window: How many items on each side of the center of the window include_before: Whether to include the items before the center (if 0, center is not included either), defaults to 1. include_after: Whether to include the items after the center (if 0, center is not included either), defaults to 1.

Retrieve Playlist.

GET /playlists/{playlistId}

Args: playlist_id: The ID of the playlist

Get a playlist's generators.

GET /playlists/{playlistId}/generators

Args: playlist_id: The ID of the playlist

Retrieve Playlist Contents.

GET /playlists/{playlistId}/items

Args: playlist_id: The ID of the playlist type: The metadata types of the item to return. Values past the first are only used in fetching items from the background processing playlist.

Get a playlist generator.

GET /playlists/{playlistId}/items/{generatorId}

Args: playlist_id: The ID of the playlist generator_id: The generator item ID to delete.

Get a playlist generator's items.

GET /playlists/{playlistId}/items/{generatorId}/items

Args: playlist_id: The ID of the playlist generator_id: The generator item ID to delete.

Get Server Details.

GET /servers/{machineId}

Args: machine_id: The unique machine identifier of the server

Browse Filesystem Path.

GET /services/browse/{base64path}

Args: base64path: The base64path

Get Single History Item.

GET /status/sessions/history/{historyId}

Args: history_id: The id of the history item (the historyKey from above)

Get Sync Item.

GET /sync/items/{syncId}

Args: sync_id: The unique identifier of the sync item

Get Metadata Agent Details.

GET /system/agents/{agentId}

Args: agent_id: The unique identifier of the metadata agent

Get User Opt-Outs.

GET /user/{uuid}/settings/opt_outs

Args: uuid: The universally unique identifier

Get System Accounts.

GET /accounts

Get all activities.

GET /activities

Get Auth Keys.

GET /auth/keys

Get Auth Nonce.

GET /auth/nonce

Get all Butler tasks.

GET /butler

Get Claim Token.

GET /claim/token.json

Get Clients.

GET /clients

Get Cloud Server.

GET /cloud_server

Get System Devices.

GET /devices

Get Diagnostics.

GET /diagnostics

Download Database Diagnostics.

GET /diagnostics/databases

Download Log Bundle.

GET /diagnostics/logs

Connect to Eventsource.

GET /:/eventsource/notifications

Args:
    filter: By default, all events except logs are sent. A rich filtering mechanism is provided to allow clients to opt into or out of each event type using the `filters` parameter. For example:

• filters=-log: All event types except logs (the default).

• filters=foo,bar: Only the foo and bar event types.

• filters=: All events types.

• filters=-foo,bar: All event types except foo and bar.

Get Features.

GET /features

Get Friends.

GET /friends

Get GeoIP.

GET /geoip

Get home hubs.

GET /home

Get home hubs Users.

GET /home/users

Get global hubs.

GET /hubs

Args: only_transient: Only return hubs which are "transient", meaning those which are prone to changing after media playback or addition (e.g. On Deck, or Recently Added) identifier: If provided, limit to only specified hubs

Get the continue watching hub.

GET /hubs/continueWatching

Get Continue Watching Items.

GET /hubs/continueWatching/items

Get home hubs Recently Added.

GET /hubs/home/recentlyAdded

Get a hub's items.

GET /hubs/items

Args: identifier: If provided, limit to only specified hubs

Get the hubs which are promoted.

GET /hubs/promoted

Search Hub.

GET /hubs/search

Args: query: The query term section_id: This gives context to the search, and can result in re-ordering of search result hubs. limit: The number of items to return per hub. 3 if not specified include_collections: Include collection results in search hubs

Voice Search Hub.

GET /hubs/search/voice

Args: query: The query term limit: The number of items to return per hub. 3 if not specified include_collections: Include collection results in search hubs

Get PMS identity.

GET /identity

Get IP.

GET /ip

Get Root Library.

GET /library

Get all items in library.

GET /library/all

Get library matches.

GET /library/matches

Args: include_full_metadata: Include full metadata in the response include_ancestor_metadata: Include ancestor metadata in the response include_alternate_metadata_sources: Include alternate metadata sources in the response guid: Used for movies, shows, artists, albums, and tracks. Allowed for various URI schemes, to be defined. year: Used for movies shows, and albums. Optional. path: Used for movies, episodes, and tracks. The full path to the media file, used for "cloud-scanning" an item. grandparent_title: Used for episodes and tracks. The title of the show/artist. Required if path isn't passed. grandparent_year: Used for episodes. The year of the show. parent_index: Used for episodes and tracks. The season/album number. index: Used for episodes and tracks. The episode/tracks number in the season/album. originally_available_at: Used for episodes. In the format YYYY-MM-DD. parent_title: Used for albums and tracks. The artist name for albums or the album name for tracks.

Get Optimize Library.

GET /library/optimize

Get random artwork.

GET /library/randomArtwork

Args: sections: The sections for which to fetch artwork.

Get Global Recently Added.

GET /library/recentlyAdded

Search Discover.

GET /library/search

Args: query: The search query string limit: Maximum number of items to return search_types: Types of content to search for search_providers: Providers to include in the search include_metadata: Include metadata in the search results

Get Library Sections (Fallback).

GET /library/sections/

Get library sections (main Media Provider Only).

GET /library/sections/all

Get section prefs.

GET /library/sections/prefs

Args: type: The metadata type agent: The metadata agent in use

Get Watchlist.

GET /library/sections/watchlist/all

Get all library tags of a type.

GET /library/tags

Get DVRs.

GET /livetv/dvrs

Args: uuid: Filter by DVR UUID. lineup: Filter by lineup.

Compute the best channel map.

GET /livetv/epg/channelmap

Args: device: The URI describing the device lineup: The URI describing the lineup

Get channels for a lineup.

GET /livetv/epg/channels

Args: lineup: The URI describing the lineup

Get all countries.

GET /livetv/epg/countries

Get EPG Guide.

GET /livetv/epg/guide

Get all languages.

GET /livetv/epg/languages

Compute the best lineup.

GET /livetv/epg/lineup

Args: device: The URI describing the device lineup_group: The URI describing the lineupGroup

Get the channels for multiple lineups.

GET /livetv/epg/lineupchannels

Args: lineup: The URIs describing the lineups

Search EPG.

GET /livetv/epg/search

Get DVR Recordings.

GET /livetv/recordings

Get all sessions.

GET /livetv/sessions

Args: dvr_id: Filter by DVR ID. channel: Filter by channel ID.

Get available grabbers.

GET /media/grabbers

Args: protocol: Only return grabbers providing this protocol.

Get all devices.

GET /media/grabbers/devices

Tell grabbers to discover devices.

GET /media/grabbers/devices/discover

Args: protocol: Protocol to filter discovery. grabber_identifier: Targeted grabber identifier.

Get the list of available media providers.

GET /media/providers

Get all subscriptions.

GET /media/subscriptions

Args: include_grabs: Indicates whether the active grabs should be included as well include_storage: Compute the storage of recorded items desired by this subscription

Get all scheduled recordings.

GET /media/subscriptions/scheduled

Get the subscription template.

GET /media/subscriptions/template

Args: guid: The guid of the item for which to get the template type: Subscription type. target_library_section_id: Target library section ID.

Transcode Music.

GET /music/:/transcode

Get MyPlex Account.

GET /myplex/account

Transcode an image.

GET /photo/:/transcode

Args:
    url: The source URL for the image to transcode.  Note, if this URL requires a token such as `X-Plex-Token`, it should be given as a query parameter to this url.
    format: The output format for the image; defaults to jpg
    width: The desired width of the output image
    height: The desired height of the output image
    quality: The desired quality of the output.  -1 means the highest quality.  Defaults to -1
    background: The background color to apply before painting the image.  Only really applicable if image has transparency.  Defaults to none
    upscale: Indicates if image should be upscaled to the desired width/height.  Defaults to false
    min_size: Indicates if image should be scaled to fit the smaller dimension.  By default (false) the image is scaled to fit within the width/height specified but if this parameter is true, it will allow overflowing one dimension to fit the other.  Essentially it is making the width/height minimum sizes of the image or sizing the image to fill the entire width/height even if it overflows one dimension.
    rotate: Obey the rotation values specified in EXIF data.  Defaults to true.
    blur: Apply a blur to the image, Defaults to 0 (none)
    saturation: Scale the image saturation by the specified percentage.  Defaults to 100
    opacity: Render the image at the specified opacity percentage.  Defaults to 100
    chroma_subsampling: Use the specified chroma subsambling.

• 0: 411

• 1: 420

• 2: 422

• 3: 444 Defaults to 3 (444) blend_color: The color to blend with the image. Defaults to none

Ping the server.

GET /ping

Get Conversion Queue.

GET /playQueues/1

Get Client Resources.

GET /player/resources

Player Poll Timeline.

GET /player/timeline/poll

List playlists.

GET /playlists

Args: playlist_type: Limit to a type of playlist type: Filter by playlist type. Use 42 for optimized/conversion items.

Get all preferences.

GET /:/prefs

Get a preferences.

GET /:/prefs/get

Args: id: The preference to fetch

Get Progress.

GET /:/progress

Args: key: The metadata key of the item time: The current playback position in milliseconds

Get Legacy Resources.

GET /api/resources

Get Server Resources.

GET /resources

Args:
    include_https: Include Https entries in the results
    include_relay: Include Relay addresses in the results 

E.g: https://10-0-0-25.bbf8e10c7fa20447cacee74cd9914cde.plex.direct:32400 include_ipv6: Include IPv6 entries in the results

Get PMS info.

GET /

Get Source Connection Information.

GET /security/resources

Args: source: The source identifier with an included prefix. refresh: Force refresh

Get User Server Association.

GET /server

Get Server Access Tokens.

GET /server/access_tokens

Get Server User Features.

GET /server/users/features

Get Local Servers.

GET /servers

Browse Filesystem.

GET /services/browse

Args: include_files: Include files in browse results

Get UltraBlur Colors.

GET /services/ultrablur/colors

Args: url: Url for image which requires color extraction. Can be relative PMS library path or absolute url.

Get UltraBlur Image.

GET /services/ultrablur/image

Args: top_left: The base color (hex) for the top left quadrant. top_right: The base color (hex) for the top right quadrant. bottom_right: The base color (hex) for the bottom right quadrant. bottom_left: The base color (hex) for the bottom left quadrant. width: Width in pixels for the image. height: Height in pixels for the image. noise: Whether to add noise to the ouput image. Noise can reduce color banding with the gradients. Image sizes with noise will be larger.

Get Bandwidth Statistics.

GET /statistics/bandwidth

Args: timespan: Dashboard timespan (1-6) account_id: Filter by account ID device_id: Filter by device ID lan: Filter to LAN-only traffic

Get Resource Statistics.

GET /statistics/resources

List Sessions.

GET /status/sessions

Get background tasks.

GET /status/sessions/background

List Playback History.

GET /status/sessions/history/all

Args: account_id: The account id to restrict view history viewed_at: The time period to restrict history (typically of the form viewedAt>=12456789) library_section_id: The library section id to restrict view history metadata_item_id: The metadata item to restrict view history (can provide the id for a show to see all of that show's view history). Note this is translated to metadata_items.id, parents.id, or grandparents.id internally depending on the metadata type. sort: The field on which to sort. Multiple orderings can be specified separated by , and the direction specified following a : (desc or asc; asc is assumed if not provided). Note metadataItemID may not be used here. exclude_elements: Comma-separated list of elements to exclude from the response exclude_fields: Comma-separated list of fields to exclude from the response include_fields: Whitelist of fields to return include_elements: Whitelist of elements to include viewed_at_query: Greater-than filter for viewedAt timestamp viewed_at_query_2: Less-than filter for viewedAt timestamp device_id: Filter by device ID

Get Sync Status.

GET /sync

Get Sync Items.

GET /sync/items

Get Sync Queue.

GET /sync/queue

Get Sync Transcode Queue.

GET /sync/transcodeQueue

Get Metadata Agents.

GET /system/agents

Get System Settings.

GET /system/settings

Check for System Updates.

GET /system/updates

Get Transcode Sessions.

GET /transcode/sessions

Querying status of updates.

GET /updater/status

Get Token Details.

GET /user

Get Legacy Users.

GET /api/users/

Get list of all connected users.

GET /users

Get Account (XML).

GET /users/account

Get Account (JSON).

GET /users/account.json

User Webhooks.

GET /api/v2/user/webhooks

Get Webhooks.

GET /webhooks

Connect to WebSocket.

GET /:/websocket/notifications

Args:
    filter: By default, all events except logs are sent. A rich filtering mechanism is provided to allow clients to opt into or out of each event type using the `filters` parameter. For example:

• filters=-log: All event types except logs (the default).

• filters=foo,bar: Only the foo and bar event types.

• filters=: All events types.

• filters=-foo,bar: All event types except foo and bar.

Get WebSocket Notifications.

GET /:/websockets/notifications

Update DVR Settings.

PATCH /livetv/dvrs/{dvrId}

Args: dvr_id: The ID of the DVR.

Remove From Continue Watching.

PUT /actions/removeFromContinueWatching

Args: key: The metadata key of the item

Update Home User.

PUT /home/users/{userId}

Args: user_id: The unique identifier of the user

Update Restricted User.

PUT /home/users/restricted/{userId}

Args: user_id: The unique identifier of the user

Change hub visibility.

PUT /hubs/sections/{sectionId}/manage/{identifier}

Args: section_id: The section ID for the hubs to change identifier: The identifier of the hub to change promoted_to_recommended: Whether this hub should be displayed in recommended promoted_to_own_home: Whether this hub should be displayed in admin's home promoted_to_shared_home: Whether this hub should be displayed in shared user's home

Move Hub.

PUT /hubs/sections/{sectionId}/manage/move

Args: section_id: The section ID for the hubs to reorder identifier: The identifier of the hub to move after: The identifier of the hub to order this hub after (or empty/missing to put this hub first)

Accept an Invite.

PUT /api/invites/requests/{inviteId}

Args: invite_id: The pending invitation ID. friend: Whether the invitation includes a friend relationship. home: Whether the invitation includes Plex Home membership. server: Whether the invitation includes access to a shared server.

Clean bundles.

PUT /library/clean/bundles

Add items to a collection.

PUT /library/collections/{collectionId}/items

Args: collection_id: The collection id uri: The URI describing the items to add to this collection

Update an item in a collection.

PUT /library/collections/{collectionId}/items/{itemId}

Args: collection_id: The collection id item_id: The item to delete

Reorder an item in the collection.

PUT /library/collections/{collectionId}/items/{itemId}/move

Args: collection_id: The collection id item_id: The item to move after: The item to move this item after. If not provided, this item will be moved to the beginning

Edit a metadata item.

PUT /library/metadata/{ids}

Args: ids: Comma-separated list of IDs args: The new values for the metadata item

Ad-detect an item.

PUT /library/metadata/{ids}/addetect

Args: ids: Comma-separated list of IDs

Analyze an item.

PUT /library/metadata/{ids}/analyze

Args: ids: Comma-separated list of IDs thumb_offset: Set the offset to be used for thumbnails art_offset: Set the offset to be used for artwork

Set an item's artwork, theme, etc.

PUT /library/metadata/{ids}/{element}

Args: ids: Comma-separated list of IDs element: The type of artwork element (e.g., art, poster, thumb) url: The url of the new asset.

Generate thumbs of chapters for an item.

PUT /library/metadata/{ids}/chapterThumbs

Args: ids: Comma-separated list of IDs force: Force the operation even if conditions are not met

Credit detect a metadata item.

PUT /library/metadata/{ids}/credits

Args: ids: Comma-separated list of IDs force: Force the operation even if conditions are not met manual: Whether to perform the operation manually

Start BIF generation of an item.

PUT /library/metadata/{ids}/index

Args: ids: Comma-separated list of IDs force: Force the operation even if conditions are not met

Intro detect an item.

PUT /library/metadata/{ids}/intro

Args: ids: Comma-separated list of IDs force: Indicate whether detection should be re-run threshold: The threshold for determining if content is an intro or not

Edit a marker.

PUT /library/metadata/{ids}/marker/{marker}

Args: ids: Comma-separated list of IDs marker: The id of the marker to edit type: The type of marker to edit/create start_time_offset: The start time of the marker end_time_offset: The end time of the marker attributes: The attributes to assign to this marker

Match a metadata item.

PUT /library/metadata/{ids}/match

Args: ids: Comma-separated list of IDs guid: The guid name: The name year: The year to filter by

Get metadata matches for an item.

PUT /library/metadata/{ids}/matches

Args: ids: Comma-separated list of IDs title: The title to filter by parent_title: The parentTitle agent: The identifier of the metadata agent to use language: The language code to use year: The year to filter by manual: Whether to perform the operation manually

Merge a metadata item.

PUT /library/metadata/{ids}/merge

Args: ids: Comma-separated list of IDs ids_query: Comma-separated list of item identifiers

Set metadata preferences.

PUT /library/metadata/{ids}/prefs

Args: ids: Comma-separated list of IDs args: The args

Refresh a metadata item.

PUT /library/metadata/{ids}/refresh

Args: ids: Comma-separated list of IDs agent: The identifier of the metadata agent to use mark_updated: The markUpdated skip_refresh: Skip synchronous refresh

Split a metadata item.

PUT /library/metadata/{ids}/split

Args: ids: Comma-separated list of IDs

Unmatch a metadata item.

PUT /library/metadata/{ids}/unmatch

Args: ids: Comma-separated list of IDs

Detect voice activity.

PUT /library/metadata/{ids}/voiceActivity

Args: ids: Comma-separated list of IDs force: Indicate whether detection should be re-run manual: Indicate whether detection is manually run

Optimize the Database.

PUT /library/optimize

Args: async_: If set, don't wait for completion but return an activity

Set stream selection.

PUT /library/parts/{partId}

Args: part_id: The id of the part to select streams on audio_stream_id: The id of the audio stream to select in this part subtitle_stream_id: The id of the subtitle stream to select in this part. Specify 0 to select no subtitle all_parts: Perform the same for all parts of this media selecting similar streams in each

Edit a library section.

PUT /library/sections/{sectionId}

Args: section_id: The section identifier name: The name of the new section scanner: The scanner this section should use agent: The agent this section should use for metadata metadata_agent_provider_group_id: The agent group id for this section language: The language of this section locations: The locations on disk to add to this section prefs: The preferences for this section

Set the fields of the filtered items.

PUT /library/sections/{sectionId}/all

Args: section_id: The id of the section type: The media type to filter by filters: The filters to apply to determine which items should be modified field_value: Set the specified field to a new value field_locked: Set the specified field to locked (or unlocked if set to 0) title_value: This field is treated specially by albums or artists and may be used for implicit reparenting. artist_title_value: Reparents set of Tracks or Albums - used with album.title.* in the case of tracks artist_title_id: Reparents set of Tracks or Albums - used with album.title.* in the case of tracks album_title_value: Reparents set of Tracks - Must be used in conjunction with artist.title.value or id album_title_id: Reparents set of Tracks - Must be used in conjunction with artist.title.value or id tagtype_idx_tag_tag: Creates tag and associates it with each item in the set. - [idx] links this and the next parameters together tagtype_idx_tagging_object: Here object may be text/thumb/art/theme - Optionally used in conjunction with tag.tag, to update association info across the set. tagtype_tag_tag: Remove comma separated tags from the set of items tagtype_tag: Remove associations of this type (e.g. genre) from the set of items

Analyze a section.

PUT /library/sections/{sectionId}/analyze

Args: section_id: Section identifier

Edit Section.

PUT /library/sections/{sectionId}/edit

Args: section_id: The unique identifier of the library section

Empty section trash.

PUT /library/sections/{sectionId}/emptyTrash

Args: section_id: Section identifier

Move Section.

PUT /library/sections/{sectionId}/move

Args: section_id: The unique identifier of the library section

Set section prefs.

PUT /library/sections/{sectionId}/prefs

Args: section_id: Section identifier prefs: The preference key to retrieve or set

Set a stream offset.

PUT /library/streams/{streamId}.{ext}

Args: stream_id: The id of the stream ext: This is not a part of this endpoint but documented here to satisfy OpenAPI offset: The offest in ms

Update DVR Settings.

PUT /livetv/dvrs/{dvrId}

Args: dvr_id: The ID of the DVR.

Add a device to an existing DVR.

PUT /livetv/dvrs/{dvrId}/devices/{deviceId}

Args: dvr_id: The ID of the DVR. device_id: The ID of the device to add.

Add a DVR Lineup.

PUT /livetv/dvrs/{dvrId}/lineups

Args: dvr_id: The ID of the DVR. lineup: The lineup to delete

Set DVR preferences.

PUT /livetv/dvrs/{dvrId}/prefs

Args: dvr_id: The ID of the DVR. name: Set the name preference to the provided value value: Preference value to set.

Logging a single-line message to the Plex Media Server log.

PUT /log

Args: level: An integer log level to write to the PMS log with.

• 0: Error

• 1: Warning

• 2: Info

• 3: Debug

• 4: Verbose message: The text of the message to write to the log. source: A string indicating the source of the message.

Enable or disable a device.

PUT /media/grabbers/devices/{deviceId}

Args: device_id: The ID of the device. enabled: Whether to enable the device

Set a device's channel mapping.

PUT /media/grabbers/devices/{deviceId}/channelmap

Args: device_id: The ID of the device. channel_mapping: The mapping of changes, passed as a map of device channel to lineup VCN. channel_mapping_by_key: The mapping of changes, passed as a map of device channel to lineup key. channels_enabled: The channels which are enabled.

Set device preferences.

PUT /media/grabbers/devices/{deviceId}/prefs

Args: device_id: The ID of the device. name: The preference names and values. value: Preference value to set.

Edit a subscription.

PUT /media/subscriptions/{subscriptionId}

Args: subscription_id: The unique identifier of the subscription prefs: The preference key to retrieve or set

Re-order a subscription.

PUT /media/subscriptions/{subscriptionId}/move

Args: subscription_id: The unique identifier of the subscription after: The subscription to move this sub after. If missing will insert at the beginning of the list

Refresh Reachability.

PUT /myplex/refreshReachability

Link OAuth PIN.

PUT /pins/link

Args: body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.

Add a generator or playlist to a play queue.

PUT /playQueues/{playQueueId}

Args: play_queue_id: The ID of the play queue. uri: The content URI for what we're adding to the queue. playlist_id: The ID of the playlist to add to the playQueue. next: Play this item next (defaults to 0 - queueing at the end of manually queued items).

Move an item in a play queue.

PUT /playQueues/{playQueueId}/items/{playQueueItemId}/move

Args: play_queue_id: The ID of the play queue. play_queue_item_id: The play queue item ID to delete. after: The play queue item ID to insert the new item after. If not present, moves to the beginning.

Reset a play queue.

PUT /playQueues/{playQueueId}/reset

Args: play_queue_id: The ID of the play queue.

Shuffle a play queue.

PUT /playQueues/{playQueueId}/shuffle

Args: play_queue_id: The ID of the play queue.

Unshuffle a play queue.

PUT /playQueues/{playQueueId}/unshuffle

Args: play_queue_id: The ID of the play queue.

Editing a Playlist.

PUT /playlists/{playlistId}

Args: playlist_id: The ID of the playlist

Adding to a Playlist.

PUT /playlists/{playlistId}/items

Args: playlist_id: The ID of the playlist uri: The content URI for the playlist. play_queue_id: The play queue to add to a playlist.

Modify a Generator.

PUT /playlists/{playlistId}/items/{generatorId}

Args:
    playlist_id: The ID of the playlist
    generator_id: The generator item ID to modify.
    item: Note: OpenAPI cannot properly render this query parameter example ([See GHI](https://github.com/OAI/OpenAPI-Specification/issues/1706)).  It should be rendered as:

Item[type]=42&Item[title]=Jack-Jack Attack&Item[target]=&Item[targetTagID]=1&Item[locationID]=-1&Item[Location][uri]=library://82503060-0d68-4603-b594-8b071d54819e/item//library/metadata/146&Item[Policy][scope]=all&Item[Policy][value]=&Item[Policy][unwatched]=0

Reprocess a generator.

PUT /playlists/{playlistId}/items/{generatorId}/{metadataId}/{action}

Args: playlist_id: The ID of the playlist generator_id: The generator item ID to act on metadata_id: The metadata item ID to act on action: The action to perform for this item on this optimizer queue

Moving items in a playlist.

PUT /playlists/{playlistId}/items/{playlistItemId}/move

Args: playlist_id: The ID of the playlist playlist_item_id: The playlist item ID to move. after: The playlist item ID to insert the new item after. If not provided, item is moved to beginning of playlist

Set preferences.

PUT /:/prefs

Args: prefs: The preference key to retrieve or set

Rate an item.

PUT /:/rate

Args: identifier: The identifier of the media provider containing the media to rate. Typically com.plexapp.plugins.library key: The key of the item to rate. This is the ratingKey found in metadata items rating: The rating to give the item. rated_at: The time when the rating occurred. If not present, interpreted as now.

Mark an item as played.

PUT /:/scrobble

Args: identifier: The identifier of the media provider containing the media to rate. Typically com.plexapp.plugins.library key: The key of the item to rate. This is the ratingKey found in metadata items uri: URI of the item to scrobble. Format is library://<section-uuid>/item/<url-encoded-key> or plex://movie/<guid> or plex://episode/<guid>.

Update Share.

PUT /sharings/{userId}

Args: user_id: The unique identifier of the user

Refresh Sync Content.

PUT /sync/refreshContent

Refresh Sync Lists.

PUT /sync/refreshSynclists

Mark an item as unplayed.

PUT /:/unscrobble

Args: identifier: The identifier of the media provider containing the media to rate. Typically com.plexapp.plugins.library key: The key of the item to rate. This is the ratingKey found in metadata items uri: URI of the item to scrobble. Format is library://<section-uuid>/item/<url-encoded-key> or plex://movie/<guid> or plex://episode/<guid>.

Applying updates.

PUT /updater/apply

Args: 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 immediately. skip: Indicate that the latest version should be marked as skipped. The entry for this version will have the state set to skipped.

Checking for updates.

PUT /updater/check

Args: download: Indicate that you want to start download any updates found.

Update View State Sync.

PUT /user/view_state_sync