diff --git a/.commitlintrc.json b/.commitlintrc.json new file mode 100644 index 0000000..c30e5a9 --- /dev/null +++ b/.commitlintrc.json @@ -0,0 +1,3 @@ +{ + "extends": ["@commitlint/config-conventional"] +} diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 0000000..9e358f0 --- /dev/null +++ b/.editorconfig @@ -0,0 +1,9 @@ +root = true + +[*] +indent_style = space +indent_size = 2 +charset = utf-8 +end_of_line = lf +trim_trailing_whitespace = true +insert_final_newline = true diff --git a/.eslintrc b/.eslintrc new file mode 100644 index 0000000..79f3793 --- /dev/null +++ b/.eslintrc @@ -0,0 +1,86 @@ +{ + "extends": [ + "eslint:recommended", + "plugin:@typescript-eslint/eslint-recommended", + "plugin:@typescript-eslint/recommended", + "plugin:import/recommended", + "plugin:import/typescript", + "next", + "next/core-web-vitals", + "plugin:prettier/recommended" + ], + "env": { + "node": true + }, + "parser": "@typescript-eslint/parser", + "plugins": [ + "@typescript-eslint", + "import", + "simple-import-sort", + "unused-imports", + "prettier", + "@typescript-eslint/eslint-plugin" + ], + "settings": { + "import/parsers": { + "@typescript-eslint/parser": [".ts", ".tsx"] + }, + "import/resolver": { + "typescript": { + "project": "./tsconfig.json", + "alwaysTryTypes": true + } + } + }, + "parserOptions": { + "tsconfigRootDir": "./", + "sourceType": "module", + "ecmaVersion": 2019 + }, + "rules": { + "prettier/prettier": "error", + "@typescript-eslint/no-explicit-any": "off", + "@typescript-eslint/interface-name-prefix": "off", + "@typescript-eslint/explicit-function-return-type": "off", + "@typescript-eslint/explicit-module-boundary-types": "off", + "@typescript-eslint/no-empty-function": "warn", + "@typescript-eslint/no-unused-vars": [ + "warn", + { + "argsIgnorePattern": "^_" + } + ], + "import/no-unresolved": "error", + "no-shadow": 0, + "spaced-comment": ["error", "always"], + "arrow-body-style": "error", + "padding-line-between-statements": [ + "error", + { + "blankLine": "always", + "prev": "*", + "next": ["return", "while", "switch", "block", "for"] + }, + { + "blankLine": "always", + "prev": ["block", "while", "switch", "if", "for"], + "next": "*" + } + ], + "no-console": [ + "error", + { + "allow": ["warn", "error", "info"] + } + ], + "no-duplicate-imports": "error", + "curly": "error", + "lines-between-class-members": ["error", "always"], + "@typescript-eslint/no-extra-semi": "off", + "@typescript-eslint/no-non-null-assertion": "off", + "@next/next/no-img-element": "off", + "no-case-declarations": "off", + "react-hooks/exhaustive-deps": "off" + }, + "ignorePatterns": ["node_modules", "out", ".next", "next.config.js"] +} diff --git a/.github/workflows/generate-docs.yaml b/.github/workflows/generate-docs.yaml new file mode 100644 index 0000000..db07f05 --- /dev/null +++ b/.github/workflows/generate-docs.yaml @@ -0,0 +1,34 @@ +name: Generate Docs +permissions: + checks: write + contents: write + pull-requests: write + statuses: write +"on": + workflow_dispatch: + inputs: + force: + description: Force generation of SDKs + type: boolean + default: false + schedule: + - cron: 0 0 * * * +jobs: + generate: + uses: speakeasy-api/sdk-generation-action/.github/workflows/sdk-generation.yaml@v14 + with: + force: ${{ github.event.inputs.force }} + languages: | + - docs + docs_languages: | + - python + - typescript + - go + - curl + mode: direct + openapi_docs: | + - https://{openapi_spec}.yaml + speakeasy_version: latest + secrets: + github_access_token: ${{ secrets.GITHUB_TOKEN }} + speakeasy_api_key: ${{ secrets.SPEAKEASY_API_KEY }} \ No newline at end of file diff --git a/.gitignore b/.gitignore index 20b0c92..3a7c234 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,7 @@ +node_modules +.idea +/build/ +/out/ # Logs logs *.log diff --git a/.npmrc b/.npmrc new file mode 100644 index 0000000..82b4bd3 --- /dev/null +++ b/.npmrc @@ -0,0 +1,2 @@ +save-exact = true +strict-peer-dependencies=false diff --git a/.nvmrc b/.nvmrc new file mode 100644 index 0000000..b6a7d89 --- /dev/null +++ b/.nvmrc @@ -0,0 +1 @@ +16 diff --git a/.prettierrc b/.prettierrc new file mode 100644 index 0000000..42904eb --- /dev/null +++ b/.prettierrc @@ -0,0 +1,7 @@ +{ + "arrowParens": "always", + "singleQuote": true, + "jsxSingleQuote": true, + "tabWidth": 2, + "semi": true +} diff --git a/Dockerfile b/Dockerfile new file mode 100644 index 0000000..a4ccb2d --- /dev/null +++ b/Dockerfile @@ -0,0 +1,26 @@ +FROM golang:1.21-alpine as builder + +WORKDIR /app + +RUN go mod init server + +# Copy the server.go file. +COPY server.go ./ + +# Copy the 'out' directory +COPY out/ ./out/ + +RUN go build -o /server + +FROM gcr.io/distroless/base + +WORKDIR / + +COPY --from=builder /server /server +COPY --from=builder /app/out/ /out/ + +ENV PORT=8080 + +EXPOSE 8080 + +ENTRYPOINT ["/server"] diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..108a8b4 --- /dev/null +++ b/Makefile @@ -0,0 +1,2 @@ +docs: + speakeasy generate docs --schema https://raw.githubusercontent.com/LukeHagar/plex-api-spec/main/plex-media-server-spec-dereferenced.yaml --out ./ --langs python,typescript,go,curl --compile \ No newline at end of file diff --git a/content/languages.tsx b/content/languages.tsx new file mode 100644 index 0000000..7566cfd --- /dev/null +++ b/content/languages.tsx @@ -0,0 +1,88 @@ +import React, { + ReactElement, + ReactNode, + useCallback, + useContext, + useMemo, +} from 'react'; +import { Columns, RHS } from '@/src/components/Columns'; +import { + Authentication, + Parameters, + Response, +} from '@/src/components/Parameters'; +import { LanguageContext } from '@/src/utils/contexts/languageContext'; +import { LinkableContext } from '@/src/utils/contexts/linkableContext'; +import { usePathname } from 'next/navigation'; +import { useSetPage } from '@/src/components/scrollManager'; + +export const Languages = ["python", "typescript", "go", "curl"]; +export type Language = (typeof Languages)[number]; +export const DefaultLanguage = 'typescript'; + +export const LanguageProvider = (props: { children: ReactNode }) => { + const slug = usePathname(); + const setPage = useSetPage(); + + const language = useMemo(() => { + // slug is in the form "/typescript/installation" (or null) + const routeLang = slug?.split('/')[1]; + + return routeLang || DefaultLanguage; + }, [slug]); + + const setLanguage = useCallback( + (newLanguage: string) => { + const langRoutePrefix = (lang: string) => `/${lang}/`; + + // Using window.location.pathname because router.asPath often has [...rest] in it + const newPath = window.location.pathname.replace( + langRoutePrefix(language), + langRoutePrefix(newLanguage), + ); + + setPage(newPath); + }, + [language, setPage], + ); + + const context = { + language, + setLanguage, + languages: Languages, + }; + + return ( + + {props.children} + + ); +}; + +export const LanguageSwitch = (props: { + langToContent: Partial>; +}) => { + const { language } = useContext(LanguageContext); + + return ( + + {props.langToContent[language]} + + ); +}; + +export const LanguageOperation = (props: { + usage: ReactElement; + authentication?: ReactElement; + parameters: ReactElement; + response: ReactElement; +}) => ( + + {props.authentication ? ( + {props.authentication} + ) : null} + {props.parameters} + {props.response} + {props.usage} + +); diff --git a/content/pages/01-reference/curl/client_sdks/_snippet.mdx b/content/pages/01-reference/curl/client_sdks/_snippet.mdx new file mode 100644 index 0000000..0b5e9cd --- /dev/null +++ b/content/pages/01-reference/curl/client_sdks/_snippet.mdx @@ -0,0 +1,5 @@ +import SDKPicker from '/src/components/SDKPicker'; + +We offer native client SDKs in the following languages. Select a language to view documentation and usage examples for that language. + + diff --git a/content/pages/01-reference/curl/client_sdks/client_sdks.mdx b/content/pages/01-reference/curl/client_sdks/client_sdks.mdx new file mode 100644 index 0000000..428f4db --- /dev/null +++ b/content/pages/01-reference/curl/client_sdks/client_sdks.mdx @@ -0,0 +1,3 @@ +## Client SDKs + +{/* render client_sdks */} diff --git a/content/pages/01-reference/curl/curl.mdx b/content/pages/01-reference/curl/curl.mdx new file mode 100644 index 0000000..1f7d786 --- /dev/null +++ b/content/pages/01-reference/curl/curl.mdx @@ -0,0 +1,17 @@ +# API and SDK reference + +{/* Start Imports */} + +import ClientSDKs from "./client_sdks/client_sdks.mdx"; +import Resources from "./resources/resources.mdx"; + +{/* End Imports */} +{/* Start Sections */} + + + +--- + + + +{/* End Sections */} diff --git a/content/pages/01-reference/curl/resources/activities/activities.mdx b/content/pages/01-reference/curl/resources/activities/activities.mdx new file mode 100644 index 0000000..d577083 --- /dev/null +++ b/content/pages/01-reference/curl/resources/activities/activities.mdx @@ -0,0 +1,23 @@ +import GetServerActivities from "./get_server_activities/get_server_activities.mdx"; +import CancelServerActivities from "./cancel_server_activities/cancel_server_activities.mdx"; + +## Activities +Activities are awesome. They provide a way to monitor and control asynchronous operations on the server. In order to receive real\-time updates for activities, a client would normally subscribe via either EventSource or Websocket endpoints. +Activities are associated with HTTP replies via a special `X\-Plex\-Activity` header which contains the UUID of the activity. +Activities are optional cancellable. If cancellable, they may be cancelled via the `DELETE` endpoint. Other details: +\- They can contain a `progress` (from 0 to 100) marking the percent completion of the activity. +\- They must contain an `type` which is used by clients to distinguish the specific activity. +\- They may contain a `Context` object with attributes which associate the activity with various specific entities (items, libraries, etc.) +\- The may contain a `Response` object which attributes which represent the result of the asynchronous operation. + + +### Available Operations + +* [Get Server Activities](/curl/activities/get_server_activities) - Get Server Activities +* [Cancel Server Activities](/curl/activities/cancel_server_activities) - Cancel Server Activities + +--- + + +--- + diff --git a/content/pages/01-reference/curl/resources/activities/cancel_server_activities/_authentication.mdx b/content/pages/01-reference/curl/resources/activities/cancel_server_activities/_authentication.mdx new file mode 100644 index 0000000..ac82b0b --- /dev/null +++ b/content/pages/01-reference/curl/resources/activities/cancel_server_activities/_authentication.mdx @@ -0,0 +1,9 @@ +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### API key _— in HTTP header_ + +Set your API key in a `X-Plex-Token` HTTP header. + +Example: `` + diff --git a/content/pages/01-reference/curl/resources/activities/cancel_server_activities/_header.mdx b/content/pages/01-reference/curl/resources/activities/cancel_server_activities/_header.mdx new file mode 100644 index 0000000..951aa1c --- /dev/null +++ b/content/pages/01-reference/curl/resources/activities/cancel_server_activities/_header.mdx @@ -0,0 +1,7 @@ +import OperationInfo from '/src/components/OperationInfo'; + +## Cancel Server Activities + + + +Cancel Server Activities diff --git a/content/pages/01-reference/curl/resources/activities/cancel_server_activities/_parameters.mdx b/content/pages/01-reference/curl/resources/activities/cancel_server_activities/_parameters.mdx new file mode 100644 index 0000000..779c58c --- /dev/null +++ b/content/pages/01-reference/curl/resources/activities/cancel_server_activities/_parameters.mdx @@ -0,0 +1,5 @@ +{/* Autogenerated DO NOT EDIT */} +##### `activityUUID` _string_ +The UUID of the activity to cancel. + + diff --git a/content/pages/01-reference/curl/resources/activities/cancel_server_activities/_response.mdx b/content/pages/01-reference/curl/resources/activities/cancel_server_activities/_response.mdx new file mode 100644 index 0000000..1b23813 --- /dev/null +++ b/content/pages/01-reference/curl/resources/activities/cancel_server_activities/_response.mdx @@ -0,0 +1,26 @@ +{/* Autogenerated DO NOT EDIT */} + +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; +import { TabbedSection, Tab } from '@/src/components/TabbedSection'; +import StatusCode from '@/src/components/StatusCode'; + + + {/* prettier-ignore */} + }> + _No response body._ + + {/* prettier-ignore */} + }> + _No response body._ + + {/* prettier-ignore */} + }> + *JSON object* + + ##### `errors` _array (optional)_ + + + + + diff --git a/content/pages/01-reference/curl/resources/activities/cancel_server_activities/_usage.mdx b/content/pages/01-reference/curl/resources/activities/cancel_server_activities/_usage.mdx new file mode 100644 index 0000000..0f51438 --- /dev/null +++ b/content/pages/01-reference/curl/resources/activities/cancel_server_activities/_usage.mdx @@ -0,0 +1,21 @@ + + +```bash Example Request +curl http://10.10.10.47:32400/activities/string \ +--header 'Accept: application/json' \ +--header 'X-Plex-Token: YOUR_API_KEY_HERE' +``` +--- + +```json Example Response + { + "errors": [ + { + "code": 1001, + "message": "User could not be authenticated", + "status": 401 + } + ] + } +``` + diff --git a/content/pages/01-reference/curl/resources/activities/cancel_server_activities/cancel_server_activities.mdx b/content/pages/01-reference/curl/resources/activities/cancel_server_activities/cancel_server_activities.mdx new file mode 100644 index 0000000..b8dd685 --- /dev/null +++ b/content/pages/01-reference/curl/resources/activities/cancel_server_activities/cancel_server_activities.mdx @@ -0,0 +1,12 @@ +import CurlHeader from './_header.mdx'; +import SDKHeader from './_header.mdx'; +import OperationHeader from '/src/components/OperationHeader'; + +###### *Activities* + +} + curlHeader={} +/> + +{/* render operation */} diff --git a/content/pages/01-reference/curl/resources/activities/get_server_activities/_authentication.mdx b/content/pages/01-reference/curl/resources/activities/get_server_activities/_authentication.mdx new file mode 100644 index 0000000..ac82b0b --- /dev/null +++ b/content/pages/01-reference/curl/resources/activities/get_server_activities/_authentication.mdx @@ -0,0 +1,9 @@ +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### API key _— in HTTP header_ + +Set your API key in a `X-Plex-Token` HTTP header. + +Example: `` + diff --git a/content/pages/01-reference/curl/resources/activities/get_server_activities/_header.mdx b/content/pages/01-reference/curl/resources/activities/get_server_activities/_header.mdx new file mode 100644 index 0000000..2bc6195 --- /dev/null +++ b/content/pages/01-reference/curl/resources/activities/get_server_activities/_header.mdx @@ -0,0 +1,7 @@ +import OperationInfo from '/src/components/OperationInfo'; + +## Get Server Activities + + + +Get Server Activities diff --git a/content/pages/01-reference/curl/resources/activities/get_server_activities/_parameters.mdx b/content/pages/01-reference/curl/resources/activities/get_server_activities/_parameters.mdx new file mode 100644 index 0000000..929b020 --- /dev/null +++ b/content/pages/01-reference/curl/resources/activities/get_server_activities/_parameters.mdx @@ -0,0 +1,2 @@ +{/* Autogenerated DO NOT EDIT */} + diff --git a/content/pages/01-reference/curl/resources/activities/get_server_activities/_response.mdx b/content/pages/01-reference/curl/resources/activities/get_server_activities/_response.mdx new file mode 100644 index 0000000..698add8 --- /dev/null +++ b/content/pages/01-reference/curl/resources/activities/get_server_activities/_response.mdx @@ -0,0 +1,35 @@ +{/* Autogenerated DO NOT EDIT */} +import GetServerActivitiesMediaContainer from "/content/types/operations/get_server_activities_media_container/curl.mdx" + +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; +import { TabbedSection, Tab } from '@/src/components/TabbedSection'; +import StatusCode from '@/src/components/StatusCode'; + + + {/* prettier-ignore */} + }> + *JSON object* + + ##### `MediaContainer` _object (optional)_ + + + + + + + + {/* prettier-ignore */} + }> + _No response body._ + + {/* prettier-ignore */} + }> + *JSON object* + + ##### `errors` _array (optional)_ + + + + + diff --git a/content/pages/01-reference/curl/resources/activities/get_server_activities/_usage.mdx b/content/pages/01-reference/curl/resources/activities/get_server_activities/_usage.mdx new file mode 100644 index 0000000..f373300 --- /dev/null +++ b/content/pages/01-reference/curl/resources/activities/get_server_activities/_usage.mdx @@ -0,0 +1,31 @@ + + +```bash Example Request +curl http://10.10.10.47:32400/activities \ +--header 'Accept: application/json' \ +--header 'X-Plex-Token: YOUR_API_KEY_HERE' +``` +--- + +```json Example Response + { + "MediaContainer": { + "size": 4375.87, + "Activity": [ + { + "uuid": "string", + "type": "string", + "cancellable": false, + "userID": 2975.34, + "title": "string", + "subtitle": "string", + "progress": 8917.73, + "Context": { + "librarySectionID": "string" + } + } + ] + } + } +``` + diff --git a/content/pages/01-reference/curl/resources/activities/get_server_activities/get_server_activities.mdx b/content/pages/01-reference/curl/resources/activities/get_server_activities/get_server_activities.mdx new file mode 100644 index 0000000..b8dd685 --- /dev/null +++ b/content/pages/01-reference/curl/resources/activities/get_server_activities/get_server_activities.mdx @@ -0,0 +1,12 @@ +import CurlHeader from './_header.mdx'; +import SDKHeader from './_header.mdx'; +import OperationHeader from '/src/components/OperationHeader'; + +###### *Activities* + +} + curlHeader={} +/> + +{/* render operation */} diff --git a/content/pages/01-reference/curl/resources/butler/butler.mdx b/content/pages/01-reference/curl/resources/butler/butler.mdx new file mode 100644 index 0000000..d7fd6a5 --- /dev/null +++ b/content/pages/01-reference/curl/resources/butler/butler.mdx @@ -0,0 +1,32 @@ +import GetButlerTasks from "./get_butler_tasks/get_butler_tasks.mdx"; +import StartAllTasks from "./start_all_tasks/start_all_tasks.mdx"; +import StopAllTasks from "./stop_all_tasks/stop_all_tasks.mdx"; +import StartTask from "./start_task/start_task.mdx"; +import StopTask from "./stop_task/stop_task.mdx"; + +## Butler +Butler is the task manager of the Plex Media Server Ecosystem. + + +### Available Operations + +* [Get Butler Tasks](/curl/butler/get_butler_tasks) - Get Butler tasks +* [Start All Tasks](/curl/butler/start_all_tasks) - Start all Butler tasks +* [Stop All Tasks](/curl/butler/stop_all_tasks) - Stop all Butler tasks +* [Start Task](/curl/butler/start_task) - Start a single Butler task +* [Stop Task](/curl/butler/stop_task) - Stop a single Butler task + +--- + + +--- + + +--- + + +--- + + +--- + diff --git a/content/pages/01-reference/curl/resources/butler/get_butler_tasks/_authentication.mdx b/content/pages/01-reference/curl/resources/butler/get_butler_tasks/_authentication.mdx new file mode 100644 index 0000000..ac82b0b --- /dev/null +++ b/content/pages/01-reference/curl/resources/butler/get_butler_tasks/_authentication.mdx @@ -0,0 +1,9 @@ +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### API key _— in HTTP header_ + +Set your API key in a `X-Plex-Token` HTTP header. + +Example: `` + diff --git a/content/pages/01-reference/curl/resources/butler/get_butler_tasks/_header.mdx b/content/pages/01-reference/curl/resources/butler/get_butler_tasks/_header.mdx new file mode 100644 index 0000000..19820cd --- /dev/null +++ b/content/pages/01-reference/curl/resources/butler/get_butler_tasks/_header.mdx @@ -0,0 +1,7 @@ +import OperationInfo from '/src/components/OperationInfo'; + +## Get Butler Tasks + + + +Returns a list of butler tasks diff --git a/content/pages/01-reference/curl/resources/butler/get_butler_tasks/_parameters.mdx b/content/pages/01-reference/curl/resources/butler/get_butler_tasks/_parameters.mdx new file mode 100644 index 0000000..929b020 --- /dev/null +++ b/content/pages/01-reference/curl/resources/butler/get_butler_tasks/_parameters.mdx @@ -0,0 +1,2 @@ +{/* Autogenerated DO NOT EDIT */} + diff --git a/content/pages/01-reference/curl/resources/butler/get_butler_tasks/_response.mdx b/content/pages/01-reference/curl/resources/butler/get_butler_tasks/_response.mdx new file mode 100644 index 0000000..341a75e --- /dev/null +++ b/content/pages/01-reference/curl/resources/butler/get_butler_tasks/_response.mdx @@ -0,0 +1,35 @@ +{/* Autogenerated DO NOT EDIT */} +import ButlerTasks from "/content/types/operations/butler_tasks/curl.mdx" + +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; +import { TabbedSection, Tab } from '@/src/components/TabbedSection'; +import StatusCode from '@/src/components/StatusCode'; + + + {/* prettier-ignore */} + }> + *JSON object* + + ##### `ButlerTasks` _object (optional)_ + + + + + + + + {/* prettier-ignore */} + }> + _No response body._ + + {/* prettier-ignore */} + }> + *JSON object* + + ##### `errors` _array (optional)_ + + + + + diff --git a/content/pages/01-reference/curl/resources/butler/get_butler_tasks/_usage.mdx b/content/pages/01-reference/curl/resources/butler/get_butler_tasks/_usage.mdx new file mode 100644 index 0000000..e7148b1 --- /dev/null +++ b/content/pages/01-reference/curl/resources/butler/get_butler_tasks/_usage.mdx @@ -0,0 +1,26 @@ + + +```bash Example Request +curl http://10.10.10.47:32400/butler \ +--header 'Accept: application/json' \ +--header 'X-Plex-Token: YOUR_API_KEY_HERE' +``` +--- + +```json Example Response + { + "ButlerTasks": { + "ButlerTask": [ + { + "name": "BackupDatabase", + "interval": 3, + "scheduleRandomized": false, + "enabled": false, + "title": "Backup Database", + "description": "Create a backup copy of the server's database in the configured backup directory" + } + ] + } + } +``` + diff --git a/content/pages/01-reference/curl/resources/butler/get_butler_tasks/get_butler_tasks.mdx b/content/pages/01-reference/curl/resources/butler/get_butler_tasks/get_butler_tasks.mdx new file mode 100644 index 0000000..191b046 --- /dev/null +++ b/content/pages/01-reference/curl/resources/butler/get_butler_tasks/get_butler_tasks.mdx @@ -0,0 +1,12 @@ +import CurlHeader from './_header.mdx'; +import SDKHeader from './_header.mdx'; +import OperationHeader from '/src/components/OperationHeader'; + +###### *Butler* + +} + curlHeader={} +/> + +{/* render operation */} diff --git a/content/pages/01-reference/curl/resources/butler/start_all_tasks/_authentication.mdx b/content/pages/01-reference/curl/resources/butler/start_all_tasks/_authentication.mdx new file mode 100644 index 0000000..ac82b0b --- /dev/null +++ b/content/pages/01-reference/curl/resources/butler/start_all_tasks/_authentication.mdx @@ -0,0 +1,9 @@ +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### API key _— in HTTP header_ + +Set your API key in a `X-Plex-Token` HTTP header. + +Example: `` + diff --git a/content/pages/01-reference/curl/resources/butler/start_all_tasks/_header.mdx b/content/pages/01-reference/curl/resources/butler/start_all_tasks/_header.mdx new file mode 100644 index 0000000..3815d9b --- /dev/null +++ b/content/pages/01-reference/curl/resources/butler/start_all_tasks/_header.mdx @@ -0,0 +1,12 @@ +import OperationInfo from '/src/components/OperationInfo'; + +## Start All Tasks + + + +This endpoint will attempt to start all Butler tasks that are enabled in the settings. Butler tasks normally run automatically during a time window configured on the server's Settings page but can be manually started using this endpoint. Tasks will run with the following criteria: +1. Any tasks not scheduled to run on the current day will be skipped. +2. If a task is configured to run at a random time during the configured window and we are outside that window, the task will start immediately. +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. + diff --git a/content/pages/01-reference/curl/resources/butler/start_all_tasks/_parameters.mdx b/content/pages/01-reference/curl/resources/butler/start_all_tasks/_parameters.mdx new file mode 100644 index 0000000..929b020 --- /dev/null +++ b/content/pages/01-reference/curl/resources/butler/start_all_tasks/_parameters.mdx @@ -0,0 +1,2 @@ +{/* Autogenerated DO NOT EDIT */} + diff --git a/content/pages/01-reference/curl/resources/butler/start_all_tasks/_response.mdx b/content/pages/01-reference/curl/resources/butler/start_all_tasks/_response.mdx new file mode 100644 index 0000000..1b23813 --- /dev/null +++ b/content/pages/01-reference/curl/resources/butler/start_all_tasks/_response.mdx @@ -0,0 +1,26 @@ +{/* Autogenerated DO NOT EDIT */} + +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; +import { TabbedSection, Tab } from '@/src/components/TabbedSection'; +import StatusCode from '@/src/components/StatusCode'; + + + {/* prettier-ignore */} + }> + _No response body._ + + {/* prettier-ignore */} + }> + _No response body._ + + {/* prettier-ignore */} + }> + *JSON object* + + ##### `errors` _array (optional)_ + + + + + diff --git a/content/pages/01-reference/curl/resources/butler/start_all_tasks/_usage.mdx b/content/pages/01-reference/curl/resources/butler/start_all_tasks/_usage.mdx new file mode 100644 index 0000000..8a64738 --- /dev/null +++ b/content/pages/01-reference/curl/resources/butler/start_all_tasks/_usage.mdx @@ -0,0 +1,21 @@ + + +```bash Example Request +curl http://10.10.10.47:32400/butler \ +--header 'Accept: application/json' \ +--header 'X-Plex-Token: YOUR_API_KEY_HERE' +``` +--- + +```json Example Response + { + "errors": [ + { + "code": 1001, + "message": "User could not be authenticated", + "status": 401 + } + ] + } +``` + diff --git a/content/pages/01-reference/curl/resources/butler/start_all_tasks/start_all_tasks.mdx b/content/pages/01-reference/curl/resources/butler/start_all_tasks/start_all_tasks.mdx new file mode 100644 index 0000000..191b046 --- /dev/null +++ b/content/pages/01-reference/curl/resources/butler/start_all_tasks/start_all_tasks.mdx @@ -0,0 +1,12 @@ +import CurlHeader from './_header.mdx'; +import SDKHeader from './_header.mdx'; +import OperationHeader from '/src/components/OperationHeader'; + +###### *Butler* + +} + curlHeader={} +/> + +{/* render operation */} diff --git a/content/pages/01-reference/curl/resources/butler/start_task/_authentication.mdx b/content/pages/01-reference/curl/resources/butler/start_task/_authentication.mdx new file mode 100644 index 0000000..ac82b0b --- /dev/null +++ b/content/pages/01-reference/curl/resources/butler/start_task/_authentication.mdx @@ -0,0 +1,9 @@ +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### API key _— in HTTP header_ + +Set your API key in a `X-Plex-Token` HTTP header. + +Example: `` + diff --git a/content/pages/01-reference/curl/resources/butler/start_task/_header.mdx b/content/pages/01-reference/curl/resources/butler/start_task/_header.mdx new file mode 100644 index 0000000..a0bed79 --- /dev/null +++ b/content/pages/01-reference/curl/resources/butler/start_task/_header.mdx @@ -0,0 +1,12 @@ +import OperationInfo from '/src/components/OperationInfo'; + +## Start Task + + + +This endpoint will attempt to start a single Butler task that is enabled in the settings. Butler tasks normally run automatically during a time window configured on the server's Settings page but can be manually started using this endpoint. Tasks will run with the following criteria: +1. Any tasks not scheduled to run on the current day will be skipped. +2. If a task is configured to run at a random time during the configured window and we are outside that window, the task will start immediately. +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. + diff --git a/content/pages/01-reference/curl/resources/butler/start_task/_parameters.mdx b/content/pages/01-reference/curl/resources/butler/start_task/_parameters.mdx new file mode 100644 index 0000000..a9b703f --- /dev/null +++ b/content/pages/01-reference/curl/resources/butler/start_task/_parameters.mdx @@ -0,0 +1,12 @@ +{/* Autogenerated DO NOT EDIT */} +import TaskName from "/content/types/operations/task_name/curl.mdx" +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `taskName` _enumeration_ +the name of the task to be started. + + + + + diff --git a/content/pages/01-reference/curl/resources/butler/start_task/_response.mdx b/content/pages/01-reference/curl/resources/butler/start_task/_response.mdx new file mode 100644 index 0000000..15f1594 --- /dev/null +++ b/content/pages/01-reference/curl/resources/butler/start_task/_response.mdx @@ -0,0 +1,30 @@ +{/* Autogenerated DO NOT EDIT */} + +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; +import { TabbedSection, Tab } from '@/src/components/TabbedSection'; +import StatusCode from '@/src/components/StatusCode'; + + + {/* prettier-ignore */} + }> + _No response body._ + + {/* prettier-ignore */} + }> + _No response body._ + + {/* prettier-ignore */} + }> + _No response body._ + + {/* prettier-ignore */} + }> + *JSON object* + + ##### `errors` _array (optional)_ + + + + + diff --git a/content/pages/01-reference/curl/resources/butler/start_task/_usage.mdx b/content/pages/01-reference/curl/resources/butler/start_task/_usage.mdx new file mode 100644 index 0000000..564a399 --- /dev/null +++ b/content/pages/01-reference/curl/resources/butler/start_task/_usage.mdx @@ -0,0 +1,21 @@ + + +```bash Example Request +curl http://10.10.10.47:32400/butler/{{taskName}} \ +--header 'Accept: application/json' \ +--header 'X-Plex-Token: YOUR_API_KEY_HERE' +``` +--- + +```json Example Response + { + "errors": [ + { + "code": 1001, + "message": "User could not be authenticated", + "status": 401 + } + ] + } +``` + diff --git a/content/pages/01-reference/curl/resources/butler/start_task/start_task.mdx b/content/pages/01-reference/curl/resources/butler/start_task/start_task.mdx new file mode 100644 index 0000000..191b046 --- /dev/null +++ b/content/pages/01-reference/curl/resources/butler/start_task/start_task.mdx @@ -0,0 +1,12 @@ +import CurlHeader from './_header.mdx'; +import SDKHeader from './_header.mdx'; +import OperationHeader from '/src/components/OperationHeader'; + +###### *Butler* + +} + curlHeader={} +/> + +{/* render operation */} diff --git a/content/pages/01-reference/curl/resources/butler/stop_all_tasks/_authentication.mdx b/content/pages/01-reference/curl/resources/butler/stop_all_tasks/_authentication.mdx new file mode 100644 index 0000000..ac82b0b --- /dev/null +++ b/content/pages/01-reference/curl/resources/butler/stop_all_tasks/_authentication.mdx @@ -0,0 +1,9 @@ +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### API key _— in HTTP header_ + +Set your API key in a `X-Plex-Token` HTTP header. + +Example: `` + diff --git a/content/pages/01-reference/curl/resources/butler/stop_all_tasks/_header.mdx b/content/pages/01-reference/curl/resources/butler/stop_all_tasks/_header.mdx new file mode 100644 index 0000000..cc9b74d --- /dev/null +++ b/content/pages/01-reference/curl/resources/butler/stop_all_tasks/_header.mdx @@ -0,0 +1,8 @@ +import OperationInfo from '/src/components/OperationInfo'; + +## Stop All Tasks + + + +This endpoint will stop all currently running tasks and remove any scheduled tasks from the queue. + diff --git a/content/pages/01-reference/curl/resources/butler/stop_all_tasks/_parameters.mdx b/content/pages/01-reference/curl/resources/butler/stop_all_tasks/_parameters.mdx new file mode 100644 index 0000000..929b020 --- /dev/null +++ b/content/pages/01-reference/curl/resources/butler/stop_all_tasks/_parameters.mdx @@ -0,0 +1,2 @@ +{/* Autogenerated DO NOT EDIT */} + diff --git a/content/pages/01-reference/curl/resources/butler/stop_all_tasks/_response.mdx b/content/pages/01-reference/curl/resources/butler/stop_all_tasks/_response.mdx new file mode 100644 index 0000000..1b23813 --- /dev/null +++ b/content/pages/01-reference/curl/resources/butler/stop_all_tasks/_response.mdx @@ -0,0 +1,26 @@ +{/* Autogenerated DO NOT EDIT */} + +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; +import { TabbedSection, Tab } from '@/src/components/TabbedSection'; +import StatusCode from '@/src/components/StatusCode'; + + + {/* prettier-ignore */} + }> + _No response body._ + + {/* prettier-ignore */} + }> + _No response body._ + + {/* prettier-ignore */} + }> + *JSON object* + + ##### `errors` _array (optional)_ + + + + + diff --git a/content/pages/01-reference/curl/resources/butler/stop_all_tasks/_usage.mdx b/content/pages/01-reference/curl/resources/butler/stop_all_tasks/_usage.mdx new file mode 100644 index 0000000..8a64738 --- /dev/null +++ b/content/pages/01-reference/curl/resources/butler/stop_all_tasks/_usage.mdx @@ -0,0 +1,21 @@ + + +```bash Example Request +curl http://10.10.10.47:32400/butler \ +--header 'Accept: application/json' \ +--header 'X-Plex-Token: YOUR_API_KEY_HERE' +``` +--- + +```json Example Response + { + "errors": [ + { + "code": 1001, + "message": "User could not be authenticated", + "status": 401 + } + ] + } +``` + diff --git a/content/pages/01-reference/curl/resources/butler/stop_all_tasks/stop_all_tasks.mdx b/content/pages/01-reference/curl/resources/butler/stop_all_tasks/stop_all_tasks.mdx new file mode 100644 index 0000000..191b046 --- /dev/null +++ b/content/pages/01-reference/curl/resources/butler/stop_all_tasks/stop_all_tasks.mdx @@ -0,0 +1,12 @@ +import CurlHeader from './_header.mdx'; +import SDKHeader from './_header.mdx'; +import OperationHeader from '/src/components/OperationHeader'; + +###### *Butler* + +} + curlHeader={} +/> + +{/* render operation */} diff --git a/content/pages/01-reference/curl/resources/butler/stop_task/_authentication.mdx b/content/pages/01-reference/curl/resources/butler/stop_task/_authentication.mdx new file mode 100644 index 0000000..ac82b0b --- /dev/null +++ b/content/pages/01-reference/curl/resources/butler/stop_task/_authentication.mdx @@ -0,0 +1,9 @@ +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### API key _— in HTTP header_ + +Set your API key in a `X-Plex-Token` HTTP header. + +Example: `` + diff --git a/content/pages/01-reference/curl/resources/butler/stop_task/_header.mdx b/content/pages/01-reference/curl/resources/butler/stop_task/_header.mdx new file mode 100644 index 0000000..c2f9112 --- /dev/null +++ b/content/pages/01-reference/curl/resources/butler/stop_task/_header.mdx @@ -0,0 +1,8 @@ +import OperationInfo from '/src/components/OperationInfo'; + +## Stop Task + + + +This endpoint will stop a currently running task by name, or remove it from the list of scheduled tasks if it exists. See the section above for a list of task names for this endpoint. + diff --git a/content/pages/01-reference/curl/resources/butler/stop_task/_parameters.mdx b/content/pages/01-reference/curl/resources/butler/stop_task/_parameters.mdx new file mode 100644 index 0000000..e156381 --- /dev/null +++ b/content/pages/01-reference/curl/resources/butler/stop_task/_parameters.mdx @@ -0,0 +1,12 @@ +{/* Autogenerated DO NOT EDIT */} +import PathParamTaskName from "/content/types/operations/path_param_task_name/curl.mdx" +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `taskName` _enumeration_ +The name of the task to be started. + + + + + diff --git a/content/pages/01-reference/curl/resources/butler/stop_task/_response.mdx b/content/pages/01-reference/curl/resources/butler/stop_task/_response.mdx new file mode 100644 index 0000000..45bbcd7 --- /dev/null +++ b/content/pages/01-reference/curl/resources/butler/stop_task/_response.mdx @@ -0,0 +1,30 @@ +{/* Autogenerated DO NOT EDIT */} + +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; +import { TabbedSection, Tab } from '@/src/components/TabbedSection'; +import StatusCode from '@/src/components/StatusCode'; + + + {/* prettier-ignore */} + }> + _No response body._ + + {/* prettier-ignore */} + }> + _No response body._ + + {/* prettier-ignore */} + }> + _No response body._ + + {/* prettier-ignore */} + }> + *JSON object* + + ##### `errors` _array (optional)_ + + + + + diff --git a/content/pages/01-reference/curl/resources/butler/stop_task/_usage.mdx b/content/pages/01-reference/curl/resources/butler/stop_task/_usage.mdx new file mode 100644 index 0000000..564a399 --- /dev/null +++ b/content/pages/01-reference/curl/resources/butler/stop_task/_usage.mdx @@ -0,0 +1,21 @@ + + +```bash Example Request +curl http://10.10.10.47:32400/butler/{{taskName}} \ +--header 'Accept: application/json' \ +--header 'X-Plex-Token: YOUR_API_KEY_HERE' +``` +--- + +```json Example Response + { + "errors": [ + { + "code": 1001, + "message": "User could not be authenticated", + "status": 401 + } + ] + } +``` + diff --git a/content/pages/01-reference/curl/resources/butler/stop_task/stop_task.mdx b/content/pages/01-reference/curl/resources/butler/stop_task/stop_task.mdx new file mode 100644 index 0000000..191b046 --- /dev/null +++ b/content/pages/01-reference/curl/resources/butler/stop_task/stop_task.mdx @@ -0,0 +1,12 @@ +import CurlHeader from './_header.mdx'; +import SDKHeader from './_header.mdx'; +import OperationHeader from '/src/components/OperationHeader'; + +###### *Butler* + +} + curlHeader={} +/> + +{/* render operation */} diff --git a/content/pages/01-reference/curl/resources/hubs/get_global_hubs/_authentication.mdx b/content/pages/01-reference/curl/resources/hubs/get_global_hubs/_authentication.mdx new file mode 100644 index 0000000..ac82b0b --- /dev/null +++ b/content/pages/01-reference/curl/resources/hubs/get_global_hubs/_authentication.mdx @@ -0,0 +1,9 @@ +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### API key _— in HTTP header_ + +Set your API key in a `X-Plex-Token` HTTP header. + +Example: `` + diff --git a/content/pages/01-reference/curl/resources/hubs/get_global_hubs/_header.mdx b/content/pages/01-reference/curl/resources/hubs/get_global_hubs/_header.mdx new file mode 100644 index 0000000..e542e79 --- /dev/null +++ b/content/pages/01-reference/curl/resources/hubs/get_global_hubs/_header.mdx @@ -0,0 +1,7 @@ +import OperationInfo from '/src/components/OperationInfo'; + +## Get Global Hubs + + + +Get Global Hubs filtered by the parameters provided. diff --git a/content/pages/01-reference/curl/resources/hubs/get_global_hubs/_parameters.mdx b/content/pages/01-reference/curl/resources/hubs/get_global_hubs/_parameters.mdx new file mode 100644 index 0000000..6c21a0c --- /dev/null +++ b/content/pages/01-reference/curl/resources/hubs/get_global_hubs/_parameters.mdx @@ -0,0 +1,16 @@ +{/* Autogenerated DO NOT EDIT */} +import OnlyTransient from "/content/types/operations/only_transient/curl.mdx" +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `count` _number (optional)_ +The number of items to return with each hub. + +--- +##### `onlyTransient` _enumeration (optional)_ +Only return hubs which are "transient", meaning those which are prone to changing after media playback or addition (e.g. On Deck, or Recently Added). + + + + + diff --git a/content/pages/01-reference/curl/resources/hubs/get_global_hubs/_response.mdx b/content/pages/01-reference/curl/resources/hubs/get_global_hubs/_response.mdx new file mode 100644 index 0000000..1b23813 --- /dev/null +++ b/content/pages/01-reference/curl/resources/hubs/get_global_hubs/_response.mdx @@ -0,0 +1,26 @@ +{/* Autogenerated DO NOT EDIT */} + +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; +import { TabbedSection, Tab } from '@/src/components/TabbedSection'; +import StatusCode from '@/src/components/StatusCode'; + + + {/* prettier-ignore */} + }> + _No response body._ + + {/* prettier-ignore */} + }> + _No response body._ + + {/* prettier-ignore */} + }> + *JSON object* + + ##### `errors` _array (optional)_ + + + + + diff --git a/content/pages/01-reference/curl/resources/hubs/get_global_hubs/_usage.mdx b/content/pages/01-reference/curl/resources/hubs/get_global_hubs/_usage.mdx new file mode 100644 index 0000000..42ee115 --- /dev/null +++ b/content/pages/01-reference/curl/resources/hubs/get_global_hubs/_usage.mdx @@ -0,0 +1,21 @@ + + +```bash Example Request +curl http://10.10.10.47:32400/hubs?count=567.13 \ +--header 'Accept: application/json' \ +--header 'X-Plex-Token: YOUR_API_KEY_HERE' +``` +--- + +```json Example Response + { + "errors": [ + { + "code": 1001, + "message": "User could not be authenticated", + "status": 401 + } + ] + } +``` + diff --git a/content/pages/01-reference/curl/resources/hubs/get_global_hubs/get_global_hubs.mdx b/content/pages/01-reference/curl/resources/hubs/get_global_hubs/get_global_hubs.mdx new file mode 100644 index 0000000..6994900 --- /dev/null +++ b/content/pages/01-reference/curl/resources/hubs/get_global_hubs/get_global_hubs.mdx @@ -0,0 +1,12 @@ +import CurlHeader from './_header.mdx'; +import SDKHeader from './_header.mdx'; +import OperationHeader from '/src/components/OperationHeader'; + +###### *Hubs* + +} + curlHeader={} +/> + +{/* render operation */} diff --git a/content/pages/01-reference/curl/resources/hubs/get_library_hubs/_authentication.mdx b/content/pages/01-reference/curl/resources/hubs/get_library_hubs/_authentication.mdx new file mode 100644 index 0000000..ac82b0b --- /dev/null +++ b/content/pages/01-reference/curl/resources/hubs/get_library_hubs/_authentication.mdx @@ -0,0 +1,9 @@ +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### API key _— in HTTP header_ + +Set your API key in a `X-Plex-Token` HTTP header. + +Example: `` + diff --git a/content/pages/01-reference/curl/resources/hubs/get_library_hubs/_header.mdx b/content/pages/01-reference/curl/resources/hubs/get_library_hubs/_header.mdx new file mode 100644 index 0000000..7ffdfae --- /dev/null +++ b/content/pages/01-reference/curl/resources/hubs/get_library_hubs/_header.mdx @@ -0,0 +1,8 @@ +import OperationInfo from '/src/components/OperationInfo'; + +## Get Library Hubs + + + +This endpoint will return a list of library specific hubs + diff --git a/content/pages/01-reference/curl/resources/hubs/get_library_hubs/_parameters.mdx b/content/pages/01-reference/curl/resources/hubs/get_library_hubs/_parameters.mdx new file mode 100644 index 0000000..3a3be39 --- /dev/null +++ b/content/pages/01-reference/curl/resources/hubs/get_library_hubs/_parameters.mdx @@ -0,0 +1,20 @@ +{/* Autogenerated DO NOT EDIT */} +import QueryParamOnlyTransient from "/content/types/operations/query_param_only_transient/curl.mdx" +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `sectionId` _number_ +the Id of the library to query + +--- +##### `count` _number (optional)_ +The number of items to return with each hub. + +--- +##### `onlyTransient` _enumeration (optional)_ +Only return hubs which are "transient", meaning those which are prone to changing after media playback or addition (e.g. On Deck, or Recently Added). + + + + + diff --git a/content/pages/01-reference/curl/resources/hubs/get_library_hubs/_response.mdx b/content/pages/01-reference/curl/resources/hubs/get_library_hubs/_response.mdx new file mode 100644 index 0000000..1b23813 --- /dev/null +++ b/content/pages/01-reference/curl/resources/hubs/get_library_hubs/_response.mdx @@ -0,0 +1,26 @@ +{/* Autogenerated DO NOT EDIT */} + +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; +import { TabbedSection, Tab } from '@/src/components/TabbedSection'; +import StatusCode from '@/src/components/StatusCode'; + + + {/* prettier-ignore */} + }> + _No response body._ + + {/* prettier-ignore */} + }> + _No response body._ + + {/* prettier-ignore */} + }> + *JSON object* + + ##### `errors` _array (optional)_ + + + + + diff --git a/content/pages/01-reference/curl/resources/hubs/get_library_hubs/_usage.mdx b/content/pages/01-reference/curl/resources/hubs/get_library_hubs/_usage.mdx new file mode 100644 index 0000000..b72f0c7 --- /dev/null +++ b/content/pages/01-reference/curl/resources/hubs/get_library_hubs/_usage.mdx @@ -0,0 +1,21 @@ + + +```bash Example Request +curl http://10.10.10.47:32400/hubs/sections/9636.63?count=2726.56 \ +--header 'Accept: application/json' \ +--header 'X-Plex-Token: YOUR_API_KEY_HERE' +``` +--- + +```json Example Response + { + "errors": [ + { + "code": 1001, + "message": "User could not be authenticated", + "status": 401 + } + ] + } +``` + diff --git a/content/pages/01-reference/curl/resources/hubs/get_library_hubs/get_library_hubs.mdx b/content/pages/01-reference/curl/resources/hubs/get_library_hubs/get_library_hubs.mdx new file mode 100644 index 0000000..6994900 --- /dev/null +++ b/content/pages/01-reference/curl/resources/hubs/get_library_hubs/get_library_hubs.mdx @@ -0,0 +1,12 @@ +import CurlHeader from './_header.mdx'; +import SDKHeader from './_header.mdx'; +import OperationHeader from '/src/components/OperationHeader'; + +###### *Hubs* + +} + curlHeader={} +/> + +{/* render operation */} diff --git a/content/pages/01-reference/curl/resources/hubs/hubs.mdx b/content/pages/01-reference/curl/resources/hubs/hubs.mdx new file mode 100644 index 0000000..e5e336b --- /dev/null +++ b/content/pages/01-reference/curl/resources/hubs/hubs.mdx @@ -0,0 +1,17 @@ +import GetGlobalHubs from "./get_global_hubs/get_global_hubs.mdx"; +import GetLibraryHubs from "./get_library_hubs/get_library_hubs.mdx"; + +## Hubs +Hubs are a structured two\-dimensional container for media, generally represented by multiple horizontal rows. + + +### Available Operations + +* [Get Global Hubs](/curl/hubs/get_global_hubs) - Get Global Hubs +* [Get Library Hubs](/curl/hubs/get_library_hubs) - Get library specific hubs + +--- + + +--- + diff --git a/content/pages/01-reference/curl/resources/library/delete_library/_authentication.mdx b/content/pages/01-reference/curl/resources/library/delete_library/_authentication.mdx new file mode 100644 index 0000000..ac82b0b --- /dev/null +++ b/content/pages/01-reference/curl/resources/library/delete_library/_authentication.mdx @@ -0,0 +1,9 @@ +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### API key _— in HTTP header_ + +Set your API key in a `X-Plex-Token` HTTP header. + +Example: `` + diff --git a/content/pages/01-reference/curl/resources/library/delete_library/_header.mdx b/content/pages/01-reference/curl/resources/library/delete_library/_header.mdx new file mode 100644 index 0000000..1ff6837 --- /dev/null +++ b/content/pages/01-reference/curl/resources/library/delete_library/_header.mdx @@ -0,0 +1,7 @@ +import OperationInfo from '/src/components/OperationInfo'; + +## Delete Library + + + +Delate a library using a specific section diff --git a/content/pages/01-reference/curl/resources/library/delete_library/_parameters.mdx b/content/pages/01-reference/curl/resources/library/delete_library/_parameters.mdx new file mode 100644 index 0000000..f00261a --- /dev/null +++ b/content/pages/01-reference/curl/resources/library/delete_library/_parameters.mdx @@ -0,0 +1,7 @@ +{/* Autogenerated DO NOT EDIT */} +##### `sectionId` _number_ +the Id of the library to query +
+**Example:** `1000` + + diff --git a/content/pages/01-reference/curl/resources/library/delete_library/_response.mdx b/content/pages/01-reference/curl/resources/library/delete_library/_response.mdx new file mode 100644 index 0000000..1b23813 --- /dev/null +++ b/content/pages/01-reference/curl/resources/library/delete_library/_response.mdx @@ -0,0 +1,26 @@ +{/* Autogenerated DO NOT EDIT */} + +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; +import { TabbedSection, Tab } from '@/src/components/TabbedSection'; +import StatusCode from '@/src/components/StatusCode'; + + + {/* prettier-ignore */} + }> + _No response body._ + + {/* prettier-ignore */} + }> + _No response body._ + + {/* prettier-ignore */} + }> + *JSON object* + + ##### `errors` _array (optional)_ + + + + + diff --git a/content/pages/01-reference/curl/resources/library/delete_library/_usage.mdx b/content/pages/01-reference/curl/resources/library/delete_library/_usage.mdx new file mode 100644 index 0000000..8afc760 --- /dev/null +++ b/content/pages/01-reference/curl/resources/library/delete_library/_usage.mdx @@ -0,0 +1,21 @@ + + +```bash Example Request +curl http://10.10.10.47:32400/library/sections/1000 \ +--header 'Accept: application/json' \ +--header 'X-Plex-Token: YOUR_API_KEY_HERE' +``` +--- + +```json Example Response + { + "errors": [ + { + "code": 1001, + "message": "User could not be authenticated", + "status": 401 + } + ] + } +``` + diff --git a/content/pages/01-reference/curl/resources/library/delete_library/delete_library.mdx b/content/pages/01-reference/curl/resources/library/delete_library/delete_library.mdx new file mode 100644 index 0000000..4b79f78 --- /dev/null +++ b/content/pages/01-reference/curl/resources/library/delete_library/delete_library.mdx @@ -0,0 +1,12 @@ +import CurlHeader from './_header.mdx'; +import SDKHeader from './_header.mdx'; +import OperationHeader from '/src/components/OperationHeader'; + +###### *Library* + +} + curlHeader={} +/> + +{/* render operation */} diff --git a/content/pages/01-reference/curl/resources/library/get_common_library_items/_authentication.mdx b/content/pages/01-reference/curl/resources/library/get_common_library_items/_authentication.mdx new file mode 100644 index 0000000..ac82b0b --- /dev/null +++ b/content/pages/01-reference/curl/resources/library/get_common_library_items/_authentication.mdx @@ -0,0 +1,9 @@ +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### API key _— in HTTP header_ + +Set your API key in a `X-Plex-Token` HTTP header. + +Example: `` + diff --git a/content/pages/01-reference/curl/resources/library/get_common_library_items/_header.mdx b/content/pages/01-reference/curl/resources/library/get_common_library_items/_header.mdx new file mode 100644 index 0000000..48d0dc6 --- /dev/null +++ b/content/pages/01-reference/curl/resources/library/get_common_library_items/_header.mdx @@ -0,0 +1,8 @@ +import OperationInfo from '/src/components/OperationInfo'; + +## Get Common Library Items + + + +Represents a "Common" item. It contains only the common attributes of the items selected by the provided filter + diff --git a/content/pages/01-reference/curl/resources/library/get_common_library_items/_parameters.mdx b/content/pages/01-reference/curl/resources/library/get_common_library_items/_parameters.mdx new file mode 100644 index 0000000..308c5db --- /dev/null +++ b/content/pages/01-reference/curl/resources/library/get_common_library_items/_parameters.mdx @@ -0,0 +1,13 @@ +{/* Autogenerated DO NOT EDIT */} +##### `sectionId` _number_ +the Id of the library to query + +--- +##### `type` _number_ +item type + +--- +##### `filter` _string (optional)_ +the filter parameter + + diff --git a/content/pages/01-reference/curl/resources/library/get_common_library_items/_response.mdx b/content/pages/01-reference/curl/resources/library/get_common_library_items/_response.mdx new file mode 100644 index 0000000..45bbcd7 --- /dev/null +++ b/content/pages/01-reference/curl/resources/library/get_common_library_items/_response.mdx @@ -0,0 +1,30 @@ +{/* Autogenerated DO NOT EDIT */} + +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; +import { TabbedSection, Tab } from '@/src/components/TabbedSection'; +import StatusCode from '@/src/components/StatusCode'; + + + {/* prettier-ignore */} + }> + _No response body._ + + {/* prettier-ignore */} + }> + _No response body._ + + {/* prettier-ignore */} + }> + _No response body._ + + {/* prettier-ignore */} + }> + *JSON object* + + ##### `errors` _array (optional)_ + + + + + diff --git a/content/pages/01-reference/curl/resources/library/get_common_library_items/_usage.mdx b/content/pages/01-reference/curl/resources/library/get_common_library_items/_usage.mdx new file mode 100644 index 0000000..1539dba --- /dev/null +++ b/content/pages/01-reference/curl/resources/library/get_common_library_items/_usage.mdx @@ -0,0 +1,21 @@ + + +```bash Example Request +curl http://10.10.10.47:32400/library/sections/8360.79/common?filter=string&type=710.36 \ +--header 'Accept: application/json' \ +--header 'X-Plex-Token: YOUR_API_KEY_HERE' +``` +--- + +```json Example Response + { + "errors": [ + { + "code": 1001, + "message": "User could not be authenticated", + "status": 401 + } + ] + } +``` + diff --git a/content/pages/01-reference/curl/resources/library/get_common_library_items/get_common_library_items.mdx b/content/pages/01-reference/curl/resources/library/get_common_library_items/get_common_library_items.mdx new file mode 100644 index 0000000..4b79f78 --- /dev/null +++ b/content/pages/01-reference/curl/resources/library/get_common_library_items/get_common_library_items.mdx @@ -0,0 +1,12 @@ +import CurlHeader from './_header.mdx'; +import SDKHeader from './_header.mdx'; +import OperationHeader from '/src/components/OperationHeader'; + +###### *Library* + +} + curlHeader={} +/> + +{/* render operation */} diff --git a/content/pages/01-reference/curl/resources/library/get_file_hash/_authentication.mdx b/content/pages/01-reference/curl/resources/library/get_file_hash/_authentication.mdx new file mode 100644 index 0000000..ac82b0b --- /dev/null +++ b/content/pages/01-reference/curl/resources/library/get_file_hash/_authentication.mdx @@ -0,0 +1,9 @@ +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### API key _— in HTTP header_ + +Set your API key in a `X-Plex-Token` HTTP header. + +Example: `` + diff --git a/content/pages/01-reference/curl/resources/library/get_file_hash/_header.mdx b/content/pages/01-reference/curl/resources/library/get_file_hash/_header.mdx new file mode 100644 index 0000000..50285f8 --- /dev/null +++ b/content/pages/01-reference/curl/resources/library/get_file_hash/_header.mdx @@ -0,0 +1,7 @@ +import OperationInfo from '/src/components/OperationInfo'; + +## Get File Hash + + + +This resource returns hash values for local files diff --git a/content/pages/01-reference/curl/resources/library/get_file_hash/_parameters.mdx b/content/pages/01-reference/curl/resources/library/get_file_hash/_parameters.mdx new file mode 100644 index 0000000..582a652 --- /dev/null +++ b/content/pages/01-reference/curl/resources/library/get_file_hash/_parameters.mdx @@ -0,0 +1,11 @@ +{/* Autogenerated DO NOT EDIT */} +##### `url` _string_ +This is the path to the local file, must be prefixed by `file://` +
+**Example:** `file://C:\Image.png&type=13` + +--- +##### `type` _number (optional)_ +Item type + + diff --git a/content/pages/01-reference/curl/resources/library/get_file_hash/_response.mdx b/content/pages/01-reference/curl/resources/library/get_file_hash/_response.mdx new file mode 100644 index 0000000..1b23813 --- /dev/null +++ b/content/pages/01-reference/curl/resources/library/get_file_hash/_response.mdx @@ -0,0 +1,26 @@ +{/* Autogenerated DO NOT EDIT */} + +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; +import { TabbedSection, Tab } from '@/src/components/TabbedSection'; +import StatusCode from '@/src/components/StatusCode'; + + + {/* prettier-ignore */} + }> + _No response body._ + + {/* prettier-ignore */} + }> + _No response body._ + + {/* prettier-ignore */} + }> + *JSON object* + + ##### `errors` _array (optional)_ + + + + + diff --git a/content/pages/01-reference/curl/resources/library/get_file_hash/_usage.mdx b/content/pages/01-reference/curl/resources/library/get_file_hash/_usage.mdx new file mode 100644 index 0000000..764580a --- /dev/null +++ b/content/pages/01-reference/curl/resources/library/get_file_hash/_usage.mdx @@ -0,0 +1,21 @@ + + +```bash Example Request +curl http://10.10.10.47:32400/library/hashes?type=8121.69&url=file%3A%2F%2FC%3A%5CImage.png%26type%3D13 \ +--header 'Accept: application/json' \ +--header 'X-Plex-Token: YOUR_API_KEY_HERE' +``` +--- + +```json Example Response + { + "errors": [ + { + "code": 1001, + "message": "User could not be authenticated", + "status": 401 + } + ] + } +``` + diff --git a/content/pages/01-reference/curl/resources/library/get_file_hash/get_file_hash.mdx b/content/pages/01-reference/curl/resources/library/get_file_hash/get_file_hash.mdx new file mode 100644 index 0000000..4b79f78 --- /dev/null +++ b/content/pages/01-reference/curl/resources/library/get_file_hash/get_file_hash.mdx @@ -0,0 +1,12 @@ +import CurlHeader from './_header.mdx'; +import SDKHeader from './_header.mdx'; +import OperationHeader from '/src/components/OperationHeader'; + +###### *Library* + +} + curlHeader={} +/> + +{/* render operation */} diff --git a/content/pages/01-reference/curl/resources/library/get_latest_library_items/_authentication.mdx b/content/pages/01-reference/curl/resources/library/get_latest_library_items/_authentication.mdx new file mode 100644 index 0000000..ac82b0b --- /dev/null +++ b/content/pages/01-reference/curl/resources/library/get_latest_library_items/_authentication.mdx @@ -0,0 +1,9 @@ +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### API key _— in HTTP header_ + +Set your API key in a `X-Plex-Token` HTTP header. + +Example: `` + diff --git a/content/pages/01-reference/curl/resources/library/get_latest_library_items/_header.mdx b/content/pages/01-reference/curl/resources/library/get_latest_library_items/_header.mdx new file mode 100644 index 0000000..f3df705 --- /dev/null +++ b/content/pages/01-reference/curl/resources/library/get_latest_library_items/_header.mdx @@ -0,0 +1,8 @@ +import OperationInfo from '/src/components/OperationInfo'; + +## Get Latest Library Items + + + +This endpoint will return a list of the latest library items filtered by the filter and type provided + diff --git a/content/pages/01-reference/curl/resources/library/get_latest_library_items/_parameters.mdx b/content/pages/01-reference/curl/resources/library/get_latest_library_items/_parameters.mdx new file mode 100644 index 0000000..308c5db --- /dev/null +++ b/content/pages/01-reference/curl/resources/library/get_latest_library_items/_parameters.mdx @@ -0,0 +1,13 @@ +{/* Autogenerated DO NOT EDIT */} +##### `sectionId` _number_ +the Id of the library to query + +--- +##### `type` _number_ +item type + +--- +##### `filter` _string (optional)_ +the filter parameter + + diff --git a/content/pages/01-reference/curl/resources/library/get_latest_library_items/_response.mdx b/content/pages/01-reference/curl/resources/library/get_latest_library_items/_response.mdx new file mode 100644 index 0000000..1b23813 --- /dev/null +++ b/content/pages/01-reference/curl/resources/library/get_latest_library_items/_response.mdx @@ -0,0 +1,26 @@ +{/* Autogenerated DO NOT EDIT */} + +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; +import { TabbedSection, Tab } from '@/src/components/TabbedSection'; +import StatusCode from '@/src/components/StatusCode'; + + + {/* prettier-ignore */} + }> + _No response body._ + + {/* prettier-ignore */} + }> + _No response body._ + + {/* prettier-ignore */} + }> + *JSON object* + + ##### `errors` _array (optional)_ + + + + + diff --git a/content/pages/01-reference/curl/resources/library/get_latest_library_items/_usage.mdx b/content/pages/01-reference/curl/resources/library/get_latest_library_items/_usage.mdx new file mode 100644 index 0000000..3dbfef7 --- /dev/null +++ b/content/pages/01-reference/curl/resources/library/get_latest_library_items/_usage.mdx @@ -0,0 +1,21 @@ + + +```bash Example Request +curl http://10.10.10.47:32400/library/sections/3927.85/latest?filter=string&type=9255.97 \ +--header 'Accept: application/json' \ +--header 'X-Plex-Token: YOUR_API_KEY_HERE' +``` +--- + +```json Example Response + { + "errors": [ + { + "code": 1001, + "message": "User could not be authenticated", + "status": 401 + } + ] + } +``` + diff --git a/content/pages/01-reference/curl/resources/library/get_latest_library_items/get_latest_library_items.mdx b/content/pages/01-reference/curl/resources/library/get_latest_library_items/get_latest_library_items.mdx new file mode 100644 index 0000000..4b79f78 --- /dev/null +++ b/content/pages/01-reference/curl/resources/library/get_latest_library_items/get_latest_library_items.mdx @@ -0,0 +1,12 @@ +import CurlHeader from './_header.mdx'; +import SDKHeader from './_header.mdx'; +import OperationHeader from '/src/components/OperationHeader'; + +###### *Library* + +} + curlHeader={} +/> + +{/* render operation */} diff --git a/content/pages/01-reference/curl/resources/library/get_libraries/_authentication.mdx b/content/pages/01-reference/curl/resources/library/get_libraries/_authentication.mdx new file mode 100644 index 0000000..ac82b0b --- /dev/null +++ b/content/pages/01-reference/curl/resources/library/get_libraries/_authentication.mdx @@ -0,0 +1,9 @@ +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### API key _— in HTTP header_ + +Set your API key in a `X-Plex-Token` HTTP header. + +Example: `` + diff --git a/content/pages/01-reference/curl/resources/library/get_libraries/_header.mdx b/content/pages/01-reference/curl/resources/library/get_libraries/_header.mdx new file mode 100644 index 0000000..d220937 --- /dev/null +++ b/content/pages/01-reference/curl/resources/library/get_libraries/_header.mdx @@ -0,0 +1,13 @@ +import OperationInfo from '/src/components/OperationInfo'; + +## Get Libraries + + + +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. +For example, a music library has an artist > albums > tracks structure, whereas a movie library is flat. + +Libraries have features beyond just being a collection of media; for starters, they include information about supported types, filters and sorts. +This allows a client to provide a rich interface around the media (e.g. allow sorting movies by release year). + diff --git a/content/pages/01-reference/curl/resources/library/get_libraries/_parameters.mdx b/content/pages/01-reference/curl/resources/library/get_libraries/_parameters.mdx new file mode 100644 index 0000000..929b020 --- /dev/null +++ b/content/pages/01-reference/curl/resources/library/get_libraries/_parameters.mdx @@ -0,0 +1,2 @@ +{/* Autogenerated DO NOT EDIT */} + diff --git a/content/pages/01-reference/curl/resources/library/get_libraries/_response.mdx b/content/pages/01-reference/curl/resources/library/get_libraries/_response.mdx new file mode 100644 index 0000000..1b23813 --- /dev/null +++ b/content/pages/01-reference/curl/resources/library/get_libraries/_response.mdx @@ -0,0 +1,26 @@ +{/* Autogenerated DO NOT EDIT */} + +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; +import { TabbedSection, Tab } from '@/src/components/TabbedSection'; +import StatusCode from '@/src/components/StatusCode'; + + + {/* prettier-ignore */} + }> + _No response body._ + + {/* prettier-ignore */} + }> + _No response body._ + + {/* prettier-ignore */} + }> + *JSON object* + + ##### `errors` _array (optional)_ + + + + + diff --git a/content/pages/01-reference/curl/resources/library/get_libraries/_usage.mdx b/content/pages/01-reference/curl/resources/library/get_libraries/_usage.mdx new file mode 100644 index 0000000..d559e96 --- /dev/null +++ b/content/pages/01-reference/curl/resources/library/get_libraries/_usage.mdx @@ -0,0 +1,21 @@ + + +```bash Example Request +curl http://10.10.10.47:32400/library/sections \ +--header 'Accept: application/json' \ +--header 'X-Plex-Token: YOUR_API_KEY_HERE' +``` +--- + +```json Example Response + { + "errors": [ + { + "code": 1001, + "message": "User could not be authenticated", + "status": 401 + } + ] + } +``` + diff --git a/content/pages/01-reference/curl/resources/library/get_libraries/get_libraries.mdx b/content/pages/01-reference/curl/resources/library/get_libraries/get_libraries.mdx new file mode 100644 index 0000000..4b79f78 --- /dev/null +++ b/content/pages/01-reference/curl/resources/library/get_libraries/get_libraries.mdx @@ -0,0 +1,12 @@ +import CurlHeader from './_header.mdx'; +import SDKHeader from './_header.mdx'; +import OperationHeader from '/src/components/OperationHeader'; + +###### *Library* + +} + curlHeader={} +/> + +{/* render operation */} diff --git a/content/pages/01-reference/curl/resources/library/get_library/_authentication.mdx b/content/pages/01-reference/curl/resources/library/get_library/_authentication.mdx new file mode 100644 index 0000000..ac82b0b --- /dev/null +++ b/content/pages/01-reference/curl/resources/library/get_library/_authentication.mdx @@ -0,0 +1,9 @@ +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### API key _— in HTTP header_ + +Set your API key in a `X-Plex-Token` HTTP header. + +Example: `` + diff --git a/content/pages/01-reference/curl/resources/library/get_library/_header.mdx b/content/pages/01-reference/curl/resources/library/get_library/_header.mdx new file mode 100644 index 0000000..4361404 --- /dev/null +++ b/content/pages/01-reference/curl/resources/library/get_library/_header.mdx @@ -0,0 +1,26 @@ +import OperationInfo from '/src/components/OperationInfo'; + +## Get Library + + + +Returns details for the library. This can be thought of as an interstitial endpoint because it contains information about the library, rather than content itself. These details are: + +- A list of `Directory` objects: These used to be used by clients to build a menuing system. There are four flavors of directory found here: + - Primary: (e.g. all, On Deck) These are still used in some clients to provide "shortcuts" to subsets of media. However, with the exception of On Deck, all of them can be created by media queries, and the desire is to allow these to be customized by users. + - Secondary: These are marked with `secondary="1"` and were used by old clients to provide nested menus allowing for primative (but structured) navigation. + - Special: There is a By Folder entry which allows browsing the media by the underlying filesystem structure, and there's a completely obsolete entry marked `search="1"` which used to be used to allow clients to build search dialogs on the fly. +- A list of `Type` objects: These represent the types of things found in this library, and for each one, a list of `Filter` and `Sort` objects. These can be used to build rich controls around a grid of media to allow filtering and organizing. Note that these filters and sorts are optional, and without them, the client won't render any filtering controls. The `Type` object contains: + - `key`: This provides the root endpoint returning the actual media list for the type. + - `type`: This is the metadata type for the type (if a standard Plex type). + - `title`: The title for for the content of this type (e.g. "Movies"). +- Each `Filter` object contains a description of the filter. Note that it is not an exhaustive list of the full media query language, but an inportant subset useful for top-level API. + - `filter`: This represents the filter name used for the filter, which can be used to construct complex media queries with. + - `filterType`: This is either `string`, `integer`, or `boolean`, and describes the type of values used for the filter. + - `key`: This provides the endpoint where the possible range of values for the filter can be retrieved (e.g. for a "Genre" filter, it returns a list of all the genres in the library). This will include a `type` argument that matches the metadata type of the Type element. + - `title`: The title for the filter. +- Each `Sort` object contains a description of the sort field. + - `defaultDirection`: Can be either `asc` or `desc`, and specifies the default direction for the sort field (e.g. titles default to alphabetically ascending). + - `descKey` and `key`: Contains the parameters passed to the `sort=...` media query for each direction of the sort. + - `title`: The title of the field. + diff --git a/content/pages/01-reference/curl/resources/library/get_library/_parameters.mdx b/content/pages/01-reference/curl/resources/library/get_library/_parameters.mdx new file mode 100644 index 0000000..2b99c38 --- /dev/null +++ b/content/pages/01-reference/curl/resources/library/get_library/_parameters.mdx @@ -0,0 +1,20 @@ +{/* Autogenerated DO NOT EDIT */} +import IncludeDetails from "/content/types/operations/include_details/curl.mdx" +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `sectionId` _number_ +the Id of the library to query +
+**Example:** `1000` + +--- +##### `includeDetails` _enumeration (optional)_ +Whether or not to include details for a section (types, filters, and sorts). +Only exists for backwards compatibility, media providers other than the server libraries have it on always. + + + + + + diff --git a/content/pages/01-reference/curl/resources/library/get_library/_response.mdx b/content/pages/01-reference/curl/resources/library/get_library/_response.mdx new file mode 100644 index 0000000..1b23813 --- /dev/null +++ b/content/pages/01-reference/curl/resources/library/get_library/_response.mdx @@ -0,0 +1,26 @@ +{/* Autogenerated DO NOT EDIT */} + +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; +import { TabbedSection, Tab } from '@/src/components/TabbedSection'; +import StatusCode from '@/src/components/StatusCode'; + + + {/* prettier-ignore */} + }> + _No response body._ + + {/* prettier-ignore */} + }> + _No response body._ + + {/* prettier-ignore */} + }> + *JSON object* + + ##### `errors` _array (optional)_ + + + + + diff --git a/content/pages/01-reference/curl/resources/library/get_library/_usage.mdx b/content/pages/01-reference/curl/resources/library/get_library/_usage.mdx new file mode 100644 index 0000000..8afc760 --- /dev/null +++ b/content/pages/01-reference/curl/resources/library/get_library/_usage.mdx @@ -0,0 +1,21 @@ + + +```bash Example Request +curl http://10.10.10.47:32400/library/sections/1000 \ +--header 'Accept: application/json' \ +--header 'X-Plex-Token: YOUR_API_KEY_HERE' +``` +--- + +```json Example Response + { + "errors": [ + { + "code": 1001, + "message": "User could not be authenticated", + "status": 401 + } + ] + } +``` + diff --git a/content/pages/01-reference/curl/resources/library/get_library/get_library.mdx b/content/pages/01-reference/curl/resources/library/get_library/get_library.mdx new file mode 100644 index 0000000..4b79f78 --- /dev/null +++ b/content/pages/01-reference/curl/resources/library/get_library/get_library.mdx @@ -0,0 +1,12 @@ +import CurlHeader from './_header.mdx'; +import SDKHeader from './_header.mdx'; +import OperationHeader from '/src/components/OperationHeader'; + +###### *Library* + +} + curlHeader={} +/> + +{/* render operation */} diff --git a/content/pages/01-reference/curl/resources/library/get_library_items/_authentication.mdx b/content/pages/01-reference/curl/resources/library/get_library_items/_authentication.mdx new file mode 100644 index 0000000..ac82b0b --- /dev/null +++ b/content/pages/01-reference/curl/resources/library/get_library_items/_authentication.mdx @@ -0,0 +1,9 @@ +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### API key _— in HTTP header_ + +Set your API key in a `X-Plex-Token` HTTP header. + +Example: `` + diff --git a/content/pages/01-reference/curl/resources/library/get_library_items/_header.mdx b/content/pages/01-reference/curl/resources/library/get_library_items/_header.mdx new file mode 100644 index 0000000..bc8090d --- /dev/null +++ b/content/pages/01-reference/curl/resources/library/get_library_items/_header.mdx @@ -0,0 +1,8 @@ +import OperationInfo from '/src/components/OperationInfo'; + +## Get Library Items + + + +This endpoint will return a list of library items filtered by the filter and type provided + diff --git a/content/pages/01-reference/curl/resources/library/get_library_items/_parameters.mdx b/content/pages/01-reference/curl/resources/library/get_library_items/_parameters.mdx new file mode 100644 index 0000000..5bce120 --- /dev/null +++ b/content/pages/01-reference/curl/resources/library/get_library_items/_parameters.mdx @@ -0,0 +1,13 @@ +{/* Autogenerated DO NOT EDIT */} +##### `sectionId` _number_ +the Id of the library to query + +--- +##### `type` _number (optional)_ +item type + +--- +##### `filter` _string (optional)_ +the filter parameter + + diff --git a/content/pages/01-reference/curl/resources/library/get_library_items/_response.mdx b/content/pages/01-reference/curl/resources/library/get_library_items/_response.mdx new file mode 100644 index 0000000..1b23813 --- /dev/null +++ b/content/pages/01-reference/curl/resources/library/get_library_items/_response.mdx @@ -0,0 +1,26 @@ +{/* Autogenerated DO NOT EDIT */} + +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; +import { TabbedSection, Tab } from '@/src/components/TabbedSection'; +import StatusCode from '@/src/components/StatusCode'; + + + {/* prettier-ignore */} + }> + _No response body._ + + {/* prettier-ignore */} + }> + _No response body._ + + {/* prettier-ignore */} + }> + *JSON object* + + ##### `errors` _array (optional)_ + + + + + diff --git a/content/pages/01-reference/curl/resources/library/get_library_items/_usage.mdx b/content/pages/01-reference/curl/resources/library/get_library_items/_usage.mdx new file mode 100644 index 0000000..13d4929 --- /dev/null +++ b/content/pages/01-reference/curl/resources/library/get_library_items/_usage.mdx @@ -0,0 +1,21 @@ + + +```bash Example Request +curl http://10.10.10.47:32400/library/sections/5288.95/all?filter=string&type=4799.77 \ +--header 'Accept: application/json' \ +--header 'X-Plex-Token: YOUR_API_KEY_HERE' +``` +--- + +```json Example Response + { + "errors": [ + { + "code": 1001, + "message": "User could not be authenticated", + "status": 401 + } + ] + } +``` + diff --git a/content/pages/01-reference/curl/resources/library/get_library_items/get_library_items.mdx b/content/pages/01-reference/curl/resources/library/get_library_items/get_library_items.mdx new file mode 100644 index 0000000..4b79f78 --- /dev/null +++ b/content/pages/01-reference/curl/resources/library/get_library_items/get_library_items.mdx @@ -0,0 +1,12 @@ +import CurlHeader from './_header.mdx'; +import SDKHeader from './_header.mdx'; +import OperationHeader from '/src/components/OperationHeader'; + +###### *Library* + +} + curlHeader={} +/> + +{/* render operation */} diff --git a/content/pages/01-reference/curl/resources/library/get_metadata/_authentication.mdx b/content/pages/01-reference/curl/resources/library/get_metadata/_authentication.mdx new file mode 100644 index 0000000..ac82b0b --- /dev/null +++ b/content/pages/01-reference/curl/resources/library/get_metadata/_authentication.mdx @@ -0,0 +1,9 @@ +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### API key _— in HTTP header_ + +Set your API key in a `X-Plex-Token` HTTP header. + +Example: `` + diff --git a/content/pages/01-reference/curl/resources/library/get_metadata/_header.mdx b/content/pages/01-reference/curl/resources/library/get_metadata/_header.mdx new file mode 100644 index 0000000..929a367 --- /dev/null +++ b/content/pages/01-reference/curl/resources/library/get_metadata/_header.mdx @@ -0,0 +1,8 @@ +import OperationInfo from '/src/components/OperationInfo'; + +## Get Metadata + + + +This endpoint will return the metadata of a library item specified with the ratingKey. + diff --git a/content/pages/01-reference/curl/resources/library/get_metadata/_parameters.mdx b/content/pages/01-reference/curl/resources/library/get_metadata/_parameters.mdx new file mode 100644 index 0000000..0586d50 --- /dev/null +++ b/content/pages/01-reference/curl/resources/library/get_metadata/_parameters.mdx @@ -0,0 +1,5 @@ +{/* Autogenerated DO NOT EDIT */} +##### `ratingKey` _number_ +the id of the library item to return the children of. + + diff --git a/content/pages/01-reference/curl/resources/library/get_metadata/_response.mdx b/content/pages/01-reference/curl/resources/library/get_metadata/_response.mdx new file mode 100644 index 0000000..1b23813 --- /dev/null +++ b/content/pages/01-reference/curl/resources/library/get_metadata/_response.mdx @@ -0,0 +1,26 @@ +{/* Autogenerated DO NOT EDIT */} + +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; +import { TabbedSection, Tab } from '@/src/components/TabbedSection'; +import StatusCode from '@/src/components/StatusCode'; + + + {/* prettier-ignore */} + }> + _No response body._ + + {/* prettier-ignore */} + }> + _No response body._ + + {/* prettier-ignore */} + }> + *JSON object* + + ##### `errors` _array (optional)_ + + + + + diff --git a/content/pages/01-reference/curl/resources/library/get_metadata/_usage.mdx b/content/pages/01-reference/curl/resources/library/get_metadata/_usage.mdx new file mode 100644 index 0000000..93ed8b3 --- /dev/null +++ b/content/pages/01-reference/curl/resources/library/get_metadata/_usage.mdx @@ -0,0 +1,21 @@ + + +```bash Example Request +curl http://10.10.10.47:32400/library/metadata/3373.96 \ +--header 'Accept: application/json' \ +--header 'X-Plex-Token: YOUR_API_KEY_HERE' +``` +--- + +```json Example Response + { + "errors": [ + { + "code": 1001, + "message": "User could not be authenticated", + "status": 401 + } + ] + } +``` + diff --git a/content/pages/01-reference/curl/resources/library/get_metadata/get_metadata.mdx b/content/pages/01-reference/curl/resources/library/get_metadata/get_metadata.mdx new file mode 100644 index 0000000..4b79f78 --- /dev/null +++ b/content/pages/01-reference/curl/resources/library/get_metadata/get_metadata.mdx @@ -0,0 +1,12 @@ +import CurlHeader from './_header.mdx'; +import SDKHeader from './_header.mdx'; +import OperationHeader from '/src/components/OperationHeader'; + +###### *Library* + +} + curlHeader={} +/> + +{/* render operation */} diff --git a/content/pages/01-reference/curl/resources/library/get_metadata_children/_authentication.mdx b/content/pages/01-reference/curl/resources/library/get_metadata_children/_authentication.mdx new file mode 100644 index 0000000..ac82b0b --- /dev/null +++ b/content/pages/01-reference/curl/resources/library/get_metadata_children/_authentication.mdx @@ -0,0 +1,9 @@ +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### API key _— in HTTP header_ + +Set your API key in a `X-Plex-Token` HTTP header. + +Example: `` + diff --git a/content/pages/01-reference/curl/resources/library/get_metadata_children/_header.mdx b/content/pages/01-reference/curl/resources/library/get_metadata_children/_header.mdx new file mode 100644 index 0000000..1579d0e --- /dev/null +++ b/content/pages/01-reference/curl/resources/library/get_metadata_children/_header.mdx @@ -0,0 +1,8 @@ +import OperationInfo from '/src/components/OperationInfo'; + +## Get Metadata Children + + + +This endpoint will return the children of of a library item specified with the ratingKey. + diff --git a/content/pages/01-reference/curl/resources/library/get_metadata_children/_parameters.mdx b/content/pages/01-reference/curl/resources/library/get_metadata_children/_parameters.mdx new file mode 100644 index 0000000..0586d50 --- /dev/null +++ b/content/pages/01-reference/curl/resources/library/get_metadata_children/_parameters.mdx @@ -0,0 +1,5 @@ +{/* Autogenerated DO NOT EDIT */} +##### `ratingKey` _number_ +the id of the library item to return the children of. + + diff --git a/content/pages/01-reference/curl/resources/library/get_metadata_children/_response.mdx b/content/pages/01-reference/curl/resources/library/get_metadata_children/_response.mdx new file mode 100644 index 0000000..1b23813 --- /dev/null +++ b/content/pages/01-reference/curl/resources/library/get_metadata_children/_response.mdx @@ -0,0 +1,26 @@ +{/* Autogenerated DO NOT EDIT */} + +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; +import { TabbedSection, Tab } from '@/src/components/TabbedSection'; +import StatusCode from '@/src/components/StatusCode'; + + + {/* prettier-ignore */} + }> + _No response body._ + + {/* prettier-ignore */} + }> + _No response body._ + + {/* prettier-ignore */} + }> + *JSON object* + + ##### `errors` _array (optional)_ + + + + + diff --git a/content/pages/01-reference/curl/resources/library/get_metadata_children/_usage.mdx b/content/pages/01-reference/curl/resources/library/get_metadata_children/_usage.mdx new file mode 100644 index 0000000..16cdd79 --- /dev/null +++ b/content/pages/01-reference/curl/resources/library/get_metadata_children/_usage.mdx @@ -0,0 +1,21 @@ + + +```bash Example Request +curl http://10.10.10.47:32400/library/metadata/871.29/children \ +--header 'Accept: application/json' \ +--header 'X-Plex-Token: YOUR_API_KEY_HERE' +``` +--- + +```json Example Response + { + "errors": [ + { + "code": 1001, + "message": "User could not be authenticated", + "status": 401 + } + ] + } +``` + diff --git a/content/pages/01-reference/curl/resources/library/get_metadata_children/get_metadata_children.mdx b/content/pages/01-reference/curl/resources/library/get_metadata_children/get_metadata_children.mdx new file mode 100644 index 0000000..4b79f78 --- /dev/null +++ b/content/pages/01-reference/curl/resources/library/get_metadata_children/get_metadata_children.mdx @@ -0,0 +1,12 @@ +import CurlHeader from './_header.mdx'; +import SDKHeader from './_header.mdx'; +import OperationHeader from '/src/components/OperationHeader'; + +###### *Library* + +} + curlHeader={} +/> + +{/* render operation */} diff --git a/content/pages/01-reference/curl/resources/library/get_on_deck/_authentication.mdx b/content/pages/01-reference/curl/resources/library/get_on_deck/_authentication.mdx new file mode 100644 index 0000000..ac82b0b --- /dev/null +++ b/content/pages/01-reference/curl/resources/library/get_on_deck/_authentication.mdx @@ -0,0 +1,9 @@ +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### API key _— in HTTP header_ + +Set your API key in a `X-Plex-Token` HTTP header. + +Example: `` + diff --git a/content/pages/01-reference/curl/resources/library/get_on_deck/_header.mdx b/content/pages/01-reference/curl/resources/library/get_on_deck/_header.mdx new file mode 100644 index 0000000..4217abd --- /dev/null +++ b/content/pages/01-reference/curl/resources/library/get_on_deck/_header.mdx @@ -0,0 +1,8 @@ +import OperationInfo from '/src/components/OperationInfo'; + +## Get On Deck + + + +This endpoint will return the on deck content. + diff --git a/content/pages/01-reference/curl/resources/library/get_on_deck/_parameters.mdx b/content/pages/01-reference/curl/resources/library/get_on_deck/_parameters.mdx new file mode 100644 index 0000000..929b020 --- /dev/null +++ b/content/pages/01-reference/curl/resources/library/get_on_deck/_parameters.mdx @@ -0,0 +1,2 @@ +{/* Autogenerated DO NOT EDIT */} + diff --git a/content/pages/01-reference/curl/resources/library/get_on_deck/_response.mdx b/content/pages/01-reference/curl/resources/library/get_on_deck/_response.mdx new file mode 100644 index 0000000..0542cd5 --- /dev/null +++ b/content/pages/01-reference/curl/resources/library/get_on_deck/_response.mdx @@ -0,0 +1,35 @@ +{/* Autogenerated DO NOT EDIT */} +import GetOnDeckMediaContainer from "/content/types/operations/get_on_deck_media_container/curl.mdx" + +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; +import { TabbedSection, Tab } from '@/src/components/TabbedSection'; +import StatusCode from '@/src/components/StatusCode'; + + + {/* prettier-ignore */} + }> + *JSON object* + + ##### `MediaContainer` _object (optional)_ + + + + + + + + {/* prettier-ignore */} + }> + _No response body._ + + {/* prettier-ignore */} + }> + *JSON object* + + ##### `errors` _array (optional)_ + + + + + diff --git a/content/pages/01-reference/curl/resources/library/get_on_deck/_usage.mdx b/content/pages/01-reference/curl/resources/library/get_on_deck/_usage.mdx new file mode 100644 index 0000000..c7d1047 --- /dev/null +++ b/content/pages/01-reference/curl/resources/library/get_on_deck/_usage.mdx @@ -0,0 +1,122 @@ + + +```bash Example Request +curl http://10.10.10.47:32400/library/onDeck \ +--header 'Accept: application/json' \ +--header 'X-Plex-Token: YOUR_API_KEY_HERE' +``` +--- + +```json Example Response + { + "MediaContainer": { + "size": 16, + "allowSync": false, + "identifier": "com.plexapp.plugins.library", + "mediaTagPrefix": "/system/bundle/media/flags/", + "mediaTagVersion": 1680021154, + "mixedParents": false, + "Metadata": [ + { + "allowSync": false, + "librarySectionID": 2, + "librarySectionTitle": "TV Shows", + "librarySectionUUID": "4bb2521c-8ba9-459b-aaee-8ab8bc35eabd", + "ratingKey": 49564, + "key": "/library/metadata/49564", + "parentRatingKey": 49557, + "grandparentRatingKey": 49556, + "guid": "plex://episode/5ea7d7402e7ab10042e74d4f", + "parentGuid": "plex://season/602e754d67f4c8002ce54b3d", + "grandparentGuid": "plex://show/5d9c090e705e7a001e6e94d8", + "type": "episode", + "title": "Circus", + "grandparentKey": "/library/metadata/49556", + "parentKey": "/library/metadata/49557", + "librarySectionKey": "/library/sections/2", + "grandparentTitle": "Bluey (2018)", + "parentTitle": "Season 2", + "contentRating": "TV-Y", + "summary": "Bluey is the ringmaster in a game of circus with her friends but Hercules wants to play his motorcycle game instead. Luckily Bluey has a solution to keep everyone happy.", + "index": 33, + "parentIndex": 2, + "lastViewedAt": 1681908352, + "year": 2018, + "thumb": "/library/metadata/49564/thumb/1654258204", + "art": "/library/metadata/49556/art/1680939546", + "parentThumb": "/library/metadata/49557/thumb/1654258204", + "grandparentThumb": "/library/metadata/49556/thumb/1680939546", + "grandparentArt": "/library/metadata/49556/art/1680939546", + "grandparentTheme": "/library/metadata/49556/theme/1680939546", + "duration": 420080, + "originallyAvailableAt": "2020-10-31T00:00:00Z", + "addedAt": 1654258196, + "updatedAt": 1654258204, + "Media": [ + { + "id": 80994, + "duration": 420080, + "bitrate": 1046, + "width": 1920, + "height": 1080, + "aspectRatio": 1.78, + "audioChannels": 2, + "audioCodec": "aac", + "videoCodec": "hevc", + "videoResolution": "1080", + "container": "mkv", + "videoFrameRate": "PAL", + "audioProfile": "lc", + "videoProfile": "main", + "Part": [ + { + "id": 80994, + "key": "/library/parts/80994/1655007810/file.mkv", + "duration": 420080, + "file": "/tvshows/Bluey (2018)/Bluey (2018) - S02E33 - Circus.mkv", + "size": 55148931, + "audioProfile": "lc", + "container": "mkv", + "videoProfile": "main", + "Stream": [ + { + "id": 211234, + "streamType": 1, + "default": false, + "codec": "hevc", + "index": 0, + "bitrate": 918, + "language": "English", + "languageTag": "en", + "languageCode": "eng", + "bitDepth": 8, + "chromaLocation": "left", + "chromaSubsampling": "4:2:0", + "codedHeight": 1080, + "codedWidth": 1920, + "colorRange": "tv", + "frameRate": 25, + "height": 1080, + "level": 120, + "profile": "main", + "refFrames": 1, + "width": 1920, + "displayTitle": "1080p (HEVC Main)", + "extendedDisplayTitle": "1080p (HEVC Main)" + } + ] + } + ] + } + ], + "guids": [ + { + "id": "imdb://tt13303712" + } + ] + } + ] + } + } +``` + diff --git a/content/pages/01-reference/curl/resources/library/get_on_deck/get_on_deck.mdx b/content/pages/01-reference/curl/resources/library/get_on_deck/get_on_deck.mdx new file mode 100644 index 0000000..4b79f78 --- /dev/null +++ b/content/pages/01-reference/curl/resources/library/get_on_deck/get_on_deck.mdx @@ -0,0 +1,12 @@ +import CurlHeader from './_header.mdx'; +import SDKHeader from './_header.mdx'; +import OperationHeader from '/src/components/OperationHeader'; + +###### *Library* + +} + curlHeader={} +/> + +{/* render operation */} diff --git a/content/pages/01-reference/curl/resources/library/get_recently_added/_authentication.mdx b/content/pages/01-reference/curl/resources/library/get_recently_added/_authentication.mdx new file mode 100644 index 0000000..ac82b0b --- /dev/null +++ b/content/pages/01-reference/curl/resources/library/get_recently_added/_authentication.mdx @@ -0,0 +1,9 @@ +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### API key _— in HTTP header_ + +Set your API key in a `X-Plex-Token` HTTP header. + +Example: `` + diff --git a/content/pages/01-reference/curl/resources/library/get_recently_added/_header.mdx b/content/pages/01-reference/curl/resources/library/get_recently_added/_header.mdx new file mode 100644 index 0000000..5e61973 --- /dev/null +++ b/content/pages/01-reference/curl/resources/library/get_recently_added/_header.mdx @@ -0,0 +1,8 @@ +import OperationInfo from '/src/components/OperationInfo'; + +## Get Recently Added + + + +This endpoint will return the recently added content. + diff --git a/content/pages/01-reference/curl/resources/library/get_recently_added/_parameters.mdx b/content/pages/01-reference/curl/resources/library/get_recently_added/_parameters.mdx new file mode 100644 index 0000000..929b020 --- /dev/null +++ b/content/pages/01-reference/curl/resources/library/get_recently_added/_parameters.mdx @@ -0,0 +1,2 @@ +{/* Autogenerated DO NOT EDIT */} + diff --git a/content/pages/01-reference/curl/resources/library/get_recently_added/_response.mdx b/content/pages/01-reference/curl/resources/library/get_recently_added/_response.mdx new file mode 100644 index 0000000..d8d63ac --- /dev/null +++ b/content/pages/01-reference/curl/resources/library/get_recently_added/_response.mdx @@ -0,0 +1,35 @@ +{/* Autogenerated DO NOT EDIT */} +import GetRecentlyAddedMediaContainer from "/content/types/operations/get_recently_added_media_container/curl.mdx" + +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; +import { TabbedSection, Tab } from '@/src/components/TabbedSection'; +import StatusCode from '@/src/components/StatusCode'; + + + {/* prettier-ignore */} + }> + *JSON object* + + ##### `MediaContainer` _object (optional)_ + + + + + + + + {/* prettier-ignore */} + }> + _No response body._ + + {/* prettier-ignore */} + }> + *JSON object* + + ##### `errors` _array (optional)_ + + + + + diff --git a/content/pages/01-reference/curl/resources/library/get_recently_added/_usage.mdx b/content/pages/01-reference/curl/resources/library/get_recently_added/_usage.mdx new file mode 100644 index 0000000..916e63c --- /dev/null +++ b/content/pages/01-reference/curl/resources/library/get_recently_added/_usage.mdx @@ -0,0 +1,110 @@ + + +```bash Example Request +curl http://10.10.10.47:32400/library/recentlyAdded \ +--header 'Accept: application/json' \ +--header 'X-Plex-Token: YOUR_API_KEY_HERE' +``` +--- + +```json Example Response + { + "MediaContainer": { + "size": 50, + "allowSync": false, + "identifier": "com.plexapp.plugins.library", + "mediaTagPrefix": "/system/bundle/media/flags/", + "mediaTagVersion": 1680021154, + "mixedParents": false, + "Metadata": [ + { + "allowSync": false, + "librarySectionID": 1, + "librarySectionTitle": "Movies", + "librarySectionUUID": "322a231a-b7f7-49f5-920f-14c61199cd30", + "ratingKey": 59398, + "key": "/library/metadata/59398", + "guid": "plex://movie/5e161a83bea6ac004126e148", + "studio": "Marvel Studios", + "type": "movie", + "title": "Ant-Man and the Wasp: Quantumania", + "contentRating": "PG-13", + "summary": "Scott Lang and Hope Van Dyne along with Hank Pym and Janet Van Dyne explore the Quantum Realm where they interact with strange creatures and embark on an adventure that goes beyond the limits of what they thought was possible.", + "rating": 4.7, + "audienceRating": 8.3, + "year": 2023, + "tagline": "Witness the beginning of a new dynasty.", + "thumb": "/library/metadata/59398/thumb/1681888010", + "art": "/library/metadata/59398/art/1681888010", + "duration": 7474422, + "originallyAvailableAt": "2023-02-15T00:00:00Z", + "addedAt": 1681803215, + "updatedAt": 1681888010, + "audienceRatingImage": "rottentomatoes://image.rating.upright", + "chapterSource": "media", + "primaryExtraKey": "/library/metadata/59399", + "ratingImage": "rottentomatoes://image.rating.rotten", + "Media": [ + { + "id": 120345, + "duration": 7474422, + "bitrate": 3623, + "width": 1920, + "height": 804, + "aspectRatio": 2.35, + "audioChannels": 6, + "audioCodec": "ac3", + "videoCodec": "h264", + "videoResolution": 1080, + "container": "mp4", + "videoFrameRate": "24p", + "optimizedForStreaming": 0, + "has64bitOffsets": false, + "videoProfile": "high", + "Part": [ + { + "id": 120353, + "key": "/library/parts/120353/1681803203/file.mp4", + "duration": 7474422, + "file": "/movies/Ant-Man and the Wasp Quantumania (2023)/Ant-Man.and.the.Wasp.Quantumania.2023.1080p.mp4", + "size": 3395307162, + "container": "mp4", + "has64bitOffsets": false, + "hasThumbnail": 1, + "optimizedForStreaming": false, + "videoProfile": "high" + } + ] + } + ], + "Genre": [ + { + "tag": "Comedy" + } + ], + "Director": [ + { + "tag": "Peyton Reed" + } + ], + "Writer": [ + { + "tag": "Jeff Loveness" + } + ], + "Country": [ + { + "tag": "United States of America" + } + ], + "Role": [ + { + "tag": "Paul Rudd" + } + ] + } + ] + } + } +``` + diff --git a/content/pages/01-reference/curl/resources/library/get_recently_added/get_recently_added.mdx b/content/pages/01-reference/curl/resources/library/get_recently_added/get_recently_added.mdx new file mode 100644 index 0000000..4b79f78 --- /dev/null +++ b/content/pages/01-reference/curl/resources/library/get_recently_added/get_recently_added.mdx @@ -0,0 +1,12 @@ +import CurlHeader from './_header.mdx'; +import SDKHeader from './_header.mdx'; +import OperationHeader from '/src/components/OperationHeader'; + +###### *Library* + +} + curlHeader={} +/> + +{/* render operation */} diff --git a/content/pages/01-reference/curl/resources/library/library.mdx b/content/pages/01-reference/curl/resources/library/library.mdx new file mode 100644 index 0000000..3b5c394 --- /dev/null +++ b/content/pages/01-reference/curl/resources/library/library.mdx @@ -0,0 +1,67 @@ +import GetFileHash from "./get_file_hash/get_file_hash.mdx"; +import GetRecentlyAdded from "./get_recently_added/get_recently_added.mdx"; +import GetLibraries from "./get_libraries/get_libraries.mdx"; +import GetLibrary from "./get_library/get_library.mdx"; +import DeleteLibrary from "./delete_library/delete_library.mdx"; +import GetLibraryItems from "./get_library_items/get_library_items.mdx"; +import RefreshLibrary from "./refresh_library/refresh_library.mdx"; +import GetLatestLibraryItems from "./get_latest_library_items/get_latest_library_items.mdx"; +import GetCommonLibraryItems from "./get_common_library_items/get_common_library_items.mdx"; +import GetMetadata from "./get_metadata/get_metadata.mdx"; +import GetMetadataChildren from "./get_metadata_children/get_metadata_children.mdx"; +import GetOnDeck from "./get_on_deck/get_on_deck.mdx"; + +## Library +API Calls interacting with Plex Media Server Libraries + + +### Available Operations + +* [Get File Hash](/curl/library/get_file_hash) - Get Hash Value +* [Get Recently Added](/curl/library/get_recently_added) - Get Recently Added +* [Get Libraries](/curl/library/get_libraries) - Get All Libraries +* [Get Library](/curl/library/get_library) - Get Library Details +* [Delete Library](/curl/library/delete_library) - Delete Library Section +* [Get Library Items](/curl/library/get_library_items) - Get Library Items +* [Refresh Library](/curl/library/refresh_library) - Refresh Library +* [Get Latest Library Items](/curl/library/get_latest_library_items) - Get Latest Library Items +* [Get Common Library Items](/curl/library/get_common_library_items) - Get Common Library Items +* [Get Metadata](/curl/library/get_metadata) - Get Items Metadata +* [Get Metadata Children](/curl/library/get_metadata_children) - Get Items Children +* [Get On Deck](/curl/library/get_on_deck) - Get On Deck + +--- + + +--- + + +--- + + +--- + + +--- + + +--- + + +--- + + +--- + + +--- + + +--- + + +--- + + +--- + diff --git a/content/pages/01-reference/curl/resources/library/refresh_library/_authentication.mdx b/content/pages/01-reference/curl/resources/library/refresh_library/_authentication.mdx new file mode 100644 index 0000000..ac82b0b --- /dev/null +++ b/content/pages/01-reference/curl/resources/library/refresh_library/_authentication.mdx @@ -0,0 +1,9 @@ +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### API key _— in HTTP header_ + +Set your API key in a `X-Plex-Token` HTTP header. + +Example: `` + diff --git a/content/pages/01-reference/curl/resources/library/refresh_library/_header.mdx b/content/pages/01-reference/curl/resources/library/refresh_library/_header.mdx new file mode 100644 index 0000000..cd38c08 --- /dev/null +++ b/content/pages/01-reference/curl/resources/library/refresh_library/_header.mdx @@ -0,0 +1,8 @@ +import OperationInfo from '/src/components/OperationInfo'; + +## Refresh Library + + + +This endpoint Refreshes the library. + diff --git a/content/pages/01-reference/curl/resources/library/refresh_library/_parameters.mdx b/content/pages/01-reference/curl/resources/library/refresh_library/_parameters.mdx new file mode 100644 index 0000000..dd81d6c --- /dev/null +++ b/content/pages/01-reference/curl/resources/library/refresh_library/_parameters.mdx @@ -0,0 +1,5 @@ +{/* Autogenerated DO NOT EDIT */} +##### `sectionId` _number_ +the Id of the library to refresh + + diff --git a/content/pages/01-reference/curl/resources/library/refresh_library/_response.mdx b/content/pages/01-reference/curl/resources/library/refresh_library/_response.mdx new file mode 100644 index 0000000..1b23813 --- /dev/null +++ b/content/pages/01-reference/curl/resources/library/refresh_library/_response.mdx @@ -0,0 +1,26 @@ +{/* Autogenerated DO NOT EDIT */} + +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; +import { TabbedSection, Tab } from '@/src/components/TabbedSection'; +import StatusCode from '@/src/components/StatusCode'; + + + {/* prettier-ignore */} + }> + _No response body._ + + {/* prettier-ignore */} + }> + _No response body._ + + {/* prettier-ignore */} + }> + *JSON object* + + ##### `errors` _array (optional)_ + + + + + diff --git a/content/pages/01-reference/curl/resources/library/refresh_library/_usage.mdx b/content/pages/01-reference/curl/resources/library/refresh_library/_usage.mdx new file mode 100644 index 0000000..df64a68 --- /dev/null +++ b/content/pages/01-reference/curl/resources/library/refresh_library/_usage.mdx @@ -0,0 +1,21 @@ + + +```bash Example Request +curl http://10.10.10.47:32400/library/sections/5680.45/refresh \ +--header 'Accept: application/json' \ +--header 'X-Plex-Token: YOUR_API_KEY_HERE' +``` +--- + +```json Example Response + { + "errors": [ + { + "code": 1001, + "message": "User could not be authenticated", + "status": 401 + } + ] + } +``` + diff --git a/content/pages/01-reference/curl/resources/library/refresh_library/refresh_library.mdx b/content/pages/01-reference/curl/resources/library/refresh_library/refresh_library.mdx new file mode 100644 index 0000000..4b79f78 --- /dev/null +++ b/content/pages/01-reference/curl/resources/library/refresh_library/refresh_library.mdx @@ -0,0 +1,12 @@ +import CurlHeader from './_header.mdx'; +import SDKHeader from './_header.mdx'; +import OperationHeader from '/src/components/OperationHeader'; + +###### *Library* + +} + curlHeader={} +/> + +{/* render operation */} diff --git a/content/pages/01-reference/curl/resources/log/enable_paper_trail/_authentication.mdx b/content/pages/01-reference/curl/resources/log/enable_paper_trail/_authentication.mdx new file mode 100644 index 0000000..ac82b0b --- /dev/null +++ b/content/pages/01-reference/curl/resources/log/enable_paper_trail/_authentication.mdx @@ -0,0 +1,9 @@ +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### API key _— in HTTP header_ + +Set your API key in a `X-Plex-Token` HTTP header. + +Example: `` + diff --git a/content/pages/01-reference/curl/resources/log/enable_paper_trail/_header.mdx b/content/pages/01-reference/curl/resources/log/enable_paper_trail/_header.mdx new file mode 100644 index 0000000..8a13f44 --- /dev/null +++ b/content/pages/01-reference/curl/resources/log/enable_paper_trail/_header.mdx @@ -0,0 +1,8 @@ +import OperationInfo from '/src/components/OperationInfo'; + +## Enable Paper Trail + + + +This endpoint will enable all Plex Media Serverlogs to be sent to the Papertrail networked logging site for a period of time. + diff --git a/content/pages/01-reference/curl/resources/log/enable_paper_trail/_parameters.mdx b/content/pages/01-reference/curl/resources/log/enable_paper_trail/_parameters.mdx new file mode 100644 index 0000000..929b020 --- /dev/null +++ b/content/pages/01-reference/curl/resources/log/enable_paper_trail/_parameters.mdx @@ -0,0 +1,2 @@ +{/* Autogenerated DO NOT EDIT */} + diff --git a/content/pages/01-reference/curl/resources/log/enable_paper_trail/_response.mdx b/content/pages/01-reference/curl/resources/log/enable_paper_trail/_response.mdx new file mode 100644 index 0000000..6ac4bd3 --- /dev/null +++ b/content/pages/01-reference/curl/resources/log/enable_paper_trail/_response.mdx @@ -0,0 +1,30 @@ +{/* Autogenerated DO NOT EDIT */} + +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; +import { TabbedSection, Tab } from '@/src/components/TabbedSection'; +import StatusCode from '@/src/components/StatusCode'; + + + {/* prettier-ignore */} + }> + _No response body._ + + {/* prettier-ignore */} + }> + _No response body._ + + {/* prettier-ignore */} + }> + _No response body._ + + {/* prettier-ignore */} + }> + *JSON object* + + ##### `errors` _array (optional)_ + + + + + diff --git a/content/pages/01-reference/curl/resources/log/enable_paper_trail/_usage.mdx b/content/pages/01-reference/curl/resources/log/enable_paper_trail/_usage.mdx new file mode 100644 index 0000000..703d4d1 --- /dev/null +++ b/content/pages/01-reference/curl/resources/log/enable_paper_trail/_usage.mdx @@ -0,0 +1,21 @@ + + +```bash Example Request +curl http://10.10.10.47:32400/log/networked \ +--header 'Accept: application/json' \ +--header 'X-Plex-Token: YOUR_API_KEY_HERE' +``` +--- + +```json Example Response + { + "errors": [ + { + "code": 1001, + "message": "User could not be authenticated", + "status": 401 + } + ] + } +``` + diff --git a/content/pages/01-reference/curl/resources/log/enable_paper_trail/enable_paper_trail.mdx b/content/pages/01-reference/curl/resources/log/enable_paper_trail/enable_paper_trail.mdx new file mode 100644 index 0000000..2f0fa6c --- /dev/null +++ b/content/pages/01-reference/curl/resources/log/enable_paper_trail/enable_paper_trail.mdx @@ -0,0 +1,12 @@ +import CurlHeader from './_header.mdx'; +import SDKHeader from './_header.mdx'; +import OperationHeader from '/src/components/OperationHeader'; + +###### *Log* + +} + curlHeader={} +/> + +{/* render operation */} diff --git a/content/pages/01-reference/curl/resources/log/log.mdx b/content/pages/01-reference/curl/resources/log/log.mdx new file mode 100644 index 0000000..11a1793 --- /dev/null +++ b/content/pages/01-reference/curl/resources/log/log.mdx @@ -0,0 +1,22 @@ +import LogLine from "./log_line/log_line.mdx"; +import LogMultiLine from "./log_multi_line/log_multi_line.mdx"; +import EnablePaperTrail from "./enable_paper_trail/enable_paper_trail.mdx"; + +## Log +Submit logs to the Log Handler for Plex Media Server + + +### Available Operations + +* [Log Line](/curl/log/log_line) - Logging a single line message. +* [Log Multi Line](/curl/log/log_multi_line) - Logging a multi-line message +* [Enable Paper Trail](/curl/log/enable_paper_trail) - Enabling Papertrail + +--- + + +--- + + +--- + diff --git a/content/pages/01-reference/curl/resources/log/log_line/_authentication.mdx b/content/pages/01-reference/curl/resources/log/log_line/_authentication.mdx new file mode 100644 index 0000000..ac82b0b --- /dev/null +++ b/content/pages/01-reference/curl/resources/log/log_line/_authentication.mdx @@ -0,0 +1,9 @@ +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### API key _— in HTTP header_ + +Set your API key in a `X-Plex-Token` HTTP header. + +Example: `` + diff --git a/content/pages/01-reference/curl/resources/log/log_line/_header.mdx b/content/pages/01-reference/curl/resources/log/log_line/_header.mdx new file mode 100644 index 0000000..bc091f1 --- /dev/null +++ b/content/pages/01-reference/curl/resources/log/log_line/_header.mdx @@ -0,0 +1,8 @@ +import OperationInfo from '/src/components/OperationInfo'; + +## Log Line + + + +This endpoint will write a single-line log message, including a level and source to the main Plex Media Server log. + diff --git a/content/pages/01-reference/curl/resources/log/log_line/_parameters.mdx b/content/pages/01-reference/curl/resources/log/log_line/_parameters.mdx new file mode 100644 index 0000000..e220d77 --- /dev/null +++ b/content/pages/01-reference/curl/resources/log/log_line/_parameters.mdx @@ -0,0 +1,26 @@ +{/* Autogenerated DO NOT EDIT */} +import Level from "/content/types/operations/level/curl.mdx" +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `level` _enumeration_ +An integer log level to write to the PMS log with. +0: Error +1: Warning +2: Info +3: Debug +4: Verbose + + + + + +--- +##### `message` _string_ +The text of the message to write to the log. + +--- +##### `source` _string_ +a string indicating the source of the message. + + diff --git a/content/pages/01-reference/curl/resources/log/log_line/_response.mdx b/content/pages/01-reference/curl/resources/log/log_line/_response.mdx new file mode 100644 index 0000000..1b23813 --- /dev/null +++ b/content/pages/01-reference/curl/resources/log/log_line/_response.mdx @@ -0,0 +1,26 @@ +{/* Autogenerated DO NOT EDIT */} + +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; +import { TabbedSection, Tab } from '@/src/components/TabbedSection'; +import StatusCode from '@/src/components/StatusCode'; + + + {/* prettier-ignore */} + }> + _No response body._ + + {/* prettier-ignore */} + }> + _No response body._ + + {/* prettier-ignore */} + }> + *JSON object* + + ##### `errors` _array (optional)_ + + + + + diff --git a/content/pages/01-reference/curl/resources/log/log_line/_usage.mdx b/content/pages/01-reference/curl/resources/log/log_line/_usage.mdx new file mode 100644 index 0000000..188f4d6 --- /dev/null +++ b/content/pages/01-reference/curl/resources/log/log_line/_usage.mdx @@ -0,0 +1,21 @@ + + +```bash Example Request +curl http://10.10.10.47:32400/log?message=string&source=string \ +--header 'Accept: application/json' \ +--header 'X-Plex-Token: YOUR_API_KEY_HERE' +``` +--- + +```json Example Response + { + "errors": [ + { + "code": 1001, + "message": "User could not be authenticated", + "status": 401 + } + ] + } +``` + diff --git a/content/pages/01-reference/curl/resources/log/log_line/log_line.mdx b/content/pages/01-reference/curl/resources/log/log_line/log_line.mdx new file mode 100644 index 0000000..2f0fa6c --- /dev/null +++ b/content/pages/01-reference/curl/resources/log/log_line/log_line.mdx @@ -0,0 +1,12 @@ +import CurlHeader from './_header.mdx'; +import SDKHeader from './_header.mdx'; +import OperationHeader from '/src/components/OperationHeader'; + +###### *Log* + +} + curlHeader={} +/> + +{/* render operation */} diff --git a/content/pages/01-reference/curl/resources/log/log_multi_line/_authentication.mdx b/content/pages/01-reference/curl/resources/log/log_multi_line/_authentication.mdx new file mode 100644 index 0000000..ac82b0b --- /dev/null +++ b/content/pages/01-reference/curl/resources/log/log_multi_line/_authentication.mdx @@ -0,0 +1,9 @@ +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### API key _— in HTTP header_ + +Set your API key in a `X-Plex-Token` HTTP header. + +Example: `` + diff --git a/content/pages/01-reference/curl/resources/log/log_multi_line/_header.mdx b/content/pages/01-reference/curl/resources/log/log_multi_line/_header.mdx new file mode 100644 index 0000000..3a5596d --- /dev/null +++ b/content/pages/01-reference/curl/resources/log/log_multi_line/_header.mdx @@ -0,0 +1,8 @@ +import OperationInfo from '/src/components/OperationInfo'; + +## Log Multi Line + + + +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. + diff --git a/content/pages/01-reference/curl/resources/log/log_multi_line/_parameters.mdx b/content/pages/01-reference/curl/resources/log/log_multi_line/_parameters.mdx new file mode 100644 index 0000000..929b020 --- /dev/null +++ b/content/pages/01-reference/curl/resources/log/log_multi_line/_parameters.mdx @@ -0,0 +1,2 @@ +{/* Autogenerated DO NOT EDIT */} + diff --git a/content/pages/01-reference/curl/resources/log/log_multi_line/_response.mdx b/content/pages/01-reference/curl/resources/log/log_multi_line/_response.mdx new file mode 100644 index 0000000..1b23813 --- /dev/null +++ b/content/pages/01-reference/curl/resources/log/log_multi_line/_response.mdx @@ -0,0 +1,26 @@ +{/* Autogenerated DO NOT EDIT */} + +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; +import { TabbedSection, Tab } from '@/src/components/TabbedSection'; +import StatusCode from '@/src/components/StatusCode'; + + + {/* prettier-ignore */} + }> + _No response body._ + + {/* prettier-ignore */} + }> + _No response body._ + + {/* prettier-ignore */} + }> + *JSON object* + + ##### `errors` _array (optional)_ + + + + + diff --git a/content/pages/01-reference/curl/resources/log/log_multi_line/_usage.mdx b/content/pages/01-reference/curl/resources/log/log_multi_line/_usage.mdx new file mode 100644 index 0000000..b3c61ad --- /dev/null +++ b/content/pages/01-reference/curl/resources/log/log_multi_line/_usage.mdx @@ -0,0 +1,21 @@ + + +```bash Example Request +curl http://10.10.10.47:32400/log \ +--header 'Accept: application/json' \ +--header 'X-Plex-Token: YOUR_API_KEY_HERE' +``` +--- + +```json Example Response + { + "errors": [ + { + "code": 1001, + "message": "User could not be authenticated", + "status": 401 + } + ] + } +``` + diff --git a/content/pages/01-reference/curl/resources/log/log_multi_line/log_multi_line.mdx b/content/pages/01-reference/curl/resources/log/log_multi_line/log_multi_line.mdx new file mode 100644 index 0000000..2f0fa6c --- /dev/null +++ b/content/pages/01-reference/curl/resources/log/log_multi_line/log_multi_line.mdx @@ -0,0 +1,12 @@ +import CurlHeader from './_header.mdx'; +import SDKHeader from './_header.mdx'; +import OperationHeader from '/src/components/OperationHeader'; + +###### *Log* + +} + curlHeader={} +/> + +{/* render operation */} diff --git a/content/pages/01-reference/curl/resources/media/mark_played/_authentication.mdx b/content/pages/01-reference/curl/resources/media/mark_played/_authentication.mdx new file mode 100644 index 0000000..ac82b0b --- /dev/null +++ b/content/pages/01-reference/curl/resources/media/mark_played/_authentication.mdx @@ -0,0 +1,9 @@ +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### API key _— in HTTP header_ + +Set your API key in a `X-Plex-Token` HTTP header. + +Example: `` + diff --git a/content/pages/01-reference/curl/resources/media/mark_played/_header.mdx b/content/pages/01-reference/curl/resources/media/mark_played/_header.mdx new file mode 100644 index 0000000..7c37f18 --- /dev/null +++ b/content/pages/01-reference/curl/resources/media/mark_played/_header.mdx @@ -0,0 +1,7 @@ +import OperationInfo from '/src/components/OperationInfo'; + +## Mark Played + + + +This will mark the provided media key as Played. diff --git a/content/pages/01-reference/curl/resources/media/mark_played/_parameters.mdx b/content/pages/01-reference/curl/resources/media/mark_played/_parameters.mdx new file mode 100644 index 0000000..d45107d --- /dev/null +++ b/content/pages/01-reference/curl/resources/media/mark_played/_parameters.mdx @@ -0,0 +1,7 @@ +{/* Autogenerated DO NOT EDIT */} +##### `key` _number_ +The media key to mark as played +
+**Example:** `59398` + + diff --git a/content/pages/01-reference/curl/resources/media/mark_played/_response.mdx b/content/pages/01-reference/curl/resources/media/mark_played/_response.mdx new file mode 100644 index 0000000..1b23813 --- /dev/null +++ b/content/pages/01-reference/curl/resources/media/mark_played/_response.mdx @@ -0,0 +1,26 @@ +{/* Autogenerated DO NOT EDIT */} + +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; +import { TabbedSection, Tab } from '@/src/components/TabbedSection'; +import StatusCode from '@/src/components/StatusCode'; + + + {/* prettier-ignore */} + }> + _No response body._ + + {/* prettier-ignore */} + }> + _No response body._ + + {/* prettier-ignore */} + }> + *JSON object* + + ##### `errors` _array (optional)_ + + + + + diff --git a/content/pages/01-reference/curl/resources/media/mark_played/_usage.mdx b/content/pages/01-reference/curl/resources/media/mark_played/_usage.mdx new file mode 100644 index 0000000..90be652 --- /dev/null +++ b/content/pages/01-reference/curl/resources/media/mark_played/_usage.mdx @@ -0,0 +1,21 @@ + + +```bash Example Request +curl http://10.10.10.47:32400/:/scrobble?key=59398 \ +--header 'Accept: application/json' \ +--header 'X-Plex-Token: YOUR_API_KEY_HERE' +``` +--- + +```json Example Response + { + "errors": [ + { + "code": 1001, + "message": "User could not be authenticated", + "status": 401 + } + ] + } +``` + diff --git a/content/pages/01-reference/curl/resources/media/mark_played/mark_played.mdx b/content/pages/01-reference/curl/resources/media/mark_played/mark_played.mdx new file mode 100644 index 0000000..ef31aa0 --- /dev/null +++ b/content/pages/01-reference/curl/resources/media/mark_played/mark_played.mdx @@ -0,0 +1,12 @@ +import CurlHeader from './_header.mdx'; +import SDKHeader from './_header.mdx'; +import OperationHeader from '/src/components/OperationHeader'; + +###### *Media* + +} + curlHeader={} +/> + +{/* render operation */} diff --git a/content/pages/01-reference/curl/resources/media/mark_unplayed/_authentication.mdx b/content/pages/01-reference/curl/resources/media/mark_unplayed/_authentication.mdx new file mode 100644 index 0000000..ac82b0b --- /dev/null +++ b/content/pages/01-reference/curl/resources/media/mark_unplayed/_authentication.mdx @@ -0,0 +1,9 @@ +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### API key _— in HTTP header_ + +Set your API key in a `X-Plex-Token` HTTP header. + +Example: `` + diff --git a/content/pages/01-reference/curl/resources/media/mark_unplayed/_header.mdx b/content/pages/01-reference/curl/resources/media/mark_unplayed/_header.mdx new file mode 100644 index 0000000..9f18776 --- /dev/null +++ b/content/pages/01-reference/curl/resources/media/mark_unplayed/_header.mdx @@ -0,0 +1,7 @@ +import OperationInfo from '/src/components/OperationInfo'; + +## Mark Unplayed + + + +This will mark the provided media key as Unplayed. diff --git a/content/pages/01-reference/curl/resources/media/mark_unplayed/_parameters.mdx b/content/pages/01-reference/curl/resources/media/mark_unplayed/_parameters.mdx new file mode 100644 index 0000000..5ea2d9c --- /dev/null +++ b/content/pages/01-reference/curl/resources/media/mark_unplayed/_parameters.mdx @@ -0,0 +1,7 @@ +{/* Autogenerated DO NOT EDIT */} +##### `key` _number_ +The media key to mark as Unplayed +
+**Example:** `59398` + + diff --git a/content/pages/01-reference/curl/resources/media/mark_unplayed/_response.mdx b/content/pages/01-reference/curl/resources/media/mark_unplayed/_response.mdx new file mode 100644 index 0000000..1b23813 --- /dev/null +++ b/content/pages/01-reference/curl/resources/media/mark_unplayed/_response.mdx @@ -0,0 +1,26 @@ +{/* Autogenerated DO NOT EDIT */} + +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; +import { TabbedSection, Tab } from '@/src/components/TabbedSection'; +import StatusCode from '@/src/components/StatusCode'; + + + {/* prettier-ignore */} + }> + _No response body._ + + {/* prettier-ignore */} + }> + _No response body._ + + {/* prettier-ignore */} + }> + *JSON object* + + ##### `errors` _array (optional)_ + + + + + diff --git a/content/pages/01-reference/curl/resources/media/mark_unplayed/_usage.mdx b/content/pages/01-reference/curl/resources/media/mark_unplayed/_usage.mdx new file mode 100644 index 0000000..75a8007 --- /dev/null +++ b/content/pages/01-reference/curl/resources/media/mark_unplayed/_usage.mdx @@ -0,0 +1,21 @@ + + +```bash Example Request +curl http://10.10.10.47:32400/:/unscrobble?key=59398 \ +--header 'Accept: application/json' \ +--header 'X-Plex-Token: YOUR_API_KEY_HERE' +``` +--- + +```json Example Response + { + "errors": [ + { + "code": 1001, + "message": "User could not be authenticated", + "status": 401 + } + ] + } +``` + diff --git a/content/pages/01-reference/curl/resources/media/mark_unplayed/mark_unplayed.mdx b/content/pages/01-reference/curl/resources/media/mark_unplayed/mark_unplayed.mdx new file mode 100644 index 0000000..ef31aa0 --- /dev/null +++ b/content/pages/01-reference/curl/resources/media/mark_unplayed/mark_unplayed.mdx @@ -0,0 +1,12 @@ +import CurlHeader from './_header.mdx'; +import SDKHeader from './_header.mdx'; +import OperationHeader from '/src/components/OperationHeader'; + +###### *Media* + +} + curlHeader={} +/> + +{/* render operation */} diff --git a/content/pages/01-reference/curl/resources/media/media.mdx b/content/pages/01-reference/curl/resources/media/media.mdx new file mode 100644 index 0000000..8be99de --- /dev/null +++ b/content/pages/01-reference/curl/resources/media/media.mdx @@ -0,0 +1,22 @@ +import MarkPlayed from "./mark_played/mark_played.mdx"; +import MarkUnplayed from "./mark_unplayed/mark_unplayed.mdx"; +import UpdatePlayProgress from "./update_play_progress/update_play_progress.mdx"; + +## Media +API Calls interacting with Plex Media Server Media + + +### Available Operations + +* [Mark Played](/curl/media/mark_played) - Mark Media Played +* [Mark Unplayed](/curl/media/mark_unplayed) - Mark Media Unplayed +* [Update Play Progress](/curl/media/update_play_progress) - Update Media Play Progress + +--- + + +--- + + +--- + diff --git a/content/pages/01-reference/curl/resources/media/update_play_progress/_authentication.mdx b/content/pages/01-reference/curl/resources/media/update_play_progress/_authentication.mdx new file mode 100644 index 0000000..ac82b0b --- /dev/null +++ b/content/pages/01-reference/curl/resources/media/update_play_progress/_authentication.mdx @@ -0,0 +1,9 @@ +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### API key _— in HTTP header_ + +Set your API key in a `X-Plex-Token` HTTP header. + +Example: `` + diff --git a/content/pages/01-reference/curl/resources/media/update_play_progress/_header.mdx b/content/pages/01-reference/curl/resources/media/update_play_progress/_header.mdx new file mode 100644 index 0000000..0a315bb --- /dev/null +++ b/content/pages/01-reference/curl/resources/media/update_play_progress/_header.mdx @@ -0,0 +1,8 @@ +import OperationInfo from '/src/components/OperationInfo'; + +## Update Play Progress + + + +This API command can be used to update the play progress of a media item. + diff --git a/content/pages/01-reference/curl/resources/media/update_play_progress/_parameters.mdx b/content/pages/01-reference/curl/resources/media/update_play_progress/_parameters.mdx new file mode 100644 index 0000000..ccfcbf9 --- /dev/null +++ b/content/pages/01-reference/curl/resources/media/update_play_progress/_parameters.mdx @@ -0,0 +1,13 @@ +{/* Autogenerated DO NOT EDIT */} +##### `key` _string_ +the media key + +--- +##### `time` _number_ +The time, in milliseconds, used to set the media playback progress. + +--- +##### `state` _string_ +The playback state of the media item. + + diff --git a/content/pages/01-reference/curl/resources/media/update_play_progress/_response.mdx b/content/pages/01-reference/curl/resources/media/update_play_progress/_response.mdx new file mode 100644 index 0000000..1b23813 --- /dev/null +++ b/content/pages/01-reference/curl/resources/media/update_play_progress/_response.mdx @@ -0,0 +1,26 @@ +{/* Autogenerated DO NOT EDIT */} + +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; +import { TabbedSection, Tab } from '@/src/components/TabbedSection'; +import StatusCode from '@/src/components/StatusCode'; + + + {/* prettier-ignore */} + }> + _No response body._ + + {/* prettier-ignore */} + }> + _No response body._ + + {/* prettier-ignore */} + }> + *JSON object* + + ##### `errors` _array (optional)_ + + + + + diff --git a/content/pages/01-reference/curl/resources/media/update_play_progress/_usage.mdx b/content/pages/01-reference/curl/resources/media/update_play_progress/_usage.mdx new file mode 100644 index 0000000..3720c68 --- /dev/null +++ b/content/pages/01-reference/curl/resources/media/update_play_progress/_usage.mdx @@ -0,0 +1,21 @@ + + +```bash Example Request +curl http://10.10.10.47:32400/:/progress?key=string&state=string&time=3843.82 \ +--header 'Accept: application/json' \ +--header 'X-Plex-Token: YOUR_API_KEY_HERE' +``` +--- + +```json Example Response + { + "errors": [ + { + "code": 1001, + "message": "User could not be authenticated", + "status": 401 + } + ] + } +``` + diff --git a/content/pages/01-reference/curl/resources/media/update_play_progress/update_play_progress.mdx b/content/pages/01-reference/curl/resources/media/update_play_progress/update_play_progress.mdx new file mode 100644 index 0000000..ef31aa0 --- /dev/null +++ b/content/pages/01-reference/curl/resources/media/update_play_progress/update_play_progress.mdx @@ -0,0 +1,12 @@ +import CurlHeader from './_header.mdx'; +import SDKHeader from './_header.mdx'; +import OperationHeader from '/src/components/OperationHeader'; + +###### *Media* + +} + curlHeader={} +/> + +{/* render operation */} diff --git a/content/pages/01-reference/curl/resources/playlists/add_playlist_contents/_authentication.mdx b/content/pages/01-reference/curl/resources/playlists/add_playlist_contents/_authentication.mdx new file mode 100644 index 0000000..ac82b0b --- /dev/null +++ b/content/pages/01-reference/curl/resources/playlists/add_playlist_contents/_authentication.mdx @@ -0,0 +1,9 @@ +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### API key _— in HTTP header_ + +Set your API key in a `X-Plex-Token` HTTP header. + +Example: `` + diff --git a/content/pages/01-reference/curl/resources/playlists/add_playlist_contents/_header.mdx b/content/pages/01-reference/curl/resources/playlists/add_playlist_contents/_header.mdx new file mode 100644 index 0000000..1f25b87 --- /dev/null +++ b/content/pages/01-reference/curl/resources/playlists/add_playlist_contents/_header.mdx @@ -0,0 +1,9 @@ +import OperationInfo from '/src/components/OperationInfo'; + +## Add Playlist Contents + + + +Adds a generator to a playlist, same parameters as the POST above. With a dumb playlist, this adds the specified items to the playlist. +With a smart playlist, passing a new `uri` parameter replaces the rules for the playlist. Returns the playlist. + diff --git a/content/pages/01-reference/curl/resources/playlists/add_playlist_contents/_parameters.mdx b/content/pages/01-reference/curl/resources/playlists/add_playlist_contents/_parameters.mdx new file mode 100644 index 0000000..5d3e953 --- /dev/null +++ b/content/pages/01-reference/curl/resources/playlists/add_playlist_contents/_parameters.mdx @@ -0,0 +1,17 @@ +{/* Autogenerated DO NOT EDIT */} +##### `playlistID` _number_ +the ID of the playlist + +--- +##### `uri` _string_ +the content URI for the playlist +
+**Example:** `library://..` + +--- +##### `playQueueID` _number_ +the play queue to add to a playlist +
+**Example:** `123` + + diff --git a/content/pages/01-reference/curl/resources/playlists/add_playlist_contents/_response.mdx b/content/pages/01-reference/curl/resources/playlists/add_playlist_contents/_response.mdx new file mode 100644 index 0000000..1b23813 --- /dev/null +++ b/content/pages/01-reference/curl/resources/playlists/add_playlist_contents/_response.mdx @@ -0,0 +1,26 @@ +{/* Autogenerated DO NOT EDIT */} + +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; +import { TabbedSection, Tab } from '@/src/components/TabbedSection'; +import StatusCode from '@/src/components/StatusCode'; + + + {/* prettier-ignore */} + }> + _No response body._ + + {/* prettier-ignore */} + }> + _No response body._ + + {/* prettier-ignore */} + }> + *JSON object* + + ##### `errors` _array (optional)_ + + + + + diff --git a/content/pages/01-reference/curl/resources/playlists/add_playlist_contents/_usage.mdx b/content/pages/01-reference/curl/resources/playlists/add_playlist_contents/_usage.mdx new file mode 100644 index 0000000..46ef29a --- /dev/null +++ b/content/pages/01-reference/curl/resources/playlists/add_playlist_contents/_usage.mdx @@ -0,0 +1,21 @@ + + +```bash Example Request +curl http://10.10.10.47:32400/playlists/8700.13/items?playQueueID=123&uri=library%3A%2F%2F.. \ +--header 'Accept: application/json' \ +--header 'X-Plex-Token: YOUR_API_KEY_HERE' +``` +--- + +```json Example Response + { + "errors": [ + { + "code": 1001, + "message": "User could not be authenticated", + "status": 401 + } + ] + } +``` + diff --git a/content/pages/01-reference/curl/resources/playlists/add_playlist_contents/add_playlist_contents.mdx b/content/pages/01-reference/curl/resources/playlists/add_playlist_contents/add_playlist_contents.mdx new file mode 100644 index 0000000..885d93d --- /dev/null +++ b/content/pages/01-reference/curl/resources/playlists/add_playlist_contents/add_playlist_contents.mdx @@ -0,0 +1,12 @@ +import CurlHeader from './_header.mdx'; +import SDKHeader from './_header.mdx'; +import OperationHeader from '/src/components/OperationHeader'; + +###### *Playlists* + +} + curlHeader={} +/> + +{/* render operation */} diff --git a/content/pages/01-reference/curl/resources/playlists/clear_playlist_contents/_authentication.mdx b/content/pages/01-reference/curl/resources/playlists/clear_playlist_contents/_authentication.mdx new file mode 100644 index 0000000..ac82b0b --- /dev/null +++ b/content/pages/01-reference/curl/resources/playlists/clear_playlist_contents/_authentication.mdx @@ -0,0 +1,9 @@ +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### API key _— in HTTP header_ + +Set your API key in a `X-Plex-Token` HTTP header. + +Example: `` + diff --git a/content/pages/01-reference/curl/resources/playlists/clear_playlist_contents/_header.mdx b/content/pages/01-reference/curl/resources/playlists/clear_playlist_contents/_header.mdx new file mode 100644 index 0000000..455a008 --- /dev/null +++ b/content/pages/01-reference/curl/resources/playlists/clear_playlist_contents/_header.mdx @@ -0,0 +1,8 @@ +import OperationInfo from '/src/components/OperationInfo'; + +## Clear Playlist Contents + + + +Clears a playlist, only works with dumb playlists. Returns the playlist. + diff --git a/content/pages/01-reference/curl/resources/playlists/clear_playlist_contents/_parameters.mdx b/content/pages/01-reference/curl/resources/playlists/clear_playlist_contents/_parameters.mdx new file mode 100644 index 0000000..6e2026a --- /dev/null +++ b/content/pages/01-reference/curl/resources/playlists/clear_playlist_contents/_parameters.mdx @@ -0,0 +1,5 @@ +{/* Autogenerated DO NOT EDIT */} +##### `playlistID` _number_ +the ID of the playlist + + diff --git a/content/pages/01-reference/curl/resources/playlists/clear_playlist_contents/_response.mdx b/content/pages/01-reference/curl/resources/playlists/clear_playlist_contents/_response.mdx new file mode 100644 index 0000000..1b23813 --- /dev/null +++ b/content/pages/01-reference/curl/resources/playlists/clear_playlist_contents/_response.mdx @@ -0,0 +1,26 @@ +{/* Autogenerated DO NOT EDIT */} + +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; +import { TabbedSection, Tab } from '@/src/components/TabbedSection'; +import StatusCode from '@/src/components/StatusCode'; + + + {/* prettier-ignore */} + }> + _No response body._ + + {/* prettier-ignore */} + }> + _No response body._ + + {/* prettier-ignore */} + }> + *JSON object* + + ##### `errors` _array (optional)_ + + + + + diff --git a/content/pages/01-reference/curl/resources/playlists/clear_playlist_contents/_usage.mdx b/content/pages/01-reference/curl/resources/playlists/clear_playlist_contents/_usage.mdx new file mode 100644 index 0000000..734c63b --- /dev/null +++ b/content/pages/01-reference/curl/resources/playlists/clear_playlist_contents/_usage.mdx @@ -0,0 +1,21 @@ + + +```bash Example Request +curl http://10.10.10.47:32400/playlists/1403.5/items \ +--header 'Accept: application/json' \ +--header 'X-Plex-Token: YOUR_API_KEY_HERE' +``` +--- + +```json Example Response + { + "errors": [ + { + "code": 1001, + "message": "User could not be authenticated", + "status": 401 + } + ] + } +``` + diff --git a/content/pages/01-reference/curl/resources/playlists/clear_playlist_contents/clear_playlist_contents.mdx b/content/pages/01-reference/curl/resources/playlists/clear_playlist_contents/clear_playlist_contents.mdx new file mode 100644 index 0000000..885d93d --- /dev/null +++ b/content/pages/01-reference/curl/resources/playlists/clear_playlist_contents/clear_playlist_contents.mdx @@ -0,0 +1,12 @@ +import CurlHeader from './_header.mdx'; +import SDKHeader from './_header.mdx'; +import OperationHeader from '/src/components/OperationHeader'; + +###### *Playlists* + +} + curlHeader={} +/> + +{/* render operation */} diff --git a/content/pages/01-reference/curl/resources/playlists/create_playlist/_authentication.mdx b/content/pages/01-reference/curl/resources/playlists/create_playlist/_authentication.mdx new file mode 100644 index 0000000..ac82b0b --- /dev/null +++ b/content/pages/01-reference/curl/resources/playlists/create_playlist/_authentication.mdx @@ -0,0 +1,9 @@ +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### API key _— in HTTP header_ + +Set your API key in a `X-Plex-Token` HTTP header. + +Example: `` + diff --git a/content/pages/01-reference/curl/resources/playlists/create_playlist/_header.mdx b/content/pages/01-reference/curl/resources/playlists/create_playlist/_header.mdx new file mode 100644 index 0000000..041613e --- /dev/null +++ b/content/pages/01-reference/curl/resources/playlists/create_playlist/_header.mdx @@ -0,0 +1,10 @@ +import OperationInfo from '/src/components/OperationInfo'; + +## Create Playlist + + + +Create a new playlist. By default the playlist is blank. To create a playlist along with a first item, pass: +- `uri` - The content URI for what we're playing (e.g. `library://...`). +- `playQueueID` - To create a playlist from an existing play queue. + diff --git a/content/pages/01-reference/curl/resources/playlists/create_playlist/_parameters.mdx b/content/pages/01-reference/curl/resources/playlists/create_playlist/_parameters.mdx new file mode 100644 index 0000000..cdcf83d --- /dev/null +++ b/content/pages/01-reference/curl/resources/playlists/create_playlist/_parameters.mdx @@ -0,0 +1,32 @@ +{/* Autogenerated DO NOT EDIT */} +import Type from "/content/types/operations/type/curl.mdx" +import Smart from "/content/types/operations/smart/curl.mdx" +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `title` _string_ +name of the playlist + +--- +##### `type` _enumeration_ +type of playlist to create + + + + +--- +##### `smart` _enumeration_ +whether the playlist is smart or not + + + + +--- +##### `uri` _string (optional)_ +the content URI for the playlist + +--- +##### `playQueueID` _number (optional)_ +the play queue to copy to a playlist + + diff --git a/content/pages/01-reference/curl/resources/playlists/create_playlist/_response.mdx b/content/pages/01-reference/curl/resources/playlists/create_playlist/_response.mdx new file mode 100644 index 0000000..1b23813 --- /dev/null +++ b/content/pages/01-reference/curl/resources/playlists/create_playlist/_response.mdx @@ -0,0 +1,26 @@ +{/* Autogenerated DO NOT EDIT */} + +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; +import { TabbedSection, Tab } from '@/src/components/TabbedSection'; +import StatusCode from '@/src/components/StatusCode'; + + + {/* prettier-ignore */} + }> + _No response body._ + + {/* prettier-ignore */} + }> + _No response body._ + + {/* prettier-ignore */} + }> + *JSON object* + + ##### `errors` _array (optional)_ + + + + + diff --git a/content/pages/01-reference/curl/resources/playlists/create_playlist/_usage.mdx b/content/pages/01-reference/curl/resources/playlists/create_playlist/_usage.mdx new file mode 100644 index 0000000..01b3a54 --- /dev/null +++ b/content/pages/01-reference/curl/resources/playlists/create_playlist/_usage.mdx @@ -0,0 +1,21 @@ + + +```bash Example Request +curl http://10.10.10.47:32400/playlists?playQueueID=6481.72&title=string&uri=string \ +--header 'Accept: application/json' \ +--header 'X-Plex-Token: YOUR_API_KEY_HERE' +``` +--- + +```json Example Response + { + "errors": [ + { + "code": 1001, + "message": "User could not be authenticated", + "status": 401 + } + ] + } +``` + diff --git a/content/pages/01-reference/curl/resources/playlists/create_playlist/create_playlist.mdx b/content/pages/01-reference/curl/resources/playlists/create_playlist/create_playlist.mdx new file mode 100644 index 0000000..885d93d --- /dev/null +++ b/content/pages/01-reference/curl/resources/playlists/create_playlist/create_playlist.mdx @@ -0,0 +1,12 @@ +import CurlHeader from './_header.mdx'; +import SDKHeader from './_header.mdx'; +import OperationHeader from '/src/components/OperationHeader'; + +###### *Playlists* + +} + curlHeader={} +/> + +{/* render operation */} diff --git a/content/pages/01-reference/curl/resources/playlists/delete_playlist/_authentication.mdx b/content/pages/01-reference/curl/resources/playlists/delete_playlist/_authentication.mdx new file mode 100644 index 0000000..ac82b0b --- /dev/null +++ b/content/pages/01-reference/curl/resources/playlists/delete_playlist/_authentication.mdx @@ -0,0 +1,9 @@ +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### API key _— in HTTP header_ + +Set your API key in a `X-Plex-Token` HTTP header. + +Example: `` + diff --git a/content/pages/01-reference/curl/resources/playlists/delete_playlist/_header.mdx b/content/pages/01-reference/curl/resources/playlists/delete_playlist/_header.mdx new file mode 100644 index 0000000..ebc2fe5 --- /dev/null +++ b/content/pages/01-reference/curl/resources/playlists/delete_playlist/_header.mdx @@ -0,0 +1,8 @@ +import OperationInfo from '/src/components/OperationInfo'; + +## Delete Playlist + + + +This endpoint will delete a playlist + diff --git a/content/pages/01-reference/curl/resources/playlists/delete_playlist/_parameters.mdx b/content/pages/01-reference/curl/resources/playlists/delete_playlist/_parameters.mdx new file mode 100644 index 0000000..6e2026a --- /dev/null +++ b/content/pages/01-reference/curl/resources/playlists/delete_playlist/_parameters.mdx @@ -0,0 +1,5 @@ +{/* Autogenerated DO NOT EDIT */} +##### `playlistID` _number_ +the ID of the playlist + + diff --git a/content/pages/01-reference/curl/resources/playlists/delete_playlist/_response.mdx b/content/pages/01-reference/curl/resources/playlists/delete_playlist/_response.mdx new file mode 100644 index 0000000..1b23813 --- /dev/null +++ b/content/pages/01-reference/curl/resources/playlists/delete_playlist/_response.mdx @@ -0,0 +1,26 @@ +{/* Autogenerated DO NOT EDIT */} + +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; +import { TabbedSection, Tab } from '@/src/components/TabbedSection'; +import StatusCode from '@/src/components/StatusCode'; + + + {/* prettier-ignore */} + }> + _No response body._ + + {/* prettier-ignore */} + }> + _No response body._ + + {/* prettier-ignore */} + }> + *JSON object* + + ##### `errors` _array (optional)_ + + + + + diff --git a/content/pages/01-reference/curl/resources/playlists/delete_playlist/_usage.mdx b/content/pages/01-reference/curl/resources/playlists/delete_playlist/_usage.mdx new file mode 100644 index 0000000..8678211 --- /dev/null +++ b/content/pages/01-reference/curl/resources/playlists/delete_playlist/_usage.mdx @@ -0,0 +1,21 @@ + + +```bash Example Request +curl http://10.10.10.47:32400/playlists/3682.41 \ +--header 'Accept: application/json' \ +--header 'X-Plex-Token: YOUR_API_KEY_HERE' +``` +--- + +```json Example Response + { + "errors": [ + { + "code": 1001, + "message": "User could not be authenticated", + "status": 401 + } + ] + } +``` + diff --git a/content/pages/01-reference/curl/resources/playlists/delete_playlist/delete_playlist.mdx b/content/pages/01-reference/curl/resources/playlists/delete_playlist/delete_playlist.mdx new file mode 100644 index 0000000..885d93d --- /dev/null +++ b/content/pages/01-reference/curl/resources/playlists/delete_playlist/delete_playlist.mdx @@ -0,0 +1,12 @@ +import CurlHeader from './_header.mdx'; +import SDKHeader from './_header.mdx'; +import OperationHeader from '/src/components/OperationHeader'; + +###### *Playlists* + +} + curlHeader={} +/> + +{/* render operation */} diff --git a/content/pages/01-reference/curl/resources/playlists/get_playlist/_authentication.mdx b/content/pages/01-reference/curl/resources/playlists/get_playlist/_authentication.mdx new file mode 100644 index 0000000..ac82b0b --- /dev/null +++ b/content/pages/01-reference/curl/resources/playlists/get_playlist/_authentication.mdx @@ -0,0 +1,9 @@ +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### API key _— in HTTP header_ + +Set your API key in a `X-Plex-Token` HTTP header. + +Example: `` + diff --git a/content/pages/01-reference/curl/resources/playlists/get_playlist/_header.mdx b/content/pages/01-reference/curl/resources/playlists/get_playlist/_header.mdx new file mode 100644 index 0000000..685afbe --- /dev/null +++ b/content/pages/01-reference/curl/resources/playlists/get_playlist/_header.mdx @@ -0,0 +1,9 @@ +import OperationInfo from '/src/components/OperationInfo'; + +## Get Playlist + + + +Gets detailed metadata for a playlist. A playlist for many purposes (rating, editing metadata, tagging), can be treated like a regular metadata item: +Smart playlist details contain the `content` attribute. This is the content URI for the generator. This can then be parsed by a client to provide smart playlist editing. + diff --git a/content/pages/01-reference/curl/resources/playlists/get_playlist/_parameters.mdx b/content/pages/01-reference/curl/resources/playlists/get_playlist/_parameters.mdx new file mode 100644 index 0000000..6e2026a --- /dev/null +++ b/content/pages/01-reference/curl/resources/playlists/get_playlist/_parameters.mdx @@ -0,0 +1,5 @@ +{/* Autogenerated DO NOT EDIT */} +##### `playlistID` _number_ +the ID of the playlist + + diff --git a/content/pages/01-reference/curl/resources/playlists/get_playlist/_response.mdx b/content/pages/01-reference/curl/resources/playlists/get_playlist/_response.mdx new file mode 100644 index 0000000..1b23813 --- /dev/null +++ b/content/pages/01-reference/curl/resources/playlists/get_playlist/_response.mdx @@ -0,0 +1,26 @@ +{/* Autogenerated DO NOT EDIT */} + +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; +import { TabbedSection, Tab } from '@/src/components/TabbedSection'; +import StatusCode from '@/src/components/StatusCode'; + + + {/* prettier-ignore */} + }> + _No response body._ + + {/* prettier-ignore */} + }> + _No response body._ + + {/* prettier-ignore */} + }> + *JSON object* + + ##### `errors` _array (optional)_ + + + + + diff --git a/content/pages/01-reference/curl/resources/playlists/get_playlist/_usage.mdx b/content/pages/01-reference/curl/resources/playlists/get_playlist/_usage.mdx new file mode 100644 index 0000000..e4f1206 --- /dev/null +++ b/content/pages/01-reference/curl/resources/playlists/get_playlist/_usage.mdx @@ -0,0 +1,21 @@ + + +```bash Example Request +curl http://10.10.10.47:32400/playlists/202.18 \ +--header 'Accept: application/json' \ +--header 'X-Plex-Token: YOUR_API_KEY_HERE' +``` +--- + +```json Example Response + { + "errors": [ + { + "code": 1001, + "message": "User could not be authenticated", + "status": 401 + } + ] + } +``` + diff --git a/content/pages/01-reference/curl/resources/playlists/get_playlist/get_playlist.mdx b/content/pages/01-reference/curl/resources/playlists/get_playlist/get_playlist.mdx new file mode 100644 index 0000000..885d93d --- /dev/null +++ b/content/pages/01-reference/curl/resources/playlists/get_playlist/get_playlist.mdx @@ -0,0 +1,12 @@ +import CurlHeader from './_header.mdx'; +import SDKHeader from './_header.mdx'; +import OperationHeader from '/src/components/OperationHeader'; + +###### *Playlists* + +} + curlHeader={} +/> + +{/* render operation */} diff --git a/content/pages/01-reference/curl/resources/playlists/get_playlist_contents/_authentication.mdx b/content/pages/01-reference/curl/resources/playlists/get_playlist_contents/_authentication.mdx new file mode 100644 index 0000000..ac82b0b --- /dev/null +++ b/content/pages/01-reference/curl/resources/playlists/get_playlist_contents/_authentication.mdx @@ -0,0 +1,9 @@ +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### API key _— in HTTP header_ + +Set your API key in a `X-Plex-Token` HTTP header. + +Example: `` + diff --git a/content/pages/01-reference/curl/resources/playlists/get_playlist_contents/_header.mdx b/content/pages/01-reference/curl/resources/playlists/get_playlist_contents/_header.mdx new file mode 100644 index 0000000..afc7c27 --- /dev/null +++ b/content/pages/01-reference/curl/resources/playlists/get_playlist_contents/_header.mdx @@ -0,0 +1,11 @@ +import OperationInfo from '/src/components/OperationInfo'; + +## Get Playlist Contents + + + +Gets the contents of a playlist. Should be paged by clients via standard mechanisms. +By default leaves are returned (e.g. episodes, movies). In order to return other types you can use the `type` parameter. +For example, you could use this to display a list of recently added albums vis a smart playlist. +Note that for dumb playlists, items have a `playlistItemID` attribute which is used for deleting or moving items. + diff --git a/content/pages/01-reference/curl/resources/playlists/get_playlist_contents/_parameters.mdx b/content/pages/01-reference/curl/resources/playlists/get_playlist_contents/_parameters.mdx new file mode 100644 index 0000000..7887c5d --- /dev/null +++ b/content/pages/01-reference/curl/resources/playlists/get_playlist_contents/_parameters.mdx @@ -0,0 +1,9 @@ +{/* Autogenerated DO NOT EDIT */} +##### `playlistID` _number_ +the ID of the playlist + +--- +##### `type` _number_ +the metadata type of the item to return + + diff --git a/content/pages/01-reference/curl/resources/playlists/get_playlist_contents/_response.mdx b/content/pages/01-reference/curl/resources/playlists/get_playlist_contents/_response.mdx new file mode 100644 index 0000000..1b23813 --- /dev/null +++ b/content/pages/01-reference/curl/resources/playlists/get_playlist_contents/_response.mdx @@ -0,0 +1,26 @@ +{/* Autogenerated DO NOT EDIT */} + +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; +import { TabbedSection, Tab } from '@/src/components/TabbedSection'; +import StatusCode from '@/src/components/StatusCode'; + + + {/* prettier-ignore */} + }> + _No response body._ + + {/* prettier-ignore */} + }> + _No response body._ + + {/* prettier-ignore */} + }> + *JSON object* + + ##### `errors` _array (optional)_ + + + + + diff --git a/content/pages/01-reference/curl/resources/playlists/get_playlist_contents/_usage.mdx b/content/pages/01-reference/curl/resources/playlists/get_playlist_contents/_usage.mdx new file mode 100644 index 0000000..1d8a9b7 --- /dev/null +++ b/content/pages/01-reference/curl/resources/playlists/get_playlist_contents/_usage.mdx @@ -0,0 +1,21 @@ + + +```bash Example Request +curl http://10.10.10.47:32400/playlists/9571.56/items?type=7781.57 \ +--header 'Accept: application/json' \ +--header 'X-Plex-Token: YOUR_API_KEY_HERE' +``` +--- + +```json Example Response + { + "errors": [ + { + "code": 1001, + "message": "User could not be authenticated", + "status": 401 + } + ] + } +``` + diff --git a/content/pages/01-reference/curl/resources/playlists/get_playlist_contents/get_playlist_contents.mdx b/content/pages/01-reference/curl/resources/playlists/get_playlist_contents/get_playlist_contents.mdx new file mode 100644 index 0000000..885d93d --- /dev/null +++ b/content/pages/01-reference/curl/resources/playlists/get_playlist_contents/get_playlist_contents.mdx @@ -0,0 +1,12 @@ +import CurlHeader from './_header.mdx'; +import SDKHeader from './_header.mdx'; +import OperationHeader from '/src/components/OperationHeader'; + +###### *Playlists* + +} + curlHeader={} +/> + +{/* render operation */} diff --git a/content/pages/01-reference/curl/resources/playlists/get_playlists/_authentication.mdx b/content/pages/01-reference/curl/resources/playlists/get_playlists/_authentication.mdx new file mode 100644 index 0000000..ac82b0b --- /dev/null +++ b/content/pages/01-reference/curl/resources/playlists/get_playlists/_authentication.mdx @@ -0,0 +1,9 @@ +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### API key _— in HTTP header_ + +Set your API key in a `X-Plex-Token` HTTP header. + +Example: `` + diff --git a/content/pages/01-reference/curl/resources/playlists/get_playlists/_header.mdx b/content/pages/01-reference/curl/resources/playlists/get_playlists/_header.mdx new file mode 100644 index 0000000..d2ebc33 --- /dev/null +++ b/content/pages/01-reference/curl/resources/playlists/get_playlists/_header.mdx @@ -0,0 +1,7 @@ +import OperationInfo from '/src/components/OperationInfo'; + +## Get Playlists + + + +Get All Playlists given the specified filters. diff --git a/content/pages/01-reference/curl/resources/playlists/get_playlists/_parameters.mdx b/content/pages/01-reference/curl/resources/playlists/get_playlists/_parameters.mdx new file mode 100644 index 0000000..5e300e3 --- /dev/null +++ b/content/pages/01-reference/curl/resources/playlists/get_playlists/_parameters.mdx @@ -0,0 +1,20 @@ +{/* Autogenerated DO NOT EDIT */} +import PlaylistType from "/content/types/operations/playlist_type/curl.mdx" +import QueryParamSmart from "/content/types/operations/query_param_smart/curl.mdx" +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `playlistType` _enumeration (optional)_ +limit to a type of playlist. + + + + +--- +##### `smart` _enumeration (optional)_ +type of playlists to return (default is all). + + + + + diff --git a/content/pages/01-reference/curl/resources/playlists/get_playlists/_response.mdx b/content/pages/01-reference/curl/resources/playlists/get_playlists/_response.mdx new file mode 100644 index 0000000..1b23813 --- /dev/null +++ b/content/pages/01-reference/curl/resources/playlists/get_playlists/_response.mdx @@ -0,0 +1,26 @@ +{/* Autogenerated DO NOT EDIT */} + +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; +import { TabbedSection, Tab } from '@/src/components/TabbedSection'; +import StatusCode from '@/src/components/StatusCode'; + + + {/* prettier-ignore */} + }> + _No response body._ + + {/* prettier-ignore */} + }> + _No response body._ + + {/* prettier-ignore */} + }> + *JSON object* + + ##### `errors` _array (optional)_ + + + + + diff --git a/content/pages/01-reference/curl/resources/playlists/get_playlists/_usage.mdx b/content/pages/01-reference/curl/resources/playlists/get_playlists/_usage.mdx new file mode 100644 index 0000000..dcbde8a --- /dev/null +++ b/content/pages/01-reference/curl/resources/playlists/get_playlists/_usage.mdx @@ -0,0 +1,21 @@ + + +```bash Example Request +curl http://10.10.10.47:32400/playlists/all \ +--header 'Accept: application/json' \ +--header 'X-Plex-Token: YOUR_API_KEY_HERE' +``` +--- + +```json Example Response + { + "errors": [ + { + "code": 1001, + "message": "User could not be authenticated", + "status": 401 + } + ] + } +``` + diff --git a/content/pages/01-reference/curl/resources/playlists/get_playlists/get_playlists.mdx b/content/pages/01-reference/curl/resources/playlists/get_playlists/get_playlists.mdx new file mode 100644 index 0000000..885d93d --- /dev/null +++ b/content/pages/01-reference/curl/resources/playlists/get_playlists/get_playlists.mdx @@ -0,0 +1,12 @@ +import CurlHeader from './_header.mdx'; +import SDKHeader from './_header.mdx'; +import OperationHeader from '/src/components/OperationHeader'; + +###### *Playlists* + +} + curlHeader={} +/> + +{/* render operation */} diff --git a/content/pages/01-reference/curl/resources/playlists/playlists.mdx b/content/pages/01-reference/curl/resources/playlists/playlists.mdx new file mode 100644 index 0000000..97c64b9 --- /dev/null +++ b/content/pages/01-reference/curl/resources/playlists/playlists.mdx @@ -0,0 +1,55 @@ +import CreatePlaylist from "./create_playlist/create_playlist.mdx"; +import GetPlaylists from "./get_playlists/get_playlists.mdx"; +import GetPlaylist from "./get_playlist/get_playlist.mdx"; +import DeletePlaylist from "./delete_playlist/delete_playlist.mdx"; +import UpdatePlaylist from "./update_playlist/update_playlist.mdx"; +import GetPlaylistContents from "./get_playlist_contents/get_playlist_contents.mdx"; +import ClearPlaylistContents from "./clear_playlist_contents/clear_playlist_contents.mdx"; +import AddPlaylistContents from "./add_playlist_contents/add_playlist_contents.mdx"; +import UploadPlaylist from "./upload_playlist/upload_playlist.mdx"; + +## Playlists +Playlists are ordered collections of media. They can be dumb (just a list of media) or smart (based on a media query, such as "all albums from 2017"). +They can be organized in (optionally nesting) folders. +Retrieving a playlist, or its items, will trigger a refresh of its metadata. +This may cause the duration and number of items to change. + + +### Available Operations + +* [Create Playlist](/curl/playlists/create_playlist) - Create a Playlist +* [Get Playlists](/curl/playlists/get_playlists) - Get All Playlists +* [Get Playlist](/curl/playlists/get_playlist) - Retrieve Playlist +* [Delete Playlist](/curl/playlists/delete_playlist) - Deletes a Playlist +* [Update Playlist](/curl/playlists/update_playlist) - Update a Playlist +* [Get Playlist Contents](/curl/playlists/get_playlist_contents) - Retrieve Playlist Contents +* [Clear Playlist Contents](/curl/playlists/clear_playlist_contents) - Delete Playlist Contents +* [Add Playlist Contents](/curl/playlists/add_playlist_contents) - Adding to a Playlist +* [Upload Playlist](/curl/playlists/upload_playlist) - Upload Playlist + +--- + + +--- + + +--- + + +--- + + +--- + + +--- + + +--- + + +--- + + +--- + diff --git a/content/pages/01-reference/curl/resources/playlists/update_playlist/_authentication.mdx b/content/pages/01-reference/curl/resources/playlists/update_playlist/_authentication.mdx new file mode 100644 index 0000000..ac82b0b --- /dev/null +++ b/content/pages/01-reference/curl/resources/playlists/update_playlist/_authentication.mdx @@ -0,0 +1,9 @@ +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### API key _— in HTTP header_ + +Set your API key in a `X-Plex-Token` HTTP header. + +Example: `` + diff --git a/content/pages/01-reference/curl/resources/playlists/update_playlist/_header.mdx b/content/pages/01-reference/curl/resources/playlists/update_playlist/_header.mdx new file mode 100644 index 0000000..1ea2fa0 --- /dev/null +++ b/content/pages/01-reference/curl/resources/playlists/update_playlist/_header.mdx @@ -0,0 +1,8 @@ +import OperationInfo from '/src/components/OperationInfo'; + +## Update Playlist + + + +From PMS version 1.9.1 clients can also edit playlist metadata using this endpoint as they would via `PUT /library/metadata/\{playlistID\}` + diff --git a/content/pages/01-reference/curl/resources/playlists/update_playlist/_parameters.mdx b/content/pages/01-reference/curl/resources/playlists/update_playlist/_parameters.mdx new file mode 100644 index 0000000..6e2026a --- /dev/null +++ b/content/pages/01-reference/curl/resources/playlists/update_playlist/_parameters.mdx @@ -0,0 +1,5 @@ +{/* Autogenerated DO NOT EDIT */} +##### `playlistID` _number_ +the ID of the playlist + + diff --git a/content/pages/01-reference/curl/resources/playlists/update_playlist/_response.mdx b/content/pages/01-reference/curl/resources/playlists/update_playlist/_response.mdx new file mode 100644 index 0000000..1b23813 --- /dev/null +++ b/content/pages/01-reference/curl/resources/playlists/update_playlist/_response.mdx @@ -0,0 +1,26 @@ +{/* Autogenerated DO NOT EDIT */} + +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; +import { TabbedSection, Tab } from '@/src/components/TabbedSection'; +import StatusCode from '@/src/components/StatusCode'; + + + {/* prettier-ignore */} + }> + _No response body._ + + {/* prettier-ignore */} + }> + _No response body._ + + {/* prettier-ignore */} + }> + *JSON object* + + ##### `errors` _array (optional)_ + + + + + diff --git a/content/pages/01-reference/curl/resources/playlists/update_playlist/_usage.mdx b/content/pages/01-reference/curl/resources/playlists/update_playlist/_usage.mdx new file mode 100644 index 0000000..7b9f1aa --- /dev/null +++ b/content/pages/01-reference/curl/resources/playlists/update_playlist/_usage.mdx @@ -0,0 +1,21 @@ + + +```bash Example Request +curl http://10.10.10.47:32400/playlists/8326.2 \ +--header 'Accept: application/json' \ +--header 'X-Plex-Token: YOUR_API_KEY_HERE' +``` +--- + +```json Example Response + { + "errors": [ + { + "code": 1001, + "message": "User could not be authenticated", + "status": 401 + } + ] + } +``` + diff --git a/content/pages/01-reference/curl/resources/playlists/update_playlist/update_playlist.mdx b/content/pages/01-reference/curl/resources/playlists/update_playlist/update_playlist.mdx new file mode 100644 index 0000000..885d93d --- /dev/null +++ b/content/pages/01-reference/curl/resources/playlists/update_playlist/update_playlist.mdx @@ -0,0 +1,12 @@ +import CurlHeader from './_header.mdx'; +import SDKHeader from './_header.mdx'; +import OperationHeader from '/src/components/OperationHeader'; + +###### *Playlists* + +} + curlHeader={} +/> + +{/* render operation */} diff --git a/content/pages/01-reference/curl/resources/playlists/upload_playlist/_authentication.mdx b/content/pages/01-reference/curl/resources/playlists/upload_playlist/_authentication.mdx new file mode 100644 index 0000000..ac82b0b --- /dev/null +++ b/content/pages/01-reference/curl/resources/playlists/upload_playlist/_authentication.mdx @@ -0,0 +1,9 @@ +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### API key _— in HTTP header_ + +Set your API key in a `X-Plex-Token` HTTP header. + +Example: `` + diff --git a/content/pages/01-reference/curl/resources/playlists/upload_playlist/_header.mdx b/content/pages/01-reference/curl/resources/playlists/upload_playlist/_header.mdx new file mode 100644 index 0000000..6342b73 --- /dev/null +++ b/content/pages/01-reference/curl/resources/playlists/upload_playlist/_header.mdx @@ -0,0 +1,8 @@ +import OperationInfo from '/src/components/OperationInfo'; + +## Upload Playlist + + + +Imports m3u playlists by passing a path on the server to scan for m3u-formatted playlist files, or a path to a single playlist file. + diff --git a/content/pages/01-reference/curl/resources/playlists/upload_playlist/_parameters.mdx b/content/pages/01-reference/curl/resources/playlists/upload_playlist/_parameters.mdx new file mode 100644 index 0000000..f466f21 --- /dev/null +++ b/content/pages/01-reference/curl/resources/playlists/upload_playlist/_parameters.mdx @@ -0,0 +1,26 @@ +{/* Autogenerated DO NOT EDIT */} +import Force from "/content/types/operations/force/curl.mdx" +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; + +##### `path` _string_ +absolute path to a directory on the server where m3u files are stored, or the absolute path to a playlist file on the server. +If the `path` argument is a directory, that path will be scanned for playlist files to be processed. +Each file in that directory creates a separate playlist, with a name based on the filename of the file that created it. +The GUID of each playlist is based on the filename. +If the `path` argument is a file, that file will be used to create a new playlist, with the name based on the filename of the file that created it. +The GUID of each playlist is based on the filename. + +
+**Example:** `/home/barkley/playlist.m3u` + +--- +##### `force` _enumeration_ +force overwriting of duplicate playlists. By default, a playlist file uploaded with the same path will overwrite the existing playlist. +The `force` argument is used to disable overwriting. If the `force` argument is set to 0, a new playlist will be created suffixed with the date and time that the duplicate was uploaded. + + + + + + diff --git a/content/pages/01-reference/curl/resources/playlists/upload_playlist/_response.mdx b/content/pages/01-reference/curl/resources/playlists/upload_playlist/_response.mdx new file mode 100644 index 0000000..1b23813 --- /dev/null +++ b/content/pages/01-reference/curl/resources/playlists/upload_playlist/_response.mdx @@ -0,0 +1,26 @@ +{/* Autogenerated DO NOT EDIT */} + +import Collapsible from "/src/components/Collapsible"; +import Labels from "/src/lib/labels"; +import { TabbedSection, Tab } from '@/src/components/TabbedSection'; +import StatusCode from '@/src/components/StatusCode'; + + + {/* prettier-ignore */} + }> + _No response body._ + + {/* prettier-ignore */} + }> + _No response body._ + + {/* prettier-ignore */} + }> + *JSON object* + + ##### `errors` _array (optional)_ + + + + + diff --git a/content/pages/01-reference/curl/resources/playlists/upload_playlist/_usage.mdx b/content/pages/01-reference/curl/resources/playlists/upload_playlist/_usage.mdx new file mode 100644 index 0000000..8943118 --- /dev/null +++ b/content/pages/01-reference/curl/resources/playlists/upload_playlist/_usage.mdx @@ -0,0 +1,21 @@ + + +```bash Example Request +curl http://10.10.10.47:32400/playlists/upload?path=%2Fhome%2Fbarkley%2Fplaylist.m3u \ +--header 'Accept: application/json' \ +--header 'X-Plex-Token: YOUR_API_KEY_HERE' +``` +--- + +```json Example Response + { + "errors": [ + { + "code": 1001, + "message": "User could not be authenticated", + "status": 401 + } + ] + } +``` + diff --git a/content/pages/01-reference/curl/resources/playlists/upload_playlist/upload_playlist.mdx b/content/pages/01-reference/curl/resources/playlists/upload_playlist/upload_playlist.mdx new file mode 100644 index 0000000..885d93d --- /dev/null +++ b/content/pages/01-reference/curl/resources/playlists/upload_playlist/upload_playlist.mdx @@ -0,0 +1,12 @@ +import CurlHeader from './_header.mdx'; +import SDKHeader from './_header.mdx'; +import OperationHeader from '/src/components/OperationHeader'; + +###### *Playlists* + +} + curlHeader={} +/> + +{/* render operation */} diff --git a/content/pages/01-reference/curl/resources/resources.mdx b/content/pages/01-reference/curl/resources/resources.mdx new file mode 100644 index 0000000..9bca8da --- /dev/null +++ b/content/pages/01-reference/curl/resources/resources.mdx @@ -0,0 +1,56 @@ +--- +group_type: flat +--- + +import Server from "./server/server.mdx"; +import Media from "./media/media.mdx"; +import Activities from "./activities/activities.mdx"; +import Butler from "./butler/butler.mdx"; +import Hubs from "./hubs/hubs.mdx"; +import Search from "./search/search.mdx"; +import Library from "./library/library.mdx"; +import Log from "./log/log.mdx"; +import Playlists from "./playlists/playlists.mdx"; +import Security from "./security/security.mdx"; +import Sessions from "./sessions/sessions.mdx"; +import Updater from "./updater/updater.mdx"; +import Video from "./video/video.mdx"; + + + +--- + + +--- + + +--- + + +--- + + +--- + + +--- + + +--- + + +--- + + +--- + + +--- + + +--- + + +--- +