Skip to main content
Plex API Documentation home page
Plex API Documentation
Search...
⌘K
Suggest an edit
Suggest an edit
Search...
Navigation
Documentation
Plex API Reference
Community
General
GET
Get PMS info
GET
Get PMS identity
GET
Get Source Connection Information
POST
Get Transient Tokens
Events
GET
Connect to Eventsource
GET
Connect to WebSocket
Preferences
GET
Get all preferences
PUT
Set preferences
GET
Get a preferences
Rate
PUT
Rate an item
Timeline
PUT
Mark an item as played
POST
Report media timeline
PUT
Mark an item as unplayed
Activities
GET
Get all activities
DEL
Cancel a running activity
Butler
GET
Get all Butler tasks
POST
Start all Butler tasks
DEL
Stop all Butler tasks
POST
Start a single butler task
DEL
Stop a single butler task
Download Queue
POST
Create download queue
GET
Get a download queue
POST
Add to download queue
GET
Get download queue items
GET
Grab download queue item decision
GET
Grab download queue media
GET
Get download queue items
DEL
Delete download queue items
POST
Restart processing of items from the decision
Hubs
GET
Get global hubs
GET
Get the continue watching hub
GET
Get a hub's items
GET
Get the hubs which are promoted
GET
Get hubs for section by metadata item
GET
Get postplay hubs
GET
Get related hubs
GET
Get section hubs
GET
Get hubs
POST
Create a custom hub
DEL
Reset hubs to defaults
PUT
Move Hub
PUT
Change hub visibility
DEL
Delete a custom hub
Search
GET
Search Hub
GET
Voice Search Hub
Library
GET
Get all items in library
DEL
Delete library caches
PUT
Clean bundles
POST
Ingest a transient item
GET
Get library matches
PUT
Optimize the Database
GET
Get random artwork
GET
Get library sections (main Media Provider Only)
POST
Add a library section
DEL
Stop refresh
GET
Get section prefs
POST
Refresh all sections
GET
Get all library tags of a type
PUT
Edit a metadata item
DEL
Delete a metadata item
PUT
Ad-detect an item
GET
Get the leaves of an item
PUT
Analyze an item
PUT
Generate thumbs of chapters for an item
PUT
Credit detect a metadata item
GET
Get an item's extras
POST
Add to an item's extras
GET
Get a file from a metadata or media bundle
PUT
Start BIF generation of an item
PUT
Intro detect an item
POST
Create a marker
PUT
Match a metadata item
PUT
Get metadata matches for an item
PUT
Merge a metadata item
GET
Get nearest tracks to metadata item
PUT
Set metadata preferences
PUT
Refresh a metadata item
GET
Get related items
GET
Get similar items
PUT
Split a metadata item
GET
Add subtitles
GET
Get metadata items as a tree
PUT
Unmatch a metadata item
GET
Get metadata top users
PUT
Detect voice activity
GET
Get augmentation status
PUT
Set stream selection
GET
Get person details
GET
Get media for a person
GET
Get a library section by id
PUT
Edit a library section
DEL
Delete a library section
PUT
Set the fields of the filtered items
PUT
Analyze a section
GET
Get autocompletions for search
GET
Get collections in a section
GET
Get common fields for items
PUT
Empty section trash
GET
Get section filters
GET
Get list of first characters
DEL
Delete section indexes
DEL
Delete section intro markers
GET
Get section prefs
PUT
Set section prefs
POST
Refresh section
DEL
Cancel section refresh
GET
Get a section sorts
GET
Get loudness about a stream in json
GET
Get loudness about a stream
GET
Get a chapter image
PUT
Set an item's artwork, theme, etc
POST
Set an item's artwork, theme, etc
PUT
Edit a marker
DEL
Delete a marker
DEL
Delete a media item
GET
Get BIF index for a part
DEL
Delete a collection
GET
Get a section composite image
GET
Get a stream
PUT
Set a stream offset
DEL
Delete a stream
GET
Get an item's artwork, theme, etc
GET
Get a media part
GET
Get an image from part BIF
Collections
POST
Create collection
DVRs
GET
Get DVRs
POST
Create a DVR
GET
Get a single DVR
DEL
Delete a single DVR
PUT
Add a DVR Lineup
DEL
Delete a DVR Lineup
PUT
Set DVR preferences
POST
Tell a DVR to reload program guide
DEL
Tell a DVR to stop reloading program guide
POST
Tune a channel on a DVR
PUT
Add a device to an existing DVR
DEL
Remove a device from an existing DVR
EPG
GET
Compute the best channel map
GET
Get channels for a lineup
GET
Get all countries
GET
Get all languages
GET
Compute the best lineup
GET
Get the channels for mulitple lineups
GET
Get lineups for a country via postal code
GET
Get regions for a country
GET
Get lineups for a region
Live TV
GET
Get all sessions
GET
Get a single session
GET
Get a session playlist index
GET
Get a single session segment
Log
PUT
Logging a single-line message to the Plex Media Server log
POST
Logging a multi-line message to the Plex Media Server log
GET
Enabling papertrail
Devices
GET
Get available grabbers
GET
Get all devices
POST
Add a device
POST
Tell grabbers to discover devices
GET
Get device details
PUT
Enable or disable a device
DEL
Remove a device
PUT
Set a device's channel mapping
GET
Get a device's channels
PUT
Set device preferences
POST
Tell a device to scan for channels
DEL
Tell a device to stop scanning for channels
GET
Get device thumb
Provider
GET
Get the list of available media providers
POST
Add a media provider
POST
Refresh media providers
DEL
Delete a media provider
Subscriptions
GET
Get all subscriptions
POST
Create a subscription
POST
Process all subscriptions
GET
Get all scheduled recordings
GET
Get the subscription template
DEL
Cancel an existing grab
GET
Get a single subscription
PUT
Edit a subscription
DEL
Delete a subscription
PUT
Re-order a subscription
Transcoder
GET
Transcode an image
GET
Make a decision on media playback
POST
Manually trigger a transcoder fallback
GET
Transcode subtitles
GET
Start A Transcoding Session
Playlist
GET
List playlists
GET
Retrieve Playlist
GET
Retrieve Playlist Contents
Library Playlists
POST
Create a Playlist
POST
Upload
PUT
Editing a Playlist
DEL
Delete a Playlist
GET
Get a playlist's generators
PUT
Adding to a Playlist
DEL
Clearing a playlist
GET
Get a playlist generator
PUT
Modify a Generator
DEL
Delete a Generator
GET
Get a playlist generator's items
PUT
Moving items in a playlist
PUT
Reprocess a generator
Play Queue
POST
Create a play queue
GET
Retrieve a play queue
PUT
Add a generator or playlist to a play queue
DEL
Clear a play queue
PUT
Reset a play queue
PUT
Shuffle a play queue
PUT
Unshuffle a play queue
DEL
Delete an item from a play queue
PUT
Move an item in a play queue
UltraBlur
GET
Get UltraBlur Colors
GET
Get UltraBlur Image
Status
GET
List Sessions
GET
Get background tasks
GET
List Playback History
POST
Terminate a session
GET
Get Single History Item
DEL
Delete Single History Item
Updater
PUT
Applying updates
PUT
Checking for updates
GET
Querying status of updates
Content
GET
Get items in a collection
GET
Get a metadata item
GET
Set section albums
GET
Get items in the section
GET
Set section leaves
GET
Set section artwork
GET
Set section categories
GET
Set section clusters
GET
Similar tracks to transition from one to another
GET
Get all folder locations
GET
Set section moments
GET
The nearest audio tracks
GET
Get a collection's image
Library Collections
PUT
Add items to a collection
PUT
Delete an item from a collection
PUT
Reorder an item in the collection
Butler
Start a single butler task
Was this page helpful?
Yes
No
Suggest edits
Raise issue
Stop all Butler tasks
Stop a single butler task
⌘I