mirror of
https://github.com/LukeHagar/plex-sdk-docs.git
synced 2025-12-09 20:47:47 +00:00
ci: regenerated with OpenAPI Doc 0.0.3, Speakeasy CLI 1.299.1
This commit is contained in:
speakeasybot
@@ -1,4 +1,6 @@
|
||||
{/* Autogenerated DO NOT EDIT */}
|
||||
##### `activityUUID` _string_
|
||||
The UUID of the activity to cancel.
|
||||
<br/>
|
||||
**Example:** `25b71ed5-0f9d-461c-baa7-d404e9e10d3e`
|
||||
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
|
||||
<CH.Code>
|
||||
```bash Example Request
|
||||
curl http://10.10.10.47:32400/activities/<value> \
|
||||
curl http://10.10.10.47:32400/activities/25b71ed5-0f9d-461c-baa7-d404e9e10d3e \
|
||||
--header 'Accept: application/json' \
|
||||
--header 'X-Plex-Token: YOUR_API_KEY_HERE'
|
||||
```
|
||||
|
||||
@@ -0,0 +1,17 @@
|
||||
import GetTransientToken from "./get_transient_token/get_transient_token.mdx";
|
||||
import GetSourceConnectionInformation from "./get_source_connection_information/get_source_connection_information.mdx";
|
||||
|
||||
## Authentication
|
||||
API Calls regarding authentication for Plex Media Server
|
||||
|
||||
|
||||
### Available Operations
|
||||
|
||||
* [Get Transient Token](/curl/authentication/get_transient_token) - Get a Transient Token.
|
||||
* [Get Source Connection Information](/curl/authentication/get_source_connection_information) - Get Source Connection Information
|
||||
|
||||
---
|
||||
<GetTransientToken />
|
||||
|
||||
---
|
||||
<GetSourceConnectionInformation />
|
||||
@@ -1,7 +1,7 @@
|
||||
|
||||
<CH.Code>
|
||||
```bash Example Request
|
||||
curl http://10.10.10.47:32400/security/resources?source=server%3A%2F%2Fclient-identifier \
|
||||
curl http://10.10.10.47:32400/security/resources?source=provider%3A%2F%2Fprovider-identifier \
|
||||
--header 'Accept: application/json' \
|
||||
--header 'X-Plex-Token: YOUR_API_KEY_HERE'
|
||||
```
|
||||
@@ -2,7 +2,7 @@ import CurlHeader from './_header.mdx';
|
||||
import SDKHeader from './_header.mdx';
|
||||
import OperationHeader from '/src/components/OperationHeader';
|
||||
|
||||
###### *Security*
|
||||
###### *Authentication*
|
||||
|
||||
<OperationHeader
|
||||
sdkHeader={<SDKHeader />}
|
||||
@@ -2,7 +2,7 @@ import CurlHeader from './_header.mdx';
|
||||
import SDKHeader from './_header.mdx';
|
||||
import OperationHeader from '/src/components/OperationHeader';
|
||||
|
||||
###### *Security*
|
||||
###### *Authentication*
|
||||
|
||||
<OperationHeader
|
||||
sdkHeader={<SDKHeader />}
|
||||
@@ -1,7 +1,7 @@
|
||||
|
||||
<CH.Code>
|
||||
```bash Example Request
|
||||
curl http://10.10.10.47:32400/hubs?count=8121.69 \
|
||||
curl http://10.10.10.47:32400/hubs?count=7151.9 \
|
||||
--header 'Accept: application/json' \
|
||||
--header 'X-Plex-Token: YOUR_API_KEY_HERE'
|
||||
```
|
||||
@@ -13,7 +13,41 @@ curl http://10.10.10.47:32400/hubs?count=8121.69 \
|
||||
"size": 8,
|
||||
"allowSync": true,
|
||||
"identifier": "com.plexapp.plugins.library",
|
||||
"Hub": []
|
||||
"Hub": [
|
||||
{
|
||||
"hubKey": "/library/metadata/50768,65523,58188,57341,57302,57070",
|
||||
"key": "/playlists/all?type=15&sort=lastViewedAt:desc&playlistType=video,audio",
|
||||
"title": "Recent Playlists",
|
||||
"type": "playlist",
|
||||
"hubIdentifier": "home.playlists",
|
||||
"context": "hub.home.playlists",
|
||||
"size": 6,
|
||||
"more": true,
|
||||
"style": "shelf",
|
||||
"promoted": true,
|
||||
"Metadata": [
|
||||
{
|
||||
"ratingKey": "57070",
|
||||
"key": "/playlists/57070/items",
|
||||
"guid": "com.plexapp.agents.none://9fee6c5b-3143-4923-813e-57bd0190056c",
|
||||
"type": "playlist",
|
||||
"title": "November Movie Day",
|
||||
"titleSort": "Tracks",
|
||||
"summary": "",
|
||||
"smart": false,
|
||||
"playlistType": "video",
|
||||
"composite": "/playlists/57070/composite/1668787730",
|
||||
"icon": "playlist://image.smart",
|
||||
"viewCount": 2,
|
||||
"lastViewedAt": 1668787732,
|
||||
"duration": 16873000,
|
||||
"leafCount": 3,
|
||||
"addedAt": 1668779618,
|
||||
"updatedAt": 1668787730
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
|
||||
<CH.Code>
|
||||
```bash Example Request
|
||||
curl http://10.10.10.47:32400/hubs/sections/5288.95?count=4799.77 \
|
||||
curl http://10.10.10.47:32400/hubs/sections/8442.66?count=6027.63 \
|
||||
--header 'Accept: application/json' \
|
||||
--header 'X-Plex-Token: YOUR_API_KEY_HERE'
|
||||
```
|
||||
@@ -16,7 +16,112 @@ curl http://10.10.10.47:32400/hubs/sections/5288.95?count=4799.77 \
|
||||
"librarySectionID": 1,
|
||||
"librarySectionTitle": "Movies",
|
||||
"librarySectionUUID": "322a231a-b7f7-49f5-920f-14c61199cd30",
|
||||
"Hub": []
|
||||
"Hub": [
|
||||
{
|
||||
"key": "/library/sections/1/all?sort=lastViewedAt:desc&unwatched=0&viewOffset=0",
|
||||
"title": "Recently Played Movies",
|
||||
"type": "movie",
|
||||
"hubIdentifier": "movie.recentlyviewed.1",
|
||||
"context": "hub.movie.recentlyviewed",
|
||||
"size": 6,
|
||||
"more": true,
|
||||
"style": "shelf",
|
||||
"hubKey": "/library/metadata/66485,66098,57249,11449,5858,14944",
|
||||
"Metadata": [
|
||||
{
|
||||
"ratingKey": "14944",
|
||||
"key": "/library/metadata/14944",
|
||||
"guid": "plex://movie/5d77686eeb5d26001f1eb339",
|
||||
"studio": "Walt Disney Animation Studios",
|
||||
"type": "movie",
|
||||
"title": "Tangled",
|
||||
"librarySectionTitle": "Movies",
|
||||
"librarySectionID": 1,
|
||||
"librarySectionKey": "/library/sections/1",
|
||||
"contentRating": "PG",
|
||||
"summary": "The magically long-haired Rapunzel has spent her entire life in a tower, but now that a runaway thief has stumbled upon her, she is about to discover the world for the first time, and who she really is.",
|
||||
"rating": 8.9,
|
||||
"audienceRating": 8.7,
|
||||
"viewCount": 1,
|
||||
"lastViewedAt": 1704936047,
|
||||
"year": 2010,
|
||||
"tagline": "They're taking adventure to new lengths.",
|
||||
"thumb": "/library/metadata/14944/thumb/1705739847",
|
||||
"art": "/library/metadata/14944/art/1705739847",
|
||||
"duration": 6017237,
|
||||
"originallyAvailableAt": "2010-11-24T00:00:00Z",
|
||||
"addedAt": 1589412494,
|
||||
"updatedAt": 1705739847,
|
||||
"audienceRatingImage": "rottentomatoes://image.rating.upright",
|
||||
"primaryExtraKey": "/library/metadata/14952",
|
||||
"ratingImage": "rottentomatoes://image.rating.ripe",
|
||||
"Media": [
|
||||
{
|
||||
"id": 38247,
|
||||
"duration": 6017237,
|
||||
"bitrate": 2051,
|
||||
"width": 1920,
|
||||
"height": 1080,
|
||||
"aspectRatio": 1.78,
|
||||
"audioChannels": 2,
|
||||
"audioCodec": "aac",
|
||||
"videoCodec": "h264",
|
||||
"videoResolution": "1080",
|
||||
"container": "mp4",
|
||||
"videoFrameRate": "24p",
|
||||
"optimizedForStreaming": 1,
|
||||
"audioProfile": "lc",
|
||||
"has64bitOffsets": false,
|
||||
"videoProfile": "high",
|
||||
"Part": [
|
||||
{
|
||||
"id": 38247,
|
||||
"key": "/library/parts/38247/1589412494/file.mp4",
|
||||
"duration": 6017237,
|
||||
"file": "/movies/Tangled (2010)/Tangled (2010) Bluray-1080p.mp4",
|
||||
"size": 1545647447,
|
||||
"audioProfile": "lc",
|
||||
"container": "mp4",
|
||||
"has64bitOffsets": false,
|
||||
"optimizedForStreaming": true,
|
||||
"videoProfile": "high"
|
||||
}
|
||||
]
|
||||
}
|
||||
],
|
||||
"Genre": [
|
||||
{
|
||||
"tag": "Animation"
|
||||
}
|
||||
],
|
||||
"Country": [
|
||||
{
|
||||
"tag": "United States of America"
|
||||
}
|
||||
],
|
||||
"Director": [
|
||||
{
|
||||
"tag": "Nathan Greno"
|
||||
}
|
||||
],
|
||||
"Role": [
|
||||
{
|
||||
"tag": "Donna Murphy"
|
||||
}
|
||||
],
|
||||
"Writer": [
|
||||
{
|
||||
"tag": "Wilhelm Grimm"
|
||||
}
|
||||
],
|
||||
"skipCount": 1,
|
||||
"chapterSource": "media"
|
||||
}
|
||||
],
|
||||
"promoted": true,
|
||||
"random": true
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
|
||||
<CH.Code>
|
||||
```bash Example Request
|
||||
curl http://10.10.10.47:32400/library/hashes?type=8360.79&url=file%3A%2F%2FC%3A%5CImage.png%26type%3D13 \
|
||||
curl http://10.10.10.47:32400/library/hashes?type=4236.55&url=file%3A%2F%2FC%3A%5CImage.png%26type%3D13 \
|
||||
--header 'Accept: application/json' \
|
||||
--header 'X-Plex-Token: YOUR_API_KEY_HERE'
|
||||
```
|
||||
|
||||
@@ -13,7 +13,36 @@ curl http://10.10.10.47:32400/library/sections \
|
||||
"size": 5,
|
||||
"allowSync": false,
|
||||
"title1": "Plex Library",
|
||||
"Directory": []
|
||||
"Directory": [
|
||||
{
|
||||
"allowSync": true,
|
||||
"art": "/:/resources/movie-fanart.jpg",
|
||||
"composite": "/library/sections/1/composite/1705615584",
|
||||
"filters": true,
|
||||
"refreshing": false,
|
||||
"thumb": "/:/resources/movie.png",
|
||||
"key": "1",
|
||||
"type": "movie",
|
||||
"title": "Movies",
|
||||
"agent": "tv.plex.agents.movie",
|
||||
"scanner": "Plex Movie",
|
||||
"language": "en-US",
|
||||
"uuid": "322a231a-b7f7-49f5-920f-14c61199cd30",
|
||||
"updatedAt": 1705615634,
|
||||
"createdAt": 1654131312,
|
||||
"scannedAt": 1705615584,
|
||||
"content": true,
|
||||
"directory": true,
|
||||
"contentChangedAt": 3192854,
|
||||
"hidden": 0,
|
||||
"Location": [
|
||||
{
|
||||
"id": 1,
|
||||
"path": "/movies"
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
@@ -22,9 +22,61 @@ curl http://10.10.10.47:32400/library/sections/1000 \
|
||||
"title1": "Movies",
|
||||
"viewGroup": "secondary",
|
||||
"viewMode": 65592,
|
||||
"Directory": [],
|
||||
"Type": [],
|
||||
"FieldType": []
|
||||
"Directory": [
|
||||
{
|
||||
"key": "search?type=1",
|
||||
"title": "Search...",
|
||||
"secondary": true,
|
||||
"prompt": "Search Movies",
|
||||
"search": true
|
||||
}
|
||||
],
|
||||
"Type": [
|
||||
{
|
||||
"key": "/library/sections/1/all?type=1",
|
||||
"type": "movie",
|
||||
"title": "Movies",
|
||||
"active": false,
|
||||
"Filter": [
|
||||
{
|
||||
"filter": "label",
|
||||
"filterType": "string",
|
||||
"key": "/library/sections/1/label",
|
||||
"title": "Labels",
|
||||
"type": "filter"
|
||||
}
|
||||
],
|
||||
"Sort": [
|
||||
{
|
||||
"default": "asc",
|
||||
"defaultDirection": "desc",
|
||||
"descKey": "random:desc",
|
||||
"firstCharacterKey": "/library/sections/1/firstCharacter",
|
||||
"key": "random",
|
||||
"title": "Randomly"
|
||||
}
|
||||
],
|
||||
"Field": [
|
||||
{
|
||||
"key": "label",
|
||||
"title": "Label",
|
||||
"type": "tag",
|
||||
"subType": "bitrate"
|
||||
}
|
||||
]
|
||||
}
|
||||
],
|
||||
"FieldType": [
|
||||
{
|
||||
"type": "resolution",
|
||||
"Operator": [
|
||||
{
|
||||
"key": "=",
|
||||
"title": "is"
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
@@ -5,6 +5,8 @@ import Labels from "/src/lib/labels";
|
||||
|
||||
##### `sectionId` _integer_
|
||||
the Id of the library to query
|
||||
<br/>
|
||||
**Example:** `1`
|
||||
|
||||
---
|
||||
##### `tag` _enumeration_
|
||||
|
||||
@@ -17,6 +17,19 @@ import StatusCode from '@/src/components/StatusCode';
|
||||
<GetLibraryItemsMediaContainer/>
|
||||
</Collapsible>
|
||||
|
||||
</Collapsible>
|
||||
</Tab>
|
||||
{/* prettier-ignore */}
|
||||
<Tab title={<StatusCode code={"400"} />}>
|
||||
_No response body._
|
||||
</Tab>
|
||||
{/* prettier-ignore */}
|
||||
<Tab title={<StatusCode code={"401"} />}>
|
||||
*JSON object*
|
||||
<Collapsible defaultOpen openLabel={Labels.showProperties} closeLabel={Labels.hideProperties}>
|
||||
##### `errors` _array (optional)_
|
||||
|
||||
|
||||
</Collapsible>
|
||||
</Tab>
|
||||
</TabbedSection>
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
|
||||
<CH.Code>
|
||||
```bash Example Request
|
||||
curl http://10.10.10.47:32400/library/sections/71036/{{tag}} \
|
||||
curl http://10.10.10.47:32400/library/sections/1/{{tag}} \
|
||||
--header 'Accept: application/json' \
|
||||
--header 'X-Plex-Token: YOUR_API_KEY_HERE'
|
||||
```
|
||||
@@ -25,7 +25,114 @@ curl http://10.10.10.47:32400/library/sections/71036/{{tag}} \
|
||||
"viewGroup": "movie",
|
||||
"viewMode": 65592,
|
||||
"mixedParents": true,
|
||||
"Metadata": []
|
||||
"Metadata": [
|
||||
{
|
||||
"ratingKey": "58683",
|
||||
"key": "/library/metadata/58683",
|
||||
"guid": "plex://movie/5d7768ba96b655001fdc0408",
|
||||
"studio": "20th Century Studios",
|
||||
"type": "movie",
|
||||
"title": "Avatar: The Way of Water",
|
||||
"contentRating": "PG-13",
|
||||
"summary": "Jake Sully lives with his newfound family formed on the extrasolar moon Pandora. Once a familiar threat returns to finish what was previously started, Jake must work with Neytiri and the army of the Na'vi race to protect their home.",
|
||||
"rating": 7.6,
|
||||
"audienceRating": 9.2,
|
||||
"year": 2022,
|
||||
"tagline": "Return to Pandora.",
|
||||
"thumb": "/library/metadata/58683/thumb/1703239236",
|
||||
"art": "/library/metadata/58683/art/1703239236",
|
||||
"duration": 11558112,
|
||||
"originallyAvailableAt": "2022-12-14T00:00:00Z",
|
||||
"addedAt": 1680457607,
|
||||
"updatedAt": 1703239236,
|
||||
"audienceRatingImage": "rottentomatoes://image.rating.upright",
|
||||
"chapterSource": "media",
|
||||
"primaryExtraKey": "/library/metadata/58684",
|
||||
"ratingImage": "rottentomatoes://image.rating.ripe",
|
||||
"grandparentRatingKey": "66",
|
||||
"grandparentGuid": "plex://show/5d9c081b170e24001f2a7be4",
|
||||
"grandparentKey": "/library/metadata/66",
|
||||
"grandparentTitle": "Caprica",
|
||||
"grandparentThumb": "/library/metadata/66/thumb/1705716261",
|
||||
"grandparentArt": "/library/metadata/66/art/1705716261",
|
||||
"grandparentTheme": "/library/metadata/66/theme/1705716261",
|
||||
"Media": [
|
||||
{
|
||||
"id": 119534,
|
||||
"duration": 11558112,
|
||||
"bitrate": 25025,
|
||||
"width": 3840,
|
||||
"height": 2072,
|
||||
"aspectRatio": 1.85,
|
||||
"audioChannels": 6,
|
||||
"audioCodec": "eac3",
|
||||
"videoCodec": "hevc",
|
||||
"videoResolution": "4k",
|
||||
"container": "mkv",
|
||||
"videoFrameRate": "24p",
|
||||
"videoProfile": "main 10",
|
||||
"Part": [
|
||||
{
|
||||
"id": 119542,
|
||||
"key": "/library/parts/119542/1680457526/file.mkv",
|
||||
"duration": 11558112,
|
||||
"file": "/movies/Avatar The Way of Water (2022)/Avatar.The.Way.of.Water.2022.2160p.WEB-DL.DDP5.1.Atmos.DV.HDR10.HEVC-CMRG.mkv",
|
||||
"size": 36158371307,
|
||||
"container": "mkv",
|
||||
"videoProfile": "main 10"
|
||||
}
|
||||
]
|
||||
}
|
||||
],
|
||||
"Genre": [
|
||||
{
|
||||
"tag": "Adventure"
|
||||
}
|
||||
],
|
||||
"Country": [
|
||||
{
|
||||
"tag": "United States of America"
|
||||
}
|
||||
],
|
||||
"Director": [
|
||||
{
|
||||
"tag": "James Cameron"
|
||||
}
|
||||
],
|
||||
"Writer": [
|
||||
{
|
||||
"tag": "James Cameron"
|
||||
}
|
||||
],
|
||||
"Role": [
|
||||
{
|
||||
"tag": "Sigourney Weaver"
|
||||
}
|
||||
],
|
||||
"titleSort": "Whale",
|
||||
"viewCount": 1,
|
||||
"lastViewedAt": 1682752242,
|
||||
"originalTitle": "映画 ブラッククローバー 魔法帝の剣",
|
||||
"viewOffset": 5222500,
|
||||
"skipCount": 1,
|
||||
"index": 1,
|
||||
"theme": "/library/metadata/1/theme/1705636920",
|
||||
"leafCount": 14,
|
||||
"viewedLeafCount": 0,
|
||||
"childCount": 1,
|
||||
"hasPremiumExtras": "1",
|
||||
"hasPremiumPrimaryExtra": "1",
|
||||
"parentRatingKey": "66",
|
||||
"parentGuid": "plex://show/5d9c081b170e24001f2a7be4",
|
||||
"parentStudio": "UCP",
|
||||
"parentKey": "/library/metadata/66",
|
||||
"parentTitle": "Caprica",
|
||||
"parentIndex": 1,
|
||||
"parentYear": 2010,
|
||||
"parentThumb": "/library/metadata/66/thumb/1705716261",
|
||||
"parentTheme": "/library/metadata/66/theme/1705716261"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
|
||||
<CH.Code>
|
||||
```bash Example Request
|
||||
curl http://10.10.10.47:32400/library/metadata/6481.72 \
|
||||
curl http://10.10.10.47:32400/library/metadata/3843.82 \
|
||||
--header 'Accept: application/json' \
|
||||
--header 'X-Plex-Token: YOUR_API_KEY_HERE'
|
||||
```
|
||||
@@ -18,7 +18,167 @@ curl http://10.10.10.47:32400/library/metadata/6481.72 \
|
||||
"librarySectionUUID": "cfc899d7-3000-46f6-8489-b9592714ada5",
|
||||
"mediaTagPrefix": "/system/bundle/media/flags/",
|
||||
"mediaTagVersion": 1698860922,
|
||||
"Metadata": []
|
||||
"Metadata": [
|
||||
{
|
||||
"ratingKey": "17",
|
||||
"key": "/library/metadata/17",
|
||||
"guid": "plex://movie/5d77683f6f4521001ea9dc53",
|
||||
"studio": "Universal Pictures",
|
||||
"type": "movie",
|
||||
"title": "Serenity",
|
||||
"librarySectionTitle": "Movies",
|
||||
"librarySectionID": 1,
|
||||
"librarySectionKey": "/library/sections/1",
|
||||
"contentRating": "PG-13",
|
||||
"summary": "Serenity continues the story of the TV series it was based upon (\"Firefly\"). River Tam had a secret - one in which she's not even aware - so dangerous, no one's safe, as an Alliance operative's sent to capture her, and all others are considered irrelevant to his job.",
|
||||
"rating": 8.2,
|
||||
"audienceRating": 9.1,
|
||||
"year": 2005,
|
||||
"tagline": "They aim to misbehave.",
|
||||
"thumb": "/library/metadata/17/thumb/1705637165",
|
||||
"art": "/library/metadata/17/art/1705637165",
|
||||
"duration": 141417,
|
||||
"originallyAvailableAt": "2005-09-29T00:00:00Z",
|
||||
"addedAt": 1705637164,
|
||||
"updatedAt": 1705637165,
|
||||
"audienceRatingImage": "rottentomatoes://image.rating.upright",
|
||||
"hasPremiumPrimaryExtra": "1",
|
||||
"ratingImage": "rottentomatoes://image.rating.ripe",
|
||||
"Media": [
|
||||
{
|
||||
"id": 15,
|
||||
"duration": 141417,
|
||||
"bitrate": 2278,
|
||||
"width": 1920,
|
||||
"height": 814,
|
||||
"aspectRatio": 2.35,
|
||||
"audioChannels": 2,
|
||||
"audioCodec": "aac",
|
||||
"videoCodec": "h264",
|
||||
"videoResolution": "1080",
|
||||
"container": "mp4",
|
||||
"videoFrameRate": "24p",
|
||||
"optimizedForStreaming": 0,
|
||||
"audioProfile": "lc",
|
||||
"has64bitOffsets": false,
|
||||
"videoProfile": "high",
|
||||
"Part": [
|
||||
{
|
||||
"id": 15,
|
||||
"key": "/library/parts/15/1705637151/file.mp4",
|
||||
"duration": 141417,
|
||||
"file": "/movies/Serenity (2005)/Serenity (2005).mp4",
|
||||
"size": 40271948,
|
||||
"audioProfile": "lc",
|
||||
"container": "mp4",
|
||||
"has64bitOffsets": false,
|
||||
"optimizedForStreaming": false,
|
||||
"videoProfile": "high",
|
||||
"Stream": [
|
||||
{
|
||||
"id": 29,
|
||||
"streamType": 2,
|
||||
"default": true,
|
||||
"codec": "aac",
|
||||
"index": 0,
|
||||
"bitrate": 128,
|
||||
"bitDepth": 8,
|
||||
"chromaLocation": "left",
|
||||
"chromaSubsampling": "14520",
|
||||
"codedHeight": 816,
|
||||
"codedWidth": 1920,
|
||||
"colorPrimaries": "bt709",
|
||||
"colorRange": "tv",
|
||||
"colorSpace": "bt709",
|
||||
"colorTrc": "bt709",
|
||||
"frameRate": 24,
|
||||
"hasScalingMatrix": false,
|
||||
"height": 814,
|
||||
"level": 40,
|
||||
"profile": "lc",
|
||||
"refFrames": 4,
|
||||
"scanType": "progressive",
|
||||
"streamIdentifier": "1",
|
||||
"width": 1920,
|
||||
"displayTitle": "English (AAC Stereo)",
|
||||
"extendedDisplayTitle": "English (AAC Stereo)",
|
||||
"selected": true,
|
||||
"channels": 2,
|
||||
"language": "English",
|
||||
"languageTag": "en",
|
||||
"languageCode": "eng",
|
||||
"samplingRate": 44100
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
||||
],
|
||||
"Genre": [
|
||||
{
|
||||
"id": 184,
|
||||
"filter": "genre=184",
|
||||
"tag": "Thriller"
|
||||
}
|
||||
],
|
||||
"Country": [
|
||||
{
|
||||
"id": 116,
|
||||
"filter": "country=116",
|
||||
"tag": "United States of America"
|
||||
}
|
||||
],
|
||||
"guids": [
|
||||
{
|
||||
"id": "tvdb://2337"
|
||||
}
|
||||
],
|
||||
"ratings": [
|
||||
{
|
||||
"image": "themoviedb://image.rating",
|
||||
"value": 7.4,
|
||||
"type": "audience"
|
||||
}
|
||||
],
|
||||
"Director": [
|
||||
{
|
||||
"id": 130,
|
||||
"filter": "director=130",
|
||||
"tag": "Joss Whedon",
|
||||
"tagKey": "5d776828880197001ec90e8f",
|
||||
"thumb": "https://metadata-static.plex.tv/people/5d776828880197001ec90e8f.jpg"
|
||||
}
|
||||
],
|
||||
"Writer": [
|
||||
{
|
||||
"id": 132,
|
||||
"filter": "writer=132",
|
||||
"tag": "Joss Whedon",
|
||||
"tagKey": "5d776828880197001ec90e8f",
|
||||
"thumb": "https://metadata-static.plex.tv/people/5d776828880197001ec90e8f.jpg"
|
||||
}
|
||||
],
|
||||
"Role": [
|
||||
{
|
||||
"id": 220,
|
||||
"filter": "actor=220",
|
||||
"tag": "Dennis Keiffer",
|
||||
"tagKey": "5d77683554f42c001f8c4708",
|
||||
"role": "Bar Guy (uncredited)",
|
||||
"thumb": "https://metadata-static.plex.tv/6/people/648e9a7ea1d537bccfcd7615134b78ce.jpg"
|
||||
}
|
||||
],
|
||||
"Producer": [
|
||||
{
|
||||
"id": 221,
|
||||
"filter": "producer=221",
|
||||
"tag": "Barry Mendel",
|
||||
"tagKey": "5d776826961905001eb90e2b",
|
||||
"thumb": "https://metadata-static.plex.tv/8/people/87877371326a964634d18556d94547e1.jpg"
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
|
||||
<CH.Code>
|
||||
```bash Example Request
|
||||
curl http://10.10.10.47:32400/library/metadata/202.18/children \
|
||||
curl http://10.10.10.47:32400/library/metadata/4375.87/children \
|
||||
--header 'Accept: application/json' \
|
||||
--header 'X-Plex-Token: YOUR_API_KEY_HERE'
|
||||
```
|
||||
@@ -32,7 +32,37 @@ curl http://10.10.10.47:32400/library/metadata/202.18/children \
|
||||
"viewGroup": "season",
|
||||
"viewMode": 65593,
|
||||
"Directory": [],
|
||||
"Metadata": []
|
||||
"Metadata": [
|
||||
{
|
||||
"ratingKey": "66488",
|
||||
"key": "/library/metadata/66488/children",
|
||||
"parentRatingKey": "30072",
|
||||
"guid": "plex://season/652aea6549508477c34c6000",
|
||||
"parentGuid": "plex://show/5d9c09190aaccd001f8f42f0",
|
||||
"parentStudio": "Amazon Studios",
|
||||
"type": "season",
|
||||
"title": "Season 2",
|
||||
"parentKey": "/library/metadata/30072",
|
||||
"parentTitle": "Reacher",
|
||||
"summary": "Based on\"Bad Luck and Trouble,\" when members of Reacher's old military unit start turning up dead, Reacher has just one thing on his mind—revenge.",
|
||||
"index": 2,
|
||||
"parentIndex": 1,
|
||||
"viewCount": 11,
|
||||
"lastViewedAt": 1705646565,
|
||||
"parentYear": 2022,
|
||||
"thumb": "/library/metadata/66488/thumb/1703065033",
|
||||
"art": "/library/metadata/30072/art/1705739923",
|
||||
"parentThumb": "/library/metadata/30072/thumb/1705739923",
|
||||
"parentTheme": "/library/metadata/30072/theme/1705739923",
|
||||
"leafCount": 8,
|
||||
"viewedLeafCount": 8,
|
||||
"addedAt": 1702602021,
|
||||
"updatedAt": 1703065033,
|
||||
"userRating": 9,
|
||||
"skipCount": 1,
|
||||
"lastRatedAt": 1703881224
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
|
||||
<CH.Code>
|
||||
```bash Example Request
|
||||
curl http://10.10.10.47:32400/library/sections/3373.96/refresh \
|
||||
curl http://10.10.10.47:32400/library/sections/6235.64/refresh \
|
||||
--header 'Accept: application/json' \
|
||||
--header 'X-Plex-Token: YOUR_API_KEY_HERE'
|
||||
```
|
||||
|
||||
@@ -17,6 +17,19 @@ import StatusCode from '@/src/components/StatusCode';
|
||||
<SearchLibraryMediaContainer/>
|
||||
</Collapsible>
|
||||
|
||||
</Collapsible>
|
||||
</Tab>
|
||||
{/* prettier-ignore */}
|
||||
<Tab title={<StatusCode code={"400"} />}>
|
||||
_No response body._
|
||||
</Tab>
|
||||
{/* prettier-ignore */}
|
||||
<Tab title={<StatusCode code={"401"} />}>
|
||||
*JSON object*
|
||||
<Collapsible defaultOpen openLabel={Labels.showProperties} closeLabel={Labels.hideProperties}>
|
||||
##### `errors` _array (optional)_
|
||||
|
||||
|
||||
</Collapsible>
|
||||
</Tab>
|
||||
</TabbedSection>
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
|
||||
<CH.Code>
|
||||
```bash Example Request
|
||||
curl http://10.10.10.47:32400/library/sections/87129/search \
|
||||
curl http://10.10.10.47:32400/library/sections/645894/search \
|
||||
--header 'Accept: application/json' \
|
||||
--header 'X-Plex-Token: YOUR_API_KEY_HERE'
|
||||
```
|
||||
@@ -22,7 +22,30 @@ curl http://10.10.10.47:32400/library/sections/87129/search \
|
||||
"title2": "Search for ''",
|
||||
"viewGroup": "season",
|
||||
"viewMode": 65593,
|
||||
"Metadata": []
|
||||
"Metadata": [
|
||||
{
|
||||
"ratingKey": "2",
|
||||
"key": "/library/metadata/2/children",
|
||||
"parentRatingKey": "1",
|
||||
"guid": "plex://season/602e67e766dfdb002c0a1b5b",
|
||||
"parentGuid": "plex://show/5d9c086c7d06d9001ffd27aa",
|
||||
"parentStudio": "Mutant Enemy Productions",
|
||||
"type": "season",
|
||||
"title": "Season 1",
|
||||
"parentKey": "/library/metadata/1",
|
||||
"parentTitle": "Firefly",
|
||||
"summary": "Captain Malcolm 'Mal' Reynolds is a former galactic war veteran who is the captain of the transport ship \"Serenity\". Mal and his crew, ensign Zoe Alleyne Washburne; Zoe's husband, pilot Hoban 'Wash' Washburne; muscular mercenary Jayne Cobb; young mechanic Kaylee Frye; former Alliance medical officer Simon Tam; his disturbed teenage sister River (both on the run from the interplanetary government \"The Alliance\"); the beautiful courtesan Inara Serra; and preacher Shepherd Book do any jobs, legal or illegal, they can find as the Serenity crew travels across the outskirts of outer space.",
|
||||
"index": 1,
|
||||
"parentIndex": 1,
|
||||
"parentYear": 2002,
|
||||
"thumb": "/library/metadata/2/thumb/1705636920",
|
||||
"art": "/library/metadata/1/art/1705636920",
|
||||
"parentThumb": "/library/metadata/1/thumb/1705636920",
|
||||
"parentTheme": "/library/metadata/1/theme/1705636920",
|
||||
"addedAt": 1705636916,
|
||||
"updatedAt": 1705636920
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
@@ -5,8 +5,12 @@ the media key
|
||||
---
|
||||
##### `time` _number_
|
||||
The time, in milliseconds, used to set the media playback progress.
|
||||
<br/>
|
||||
**Example:** `90000`
|
||||
|
||||
---
|
||||
##### `state` _string_
|
||||
The playback state of the media item.
|
||||
<br/>
|
||||
**Example:** `played`
|
||||
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
|
||||
<CH.Code>
|
||||
```bash Example Request
|
||||
curl http://10.10.10.47:32400/:/progress?key=%3Cvalue%3E&state=%3Cvalue%3E&time=7151.9 \
|
||||
curl http://10.10.10.47:32400/:/progress?key=%3Cvalue%3E&state=played&time=90000 \
|
||||
--header 'Accept: application/json' \
|
||||
--header 'X-Plex-Token: YOUR_API_KEY_HERE'
|
||||
```
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
|
||||
<CH.Code>
|
||||
```bash Example Request
|
||||
curl http://10.10.10.47:32400/playlists/9786.19/items?playQueueID=123&uri=server%3A%2F%2F12345%2Fcom.plexapp.plugins.library%2Flibrary%2Fmetadata%2F1 \
|
||||
curl http://10.10.10.47:32400/playlists/7917.25/items?playQueueID=123&uri=server%3A%2F%2F12345%2Fcom.plexapp.plugins.library%2Flibrary%2Fmetadata%2F1 \
|
||||
--header 'Accept: application/json' \
|
||||
--header 'X-Plex-Token: YOUR_API_KEY_HERE'
|
||||
```
|
||||
@@ -13,7 +13,23 @@ curl http://10.10.10.47:32400/playlists/9786.19/items?playQueueID=123&uri=server
|
||||
"size": 1,
|
||||
"leafCountAdded": 1,
|
||||
"leafCountRequested": 1,
|
||||
"Metadata": []
|
||||
"Metadata": [
|
||||
{
|
||||
"ratingKey": "94",
|
||||
"key": "/playlists/94/items",
|
||||
"guid": "com.plexapp.agents.none://972e3047-83d6-4848-a000-261f0af26ba2",
|
||||
"type": "playlist",
|
||||
"title": "A great playlist",
|
||||
"summary": "One of my great playlists",
|
||||
"smart": false,
|
||||
"playlistType": "video",
|
||||
"composite": "/playlists/94/composite/1705800070",
|
||||
"duration": 423000,
|
||||
"leafCount": 3,
|
||||
"addedAt": 1705716458,
|
||||
"updatedAt": 1705800070
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
|
||||
<CH.Code>
|
||||
```bash Example Request
|
||||
curl http://10.10.10.47:32400/playlists/8700.88/items \
|
||||
curl http://10.10.10.47:32400/playlists/4776.65/items \
|
||||
--header 'Accept: application/json' \
|
||||
--header 'X-Plex-Token: YOUR_API_KEY_HERE'
|
||||
```
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
|
||||
<CH.Code>
|
||||
```bash Example Request
|
||||
curl http://10.10.10.47:32400/playlists?playQueueID=3682.41&title=%3Cvalue%3E&uri=%3Cvalue%3E \
|
||||
curl http://10.10.10.47:32400/playlists?playQueueID=2975.34&title=%3Cvalue%3E&uri=%3Cvalue%3E \
|
||||
--header 'Accept: application/json' \
|
||||
--header 'X-Plex-Token: YOUR_API_KEY_HERE'
|
||||
```
|
||||
@@ -11,7 +11,26 @@ curl http://10.10.10.47:32400/playlists?playQueueID=3682.41&title=%3Cvalue%3E&ur
|
||||
{
|
||||
"MediaContainer": {
|
||||
"size": 7,
|
||||
"Metadata": []
|
||||
"Metadata": [
|
||||
{
|
||||
"ratingKey": "96",
|
||||
"key": "/playlists/96/items",
|
||||
"guid": "com.plexapp.agents.none://a2f92937-1408-40e2-b022-63a8a9377e55",
|
||||
"type": "playlist",
|
||||
"title": "A Great Playlist",
|
||||
"summary": "What a great playlist",
|
||||
"smart": false,
|
||||
"playlistType": "video",
|
||||
"icon": "playlist://image.smart",
|
||||
"viewCount": 1,
|
||||
"lastViewedAt": 1705719589,
|
||||
"leafCount": 1,
|
||||
"addedAt": 1705719589,
|
||||
"updatedAt": 1705724593,
|
||||
"composite": "/playlists/96/composite/1705724593",
|
||||
"duration": 141000
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
|
||||
<CH.Code>
|
||||
```bash Example Request
|
||||
curl http://10.10.10.47:32400/playlists/9571.56 \
|
||||
curl http://10.10.10.47:32400/playlists/567.13 \
|
||||
--header 'Accept: application/json' \
|
||||
--header 'X-Plex-Token: YOUR_API_KEY_HERE'
|
||||
```
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
|
||||
<CH.Code>
|
||||
```bash Example Request
|
||||
curl http://10.10.10.47:32400/playlists/8326.2 \
|
||||
curl http://10.10.10.47:32400/playlists/8917.73 \
|
||||
--header 'Accept: application/json' \
|
||||
--header 'X-Plex-Token: YOUR_API_KEY_HERE'
|
||||
```
|
||||
@@ -11,7 +11,25 @@ curl http://10.10.10.47:32400/playlists/8326.2 \
|
||||
{
|
||||
"MediaContainer": {
|
||||
"size": 1,
|
||||
"Metadata": []
|
||||
"Metadata": [
|
||||
{
|
||||
"content": "library://x/directory/%2Flibrary%2Fsections%2F1%2Fall%3Ftype%3D1%26push%3D1%26title%3D2%26or%3D1%26title%3DSerenity%26pop%3D1",
|
||||
"ratingKey": "95",
|
||||
"key": "/playlists/95/items",
|
||||
"guid": "com.plexapp.agents.none://87425529-380f-44b8-a689-9a0537e7ec91",
|
||||
"type": "playlist",
|
||||
"title": "Smart Movie Playlist",
|
||||
"summary": "",
|
||||
"smart": true,
|
||||
"playlistType": "video",
|
||||
"composite": "/playlists/95/composite/1705717387",
|
||||
"icon": "playlist://image.smart",
|
||||
"duration": 282000,
|
||||
"leafCount": 2,
|
||||
"addedAt": 1705716493,
|
||||
"updatedAt": 1705717387
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
|
||||
<CH.Code>
|
||||
```bash Example Request
|
||||
curl http://10.10.10.47:32400/playlists/1403.5/items?type=8700.13 \
|
||||
curl http://10.10.10.47:32400/playlists/2726.56/items?type=3834.41 \
|
||||
--header 'Accept: application/json' \
|
||||
--header 'X-Plex-Token: YOUR_API_KEY_HERE'
|
||||
```
|
||||
@@ -18,7 +18,95 @@ curl http://10.10.10.47:32400/playlists/1403.5/items?type=8700.13 \
|
||||
"ratingKey": "95",
|
||||
"smart": true,
|
||||
"title": "Smart Movie Playlist",
|
||||
"Metadata": []
|
||||
"Metadata": [
|
||||
{
|
||||
"ratingKey": "17",
|
||||
"key": "/library/metadata/17",
|
||||
"guid": "plex://movie/5d77683f6f4521001ea9dc53",
|
||||
"studio": "Universal Pictures",
|
||||
"type": "movie",
|
||||
"title": "Serenity",
|
||||
"titleSort": "Amazing Spider-Man 2",
|
||||
"librarySectionTitle": "Movies",
|
||||
"librarySectionID": 1,
|
||||
"librarySectionKey": "/library/sections/1",
|
||||
"contentRating": "PG-13",
|
||||
"summary": "Serenity continues the story of the TV series it was based upon (\"Firefly\"). River Tam had a secret - one in which she's not even aware - so dangerous, no one's safe, as an Alliance operative's sent to capture her, and all others are considered irrelevant to his job.",
|
||||
"rating": 8.2,
|
||||
"audienceRating": 9.1,
|
||||
"year": 2005,
|
||||
"tagline": "They aim to misbehave.",
|
||||
"thumb": "/library/metadata/17/thumb/1705637165",
|
||||
"art": "/library/metadata/17/art/1705637165",
|
||||
"duration": 141416,
|
||||
"originallyAvailableAt": "2005-09-29T00:00:00Z",
|
||||
"addedAt": 1705637164,
|
||||
"updatedAt": 1705637165,
|
||||
"audienceRatingImage": "rottentomatoes://image.rating.upright",
|
||||
"hasPremiumExtras": "1",
|
||||
"hasPremiumPrimaryExtra": "1",
|
||||
"ratingImage": "rottentomatoes://image.rating.ripe",
|
||||
"Media": [
|
||||
{
|
||||
"id": 15,
|
||||
"duration": 141416,
|
||||
"bitrate": 2273,
|
||||
"width": 1920,
|
||||
"height": 814,
|
||||
"aspectRatio": 2.35,
|
||||
"audioChannels": 2,
|
||||
"audioCodec": "aac",
|
||||
"videoCodec": "h264",
|
||||
"videoResolution": "1080",
|
||||
"container": "mp4",
|
||||
"videoFrameRate": "24p",
|
||||
"optimizedForStreaming": 0,
|
||||
"audioProfile": "lc",
|
||||
"has64bitOffsets": false,
|
||||
"videoProfile": "high",
|
||||
"Part": [
|
||||
{
|
||||
"id": 15,
|
||||
"key": "/library/parts/15/1705637151/file.mp4",
|
||||
"duration": 141416,
|
||||
"file": "/movies/Serenity (2005)/Serenity (2005).mp4",
|
||||
"size": 40271948,
|
||||
"audioProfile": "lc",
|
||||
"container": "mp4",
|
||||
"has64bitOffsets": false,
|
||||
"optimizedForStreaming": false,
|
||||
"videoProfile": "high"
|
||||
}
|
||||
]
|
||||
}
|
||||
],
|
||||
"Genre": [
|
||||
{
|
||||
"tag": "Action"
|
||||
}
|
||||
],
|
||||
"Country": [
|
||||
{
|
||||
"tag": "United States of America"
|
||||
}
|
||||
],
|
||||
"Director": [
|
||||
{
|
||||
"tag": "Joss Whedon"
|
||||
}
|
||||
],
|
||||
"Writer": [
|
||||
{
|
||||
"tag": "Joss Whedon"
|
||||
}
|
||||
],
|
||||
"Role": [
|
||||
{
|
||||
"tag": "Gina Torres"
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
@@ -11,7 +11,26 @@ curl http://10.10.10.47:32400/playlists \
|
||||
{
|
||||
"MediaContainer": {
|
||||
"size": 4,
|
||||
"Metadata": []
|
||||
"Metadata": [
|
||||
{
|
||||
"ratingKey": "92",
|
||||
"key": "/playlists/92/items",
|
||||
"guid": "com.plexapp.agents.none://7ca5aaef-58e8-4828-9e21-c009c97f2903",
|
||||
"type": "playlist",
|
||||
"title": "Static Playlist",
|
||||
"summary": "A Great Playlist",
|
||||
"smart": false,
|
||||
"playlistType": "video",
|
||||
"composite": "/playlists/92/composite/1705716440",
|
||||
"icon": "playlist://image.smart",
|
||||
"viewCount": 1,
|
||||
"lastViewedAt": 1705716298,
|
||||
"duration": 7328000,
|
||||
"leafCount": 32,
|
||||
"addedAt": 1705716298,
|
||||
"updatedAt": 1705716440
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
|
||||
<CH.Code>
|
||||
```bash Example Request
|
||||
curl http://10.10.10.47:32400/playlists/7781.57?summary=%3Cvalue%3E&title=%3Cvalue%3E \
|
||||
curl http://10.10.10.47:32400/playlists/9636.63?summary=%3Cvalue%3E&title=%3Cvalue%3E \
|
||||
--header 'Accept: application/json' \
|
||||
--header 'X-Plex-Token: YOUR_API_KEY_HERE'
|
||||
```
|
||||
|
||||
@@ -1,14 +1,16 @@
|
||||
{/* Autogenerated DO NOT EDIT */}
|
||||
##### `X-Plex-Client-Identifier` _string_
|
||||
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)
|
||||
|
||||
|
||||
---
|
||||
##### `strong` _boolean (optional)_
|
||||
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` _string (optional)_
|
||||
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)
|
||||
|
||||
<br/>
|
||||
**Example:** `Postman`
|
||||
|
||||
|
||||
@@ -3,8 +3,7 @@
|
||||
```bash Example Request
|
||||
curl https://plex.tv/api/v2/pins?strong=false \
|
||||
--header 'Accept: application/json' \
|
||||
--header 'X-Plex-Token: YOUR_API_KEY_HERE' \
|
||||
--header 'X-Plex-Client-Identifier: <value>'
|
||||
--header 'X-Plex-Client-Identifier: Postman'
|
||||
```
|
||||
---
|
||||
|
||||
|
||||
@@ -3,9 +3,11 @@
|
||||
The PinID to retrieve an access token for
|
||||
|
||||
---
|
||||
##### `X-Plex-Client-Identifier` _string_
|
||||
##### `X-Plex-Client-Identifier` _string (optional)_
|
||||
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)
|
||||
|
||||
<br/>
|
||||
**Example:** `Postman`
|
||||
|
||||
|
||||
@@ -3,8 +3,7 @@
|
||||
```bash Example Request
|
||||
curl https://plex.tv/api/v2/pins/<value> \
|
||||
--header 'Accept: application/json' \
|
||||
--header 'X-Plex-Token: YOUR_API_KEY_HERE' \
|
||||
--header 'X-Plex-Client-Identifier: <value>'
|
||||
--header 'X-Plex-Client-Identifier: Postman'
|
||||
```
|
||||
---
|
||||
|
||||
|
||||
@@ -13,7 +13,7 @@ import Library from "./library/library.mdx";
|
||||
import Log from "./log/log.mdx";
|
||||
import Plex from "./plex/plex.mdx";
|
||||
import Playlists from "./playlists/playlists.mdx";
|
||||
import Security from "./security/security.mdx";
|
||||
import Authentication from "./authentication/authentication.mdx";
|
||||
import Statistics from "./statistics/statistics.mdx";
|
||||
import Sessions from "./sessions/sessions.mdx";
|
||||
import Updater from "./updater/updater.mdx";
|
||||
@@ -51,7 +51,7 @@ import Updater from "./updater/updater.mdx";
|
||||
<Playlists/>
|
||||
|
||||
---
|
||||
<Security/>
|
||||
<Authentication/>
|
||||
|
||||
---
|
||||
<Statistics/>
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
|
||||
<CH.Code>
|
||||
```bash Example Request
|
||||
curl http://10.10.10.47:32400/hubs/search?limit=5&query=dylan§ionId=3927.85 \
|
||||
curl http://10.10.10.47:32400/hubs/search?limit=5&query=dylan§ionId=5448.83 \
|
||||
--header 'Accept: application/json' \
|
||||
--header 'X-Plex-Token: YOUR_API_KEY_HERE'
|
||||
```
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
|
||||
<CH.Code>
|
||||
```bash Example Request
|
||||
curl http://10.10.10.47:32400/hubs/search/voice?limit=5&query=dead%2Bpoop§ionId=9255.97 \
|
||||
curl http://10.10.10.47:32400/hubs/search/voice?limit=5&query=dead%2Bpoop§ionId=8472.52 \
|
||||
--header 'Accept: application/json' \
|
||||
--header 'X-Plex-Token: YOUR_API_KEY_HERE'
|
||||
```
|
||||
|
||||
@@ -1,17 +0,0 @@
|
||||
import GetTransientToken from "./get_transient_token/get_transient_token.mdx";
|
||||
import GetSourceConnectionInformation from "./get_source_connection_information/get_source_connection_information.mdx";
|
||||
|
||||
## Security
|
||||
API Calls against Security for Plex Media Server
|
||||
|
||||
|
||||
### Available Operations
|
||||
|
||||
* [Get Transient Token](/curl/security/get_transient_token) - Get a Transient Token.
|
||||
* [Get Source Connection Information](/curl/security/get_source_connection_information) - Get Source Connection Information
|
||||
|
||||
---
|
||||
<GetTransientToken />
|
||||
|
||||
---
|
||||
<GetSourceConnectionInformation />
|
||||
@@ -11,7 +11,20 @@ curl http://10.10.10.47:32400/:/prefs \
|
||||
{
|
||||
"MediaContainer": {
|
||||
"size": 161,
|
||||
"Setting": []
|
||||
"Setting": [
|
||||
{
|
||||
"id": "EnableDatabaseTrace",
|
||||
"label": "",
|
||||
"summary": "",
|
||||
"type": "bool",
|
||||
"default": false,
|
||||
"value": false,
|
||||
"hidden": true,
|
||||
"advanced": false,
|
||||
"group": "",
|
||||
"enumValues": "1:admin only|2:everyone"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
@@ -11,7 +11,29 @@ curl http://10.10.10.47:32400/status/sessions/history/all \
|
||||
{
|
||||
"MediaContainer": {
|
||||
"size": 10855,
|
||||
"Metadata": []
|
||||
"Metadata": [
|
||||
{
|
||||
"historyKey": "/status/sessions/history/1",
|
||||
"key": "/library/metadata/32171",
|
||||
"ratingKey": "32171",
|
||||
"librarySectionID": "2",
|
||||
"parentKey": "/library/metadata/32170",
|
||||
"grandparentKey": "/library/metadata/32132",
|
||||
"title": "The Noise That Blue Makes",
|
||||
"grandparentTitle": "Taskmaster",
|
||||
"type": "episode",
|
||||
"thumb": "/library/metadata/32171/thumb/-1",
|
||||
"parentThumb": "/library/metadata/32170/thumb/1654134301",
|
||||
"grandparentThumb": "/library/metadata/32132/thumb/1703933346",
|
||||
"grandparentArt": "/library/metadata/32132/art/1703933346",
|
||||
"index": 1,
|
||||
"parentIndex": 13,
|
||||
"originallyAvailableAt": "2022-04-14T00:00:00Z",
|
||||
"viewedAt": 1654139223,
|
||||
"accountID": 1,
|
||||
"deviceID": 5
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
@@ -11,7 +11,118 @@ curl http://10.10.10.47:32400/status/sessions \
|
||||
{
|
||||
"MediaContainer": {
|
||||
"size": 1,
|
||||
"Metadata": []
|
||||
"Metadata": [
|
||||
{
|
||||
"addedAt": 1705543312,
|
||||
"art": "/library/metadata/39904/art/1705310687",
|
||||
"duration": 186240,
|
||||
"grandparentArt": "/library/metadata/39904/art/1705310687",
|
||||
"grandparentGuid": "plex://artist/5d07bbfd403c6402904a6480",
|
||||
"grandparentKey": "/library/metadata/39904",
|
||||
"grandparentRatingKey": "39904",
|
||||
"grandparentThumb": "/library/metadata/39904/thumb/1705310687",
|
||||
"grandparentTitle": "Green Day",
|
||||
"guid": "plex://track/6535834f71f22f36f71a8e8f",
|
||||
"index": 1,
|
||||
"key": "/library/metadata/67085",
|
||||
"librarySectionID": "3",
|
||||
"librarySectionKey": "/library/sections/3",
|
||||
"librarySectionTitle": "Music",
|
||||
"musicAnalysisVersion": "1",
|
||||
"parentGuid": "plex://album/65394d6d472b8ab03ef47f12",
|
||||
"parentIndex": 1,
|
||||
"parentKey": "/library/metadata/67084",
|
||||
"parentRatingKey": "67084",
|
||||
"parentStudio": "Reprise Records",
|
||||
"parentThumb": "/library/metadata/67084/thumb/1705543314",
|
||||
"parentTitle": "Saviors",
|
||||
"parentYear": 2024,
|
||||
"ratingCount": 45885,
|
||||
"ratingKey": "67085",
|
||||
"sessionKey": "203",
|
||||
"thumb": "/library/metadata/67084/thumb/1705543314",
|
||||
"title": "The American Dream Is Killing Me",
|
||||
"titleSort": "American Dream Is Killing Me",
|
||||
"type": "track",
|
||||
"updatedAt": 1705543314,
|
||||
"viewOffset": 1000,
|
||||
"Media": [
|
||||
{
|
||||
"audioChannels": 2,
|
||||
"audioCodec": "flac",
|
||||
"bitrate": 1014,
|
||||
"container": "flac",
|
||||
"duration": 186240,
|
||||
"id": "130355",
|
||||
"selected": true,
|
||||
"Part": [
|
||||
{
|
||||
"container": "flac",
|
||||
"duration": 186240,
|
||||
"file": "/music/Green Day/Saviors (2024)/Green Day - Saviors - 01 - The American Dream Is Killing Me.flac",
|
||||
"hasThumbnail": "1",
|
||||
"id": "130625",
|
||||
"key": "/library/parts/130625/1705543268/file.flac",
|
||||
"size": 23644000,
|
||||
"decision": "directplay",
|
||||
"selected": true,
|
||||
"Stream": [
|
||||
{
|
||||
"albumGain": "-12.94",
|
||||
"albumPeak": "1.000000",
|
||||
"albumRange": "4.751014",
|
||||
"audioChannelLayout": "stereo",
|
||||
"bitDepth": 16,
|
||||
"bitrate": 1014,
|
||||
"channels": 2,
|
||||
"codec": "flac",
|
||||
"displayTitle": "FLAC (Stereo)",
|
||||
"extendedDisplayTitle": "FLAC (Stereo)",
|
||||
"gain": "-12.94",
|
||||
"id": "352487",
|
||||
"index": 0,
|
||||
"loudness": "-5.94",
|
||||
"lra": "1.74",
|
||||
"peak": "1.000000",
|
||||
"samplingRate": 44100,
|
||||
"selected": true,
|
||||
"streamType": 2,
|
||||
"location": "direct"
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
||||
],
|
||||
"User": {
|
||||
"id": "1",
|
||||
"thumb": "https://plex.tv/users/844780fc6f8a26b5/avatar?c=1705853661",
|
||||
"title": "Blindkitty38"
|
||||
},
|
||||
"Player": {
|
||||
"address": "10.10.10.171",
|
||||
"machineIdentifier": "3tsdzir85m2onc3qyr255aq1",
|
||||
"model": "standalone",
|
||||
"platform": "windows",
|
||||
"platformVersion": "10.0.22621",
|
||||
"product": "Plex for Windows",
|
||||
"profile": "Plex Desktop",
|
||||
"remotePublicAddress": "68.248.140.20",
|
||||
"state": "playing",
|
||||
"title": "DESKTOP-BL80MTD",
|
||||
"version": "1.85.0.4071-21128b56",
|
||||
"local": true,
|
||||
"relayed": false,
|
||||
"secure": true,
|
||||
"userID": 1
|
||||
},
|
||||
"Session": {
|
||||
"id": "93h7e00ncblxncqw9lkfaoxi",
|
||||
"bandwidth": 1050,
|
||||
"location": "lan"
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
@@ -3,4 +3,6 @@
|
||||
The timespan to retrieve statistics for
|
||||
the exact meaning of this parameter is not known
|
||||
|
||||
<br/>
|
||||
**Example:** `4`
|
||||
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
|
||||
<CH.Code>
|
||||
```bash Example Request
|
||||
curl http://10.10.10.47:32400/statistics/media?Timespan=799159 \
|
||||
curl http://10.10.10.47:32400/statistics/media?Timespan=4 \
|
||||
--header 'Accept: application/json' \
|
||||
--header 'X-Plex-Token: YOUR_API_KEY_HERE'
|
||||
```
|
||||
@@ -11,9 +11,38 @@ curl http://10.10.10.47:32400/statistics/media?Timespan=799159 \
|
||||
{
|
||||
"MediaContainer": {
|
||||
"size": 5497,
|
||||
"Device": [],
|
||||
"Account": [],
|
||||
"StatisticsMedia": []
|
||||
"Device": [
|
||||
{
|
||||
"id": 208,
|
||||
"name": "Roku Express",
|
||||
"platform": "Roku",
|
||||
"clientIdentifier": "793095d235660625108ef785cc7646e9",
|
||||
"createdAt": 1706470556
|
||||
}
|
||||
],
|
||||
"Account": [
|
||||
{
|
||||
"id": 238960586,
|
||||
"key": "/accounts/238960586",
|
||||
"name": "Diane",
|
||||
"defaultAudioLanguage": "en",
|
||||
"autoSelectAudio": true,
|
||||
"defaultSubtitleLanguage": "en",
|
||||
"subtitleMode": 1,
|
||||
"thumb": "https://plex.tv/users/50d83634246da1de/avatar?c=1707110967"
|
||||
}
|
||||
],
|
||||
"StatisticsMedia": [
|
||||
{
|
||||
"accountID": 1,
|
||||
"deviceID": 13,
|
||||
"timespan": 4,
|
||||
"at": 1707141600,
|
||||
"metadataType": 4,
|
||||
"count": 1,
|
||||
"duration": 1555
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
@@ -6,6 +6,8 @@ import Labels from "/src/lib/labels";
|
||||
|
||||
##### `tonight` _enumeration (optional)_
|
||||
Indicate that you want the update to run during the next Butler execution. Omitting this or setting it to false indicates that the update should install
|
||||
<br/>
|
||||
**Example:** `1`
|
||||
|
||||
<Collapsible openLabel={Labels.showProperties} closeLabel={Labels.hideProperties}>
|
||||
<Tonight />
|
||||
@@ -14,6 +16,8 @@ Indicate that you want the update to run during the next Butler execution. Omitt
|
||||
---
|
||||
##### `skip` _enumeration (optional)_
|
||||
Indicate that the latest version should be marked as skipped. The \<Release\> entry for this version will have the `state` set to `skipped`.
|
||||
<br/>
|
||||
**Example:** `1`
|
||||
|
||||
<Collapsible openLabel={Labels.showProperties} closeLabel={Labels.hideProperties}>
|
||||
<Skip />
|
||||
|
||||
@@ -5,6 +5,8 @@ import Labels from "/src/lib/labels";
|
||||
|
||||
##### `download` _enumeration (optional)_
|
||||
Indicate that you want to start download any updates found.
|
||||
<br/>
|
||||
**Example:** `1`
|
||||
|
||||
<Collapsible openLabel={Labels.showProperties} closeLabel={Labels.hideProperties}>
|
||||
<Download />
|
||||
|
||||
@@ -5,14 +5,20 @@ import Labels from "/src/lib/labels";
|
||||
|
||||
##### `ratingKey` _number_
|
||||
The rating key of the media item
|
||||
<br/>
|
||||
**Example:** `23409`
|
||||
|
||||
---
|
||||
##### `key` _string_
|
||||
The key of the media item to get the timeline for
|
||||
<br/>
|
||||
**Example:** `/library/metadata/23409`
|
||||
|
||||
---
|
||||
##### `state` _enumeration_
|
||||
The state of the media item
|
||||
<br/>
|
||||
**Example:** `playing`
|
||||
|
||||
<Collapsible openLabel={Labels.showProperties} closeLabel={Labels.hideProperties}>
|
||||
<State />
|
||||
@@ -21,28 +27,42 @@ The state of the media item
|
||||
---
|
||||
##### `hasMDE` _number_
|
||||
Whether the media item has MDE
|
||||
<br/>
|
||||
**Example:** `1`
|
||||
|
||||
---
|
||||
##### `time` _number_
|
||||
The time of the media item
|
||||
<br/>
|
||||
**Example:** `2000`
|
||||
|
||||
---
|
||||
##### `duration` _number_
|
||||
The duration of the media item
|
||||
<br/>
|
||||
**Example:** `10000`
|
||||
|
||||
---
|
||||
##### `context` _string_
|
||||
The context of the media item
|
||||
<br/>
|
||||
**Example:** `home:hub.continueWatching`
|
||||
|
||||
---
|
||||
##### `playQueueItemID` _number_
|
||||
The play queue item ID of the media item
|
||||
<br/>
|
||||
**Example:** `1`
|
||||
|
||||
---
|
||||
##### `playBackTime` _number_
|
||||
The playback time of the media item
|
||||
<br/>
|
||||
**Example:** `2000`
|
||||
|
||||
---
|
||||
##### `row` _number_
|
||||
The row of the media item
|
||||
<br/>
|
||||
**Example:** `1`
|
||||
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
|
||||
<CH.Code>
|
||||
```bash Example Request
|
||||
curl http://10.10.10.47:32400/:/timeline?context=%3Cvalue%3E&duration=5448.83&hasMDE=6027.63&key=%3Cvalue%3E&playBackTime=4236.55&playQueueItemID=8472.52&ratingKey=8442.66&row=6235.64&time=8579.46 \
|
||||
curl http://10.10.10.47:32400/:/timeline?context=home%3Ahub.continueWatching&duration=10000&hasMDE=1&key=%2Flibrary%2Fmetadata%2F23409&playBackTime=2000&playQueueItemID=1&ratingKey=23409&row=1&time=2000 \
|
||||
--header 'Accept: application/json' \
|
||||
--header 'X-Plex-Token: YOUR_API_KEY_HERE'
|
||||
```
|
||||
|
||||
@@ -1,64 +1,96 @@
|
||||
{/* Autogenerated DO NOT EDIT */}
|
||||
##### `hasMDE` _number_
|
||||
Whether the media item has MDE
|
||||
<br/>
|
||||
**Example:** `1`
|
||||
|
||||
---
|
||||
##### `path` _string_
|
||||
The path to the media item to transcode
|
||||
<br/>
|
||||
**Example:** `/library/metadata/23409`
|
||||
|
||||
---
|
||||
##### `mediaIndex` _number_
|
||||
The index of the media item to transcode
|
||||
<br/>
|
||||
**Example:** `0`
|
||||
|
||||
---
|
||||
##### `partIndex` _number_
|
||||
The index of the part to transcode
|
||||
<br/>
|
||||
**Example:** `0`
|
||||
|
||||
---
|
||||
##### `protocol` _string_
|
||||
The protocol to use for the transcode session
|
||||
<br/>
|
||||
**Example:** `hls`
|
||||
|
||||
---
|
||||
##### `fastSeek` _number (optional)_
|
||||
Whether to use fast seek or not
|
||||
<br/>
|
||||
**Example:** `0`
|
||||
|
||||
---
|
||||
##### `directPlay` _number (optional)_
|
||||
Whether to use direct play or not
|
||||
<br/>
|
||||
**Example:** `0`
|
||||
|
||||
---
|
||||
##### `directStream` _number (optional)_
|
||||
Whether to use direct stream or not
|
||||
<br/>
|
||||
**Example:** `0`
|
||||
|
||||
---
|
||||
##### `subtitleSize` _number (optional)_
|
||||
The size of the subtitles
|
||||
<br/>
|
||||
**Example:** `100`
|
||||
|
||||
---
|
||||
##### `subtites` _string (optional)_
|
||||
The subtitles
|
||||
<br/>
|
||||
**Example:** `burn`
|
||||
|
||||
---
|
||||
##### `audioBoost` _number (optional)_
|
||||
The audio boost
|
||||
<br/>
|
||||
**Example:** `100`
|
||||
|
||||
---
|
||||
##### `location` _string (optional)_
|
||||
The location of the transcode session
|
||||
<br/>
|
||||
**Example:** `lan`
|
||||
|
||||
---
|
||||
##### `mediaBufferSize` _number (optional)_
|
||||
The size of the media buffer
|
||||
<br/>
|
||||
**Example:** `102400`
|
||||
|
||||
---
|
||||
##### `session` _string (optional)_
|
||||
The session ID
|
||||
<br/>
|
||||
**Example:** `zvcage8b7rkioqcm8f4uns4c`
|
||||
|
||||
---
|
||||
##### `addDebugOverlay` _number (optional)_
|
||||
Whether to add a debug overlay or not
|
||||
<br/>
|
||||
**Example:** `0`
|
||||
|
||||
---
|
||||
##### `autoAdjustQuality` _number (optional)_
|
||||
Whether to auto adjust quality or not
|
||||
<br/>
|
||||
**Example:** `0`
|
||||
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
|
||||
<CH.Code>
|
||||
```bash Example Request
|
||||
curl http://10.10.10.47:32400/video/:/transcode/universal/start.mpd?addDebugOverlay=4776.65&audioBoost=2726.56&autoAdjustQuality=7917.25&directPlay=8917.73&directStream=567.13&fastSeek=2975.34&hasMDE=6458.94&location=%3Cvalue%3E&mediaBufferSize=3834.41&mediaIndex=3843.82&partIndex=4375.87&path=%3Cvalue%3E&protocol=%3Cvalue%3E&session=%3Cvalue%3E&subtites=%3Cvalue%3E&subtitleSize=9636.63 \
|
||||
curl http://10.10.10.47:32400/video/:/transcode/universal/start.mpd?addDebugOverlay=0&audioBoost=100&autoAdjustQuality=0&directPlay=0&directStream=0&fastSeek=0&hasMDE=1&location=lan&mediaBufferSize=102400&mediaIndex=0&partIndex=0&path=%2Flibrary%2Fmetadata%2F23409&protocol=hls&session=zvcage8b7rkioqcm8f4uns4c&subtites=burn&subtitleSize=100 \
|
||||
--header 'Accept: application/json' \
|
||||
--header 'X-Plex-Token: YOUR_API_KEY_HERE'
|
||||
```
|
||||
|
||||
Reference in New Issue
Block a user