diff --git a/static/plex-api-spec-dereferenced.yaml b/static/plex-api-spec-dereferenced.yaml index 9425590..fbf3830 100644 --- a/static/plex-api-spec-dereferenced.yaml +++ b/static/plex-api-spec-dereferenced.yaml @@ -29,12 +29,17 @@ servers: description: The port to access your plex server security: - PlexToken: [] + PlexClientIdentifier: [] components: securitySchemes: PlexToken: type: apiKey in: header name: X-Plex-Token + PlexClientIdentifier: + type: apiKey + in: header + name: X-Plex-Client-Identifier paths: /: get: @@ -43,6 +48,75 @@ paths: summary: Server Capabilities description: Server Capabilities operationId: getServerCapabilities + parameters: + - in: header + name: X-Plex-Device-Name + description: Primary name for the device eg. `Plex Web (Chrome)` + schema: + type: string + example: Plex Web (Chrome) + required: false + - in: header + name: X-Plex-Device + description: | + The type of device your application is running on + Device name and or model number, eg `iPhone3,2`, `Motorola XOOM™`, `LG5200TV` + schema: + type: string + example: + - 'iPhone3,2' + - Motorola XOOM™ + - LG5200TV + required: false + - in: header + name: X-Plex-Platform-Version + description: 'Operating system version, eg `4.3.1`, `10.6.7`, `3.2`' + schema: + type: string + example: + - 4.3.1 + - 10.6.7 + - 3.2 + required: false + - in: header + name: X-Plex-Platform + description: 'Platform name, eg `Web`, `iOS`, `MacOSX`, `Android`, `LG`' + schema: + type: string + example: + - Web + - iOS + - MacOSX + - Android + - LG + required: false + - in: header + name: X-Plex-Product + description: 'Plex application name, eg `Laika`, `Plex Media Server`, `Media Link`' + schema: + type: string + example: + - Laika + - Plex Media Server + - Media Link + required: false + - in: header + name: X-Plex-Provides + description: 'One or more of `[player, controller, server]`' + schema: + type: string + example: + - iOS + - MacOSX + - Android + - LG + required: false + - in: header + name: X-Plex-Version + description: Your application version number + schema: + type: string + required: false responses: '200': description: The Server Capabilities @@ -193,6 +267,75 @@ paths: summary: Get Available Clients description: Get Available Clients operationId: getAvailableClients + parameters: + - in: header + name: X-Plex-Device-Name + description: Primary name for the device eg. `Plex Web (Chrome)` + schema: + type: string + example: Plex Web (Chrome) + required: false + - in: header + name: X-Plex-Device + description: | + The type of device your application is running on + Device name and or model number, eg `iPhone3,2`, `Motorola XOOM™`, `LG5200TV` + schema: + type: string + example: + - 'iPhone3,2' + - Motorola XOOM™ + - LG5200TV + required: false + - in: header + name: X-Plex-Platform-Version + description: 'Operating system version, eg `4.3.1`, `10.6.7`, `3.2`' + schema: + type: string + example: + - 4.3.1 + - 10.6.7 + - 3.2 + required: false + - in: header + name: X-Plex-Platform + description: 'Platform name, eg `Web`, `iOS`, `MacOSX`, `Android`, `LG`' + schema: + type: string + example: + - Web + - iOS + - MacOSX + - Android + - LG + required: false + - in: header + name: X-Plex-Product + description: 'Plex application name, eg `Laika`, `Plex Media Server`, `Media Link`' + schema: + type: string + example: + - Laika + - Plex Media Server + - Media Link + required: false + - in: header + name: X-Plex-Provides + description: 'One or more of `[player, controller, server]`' + schema: + type: string + example: + - iOS + - MacOSX + - Android + - LG + required: false + - in: header + name: X-Plex-Version + description: Your application version number + schema: + type: string + required: false responses: '200': description: Available Clients @@ -272,9 +415,78 @@ paths: get: tags: - Activities - summary: Server Activities - description: Server Activities + summary: Get Server Activities + description: Get Server Activities operationId: getServerActivities + parameters: + - in: header + name: X-Plex-Device-Name + description: Primary name for the device eg. `Plex Web (Chrome)` + schema: + type: string + example: Plex Web (Chrome) + required: false + - in: header + name: X-Plex-Device + description: | + The type of device your application is running on + Device name and or model number, eg `iPhone3,2`, `Motorola XOOM™`, `LG5200TV` + schema: + type: string + example: + - 'iPhone3,2' + - Motorola XOOM™ + - LG5200TV + required: false + - in: header + name: X-Plex-Platform-Version + description: 'Operating system version, eg `4.3.1`, `10.6.7`, `3.2`' + schema: + type: string + example: + - 4.3.1 + - 10.6.7 + - 3.2 + required: false + - in: header + name: X-Plex-Platform + description: 'Platform name, eg `Web`, `iOS`, `MacOSX`, `Android`, `LG`' + schema: + type: string + example: + - Web + - iOS + - MacOSX + - Android + - LG + required: false + - in: header + name: X-Plex-Product + description: 'Plex application name, eg `Laika`, `Plex Media Server`, `Media Link`' + schema: + type: string + example: + - Laika + - Plex Media Server + - Media Link + required: false + - in: header + name: X-Plex-Provides + description: 'One or more of `[player, controller, server]`' + schema: + type: string + example: + - iOS + - MacOSX + - Android + - LG + required: false + - in: header + name: X-Plex-Version + description: Your application version number + schema: + type: string + required: false responses: '200': description: The Server Activities @@ -348,6 +560,74 @@ paths: type: string example: 25b71ed5-0f9d-461c-baa7-d404e9e10d3e required: true + - in: header + name: X-Plex-Device-Name + description: Primary name for the device eg. `Plex Web (Chrome)` + schema: + type: string + example: Plex Web (Chrome) + required: false + - in: header + name: X-Plex-Device + description: | + The type of device your application is running on + Device name and or model number, eg `iPhone3,2`, `Motorola XOOM™`, `LG5200TV` + schema: + type: string + example: + - 'iPhone3,2' + - Motorola XOOM™ + - LG5200TV + required: false + - in: header + name: X-Plex-Platform-Version + description: 'Operating system version, eg `4.3.1`, `10.6.7`, `3.2`' + schema: + type: string + example: + - 4.3.1 + - 10.6.7 + - 3.2 + required: false + - in: header + name: X-Plex-Platform + description: 'Platform name, eg `Web`, `iOS`, `MacOSX`, `Android`, `LG`' + schema: + type: string + example: + - Web + - iOS + - MacOSX + - Android + - LG + required: false + - in: header + name: X-Plex-Product + description: 'Plex application name, eg `Laika`, `Plex Media Server`, `Media Link`' + schema: + type: string + example: + - Laika + - Plex Media Server + - Media Link + required: false + - in: header + name: X-Plex-Provides + description: 'One or more of `[player, controller, server]`' + schema: + type: string + example: + - iOS + - MacOSX + - Android + - LG + required: false + - in: header + name: X-Plex-Version + description: Your application version number + schema: + type: string + required: false responses: '200': description: The Server Activity was canceled @@ -379,6 +659,75 @@ paths: summary: Querying status of updates description: Querying status of updates operationId: queryUpdateStatus + parameters: + - in: header + name: X-Plex-Device-Name + description: Primary name for the device eg. `Plex Web (Chrome)` + schema: + type: string + example: Plex Web (Chrome) + required: false + - in: header + name: X-Plex-Device + description: | + The type of device your application is running on + Device name and or model number, eg `iPhone3,2`, `Motorola XOOM™`, `LG5200TV` + schema: + type: string + example: + - 'iPhone3,2' + - Motorola XOOM™ + - LG5200TV + required: false + - in: header + name: X-Plex-Platform-Version + description: 'Operating system version, eg `4.3.1`, `10.6.7`, `3.2`' + schema: + type: string + example: + - 4.3.1 + - 10.6.7 + - 3.2 + required: false + - in: header + name: X-Plex-Platform + description: 'Platform name, eg `Web`, `iOS`, `MacOSX`, `Android`, `LG`' + schema: + type: string + example: + - Web + - iOS + - MacOSX + - Android + - LG + required: false + - in: header + name: X-Plex-Product + description: 'Plex application name, eg `Laika`, `Plex Media Server`, `Media Link`' + schema: + type: string + example: + - Laika + - Plex Media Server + - Media Link + required: false + - in: header + name: X-Plex-Provides + description: 'One or more of `[player, controller, server]`' + schema: + type: string + example: + - iOS + - MacOSX + - Android + - LG + required: false + - in: header + name: X-Plex-Version + description: Your application version number + schema: + type: string + required: false responses: '200': description: The Server Updates @@ -420,6 +769,74 @@ paths: - 0 - 1 example: 1 + - in: header + name: X-Plex-Device-Name + description: Primary name for the device eg. `Plex Web (Chrome)` + schema: + type: string + example: Plex Web (Chrome) + required: false + - in: header + name: X-Plex-Device + description: | + The type of device your application is running on + Device name and or model number, eg `iPhone3,2`, `Motorola XOOM™`, `LG5200TV` + schema: + type: string + example: + - 'iPhone3,2' + - Motorola XOOM™ + - LG5200TV + required: false + - in: header + name: X-Plex-Platform-Version + description: 'Operating system version, eg `4.3.1`, `10.6.7`, `3.2`' + schema: + type: string + example: + - 4.3.1 + - 10.6.7 + - 3.2 + required: false + - in: header + name: X-Plex-Platform + description: 'Platform name, eg `Web`, `iOS`, `MacOSX`, `Android`, `LG`' + schema: + type: string + example: + - Web + - iOS + - MacOSX + - Android + - LG + required: false + - in: header + name: X-Plex-Product + description: 'Plex application name, eg `Laika`, `Plex Media Server`, `Media Link`' + schema: + type: string + example: + - Laika + - Plex Media Server + - Media Link + required: false + - in: header + name: X-Plex-Provides + description: 'One or more of `[player, controller, server]`' + schema: + type: string + example: + - iOS + - MacOSX + - Android + - LG + required: false + - in: header + name: X-Plex-Version + description: Your application version number + schema: + type: string + required: false responses: '200': description: '' @@ -471,6 +888,74 @@ paths: - 0 - 1 example: 1 + - in: header + name: X-Plex-Device-Name + description: Primary name for the device eg. `Plex Web (Chrome)` + schema: + type: string + example: Plex Web (Chrome) + required: false + - in: header + name: X-Plex-Device + description: | + The type of device your application is running on + Device name and or model number, eg `iPhone3,2`, `Motorola XOOM™`, `LG5200TV` + schema: + type: string + example: + - 'iPhone3,2' + - Motorola XOOM™ + - LG5200TV + required: false + - in: header + name: X-Plex-Platform-Version + description: 'Operating system version, eg `4.3.1`, `10.6.7`, `3.2`' + schema: + type: string + example: + - 4.3.1 + - 10.6.7 + - 3.2 + required: false + - in: header + name: X-Plex-Platform + description: 'Platform name, eg `Web`, `iOS`, `MacOSX`, `Android`, `LG`' + schema: + type: string + example: + - Web + - iOS + - MacOSX + - Android + - LG + required: false + - in: header + name: X-Plex-Product + description: 'Plex application name, eg `Laika`, `Plex Media Server`, `Media Link`' + schema: + type: string + example: + - Laika + - Plex Media Server + - Media Link + required: false + - in: header + name: X-Plex-Provides + description: 'One or more of `[player, controller, server]`' + schema: + type: string + example: + - iOS + - MacOSX + - Android + - LG + required: false + - in: header + name: X-Plex-Version + description: Your application version number + schema: + type: string + required: false responses: '200': description: If the update process started correctly @@ -509,6 +994,75 @@ paths: 3. If a task is configured to run at a random time during the configured window and we are within that window, the task will be scheduled at a random time within the window. 4. If we are outside the configured window, the task will start immediately. operationId: startAllTasks + parameters: + - in: header + name: X-Plex-Device-Name + description: Primary name for the device eg. `Plex Web (Chrome)` + schema: + type: string + example: Plex Web (Chrome) + required: false + - in: header + name: X-Plex-Device + description: | + The type of device your application is running on + Device name and or model number, eg `iPhone3,2`, `Motorola XOOM™`, `LG5200TV` + schema: + type: string + example: + - 'iPhone3,2' + - Motorola XOOM™ + - LG5200TV + required: false + - in: header + name: X-Plex-Platform-Version + description: 'Operating system version, eg `4.3.1`, `10.6.7`, `3.2`' + schema: + type: string + example: + - 4.3.1 + - 10.6.7 + - 3.2 + required: false + - in: header + name: X-Plex-Platform + description: 'Platform name, eg `Web`, `iOS`, `MacOSX`, `Android`, `LG`' + schema: + type: string + example: + - Web + - iOS + - MacOSX + - Android + - LG + required: false + - in: header + name: X-Plex-Product + description: 'Plex application name, eg `Laika`, `Plex Media Server`, `Media Link`' + schema: + type: string + example: + - Laika + - Plex Media Server + - Media Link + required: false + - in: header + name: X-Plex-Provides + description: 'One or more of `[player, controller, server]`' + schema: + type: string + example: + - iOS + - MacOSX + - Android + - LG + required: false + - in: header + name: X-Plex-Version + description: Your application version number + schema: + type: string + required: false responses: '200': description: All tasks were started @@ -598,6 +1152,74 @@ paths: - RefreshPeriodicMetadata - UpgradeMediaAnalysis required: true + - in: header + name: X-Plex-Device-Name + description: Primary name for the device eg. `Plex Web (Chrome)` + schema: + type: string + example: Plex Web (Chrome) + required: false + - in: header + name: X-Plex-Device + description: | + The type of device your application is running on + Device name and or model number, eg `iPhone3,2`, `Motorola XOOM™`, `LG5200TV` + schema: + type: string + example: + - 'iPhone3,2' + - Motorola XOOM™ + - LG5200TV + required: false + - in: header + name: X-Plex-Platform-Version + description: 'Operating system version, eg `4.3.1`, `10.6.7`, `3.2`' + schema: + type: string + example: + - 4.3.1 + - 10.6.7 + - 3.2 + required: false + - in: header + name: X-Plex-Platform + description: 'Platform name, eg `Web`, `iOS`, `MacOSX`, `Android`, `LG`' + schema: + type: string + example: + - Web + - iOS + - MacOSX + - Android + - LG + required: false + - in: header + name: X-Plex-Product + description: 'Plex application name, eg `Laika`, `Plex Media Server`, `Media Link`' + schema: + type: string + example: + - Laika + - Plex Media Server + - Media Link + required: false + - in: header + name: X-Plex-Provides + description: 'One or more of `[player, controller, server]`' + schema: + type: string + example: + - iOS + - MacOSX + - Android + - LG + required: false + - in: header + name: X-Plex-Version + description: Your application version number + schema: + type: string + required: false responses: '200': description: The task was started successfully @@ -653,6 +1275,74 @@ paths: - RefreshPeriodicMetadata - UpgradeMediaAnalysis required: true + - in: header + name: X-Plex-Device-Name + description: Primary name for the device eg. `Plex Web (Chrome)` + schema: + type: string + example: Plex Web (Chrome) + required: false + - in: header + name: X-Plex-Device + description: | + The type of device your application is running on + Device name and or model number, eg `iPhone3,2`, `Motorola XOOM™`, `LG5200TV` + schema: + type: string + example: + - 'iPhone3,2' + - Motorola XOOM™ + - LG5200TV + required: false + - in: header + name: X-Plex-Platform-Version + description: 'Operating system version, eg `4.3.1`, `10.6.7`, `3.2`' + schema: + type: string + example: + - 4.3.1 + - 10.6.7 + - 3.2 + required: false + - in: header + name: X-Plex-Platform + description: 'Platform name, eg `Web`, `iOS`, `MacOSX`, `Android`, `LG`' + schema: + type: string + example: + - Web + - iOS + - MacOSX + - Android + - LG + required: false + - in: header + name: X-Plex-Product + description: 'Plex application name, eg `Laika`, `Plex Media Server`, `Media Link`' + schema: + type: string + example: + - Laika + - Plex Media Server + - Media Link + required: false + - in: header + name: X-Plex-Provides + description: 'One or more of `[player, controller, server]`' + schema: + type: string + example: + - iOS + - MacOSX + - Android + - LG + required: false + - in: header + name: X-Plex-Version + description: Your application version number + schema: + type: string + required: false responses: '200': description: The task was stopped @@ -720,6 +1410,74 @@ paths: type: string example: '' required: true + - in: header + name: X-Plex-Device-Name + description: Primary name for the device eg. `Plex Web (Chrome)` + schema: + type: string + example: Plex Web (Chrome) + required: false + - in: header + name: X-Plex-Device + description: | + The type of device your application is running on + Device name and or model number, eg `iPhone3,2`, `Motorola XOOM™`, `LG5200TV` + schema: + type: string + example: + - 'iPhone3,2' + - Motorola XOOM™ + - LG5200TV + required: false + - in: header + name: X-Plex-Platform-Version + description: 'Operating system version, eg `4.3.1`, `10.6.7`, `3.2`' + schema: + type: string + example: + - 4.3.1 + - 10.6.7 + - 3.2 + required: false + - in: header + name: X-Plex-Platform + description: 'Platform name, eg `Web`, `iOS`, `MacOSX`, `Android`, `LG`' + schema: + type: string + example: + - Web + - iOS + - MacOSX + - Android + - LG + required: false + - in: header + name: X-Plex-Product + description: 'Plex application name, eg `Laika`, `Plex Media Server`, `Media Link`' + schema: + type: string + example: + - Laika + - Plex Media Server + - Media Link + required: false + - in: header + name: X-Plex-Provides + description: 'One or more of `[player, controller, server]`' + schema: + type: string + example: + - iOS + - MacOSX + - Android + - LG + required: false + - in: header + name: X-Plex-Version + description: Your application version number + schema: + type: string + required: false responses: '200': description: Log Line submitted successfully @@ -751,6 +1509,75 @@ paths: description: | This endpoint will write multiple lines to the main Plex Media Server log in a single request. It takes a set of query strings as would normally sent to the above GET endpoint as a linefeed-separated block of POST data. The parameters for each query string match as above. operationId: logMultiLine + parameters: + - in: header + name: X-Plex-Device-Name + description: Primary name for the device eg. `Plex Web (Chrome)` + schema: + type: string + example: Plex Web (Chrome) + required: false + - in: header + name: X-Plex-Device + description: | + The type of device your application is running on + Device name and or model number, eg `iPhone3,2`, `Motorola XOOM™`, `LG5200TV` + schema: + type: string + example: + - 'iPhone3,2' + - Motorola XOOM™ + - LG5200TV + required: false + - in: header + name: X-Plex-Platform-Version + description: 'Operating system version, eg `4.3.1`, `10.6.7`, `3.2`' + schema: + type: string + example: + - 4.3.1 + - 10.6.7 + - 3.2 + required: false + - in: header + name: X-Plex-Platform + description: 'Platform name, eg `Web`, `iOS`, `MacOSX`, `Android`, `LG`' + schema: + type: string + example: + - Web + - iOS + - MacOSX + - Android + - LG + required: false + - in: header + name: X-Plex-Product + description: 'Plex application name, eg `Laika`, `Plex Media Server`, `Media Link`' + schema: + type: string + example: + - Laika + - Plex Media Server + - Media Link + required: false + - in: header + name: X-Plex-Provides + description: 'One or more of `[player, controller, server]`' + schema: + type: string + example: + - iOS + - MacOSX + - Android + - LG + required: false + - in: header + name: X-Plex-Version + description: Your application version number + schema: + type: string + required: false responses: '200': description: Multi-Line Log Message Posted successfully @@ -783,6 +1610,75 @@ paths: description: | This endpoint will enable all Plex Media Serverlogs to be sent to the Papertrail networked logging site for a period of time. operationId: enablePaperTrail + parameters: + - in: header + name: X-Plex-Device-Name + description: Primary name for the device eg. `Plex Web (Chrome)` + schema: + type: string + example: Plex Web (Chrome) + required: false + - in: header + name: X-Plex-Device + description: | + The type of device your application is running on + Device name and or model number, eg `iPhone3,2`, `Motorola XOOM™`, `LG5200TV` + schema: + type: string + example: + - 'iPhone3,2' + - Motorola XOOM™ + - LG5200TV + required: false + - in: header + name: X-Plex-Platform-Version + description: 'Operating system version, eg `4.3.1`, `10.6.7`, `3.2`' + schema: + type: string + example: + - 4.3.1 + - 10.6.7 + - 3.2 + required: false + - in: header + name: X-Plex-Platform + description: 'Platform name, eg `Web`, `iOS`, `MacOSX`, `Android`, `LG`' + schema: + type: string + example: + - Web + - iOS + - MacOSX + - Android + - LG + required: false + - in: header + name: X-Plex-Product + description: 'Plex application name, eg `Laika`, `Plex Media Server`, `Media Link`' + schema: + type: string + example: + - Laika + - Plex Media Server + - Media Link + required: false + - in: header + name: X-Plex-Provides + description: 'One or more of `[player, controller, server]`' + schema: + type: string + example: + - iOS + - MacOSX + - Android + - LG + required: false + - in: header + name: X-Plex-Version + description: Your application version number + schema: + type: string + required: false responses: '200': description: Papertrail enabled successfully @@ -834,6 +1730,74 @@ paths: enum: - all required: true + - in: header + name: X-Plex-Device-Name + description: Primary name for the device eg. `Plex Web (Chrome)` + schema: + type: string + example: Plex Web (Chrome) + required: false + - in: header + name: X-Plex-Device + description: | + The type of device your application is running on + Device name and or model number, eg `iPhone3,2`, `Motorola XOOM™`, `LG5200TV` + schema: + type: string + example: + - 'iPhone3,2' + - Motorola XOOM™ + - LG5200TV + required: false + - in: header + name: X-Plex-Platform-Version + description: 'Operating system version, eg `4.3.1`, `10.6.7`, `3.2`' + schema: + type: string + example: + - 4.3.1 + - 10.6.7 + - 3.2 + required: false + - in: header + name: X-Plex-Platform + description: 'Platform name, eg `Web`, `iOS`, `MacOSX`, `Android`, `LG`' + schema: + type: string + example: + - Web + - iOS + - MacOSX + - Android + - LG + required: false + - in: header + name: X-Plex-Product + description: 'Plex application name, eg `Laika`, `Plex Media Server`, `Media Link`' + schema: + type: string + example: + - Laika + - Plex Media Server + - Media Link + required: false + - in: header + name: X-Plex-Provides + description: 'One or more of `[player, controller, server]`' + schema: + type: string + example: + - iOS + - MacOSX + - Android + - LG + required: false + - in: header + name: X-Plex-Version + description: Your application version number + schema: + type: string + required: false responses: '200': description: A Transient Token @@ -877,6 +1841,74 @@ paths: - 'server://client-identifier' - 'provider://provider-identifier' required: true + - in: header + name: X-Plex-Device-Name + description: Primary name for the device eg. `Plex Web (Chrome)` + schema: + type: string + example: Plex Web (Chrome) + required: false + - in: header + name: X-Plex-Device + description: | + The type of device your application is running on + Device name and or model number, eg `iPhone3,2`, `Motorola XOOM™`, `LG5200TV` + schema: + type: string + example: + - 'iPhone3,2' + - Motorola XOOM™ + - LG5200TV + required: false + - in: header + name: X-Plex-Platform-Version + description: 'Operating system version, eg `4.3.1`, `10.6.7`, `3.2`' + schema: + type: string + example: + - 4.3.1 + - 10.6.7 + - 3.2 + required: false + - in: header + name: X-Plex-Platform + description: 'Platform name, eg `Web`, `iOS`, `MacOSX`, `Android`, `LG`' + schema: + type: string + example: + - Web + - iOS + - MacOSX + - Android + - LG + required: false + - in: header + name: X-Plex-Product + description: 'Plex application name, eg `Laika`, `Plex Media Server`, `Media Link`' + schema: + type: string + example: + - Laika + - Plex Media Server + - Media Link + required: false + - in: header + name: X-Plex-Provides + description: 'One or more of `[player, controller, server]`' + schema: + type: string + example: + - iOS + - MacOSX + - Android + - LG + required: false + - in: header + name: X-Plex-Version + description: Your application version number + schema: + type: string + required: false responses: '200': description: Source Connection Information @@ -928,6 +1960,74 @@ paths: schema: type: string required: false + - in: header + name: X-Plex-Device-Name + description: Primary name for the device eg. `Plex Web (Chrome)` + schema: + type: string + example: Plex Web (Chrome) + required: false + - in: header + name: X-Plex-Device + description: | + The type of device your application is running on + Device name and or model number, eg `iPhone3,2`, `Motorola XOOM™`, `LG5200TV` + schema: + type: string + example: + - 'iPhone3,2' + - Motorola XOOM™ + - LG5200TV + required: false + - in: header + name: X-Plex-Platform-Version + description: 'Operating system version, eg `4.3.1`, `10.6.7`, `3.2`' + schema: + type: string + example: + - 4.3.1 + - 10.6.7 + - 3.2 + required: false + - in: header + name: X-Plex-Platform + description: 'Platform name, eg `Web`, `iOS`, `MacOSX`, `Android`, `LG`' + schema: + type: string + example: + - Web + - iOS + - MacOSX + - Android + - LG + required: false + - in: header + name: X-Plex-Product + description: 'Plex application name, eg `Laika`, `Plex Media Server`, `Media Link`' + schema: + type: string + example: + - Laika + - Plex Media Server + - Media Link + required: false + - in: header + name: X-Plex-Provides + description: 'One or more of `[player, controller, server]`' + schema: + type: string + example: + - iOS + - MacOSX + - Android + - LG + required: false + - in: header + name: X-Plex-Version + description: Your application version number + schema: + type: string + required: false responses: '200': description: The details of the library @@ -967,6 +2067,74 @@ paths: schema: type: number required: true + - in: header + name: X-Plex-Device-Name + description: Primary name for the device eg. `Plex Web (Chrome)` + schema: + type: string + example: Plex Web (Chrome) + required: false + - in: header + name: X-Plex-Device + description: | + The type of device your application is running on + Device name and or model number, eg `iPhone3,2`, `Motorola XOOM™`, `LG5200TV` + schema: + type: string + example: + - 'iPhone3,2' + - Motorola XOOM™ + - LG5200TV + required: false + - in: header + name: X-Plex-Platform-Version + description: 'Operating system version, eg `4.3.1`, `10.6.7`, `3.2`' + schema: + type: string + example: + - 4.3.1 + - 10.6.7 + - 3.2 + required: false + - in: header + name: X-Plex-Platform + description: 'Platform name, eg `Web`, `iOS`, `MacOSX`, `Android`, `LG`' + schema: + type: string + example: + - Web + - iOS + - MacOSX + - Android + - LG + required: false + - in: header + name: X-Plex-Product + description: 'Plex application name, eg `Laika`, `Plex Media Server`, `Media Link`' + schema: + type: string + example: + - Laika + - Plex Media Server + - Media Link + required: false + - in: header + name: X-Plex-Provides + description: 'One or more of `[player, controller, server]`' + schema: + type: string + example: + - iOS + - MacOSX + - Android + - LG + required: false + - in: header + name: X-Plex-Version + description: Your application version number + schema: + type: string + required: false responses: '200': description: The library is refreshing @@ -1018,6 +2186,74 @@ paths: schema: type: string required: false + - in: header + name: X-Plex-Device-Name + description: Primary name for the device eg. `Plex Web (Chrome)` + schema: + type: string + example: Plex Web (Chrome) + required: false + - in: header + name: X-Plex-Device + description: | + The type of device your application is running on + Device name and or model number, eg `iPhone3,2`, `Motorola XOOM™`, `LG5200TV` + schema: + type: string + example: + - 'iPhone3,2' + - Motorola XOOM™ + - LG5200TV + required: false + - in: header + name: X-Plex-Platform-Version + description: 'Operating system version, eg `4.3.1`, `10.6.7`, `3.2`' + schema: + type: string + example: + - 4.3.1 + - 10.6.7 + - 3.2 + required: false + - in: header + name: X-Plex-Platform + description: 'Platform name, eg `Web`, `iOS`, `MacOSX`, `Android`, `LG`' + schema: + type: string + example: + - Web + - iOS + - MacOSX + - Android + - LG + required: false + - in: header + name: X-Plex-Product + description: 'Plex application name, eg `Laika`, `Plex Media Server`, `Media Link`' + schema: + type: string + example: + - Laika + - Plex Media Server + - Media Link + required: false + - in: header + name: X-Plex-Provides + description: 'One or more of `[player, controller, server]`' + schema: + type: string + example: + - iOS + - MacOSX + - Android + - LG + required: false + - in: header + name: X-Plex-Version + description: Your application version number + schema: + type: string + required: false responses: '200': description: The details of the library @@ -1069,6 +2305,74 @@ paths: schema: type: string required: false + - in: header + name: X-Plex-Device-Name + description: Primary name for the device eg. `Plex Web (Chrome)` + schema: + type: string + example: Plex Web (Chrome) + required: false + - in: header + name: X-Plex-Device + description: | + The type of device your application is running on + Device name and or model number, eg `iPhone3,2`, `Motorola XOOM™`, `LG5200TV` + schema: + type: string + example: + - 'iPhone3,2' + - Motorola XOOM™ + - LG5200TV + required: false + - in: header + name: X-Plex-Platform-Version + description: 'Operating system version, eg `4.3.1`, `10.6.7`, `3.2`' + schema: + type: string + example: + - 4.3.1 + - 10.6.7 + - 3.2 + required: false + - in: header + name: X-Plex-Platform + description: 'Platform name, eg `Web`, `iOS`, `MacOSX`, `Android`, `LG`' + schema: + type: string + example: + - Web + - iOS + - MacOSX + - Android + - LG + required: false + - in: header + name: X-Plex-Product + description: 'Plex application name, eg `Laika`, `Plex Media Server`, `Media Link`' + schema: + type: string + example: + - Laika + - Plex Media Server + - Media Link + required: false + - in: header + name: X-Plex-Provides + description: 'One or more of `[player, controller, server]`' + schema: + type: string + example: + - iOS + - MacOSX + - Android + - LG + required: false + - in: header + name: X-Plex-Version + description: Your application version number + schema: + type: string + required: false responses: '200': description: The details of the library @@ -1143,6 +2447,74 @@ paths: - 1 default: 0 required: false + - in: header + name: X-Plex-Device-Name + description: Primary name for the device eg. `Plex Web (Chrome)` + schema: + type: string + example: Plex Web (Chrome) + required: false + - in: header + name: X-Plex-Device + description: | + The type of device your application is running on + Device name and or model number, eg `iPhone3,2`, `Motorola XOOM™`, `LG5200TV` + schema: + type: string + example: + - 'iPhone3,2' + - Motorola XOOM™ + - LG5200TV + required: false + - in: header + name: X-Plex-Platform-Version + description: 'Operating system version, eg `4.3.1`, `10.6.7`, `3.2`' + schema: + type: string + example: + - 4.3.1 + - 10.6.7 + - 3.2 + required: false + - in: header + name: X-Plex-Platform + description: 'Platform name, eg `Web`, `iOS`, `MacOSX`, `Android`, `LG`' + schema: + type: string + example: + - Web + - iOS + - MacOSX + - Android + - LG + required: false + - in: header + name: X-Plex-Product + description: 'Plex application name, eg `Laika`, `Plex Media Server`, `Media Link`' + schema: + type: string + example: + - Laika + - Plex Media Server + - Media Link + required: false + - in: header + name: X-Plex-Provides + description: 'One or more of `[player, controller, server]`' + schema: + type: string + example: + - iOS + - MacOSX + - Android + - LG + required: false + - in: header + name: X-Plex-Version + description: Your application version number + schema: + type: string + required: false responses: '200': description: The details of the library @@ -1173,6 +2545,75 @@ paths: - Library summary: Get All Libraries operationId: getLibraries + parameters: + - in: header + name: X-Plex-Device-Name + description: Primary name for the device eg. `Plex Web (Chrome)` + schema: + type: string + example: Plex Web (Chrome) + required: false + - in: header + name: X-Plex-Device + description: | + The type of device your application is running on + Device name and or model number, eg `iPhone3,2`, `Motorola XOOM™`, `LG5200TV` + schema: + type: string + example: + - 'iPhone3,2' + - Motorola XOOM™ + - LG5200TV + required: false + - in: header + name: X-Plex-Platform-Version + description: 'Operating system version, eg `4.3.1`, `10.6.7`, `3.2`' + schema: + type: string + example: + - 4.3.1 + - 10.6.7 + - 3.2 + required: false + - in: header + name: X-Plex-Platform + description: 'Platform name, eg `Web`, `iOS`, `MacOSX`, `Android`, `LG`' + schema: + type: string + example: + - Web + - iOS + - MacOSX + - Android + - LG + required: false + - in: header + name: X-Plex-Product + description: 'Plex application name, eg `Laika`, `Plex Media Server`, `Media Link`' + schema: + type: string + example: + - Laika + - Plex Media Server + - Media Link + required: false + - in: header + name: X-Plex-Provides + description: 'One or more of `[player, controller, server]`' + schema: + type: string + example: + - iOS + - MacOSX + - Android + - LG + required: false + - in: header + name: X-Plex-Version + description: Your application version number + schema: + type: string + required: false description: | A library section (commonly referred to as just a library) is a collection of media. Libraries are typed, and depending on their type provide either a flat or a hierarchical view of the media. @@ -1225,6 +2666,74 @@ paths: schema: type: number required: false + - in: header + name: X-Plex-Device-Name + description: Primary name for the device eg. `Plex Web (Chrome)` + schema: + type: string + example: Plex Web (Chrome) + required: false + - in: header + name: X-Plex-Device + description: | + The type of device your application is running on + Device name and or model number, eg `iPhone3,2`, `Motorola XOOM™`, `LG5200TV` + schema: + type: string + example: + - 'iPhone3,2' + - Motorola XOOM™ + - LG5200TV + required: false + - in: header + name: X-Plex-Platform-Version + description: 'Operating system version, eg `4.3.1`, `10.6.7`, `3.2`' + schema: + type: string + example: + - 4.3.1 + - 10.6.7 + - 3.2 + required: false + - in: header + name: X-Plex-Platform + description: 'Platform name, eg `Web`, `iOS`, `MacOSX`, `Android`, `LG`' + schema: + type: string + example: + - Web + - iOS + - MacOSX + - Android + - LG + required: false + - in: header + name: X-Plex-Product + description: 'Plex application name, eg `Laika`, `Plex Media Server`, `Media Link`' + schema: + type: string + example: + - Laika + - Plex Media Server + - Media Link + required: false + - in: header + name: X-Plex-Provides + description: 'One or more of `[player, controller, server]`' + schema: + type: string + example: + - iOS + - MacOSX + - Android + - LG + required: false + - in: header + name: X-Plex-Version + description: Your application version number + schema: + type: string + required: false responses: '200': description: The hash of the file @@ -1257,6 +2766,75 @@ paths: description: | This endpoint will return the on deck content. operationId: getOnDeck + parameters: + - in: header + name: X-Plex-Device-Name + description: Primary name for the device eg. `Plex Web (Chrome)` + schema: + type: string + example: Plex Web (Chrome) + required: false + - in: header + name: X-Plex-Device + description: | + The type of device your application is running on + Device name and or model number, eg `iPhone3,2`, `Motorola XOOM™`, `LG5200TV` + schema: + type: string + example: + - 'iPhone3,2' + - Motorola XOOM™ + - LG5200TV + required: false + - in: header + name: X-Plex-Platform-Version + description: 'Operating system version, eg `4.3.1`, `10.6.7`, `3.2`' + schema: + type: string + example: + - 4.3.1 + - 10.6.7 + - 3.2 + required: false + - in: header + name: X-Plex-Platform + description: 'Platform name, eg `Web`, `iOS`, `MacOSX`, `Android`, `LG`' + schema: + type: string + example: + - Web + - iOS + - MacOSX + - Android + - LG + required: false + - in: header + name: X-Plex-Product + description: 'Plex application name, eg `Laika`, `Plex Media Server`, `Media Link`' + schema: + type: string + example: + - Laika + - Plex Media Server + - Media Link + required: false + - in: header + name: X-Plex-Provides + description: 'One or more of `[player, controller, server]`' + schema: + type: string + example: + - iOS + - MacOSX + - Android + - LG + required: false + - in: header + name: X-Plex-Version + description: Your application version number + schema: + type: string + required: false responses: '200': description: The on deck content @@ -1304,6 +2882,74 @@ paths: - 0 - 1 required: false + - in: header + name: X-Plex-Device-Name + description: Primary name for the device eg. `Plex Web (Chrome)` + schema: + type: string + example: Plex Web (Chrome) + required: false + - in: header + name: X-Plex-Device + description: | + The type of device your application is running on + Device name and or model number, eg `iPhone3,2`, `Motorola XOOM™`, `LG5200TV` + schema: + type: string + example: + - 'iPhone3,2' + - Motorola XOOM™ + - LG5200TV + required: false + - in: header + name: X-Plex-Platform-Version + description: 'Operating system version, eg `4.3.1`, `10.6.7`, `3.2`' + schema: + type: string + example: + - 4.3.1 + - 10.6.7 + - 3.2 + required: false + - in: header + name: X-Plex-Platform + description: 'Platform name, eg `Web`, `iOS`, `MacOSX`, `Android`, `LG`' + schema: + type: string + example: + - Web + - iOS + - MacOSX + - Android + - LG + required: false + - in: header + name: X-Plex-Product + description: 'Plex application name, eg `Laika`, `Plex Media Server`, `Media Link`' + schema: + type: string + example: + - Laika + - Plex Media Server + - Media Link + required: false + - in: header + name: X-Plex-Provides + description: 'One or more of `[player, controller, server]`' + schema: + type: string + example: + - iOS + - MacOSX + - Android + - LG + required: false + - in: header + name: X-Plex-Version + description: Your application version number + schema: + type: string + required: false responses: '200': description: returns global hubs @@ -1358,6 +3004,74 @@ paths: - 0 - 1 required: false + - in: header + name: X-Plex-Device-Name + description: Primary name for the device eg. `Plex Web (Chrome)` + schema: + type: string + example: Plex Web (Chrome) + required: false + - in: header + name: X-Plex-Device + description: | + The type of device your application is running on + Device name and or model number, eg `iPhone3,2`, `Motorola XOOM™`, `LG5200TV` + schema: + type: string + example: + - 'iPhone3,2' + - Motorola XOOM™ + - LG5200TV + required: false + - in: header + name: X-Plex-Platform-Version + description: 'Operating system version, eg `4.3.1`, `10.6.7`, `3.2`' + schema: + type: string + example: + - 4.3.1 + - 10.6.7 + - 3.2 + required: false + - in: header + name: X-Plex-Platform + description: 'Platform name, eg `Web`, `iOS`, `MacOSX`, `Android`, `LG`' + schema: + type: string + example: + - Web + - iOS + - MacOSX + - Android + - LG + required: false + - in: header + name: X-Plex-Product + description: 'Plex application name, eg `Laika`, `Plex Media Server`, `Media Link`' + schema: + type: string + example: + - Laika + - Plex Media Server + - Media Link + required: false + - in: header + name: X-Plex-Provides + description: 'One or more of `[player, controller, server]`' + schema: + type: string + example: + - iOS + - MacOSX + - Android + - LG + required: false + - in: header + name: X-Plex-Version + description: Your application version number + schema: + type: string + required: false responses: '200': description: The hubs specific to the library @@ -1409,6 +3123,74 @@ paths: - 0 - 1 required: false + - in: header + name: X-Plex-Device-Name + description: Primary name for the device eg. `Plex Web (Chrome)` + schema: + type: string + example: Plex Web (Chrome) + required: false + - in: header + name: X-Plex-Device + description: | + The type of device your application is running on + Device name and or model number, eg `iPhone3,2`, `Motorola XOOM™`, `LG5200TV` + schema: + type: string + example: + - 'iPhone3,2' + - Motorola XOOM™ + - LG5200TV + required: false + - in: header + name: X-Plex-Platform-Version + description: 'Operating system version, eg `4.3.1`, `10.6.7`, `3.2`' + schema: + type: string + example: + - 4.3.1 + - 10.6.7 + - 3.2 + required: false + - in: header + name: X-Plex-Platform + description: 'Platform name, eg `Web`, `iOS`, `MacOSX`, `Android`, `LG`' + schema: + type: string + example: + - Web + - iOS + - MacOSX + - Android + - LG + required: false + - in: header + name: X-Plex-Product + description: 'Plex application name, eg `Laika`, `Plex Media Server`, `Media Link`' + schema: + type: string + example: + - Laika + - Plex Media Server + - Media Link + required: false + - in: header + name: X-Plex-Provides + description: 'One or more of `[player, controller, server]`' + schema: + type: string + example: + - iOS + - MacOSX + - Android + - LG + required: false + - in: header + name: X-Plex-Version + description: Your application version number + schema: + type: string + required: false responses: '200': description: returns all playlists @@ -1481,6 +3263,74 @@ paths: schema: type: number required: false + - in: header + name: X-Plex-Device-Name + description: Primary name for the device eg. `Plex Web (Chrome)` + schema: + type: string + example: Plex Web (Chrome) + required: false + - in: header + name: X-Plex-Device + description: | + The type of device your application is running on + Device name and or model number, eg `iPhone3,2`, `Motorola XOOM™`, `LG5200TV` + schema: + type: string + example: + - 'iPhone3,2' + - Motorola XOOM™ + - LG5200TV + required: false + - in: header + name: X-Plex-Platform-Version + description: 'Operating system version, eg `4.3.1`, `10.6.7`, `3.2`' + schema: + type: string + example: + - 4.3.1 + - 10.6.7 + - 3.2 + required: false + - in: header + name: X-Plex-Platform + description: 'Platform name, eg `Web`, `iOS`, `MacOSX`, `Android`, `LG`' + schema: + type: string + example: + - Web + - iOS + - MacOSX + - Android + - LG + required: false + - in: header + name: X-Plex-Product + description: 'Plex application name, eg `Laika`, `Plex Media Server`, `Media Link`' + schema: + type: string + example: + - Laika + - Plex Media Server + - Media Link + required: false + - in: header + name: X-Plex-Provides + description: 'One or more of `[player, controller, server]`' + schema: + type: string + example: + - iOS + - MacOSX + - Android + - LG + required: false + - in: header + name: X-Plex-Version + description: Your application version number + schema: + type: string + required: false responses: '200': description: returns all playlists @@ -1521,6 +3371,74 @@ paths: schema: type: number required: true + - in: header + name: X-Plex-Device-Name + description: Primary name for the device eg. `Plex Web (Chrome)` + schema: + type: string + example: Plex Web (Chrome) + required: false + - in: header + name: X-Plex-Device + description: | + The type of device your application is running on + Device name and or model number, eg `iPhone3,2`, `Motorola XOOM™`, `LG5200TV` + schema: + type: string + example: + - 'iPhone3,2' + - Motorola XOOM™ + - LG5200TV + required: false + - in: header + name: X-Plex-Platform-Version + description: 'Operating system version, eg `4.3.1`, `10.6.7`, `3.2`' + schema: + type: string + example: + - 4.3.1 + - 10.6.7 + - 3.2 + required: false + - in: header + name: X-Plex-Platform + description: 'Platform name, eg `Web`, `iOS`, `MacOSX`, `Android`, `LG`' + schema: + type: string + example: + - Web + - iOS + - MacOSX + - Android + - LG + required: false + - in: header + name: X-Plex-Product + description: 'Plex application name, eg `Laika`, `Plex Media Server`, `Media Link`' + schema: + type: string + example: + - Laika + - Plex Media Server + - Media Link + required: false + - in: header + name: X-Plex-Provides + description: 'One or more of `[player, controller, server]`' + schema: + type: string + example: + - iOS + - MacOSX + - Android + - LG + required: false + - in: header + name: X-Plex-Version + description: Your application version number + schema: + type: string + required: false responses: '200': description: The playlist @@ -1559,6 +3477,74 @@ paths: schema: type: number required: true + - in: header + name: X-Plex-Device-Name + description: Primary name for the device eg. `Plex Web (Chrome)` + schema: + type: string + example: Plex Web (Chrome) + required: false + - in: header + name: X-Plex-Device + description: | + The type of device your application is running on + Device name and or model number, eg `iPhone3,2`, `Motorola XOOM™`, `LG5200TV` + schema: + type: string + example: + - 'iPhone3,2' + - Motorola XOOM™ + - LG5200TV + required: false + - in: header + name: X-Plex-Platform-Version + description: 'Operating system version, eg `4.3.1`, `10.6.7`, `3.2`' + schema: + type: string + example: + - 4.3.1 + - 10.6.7 + - 3.2 + required: false + - in: header + name: X-Plex-Platform + description: 'Platform name, eg `Web`, `iOS`, `MacOSX`, `Android`, `LG`' + schema: + type: string + example: + - Web + - iOS + - MacOSX + - Android + - LG + required: false + - in: header + name: X-Plex-Product + description: 'Plex application name, eg `Laika`, `Plex Media Server`, `Media Link`' + schema: + type: string + example: + - Laika + - Plex Media Server + - Media Link + required: false + - in: header + name: X-Plex-Provides + description: 'One or more of `[player, controller, server]`' + schema: + type: string + example: + - iOS + - MacOSX + - Android + - LG + required: false + - in: header + name: X-Plex-Version + description: Your application version number + schema: + type: string + required: false responses: '200': description: The playlist is deleted @@ -1645,6 +3631,74 @@ paths: schema: type: number required: true + - in: header + name: X-Plex-Device-Name + description: Primary name for the device eg. `Plex Web (Chrome)` + schema: + type: string + example: Plex Web (Chrome) + required: false + - in: header + name: X-Plex-Device + description: | + The type of device your application is running on + Device name and or model number, eg `iPhone3,2`, `Motorola XOOM™`, `LG5200TV` + schema: + type: string + example: + - 'iPhone3,2' + - Motorola XOOM™ + - LG5200TV + required: false + - in: header + name: X-Plex-Platform-Version + description: 'Operating system version, eg `4.3.1`, `10.6.7`, `3.2`' + schema: + type: string + example: + - 4.3.1 + - 10.6.7 + - 3.2 + required: false + - in: header + name: X-Plex-Platform + description: 'Platform name, eg `Web`, `iOS`, `MacOSX`, `Android`, `LG`' + schema: + type: string + example: + - Web + - iOS + - MacOSX + - Android + - LG + required: false + - in: header + name: X-Plex-Product + description: 'Plex application name, eg `Laika`, `Plex Media Server`, `Media Link`' + schema: + type: string + example: + - Laika + - Plex Media Server + - Media Link + required: false + - in: header + name: X-Plex-Provides + description: 'One or more of `[player, controller, server]`' + schema: + type: string + example: + - iOS + - MacOSX + - Android + - LG + required: false + - in: header + name: X-Plex-Version + description: Your application version number + schema: + type: string + required: false responses: '200': description: The playlist contents @@ -1683,6 +3737,74 @@ paths: schema: type: number required: true + - in: header + name: X-Plex-Device-Name + description: Primary name for the device eg. `Plex Web (Chrome)` + schema: + type: string + example: Plex Web (Chrome) + required: false + - in: header + name: X-Plex-Device + description: | + The type of device your application is running on + Device name and or model number, eg `iPhone3,2`, `Motorola XOOM™`, `LG5200TV` + schema: + type: string + example: + - 'iPhone3,2' + - Motorola XOOM™ + - LG5200TV + required: false + - in: header + name: X-Plex-Platform-Version + description: 'Operating system version, eg `4.3.1`, `10.6.7`, `3.2`' + schema: + type: string + example: + - 4.3.1 + - 10.6.7 + - 3.2 + required: false + - in: header + name: X-Plex-Platform + description: 'Platform name, eg `Web`, `iOS`, `MacOSX`, `Android`, `LG`' + schema: + type: string + example: + - Web + - iOS + - MacOSX + - Android + - LG + required: false + - in: header + name: X-Plex-Product + description: 'Plex application name, eg `Laika`, `Plex Media Server`, `Media Link`' + schema: + type: string + example: + - Laika + - Plex Media Server + - Media Link + required: false + - in: header + name: X-Plex-Provides + description: 'One or more of `[player, controller, server]`' + schema: + type: string + example: + - iOS + - MacOSX + - Android + - LG + required: false + - in: header + name: X-Plex-Version + description: Your application version number + schema: + type: string + required: false responses: '200': description: The playlist contents are cleared @@ -1736,6 +3858,74 @@ paths: type: number example: 123 required: true + - in: header + name: X-Plex-Device-Name + description: Primary name for the device eg. `Plex Web (Chrome)` + schema: + type: string + example: Plex Web (Chrome) + required: false + - in: header + name: X-Plex-Device + description: | + The type of device your application is running on + Device name and or model number, eg `iPhone3,2`, `Motorola XOOM™`, `LG5200TV` + schema: + type: string + example: + - 'iPhone3,2' + - Motorola XOOM™ + - LG5200TV + required: false + - in: header + name: X-Plex-Platform-Version + description: 'Operating system version, eg `4.3.1`, `10.6.7`, `3.2`' + schema: + type: string + example: + - 4.3.1 + - 10.6.7 + - 3.2 + required: false + - in: header + name: X-Plex-Platform + description: 'Platform name, eg `Web`, `iOS`, `MacOSX`, `Android`, `LG`' + schema: + type: string + example: + - Web + - iOS + - MacOSX + - Android + - LG + required: false + - in: header + name: X-Plex-Product + description: 'Plex application name, eg `Laika`, `Plex Media Server`, `Media Link`' + schema: + type: string + example: + - Laika + - Plex Media Server + - Media Link + required: false + - in: header + name: X-Plex-Provides + description: 'One or more of `[player, controller, server]`' + schema: + type: string + example: + - iOS + - MacOSX + - Android + - LG + required: false + - in: header + name: X-Plex-Version + description: Your application version number + schema: + type: string + required: false responses: '200': description: Playlist Updated @@ -1793,6 +3983,74 @@ paths: - 0 - 1 required: true + - in: header + name: X-Plex-Device-Name + description: Primary name for the device eg. `Plex Web (Chrome)` + schema: + type: string + example: Plex Web (Chrome) + required: false + - in: header + name: X-Plex-Device + description: | + The type of device your application is running on + Device name and or model number, eg `iPhone3,2`, `Motorola XOOM™`, `LG5200TV` + schema: + type: string + example: + - 'iPhone3,2' + - Motorola XOOM™ + - LG5200TV + required: false + - in: header + name: X-Plex-Platform-Version + description: 'Operating system version, eg `4.3.1`, `10.6.7`, `3.2`' + schema: + type: string + example: + - 4.3.1 + - 10.6.7 + - 3.2 + required: false + - in: header + name: X-Plex-Platform + description: 'Platform name, eg `Web`, `iOS`, `MacOSX`, `Android`, `LG`' + schema: + type: string + example: + - Web + - iOS + - MacOSX + - Android + - LG + required: false + - in: header + name: X-Plex-Product + description: 'Plex application name, eg `Laika`, `Plex Media Server`, `Media Link`' + schema: + type: string + example: + - Laika + - Plex Media Server + - Media Link + required: false + - in: header + name: X-Plex-Provides + description: 'One or more of `[player, controller, server]`' + schema: + type: string + example: + - iOS + - MacOSX + - Android + - LG + required: false + - in: header + name: X-Plex-Version + description: Your application version number + schema: + type: string + required: false responses: '200': description: The playlist is uploaded @@ -1859,6 +4117,74 @@ paths: type: number example: 5 default: 3 + - in: header + name: X-Plex-Device-Name + description: Primary name for the device eg. `Plex Web (Chrome)` + schema: + type: string + example: Plex Web (Chrome) + required: false + - in: header + name: X-Plex-Device + description: | + The type of device your application is running on + Device name and or model number, eg `iPhone3,2`, `Motorola XOOM™`, `LG5200TV` + schema: + type: string + example: + - 'iPhone3,2' + - Motorola XOOM™ + - LG5200TV + required: false + - in: header + name: X-Plex-Platform-Version + description: 'Operating system version, eg `4.3.1`, `10.6.7`, `3.2`' + schema: + type: string + example: + - 4.3.1 + - 10.6.7 + - 3.2 + required: false + - in: header + name: X-Plex-Platform + description: 'Platform name, eg `Web`, `iOS`, `MacOSX`, `Android`, `LG`' + schema: + type: string + example: + - Web + - iOS + - MacOSX + - Android + - LG + required: false + - in: header + name: X-Plex-Product + description: 'Plex application name, eg `Laika`, `Plex Media Server`, `Media Link`' + schema: + type: string + example: + - Laika + - Plex Media Server + - Media Link + required: false + - in: header + name: X-Plex-Provides + description: 'One or more of `[player, controller, server]`' + schema: + type: string + example: + - iOS + - MacOSX + - Android + - LG + required: false + - in: header + name: X-Plex-Version + description: Your application version number + schema: + type: string + required: false responses: '200': description: The search results @@ -1917,6 +4243,74 @@ paths: example: 5 default: 3 required: false + - in: header + name: X-Plex-Device-Name + description: Primary name for the device eg. `Plex Web (Chrome)` + schema: + type: string + example: Plex Web (Chrome) + required: false + - in: header + name: X-Plex-Device + description: | + The type of device your application is running on + Device name and or model number, eg `iPhone3,2`, `Motorola XOOM™`, `LG5200TV` + schema: + type: string + example: + - 'iPhone3,2' + - Motorola XOOM™ + - LG5200TV + required: false + - in: header + name: X-Plex-Platform-Version + description: 'Operating system version, eg `4.3.1`, `10.6.7`, `3.2`' + schema: + type: string + example: + - 4.3.1 + - 10.6.7 + - 3.2 + required: false + - in: header + name: X-Plex-Platform + description: 'Platform name, eg `Web`, `iOS`, `MacOSX`, `Android`, `LG`' + schema: + type: string + example: + - Web + - iOS + - MacOSX + - Android + - LG + required: false + - in: header + name: X-Plex-Product + description: 'Plex application name, eg `Laika`, `Plex Media Server`, `Media Link`' + schema: + type: string + example: + - Laika + - Plex Media Server + - Media Link + required: false + - in: header + name: X-Plex-Provides + description: 'One or more of `[player, controller, server]`' + schema: + type: string + example: + - iOS + - MacOSX + - Android + - LG + required: false + - in: header + name: X-Plex-Version + description: Your application version number + schema: + type: string + required: false responses: '200': description: The search results @@ -1948,6 +4342,75 @@ paths: summary: Get Active Sessions description: This will retrieve the "Now Playing" Information of the PMS. operationId: getSessions + parameters: + - in: header + name: X-Plex-Device-Name + description: Primary name for the device eg. `Plex Web (Chrome)` + schema: + type: string + example: Plex Web (Chrome) + required: false + - in: header + name: X-Plex-Device + description: | + The type of device your application is running on + Device name and or model number, eg `iPhone3,2`, `Motorola XOOM™`, `LG5200TV` + schema: + type: string + example: + - 'iPhone3,2' + - Motorola XOOM™ + - LG5200TV + required: false + - in: header + name: X-Plex-Platform-Version + description: 'Operating system version, eg `4.3.1`, `10.6.7`, `3.2`' + schema: + type: string + example: + - 4.3.1 + - 10.6.7 + - 3.2 + required: false + - in: header + name: X-Plex-Platform + description: 'Platform name, eg `Web`, `iOS`, `MacOSX`, `Android`, `LG`' + schema: + type: string + example: + - Web + - iOS + - MacOSX + - Android + - LG + required: false + - in: header + name: X-Plex-Product + description: 'Plex application name, eg `Laika`, `Plex Media Server`, `Media Link`' + schema: + type: string + example: + - Laika + - Plex Media Server + - Media Link + required: false + - in: header + name: X-Plex-Provides + description: 'One or more of `[player, controller, server]`' + schema: + type: string + example: + - iOS + - MacOSX + - Android + - LG + required: false + - in: header + name: X-Plex-Version + description: Your application version number + schema: + type: string + required: false responses: '200': description: List of Active Plex Sessions @@ -1979,6 +4442,75 @@ paths: summary: Get Session History description: This will Retrieve a listing of all history views. operationId: getSessionHistory + parameters: + - in: header + name: X-Plex-Device-Name + description: Primary name for the device eg. `Plex Web (Chrome)` + schema: + type: string + example: Plex Web (Chrome) + required: false + - in: header + name: X-Plex-Device + description: | + The type of device your application is running on + Device name and or model number, eg `iPhone3,2`, `Motorola XOOM™`, `LG5200TV` + schema: + type: string + example: + - 'iPhone3,2' + - Motorola XOOM™ + - LG5200TV + required: false + - in: header + name: X-Plex-Platform-Version + description: 'Operating system version, eg `4.3.1`, `10.6.7`, `3.2`' + schema: + type: string + example: + - 4.3.1 + - 10.6.7 + - 3.2 + required: false + - in: header + name: X-Plex-Platform + description: 'Platform name, eg `Web`, `iOS`, `MacOSX`, `Android`, `LG`' + schema: + type: string + example: + - Web + - iOS + - MacOSX + - Android + - LG + required: false + - in: header + name: X-Plex-Product + description: 'Plex application name, eg `Laika`, `Plex Media Server`, `Media Link`' + schema: + type: string + example: + - Laika + - Plex Media Server + - Media Link + required: false + - in: header + name: X-Plex-Provides + description: 'One or more of `[player, controller, server]`' + schema: + type: string + example: + - iOS + - MacOSX + - Android + - LG + required: false + - in: header + name: X-Plex-Version + description: Your application version number + schema: + type: string + required: false responses: '200': description: List of Plex Sessions @@ -2010,6 +4542,75 @@ paths: summary: Get Server Preferences description: Get Server Preferences operationId: getServerPreferences + parameters: + - in: header + name: X-Plex-Device-Name + description: Primary name for the device eg. `Plex Web (Chrome)` + schema: + type: string + example: Plex Web (Chrome) + required: false + - in: header + name: X-Plex-Device + description: | + The type of device your application is running on + Device name and or model number, eg `iPhone3,2`, `Motorola XOOM™`, `LG5200TV` + schema: + type: string + example: + - 'iPhone3,2' + - Motorola XOOM™ + - LG5200TV + required: false + - in: header + name: X-Plex-Platform-Version + description: 'Operating system version, eg `4.3.1`, `10.6.7`, `3.2`' + schema: + type: string + example: + - 4.3.1 + - 10.6.7 + - 3.2 + required: false + - in: header + name: X-Plex-Platform + description: 'Platform name, eg `Web`, `iOS`, `MacOSX`, `Android`, `LG`' + schema: + type: string + example: + - Web + - iOS + - MacOSX + - Android + - LG + required: false + - in: header + name: X-Plex-Product + description: 'Plex application name, eg `Laika`, `Plex Media Server`, `Media Link`' + schema: + type: string + example: + - Laika + - Plex Media Server + - Media Link + required: false + - in: header + name: X-Plex-Provides + description: 'One or more of `[player, controller, server]`' + schema: + type: string + example: + - iOS + - MacOSX + - Android + - LG + required: false + - in: header + name: X-Plex-Version + description: Your application version number + schema: + type: string + required: false responses: '200': description: Server Preferences @@ -2044,12 +4645,6 @@ paths: description: Get Logged in User operationId: getCurrentUserDetails parameters: - - in: header - name: X-Plex-Client-Identifier - description: 'Unique Id, UUID, serial number, or other number unique per device that identifies your client' - schema: - type: string - required: true - in: header name: X-Plex-Device-Name description: Primary name for the device eg. `Plex Web (Chrome)` @@ -2152,12 +4747,6 @@ paths: description: Get Devices operationId: getDevices parameters: - - in: header - name: X-Plex-Client-Identifier - description: 'Unique Id, UUID, serial number, or other number unique per device that identifies your client' - schema: - type: string - required: true - in: header name: X-Plex-Device-Name description: Primary name for the device eg. `Plex Web (Chrome)` @@ -2363,12 +4952,6 @@ paths: type: boolean default: false required: false - - in: header - name: X-Plex-Client-Identifier - description: 'Unique Id, UUID, serial number, or other number unique per device that identifies your client' - schema: - type: string - required: true - in: header name: X-Plex-Device-Name description: Primary name for the device eg. `Plex Web (Chrome)` @@ -2552,12 +5135,6 @@ paths: schema: type: string required: true - - in: header - name: X-Plex-Client-Identifier - description: 'Unique Id, UUID, serial number, or other number unique per device that identifies your client' - schema: - type: string - required: true - in: header name: X-Plex-Device-Name description: Primary name for the device eg. `Plex Web (Chrome)`