(plex)
API Calls that perform operations directly against https://Plex.tv
Retrieve a Pin from Plex.tv for authentication flows
import plex_api
s = plex_api.PlexAPI(
x_plex_client_identifier='Postman',
)
res = s.plex.get_pin(strong=False, x_plex_client_identifier='Postman')
if res.object is not None:
# handle response
pass| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
strong |
Optional[bool] | ➖ | Determines the kind of code returned by the API call Strong codes are used for Pin authentication flows Non-Strong codes are used for Plex.tv/link |
|
x_plex_client_identifier |
Optional[str] | ➖ | The unique identifier for the client application This is used to track the client application and its usage (UUID, serial number, or other number unique per device) |
Postman |
server_url |
Optional[str] | ➖ | An optional server URL to use. | http://localhost:8080 |
| Error Object | Status Code | Content Type |
|---|---|---|
| errors.GetPinResponseBody | 400 | application/json |
| errors.SDKError | 4xx-5xx | / |
Retrieve an Access Token from Plex.tv after the Pin has already been authenticated
import plex_api
s = plex_api.PlexAPI(
x_plex_client_identifier='Postman',
)
res = s.plex.get_token(pin_id='<value>', x_plex_client_identifier='Postman')
if res is not None:
# handle response
pass| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
pin_id |
str | ✔️ | The PinID to retrieve an access token for | |
x_plex_client_identifier |
Optional[str] | ➖ | The unique identifier for the client application This is used to track the client application and its usage (UUID, serial number, or other number unique per device) |
Postman |
server_url |
Optional[str] | ➖ | An optional server URL to use. | http://localhost:8080 |
| Error Object | Status Code | Content Type |
|---|---|---|
| errors.GetTokenResponseBody | 400 | application/json |
| errors.SDKError | 4xx-5xx | / |