mirror of
https://github.com/LukeHagar/plex-docs.git
synced 2025-12-06 04:20:40 +00:00
Updating PMS Spec
This commit is contained in:
lukehagar
@@ -1030,6 +1030,188 @@ paths:
|
|||||||
status:
|
status:
|
||||||
type: number
|
type: number
|
||||||
example: 401
|
example: 401
|
||||||
|
/companions:
|
||||||
|
get:
|
||||||
|
servers:
|
||||||
|
- url: 'https://plex.tv/api/v2'
|
||||||
|
tags:
|
||||||
|
- Plex
|
||||||
|
summary: Get Companions Data
|
||||||
|
description: Get Companions Data
|
||||||
|
operationId: getCompanionsData
|
||||||
|
responses:
|
||||||
|
'200':
|
||||||
|
description: Companions Data
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
type: array
|
||||||
|
items:
|
||||||
|
type: object
|
||||||
|
required:
|
||||||
|
- identifier
|
||||||
|
- baseURL
|
||||||
|
- title
|
||||||
|
- linkURL
|
||||||
|
- provides
|
||||||
|
- token
|
||||||
|
properties:
|
||||||
|
identifier:
|
||||||
|
type: string
|
||||||
|
example: tv.plex.sonos
|
||||||
|
baseURL:
|
||||||
|
type: string
|
||||||
|
example: 'https://sonos.plex.tv'
|
||||||
|
format: uri
|
||||||
|
title:
|
||||||
|
type: string
|
||||||
|
example: Sonos
|
||||||
|
linkURL:
|
||||||
|
type: string
|
||||||
|
example: 'https://sonos.plex.tv/link'
|
||||||
|
provides:
|
||||||
|
type: string
|
||||||
|
example: 'client,player'
|
||||||
|
token:
|
||||||
|
type: string
|
||||||
|
description: The plex authtoken used to identify with
|
||||||
|
'400':
|
||||||
|
description: 'Bad Request - A parameter was not specified, or was specified incorrectly.'
|
||||||
|
'401':
|
||||||
|
description: Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
type: object
|
||||||
|
properties:
|
||||||
|
errors:
|
||||||
|
type: array
|
||||||
|
items:
|
||||||
|
type: object
|
||||||
|
properties:
|
||||||
|
code:
|
||||||
|
type: number
|
||||||
|
example: 1001
|
||||||
|
message:
|
||||||
|
type: string
|
||||||
|
example: User could not be authenticated
|
||||||
|
status:
|
||||||
|
type: number
|
||||||
|
example: 401
|
||||||
|
/geoip:
|
||||||
|
get:
|
||||||
|
servers:
|
||||||
|
- url: 'https://plex.tv/api/v2'
|
||||||
|
security: []
|
||||||
|
tags:
|
||||||
|
- Plex
|
||||||
|
summary: Get Geo Data
|
||||||
|
description: Returns the geolocation and locale data of the caller
|
||||||
|
operationId: getGeoData
|
||||||
|
responses:
|
||||||
|
'200':
|
||||||
|
description: Gets the geo location data of the user
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
title: GeoData
|
||||||
|
type: object
|
||||||
|
description: Geo location data
|
||||||
|
examples:
|
||||||
|
- code: VI
|
||||||
|
continent_code: NA
|
||||||
|
country: United States Virgin Islands
|
||||||
|
city: Amsterdam
|
||||||
|
european_union_member: true
|
||||||
|
time_zone: America/St_Thomas
|
||||||
|
postal_code: 802
|
||||||
|
in_privacy_restricted_country: true
|
||||||
|
in_privacy_restricted_region: true
|
||||||
|
subdivisions: Saint Thomas
|
||||||
|
coordinates: '18.3381, -64.8941'
|
||||||
|
required:
|
||||||
|
- code
|
||||||
|
- continent_code
|
||||||
|
- country
|
||||||
|
- city
|
||||||
|
- european_union_member
|
||||||
|
- time_zone
|
||||||
|
- postal_code
|
||||||
|
- in_privacy_restricted_country
|
||||||
|
- in_privacy_restricted_region
|
||||||
|
- subdivisions
|
||||||
|
- coordinates
|
||||||
|
properties:
|
||||||
|
code:
|
||||||
|
type: string
|
||||||
|
description: The ISO 3166-1 alpha-2 code of the country.
|
||||||
|
example: VI
|
||||||
|
continent_code:
|
||||||
|
type: string
|
||||||
|
description: The continent code where the country is located.
|
||||||
|
example: NA
|
||||||
|
country:
|
||||||
|
type: string
|
||||||
|
description: The official name of the country.
|
||||||
|
example: United States Virgin Islands
|
||||||
|
city:
|
||||||
|
type: string
|
||||||
|
description: The name of the city.
|
||||||
|
example: Amsterdam
|
||||||
|
european_union_member:
|
||||||
|
type: boolean
|
||||||
|
description: Indicates if the country is a member of the European Union.
|
||||||
|
example: true
|
||||||
|
default: false
|
||||||
|
time_zone:
|
||||||
|
type: string
|
||||||
|
description: The time zone of the country.
|
||||||
|
example: America/St_Thomas
|
||||||
|
postal_code:
|
||||||
|
type: integer
|
||||||
|
description: The postal code of the location.
|
||||||
|
example: 802
|
||||||
|
in_privacy_restricted_country:
|
||||||
|
type: boolean
|
||||||
|
description: Indicates if the country has privacy restrictions.
|
||||||
|
example: true
|
||||||
|
default: false
|
||||||
|
in_privacy_restricted_region:
|
||||||
|
type: boolean
|
||||||
|
description: Indicates if the region has privacy restrictions.
|
||||||
|
example: true
|
||||||
|
default: false
|
||||||
|
subdivisions:
|
||||||
|
type: string
|
||||||
|
description: The name of the primary administrative subdivision.
|
||||||
|
example: Saint Thomas
|
||||||
|
coordinates:
|
||||||
|
type: string
|
||||||
|
description: 'The geographical coordinates (latitude, longitude) of the location.'
|
||||||
|
example: '18.3381, -64.8941'
|
||||||
|
'400':
|
||||||
|
description: 'Bad Request - A parameter was not specified, or was specified incorrectly.'
|
||||||
|
'401':
|
||||||
|
description: Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
type: object
|
||||||
|
properties:
|
||||||
|
errors:
|
||||||
|
type: array
|
||||||
|
items:
|
||||||
|
type: object
|
||||||
|
properties:
|
||||||
|
code:
|
||||||
|
type: number
|
||||||
|
example: 1001
|
||||||
|
message:
|
||||||
|
type: string
|
||||||
|
example: User could not be authenticated
|
||||||
|
status:
|
||||||
|
type: number
|
||||||
|
example: 401
|
||||||
/home:
|
/home:
|
||||||
get:
|
get:
|
||||||
tags:
|
tags:
|
||||||
@@ -4907,105 +5089,209 @@ paths:
|
|||||||
example: Postman
|
example: Postman
|
||||||
required: true
|
required: true
|
||||||
responses:
|
responses:
|
||||||
'201':
|
'200':
|
||||||
description: The Pin
|
description: The Pin
|
||||||
content:
|
content:
|
||||||
application/json:
|
application/json:
|
||||||
schema:
|
schema:
|
||||||
type: object
|
type: object
|
||||||
|
x-examples:
|
||||||
|
Example 1:
|
||||||
|
id: 373040866
|
||||||
|
code: 7RQZ
|
||||||
|
product: '0'
|
||||||
|
trusted: false
|
||||||
|
qr: 'https://plex.tv/api/v2/pins/qr/7RQZ'
|
||||||
|
clientIdentifier: 9klpwueublnfbvlx95w83ah9
|
||||||
|
location:
|
||||||
|
code: NL
|
||||||
|
european_union_member: true
|
||||||
|
continent_code: EU
|
||||||
|
country: The Netherlands
|
||||||
|
city: Breda
|
||||||
|
time_zone: Europe/Amsterdam
|
||||||
|
postal_code: '4814'
|
||||||
|
in_privacy_restricted_country: true
|
||||||
|
in_privacy_restricted_region: true
|
||||||
|
subdivisions: North Brabant
|
||||||
|
coordinates: '51.5869, 4.7471'
|
||||||
|
expiresIn: 876
|
||||||
|
createdAt: '2024-07-16T17:03:05Z'
|
||||||
|
expiresAt: '2024-07-16T17:18:05Z'
|
||||||
|
authToken: null
|
||||||
|
newRegistration: null
|
||||||
|
title: AuthPinContainer
|
||||||
|
examples:
|
||||||
|
- id: 308667304
|
||||||
|
code: 7RQZ
|
||||||
|
product: '0'
|
||||||
|
trusted: false
|
||||||
|
qr: 'https://plex.tv/api/v2/pins/qr/7RQZ'
|
||||||
|
clientIdentifier: string
|
||||||
|
location:
|
||||||
|
code: VI
|
||||||
|
continent_code: NA
|
||||||
|
country: United States Virgin Islands
|
||||||
|
city: Amsterdam
|
||||||
|
european_union_member: true
|
||||||
|
time_zone: America/St_Thomas
|
||||||
|
postal_code: 802
|
||||||
|
in_privacy_restricted_country: true
|
||||||
|
in_privacy_restricted_region: true
|
||||||
|
subdivisions: Saint Thomas
|
||||||
|
coordinates: '18.3381, -64.8941'
|
||||||
|
expiresIn: 876
|
||||||
|
createdAt: '2024-07-16T17:03:05Z'
|
||||||
|
expiresAt: '2024-07-16T17:18:05Z'
|
||||||
|
authToken: null
|
||||||
|
newRegistration: null
|
||||||
|
required:
|
||||||
|
- id
|
||||||
|
- code
|
||||||
|
- product
|
||||||
|
- trusted
|
||||||
|
- qr
|
||||||
|
- clientIdentifier
|
||||||
|
- location
|
||||||
|
- expiresIn
|
||||||
|
- createdAt
|
||||||
|
- expiresAt
|
||||||
properties:
|
properties:
|
||||||
id:
|
id:
|
||||||
description: PinID for use with authentication
|
type: integer
|
||||||
type: number
|
example: 308667304
|
||||||
example: 1272322473
|
|
||||||
code:
|
code:
|
||||||
type: string
|
type: string
|
||||||
example: 3patfx1a78ukcbr7x0n9bl26t
|
example: 7RQZ
|
||||||
product:
|
product:
|
||||||
type: string
|
type: string
|
||||||
example: Plex Web
|
example: '0'
|
||||||
trusted:
|
trusted:
|
||||||
type: boolean
|
type: boolean
|
||||||
|
default: false
|
||||||
qr:
|
qr:
|
||||||
description: |
|
|
||||||
a link to a QR code hosted on plex.tv
|
|
||||||
The QR code redirects to the relevant `plex.tv/link` authentication page
|
|
||||||
Which then prompts the user for the 4 Digit Link Pin
|
|
||||||
type: string
|
type: string
|
||||||
example: 'https://plex.tv/api/v2/pins/qr/3patfx1a78ukcbr7x0n9bl26t'
|
example: 'https://plex.tv/api/v2/pins/qr/7RQZ'
|
||||||
clientIdentifier:
|
clientIdentifier:
|
||||||
type: string
|
type: string
|
||||||
example: Postman
|
description: The X-Client-Identifier used in the request
|
||||||
location:
|
location:
|
||||||
|
title: GeoData
|
||||||
type: object
|
type: object
|
||||||
|
description: Geo location data
|
||||||
|
examples:
|
||||||
|
- code: VI
|
||||||
|
continent_code: NA
|
||||||
|
country: United States Virgin Islands
|
||||||
|
city: Amsterdam
|
||||||
|
european_union_member: true
|
||||||
|
time_zone: America/St_Thomas
|
||||||
|
postal_code: 802
|
||||||
|
in_privacy_restricted_country: true
|
||||||
|
in_privacy_restricted_region: true
|
||||||
|
subdivisions: Saint Thomas
|
||||||
|
coordinates: '18.3381, -64.8941'
|
||||||
|
required:
|
||||||
|
- code
|
||||||
|
- continent_code
|
||||||
|
- country
|
||||||
|
- city
|
||||||
|
- european_union_member
|
||||||
|
- time_zone
|
||||||
|
- postal_code
|
||||||
|
- in_privacy_restricted_country
|
||||||
|
- in_privacy_restricted_region
|
||||||
|
- subdivisions
|
||||||
|
- coordinates
|
||||||
properties:
|
properties:
|
||||||
code:
|
code:
|
||||||
type: string
|
type: string
|
||||||
example: US
|
description: The ISO 3166-1 alpha-2 code of the country.
|
||||||
european_union_member:
|
example: VI
|
||||||
type: boolean
|
|
||||||
continent_code:
|
continent_code:
|
||||||
type: string
|
type: string
|
||||||
|
description: The continent code where the country is located.
|
||||||
example: NA
|
example: NA
|
||||||
country:
|
country:
|
||||||
type: string
|
type: string
|
||||||
example: United States
|
description: The official name of the country.
|
||||||
|
example: United States Virgin Islands
|
||||||
city:
|
city:
|
||||||
type: string
|
type: string
|
||||||
example: Austin
|
description: The name of the city.
|
||||||
|
example: Amsterdam
|
||||||
|
european_union_member:
|
||||||
|
type: boolean
|
||||||
|
description: Indicates if the country is a member of the European Union.
|
||||||
|
example: true
|
||||||
|
default: false
|
||||||
time_zone:
|
time_zone:
|
||||||
type: string
|
type: string
|
||||||
example: America/Chicago
|
description: The time zone of the country.
|
||||||
|
example: America/St_Thomas
|
||||||
postal_code:
|
postal_code:
|
||||||
type: string
|
type: integer
|
||||||
example: 78732
|
description: The postal code of the location.
|
||||||
|
example: 802
|
||||||
in_privacy_restricted_country:
|
in_privacy_restricted_country:
|
||||||
type: boolean
|
type: boolean
|
||||||
|
description: Indicates if the country has privacy restrictions.
|
||||||
|
example: true
|
||||||
|
default: false
|
||||||
|
in_privacy_restricted_region:
|
||||||
|
type: boolean
|
||||||
|
description: Indicates if the region has privacy restrictions.
|
||||||
|
example: true
|
||||||
|
default: false
|
||||||
subdivisions:
|
subdivisions:
|
||||||
type: string
|
type: string
|
||||||
example: Texas
|
description: The name of the primary administrative subdivision.
|
||||||
|
example: Saint Thomas
|
||||||
coordinates:
|
coordinates:
|
||||||
type: string
|
type: string
|
||||||
example: 30.3768 -97.8935
|
description: 'The geographical coordinates (latitude, longitude) of the location.'
|
||||||
|
example: '18.3381, -64.8941'
|
||||||
expiresIn:
|
expiresIn:
|
||||||
type: number
|
type: integer
|
||||||
example: 1800
|
example: 876
|
||||||
|
description: 'The number of seconds this pin expires, by default 900 seconds'
|
||||||
|
default: 900
|
||||||
createdAt:
|
createdAt:
|
||||||
type: string
|
type: string
|
||||||
|
example: '2024-07-16T17:03:05Z'
|
||||||
format: date-time
|
format: date-time
|
||||||
example: 2023-04-12T17:00:03.000Z
|
|
||||||
expiresAt:
|
expiresAt:
|
||||||
type: string
|
type: string
|
||||||
format: date-time
|
format: date-time
|
||||||
example: 2023-04-12T17:30:03.000Z
|
example: '2024-07-16T17:18:05Z'
|
||||||
authToken:
|
authToken:
|
||||||
type: string
|
type: 'null'
|
||||||
format: nullable
|
|
||||||
newRegistration:
|
newRegistration:
|
||||||
type:
|
type: 'null'
|
||||||
- boolean
|
|
||||||
- 'null'
|
|
||||||
'400':
|
'400':
|
||||||
description: X-Plex-Client-Identifier is missing
|
|
||||||
content:
|
content:
|
||||||
application/json:
|
application/json:
|
||||||
schema:
|
schema:
|
||||||
type: object
|
description: Bad Request - X-Plex-Client-Identifier is missing
|
||||||
properties:
|
content:
|
||||||
errors:
|
application/json:
|
||||||
type: array
|
schema:
|
||||||
items:
|
|
||||||
type: object
|
type: object
|
||||||
properties:
|
properties:
|
||||||
code:
|
errors:
|
||||||
type: number
|
type: array
|
||||||
example: 1000
|
items:
|
||||||
message:
|
type: object
|
||||||
type: string
|
properties:
|
||||||
example: X-Plex-Client-Identifier is missing
|
code:
|
||||||
status:
|
type: integer
|
||||||
type: number
|
example: 1000
|
||||||
example: 400
|
message:
|
||||||
|
type: string
|
||||||
|
example: X-Plex-Client-Identifier is missing
|
||||||
|
status:
|
||||||
|
type: integer
|
||||||
|
example: 400
|
||||||
'/pins/{pinID}':
|
'/pins/{pinID}':
|
||||||
get:
|
get:
|
||||||
servers:
|
servers:
|
||||||
@@ -5035,104 +5321,208 @@ paths:
|
|||||||
required: true
|
required: true
|
||||||
responses:
|
responses:
|
||||||
'200':
|
'200':
|
||||||
description: Access Token
|
description: The Pin
|
||||||
content:
|
content:
|
||||||
application/json:
|
application/json:
|
||||||
schema:
|
schema:
|
||||||
type: object
|
type: object
|
||||||
|
x-examples:
|
||||||
|
Example 1:
|
||||||
|
id: 373040866
|
||||||
|
code: 7RQZ
|
||||||
|
product: '0'
|
||||||
|
trusted: false
|
||||||
|
qr: 'https://plex.tv/api/v2/pins/qr/7RQZ'
|
||||||
|
clientIdentifier: 9klpwueublnfbvlx95w83ah9
|
||||||
|
location:
|
||||||
|
code: NL
|
||||||
|
european_union_member: true
|
||||||
|
continent_code: EU
|
||||||
|
country: The Netherlands
|
||||||
|
city: Breda
|
||||||
|
time_zone: Europe/Amsterdam
|
||||||
|
postal_code: '4814'
|
||||||
|
in_privacy_restricted_country: true
|
||||||
|
in_privacy_restricted_region: true
|
||||||
|
subdivisions: North Brabant
|
||||||
|
coordinates: '51.5869, 4.7471'
|
||||||
|
expiresIn: 876
|
||||||
|
createdAt: '2024-07-16T17:03:05Z'
|
||||||
|
expiresAt: '2024-07-16T17:18:05Z'
|
||||||
|
authToken: null
|
||||||
|
newRegistration: null
|
||||||
|
title: AuthPinContainer
|
||||||
|
examples:
|
||||||
|
- id: 308667304
|
||||||
|
code: 7RQZ
|
||||||
|
product: '0'
|
||||||
|
trusted: false
|
||||||
|
qr: 'https://plex.tv/api/v2/pins/qr/7RQZ'
|
||||||
|
clientIdentifier: string
|
||||||
|
location:
|
||||||
|
code: VI
|
||||||
|
continent_code: NA
|
||||||
|
country: United States Virgin Islands
|
||||||
|
city: Amsterdam
|
||||||
|
european_union_member: true
|
||||||
|
time_zone: America/St_Thomas
|
||||||
|
postal_code: 802
|
||||||
|
in_privacy_restricted_country: true
|
||||||
|
in_privacy_restricted_region: true
|
||||||
|
subdivisions: Saint Thomas
|
||||||
|
coordinates: '18.3381, -64.8941'
|
||||||
|
expiresIn: 876
|
||||||
|
createdAt: '2024-07-16T17:03:05Z'
|
||||||
|
expiresAt: '2024-07-16T17:18:05Z'
|
||||||
|
authToken: null
|
||||||
|
newRegistration: null
|
||||||
|
required:
|
||||||
|
- id
|
||||||
|
- code
|
||||||
|
- product
|
||||||
|
- trusted
|
||||||
|
- qr
|
||||||
|
- clientIdentifier
|
||||||
|
- location
|
||||||
|
- expiresIn
|
||||||
|
- createdAt
|
||||||
|
- expiresAt
|
||||||
properties:
|
properties:
|
||||||
id:
|
id:
|
||||||
description: PinID for use with authentication
|
type: integer
|
||||||
type: number
|
example: 308667304
|
||||||
example: 1272322473
|
|
||||||
code:
|
code:
|
||||||
type: string
|
type: string
|
||||||
example: 3patfx1a78ukcbr7x0n9bl26t
|
example: 7RQZ
|
||||||
product:
|
product:
|
||||||
type: string
|
type: string
|
||||||
example: Plex Web
|
example: '0'
|
||||||
trusted:
|
trusted:
|
||||||
type: boolean
|
type: boolean
|
||||||
|
default: false
|
||||||
qr:
|
qr:
|
||||||
description: |
|
|
||||||
a link to a QR code hosted on plex.tv
|
|
||||||
The QR code redirects to the relevant `plex.tv/link` authentication page
|
|
||||||
Which then prompts the user for the 4 Digit Link Pin
|
|
||||||
type: string
|
type: string
|
||||||
example: 'https://plex.tv/api/v2/pins/qr/3patfx1a78ukcbr7x0n9bl26t'
|
example: 'https://plex.tv/api/v2/pins/qr/7RQZ'
|
||||||
clientIdentifier:
|
clientIdentifier:
|
||||||
type: string
|
type: string
|
||||||
example: Postman
|
description: The X-Client-Identifier used in the request
|
||||||
location:
|
location:
|
||||||
|
title: GeoData
|
||||||
type: object
|
type: object
|
||||||
|
description: Geo location data
|
||||||
|
examples:
|
||||||
|
- code: VI
|
||||||
|
continent_code: NA
|
||||||
|
country: United States Virgin Islands
|
||||||
|
city: Amsterdam
|
||||||
|
european_union_member: true
|
||||||
|
time_zone: America/St_Thomas
|
||||||
|
postal_code: 802
|
||||||
|
in_privacy_restricted_country: true
|
||||||
|
in_privacy_restricted_region: true
|
||||||
|
subdivisions: Saint Thomas
|
||||||
|
coordinates: '18.3381, -64.8941'
|
||||||
|
required:
|
||||||
|
- code
|
||||||
|
- continent_code
|
||||||
|
- country
|
||||||
|
- city
|
||||||
|
- european_union_member
|
||||||
|
- time_zone
|
||||||
|
- postal_code
|
||||||
|
- in_privacy_restricted_country
|
||||||
|
- in_privacy_restricted_region
|
||||||
|
- subdivisions
|
||||||
|
- coordinates
|
||||||
properties:
|
properties:
|
||||||
code:
|
code:
|
||||||
type: string
|
type: string
|
||||||
example: US
|
description: The ISO 3166-1 alpha-2 code of the country.
|
||||||
european_union_member:
|
example: VI
|
||||||
type: boolean
|
|
||||||
continent_code:
|
continent_code:
|
||||||
type: string
|
type: string
|
||||||
|
description: The continent code where the country is located.
|
||||||
example: NA
|
example: NA
|
||||||
country:
|
country:
|
||||||
type: string
|
type: string
|
||||||
example: United States
|
description: The official name of the country.
|
||||||
|
example: United States Virgin Islands
|
||||||
city:
|
city:
|
||||||
type: string
|
type: string
|
||||||
example: Austin
|
description: The name of the city.
|
||||||
|
example: Amsterdam
|
||||||
|
european_union_member:
|
||||||
|
type: boolean
|
||||||
|
description: Indicates if the country is a member of the European Union.
|
||||||
|
example: true
|
||||||
|
default: false
|
||||||
time_zone:
|
time_zone:
|
||||||
type: string
|
type: string
|
||||||
example: America/Chicago
|
description: The time zone of the country.
|
||||||
|
example: America/St_Thomas
|
||||||
postal_code:
|
postal_code:
|
||||||
type: string
|
type: integer
|
||||||
example: 78732
|
description: The postal code of the location.
|
||||||
|
example: 802
|
||||||
in_privacy_restricted_country:
|
in_privacy_restricted_country:
|
||||||
type: boolean
|
type: boolean
|
||||||
|
description: Indicates if the country has privacy restrictions.
|
||||||
|
example: true
|
||||||
|
default: false
|
||||||
|
in_privacy_restricted_region:
|
||||||
|
type: boolean
|
||||||
|
description: Indicates if the region has privacy restrictions.
|
||||||
|
example: true
|
||||||
|
default: false
|
||||||
subdivisions:
|
subdivisions:
|
||||||
type: string
|
type: string
|
||||||
example: Texas
|
description: The name of the primary administrative subdivision.
|
||||||
|
example: Saint Thomas
|
||||||
coordinates:
|
coordinates:
|
||||||
type: string
|
type: string
|
||||||
example: 30.3768 -97.8935
|
description: 'The geographical coordinates (latitude, longitude) of the location.'
|
||||||
|
example: '18.3381, -64.8941'
|
||||||
expiresIn:
|
expiresIn:
|
||||||
type: number
|
type: integer
|
||||||
example: 1800
|
example: 876
|
||||||
|
description: 'The number of seconds this pin expires, by default 900 seconds'
|
||||||
|
default: 900
|
||||||
createdAt:
|
createdAt:
|
||||||
type: string
|
type: string
|
||||||
|
example: '2024-07-16T17:03:05Z'
|
||||||
format: date-time
|
format: date-time
|
||||||
example: 2023-04-12T17:00:03.000Z
|
|
||||||
expiresAt:
|
expiresAt:
|
||||||
type: string
|
type: string
|
||||||
format: date-time
|
format: date-time
|
||||||
example: 2023-04-12T17:30:03.000Z
|
example: '2024-07-16T17:18:05Z'
|
||||||
authToken:
|
authToken:
|
||||||
type: string
|
type: 'null'
|
||||||
format: nullable
|
|
||||||
newRegistration:
|
newRegistration:
|
||||||
type:
|
type: 'null'
|
||||||
- boolean
|
|
||||||
- 'null'
|
|
||||||
'400':
|
'400':
|
||||||
description: X-Plex-Client-Identifier is missing
|
|
||||||
content:
|
content:
|
||||||
application/json:
|
application/json:
|
||||||
schema:
|
schema:
|
||||||
type: object
|
description: Bad Request - X-Plex-Client-Identifier is missing
|
||||||
properties:
|
content:
|
||||||
errors:
|
application/json:
|
||||||
type: array
|
schema:
|
||||||
items:
|
|
||||||
type: object
|
type: object
|
||||||
properties:
|
properties:
|
||||||
code:
|
errors:
|
||||||
type: number
|
type: array
|
||||||
example: 1000
|
items:
|
||||||
message:
|
type: object
|
||||||
type: string
|
properties:
|
||||||
example: X-Plex-Client-Identifier is missing
|
code:
|
||||||
status:
|
type: integer
|
||||||
type: number
|
example: 1000
|
||||||
example: 400
|
message:
|
||||||
|
type: string
|
||||||
|
example: X-Plex-Client-Identifier is missing
|
||||||
|
status:
|
||||||
|
type: integer
|
||||||
|
example: 400
|
||||||
/playlists:
|
/playlists:
|
||||||
post:
|
post:
|
||||||
tags:
|
tags:
|
||||||
|
|||||||
Reference in New Issue
Block a user