From 6c634befe02ba9d1325f798083e6aef92bc7bf5c Mon Sep 17 00:00:00 2001 From: luke-hagar-sp <98849695+luke-hagar-sp@users.noreply.github.com> Date: Mon, 27 Mar 2023 14:42:16 -0500 Subject: [PATCH] gen steps --- .gitignore | 1 - docs/plex/activities.tag.mdx | 27 +++++++++++++ docs/plex/applying-updates.api.mdx | 42 ++++++++++++++++++++ docs/plex/butler.tag.mdx | 21 ++++++++++ docs/plex/cancel-server-activities.api.mdx | 37 +++++++++++++++++ docs/plex/checkingfor-updates.api.mdx | 33 ++++++++++++++++ docs/plex/log-multiple-lines.api.mdx | 38 ++++++++++++++++++ docs/plex/log.tag.mdx | 21 ++++++++++ docs/plex/loga-line.api.mdx | 38 ++++++++++++++++++ docs/plex/plex-api.info.mdx | 23 +++++++++++ docs/plex/querying-update-status.api.mdx | 37 +++++++++++++++++ docs/plex/server-activities.api.mdx | 37 +++++++++++++++++ docs/plex/server-capabilities.api.mdx | 37 +++++++++++++++++ docs/plex/server.tag.mdx | 21 ++++++++++ docs/plex/sidebar.js | 1 + docs/plex/start-a-butler-tasks.api.mdx | 46 ++++++++++++++++++++++ docs/plex/start-all-butler-tasks.api.mdx | 42 ++++++++++++++++++++ docs/plex/stop-a-butler-tasks.api.mdx | 42 ++++++++++++++++++++ docs/plex/stop-all-butler-tasks.api.mdx | 38 ++++++++++++++++++ docs/plex/updater.tag.mdx | 22 +++++++++++ 20 files changed, 603 insertions(+), 1 deletion(-) create mode 100644 docs/plex/activities.tag.mdx create mode 100644 docs/plex/applying-updates.api.mdx create mode 100644 docs/plex/butler.tag.mdx create mode 100644 docs/plex/cancel-server-activities.api.mdx create mode 100644 docs/plex/checkingfor-updates.api.mdx create mode 100644 docs/plex/log-multiple-lines.api.mdx create mode 100644 docs/plex/log.tag.mdx create mode 100644 docs/plex/loga-line.api.mdx create mode 100644 docs/plex/plex-api.info.mdx create mode 100644 docs/plex/querying-update-status.api.mdx create mode 100644 docs/plex/server-activities.api.mdx create mode 100644 docs/plex/server-capabilities.api.mdx create mode 100644 docs/plex/server.tag.mdx create mode 100644 docs/plex/sidebar.js create mode 100644 docs/plex/start-a-butler-tasks.api.mdx create mode 100644 docs/plex/start-all-butler-tasks.api.mdx create mode 100644 docs/plex/stop-a-butler-tasks.api.mdx create mode 100644 docs/plex/stop-all-butler-tasks.api.mdx create mode 100644 docs/plex/updater.tag.mdx diff --git a/.gitignore b/.gitignore index 36ef61e..b2d6de3 100644 --- a/.gitignore +++ b/.gitignore @@ -3,7 +3,6 @@ # Production /build -/docs/plex/* # Generated files .docusaurus diff --git a/docs/plex/activities.tag.mdx b/docs/plex/activities.tag.mdx new file mode 100644 index 0000000..0937b9b --- /dev/null +++ b/docs/plex/activities.tag.mdx @@ -0,0 +1,27 @@ +--- +id: activities +title: "Activities" +description: "Activities" +custom_edit_url: null +--- + + + +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. + + + + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` + \ No newline at end of file diff --git a/docs/plex/applying-updates.api.mdx b/docs/plex/applying-updates.api.mdx new file mode 100644 index 0000000..1899ba5 --- /dev/null +++ b/docs/plex/applying-updates.api.mdx @@ -0,0 +1,42 @@ +--- +id: applying-updates +sidebar_label: Applying updates +hide_title: true +hide_table_of_contents: true +api: {"tags":["Updater"],"description":"Note that these two parameters are effectively mutually exclusive. The `tonight` parameter takes precedence and `skip` will be ignored if `tonight` is also passed\n","operationId":"applyingUpdates","parameters":[{"name":"tonight","description":"Indicate that you want the update to run during the next Butler execution. Omitting this or setting it to false indicates that the update should install","required":false,"in":"query","schema":{"enum":[0,1]},"example":1},{"name":"skip","description":"Indicate that the latest version should be marked as skipped. The entry for this version will have the `state` set to `skipped`.","required":false,"in":"query","schema":{"enum":[0,1]},"example":1}],"responses":{"200":{"description":"If the update process started correctly"},"401":{"description":"Unauthorized - Returned if the X-Plex-Token is missing from the header or query."},"500":{"description":"If the update process failed to start"}},"method":"put","path":"/updater/apply","servers":[{"url":"{Protocol}://{Local IP}:{Port}","variables":{"Protocol":{"enum":["http","https"],"default":"http","description":"The protocl to use with your plex server"},"Local IP":{"default":"10.10.10.47","description":"The Local IP Address of your plex server"},"Port":{"default":"32400","description":"The port to access your plex server"}}}],"security":[{"PlexToken":[]}],"securitySchemes":{"PlexToken":{"type":"apiKey","in":"header","name":"X-Plex-Token"}},"info":{"title":"Plex-API","summary":"A Plex Media Server API Map","description":"An Open API Spec for interacting with Plex.tv and Plex Servers","version":"0.0.2","contact":{"name":"Luke Hagar","email":"Lukeslakemail@gmail.com","url":"https://www.LukeHagar.com"}},"postman":{"name":"Applying updates","description":{"content":"Note that these two parameters are effectively mutually exclusive. The `tonight` parameter takes precedence and `skip` will be ignored if `tonight` is also passed\n","type":"text/plain"},"url":{"path":["updater","apply"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Indicate that you want the update to run during the next Butler execution. Omitting this or setting it to false indicates that the update should install","type":"text/plain"},"key":"tonight","value":""},{"disabled":false,"description":{"content":"Indicate that the latest version should be marked as skipped. The entry for this version will have the `state` set to `skipped`.","type":"text/plain"},"key":"skip","value":""}],"variable":[]},"method":"PUT"}} +sidebar_class_name: "put api-method" +info_path: docs/plex/plex-api +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import TabItem from "@theme/TabItem"; + +

Applying updates

+ + + + + +Note that these two parameters are effectively mutually exclusive. The `tonight` parameter takes precedence and `skip` will be ignored if `tonight` is also passed + + +
Query Parameters
    entry for this version will have the `state` set to `skipped`.","required":false,"in":"query","schema":{"enum":[0,1]},"example":1}}>
+ +If the update process started correctly + +
+ +Unauthorized - Returned if the X-Plex-Token is missing from the header or query. + +
+ +If the update process failed to start + +
\ No newline at end of file diff --git a/docs/plex/butler.tag.mdx b/docs/plex/butler.tag.mdx new file mode 100644 index 0000000..c87263d --- /dev/null +++ b/docs/plex/butler.tag.mdx @@ -0,0 +1,21 @@ +--- +id: butler +title: "Butler" +description: "Butler" +custom_edit_url: null +--- + + + +Butler is the task manager of the Plex Media Server Ecosystem. + + + + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` + \ No newline at end of file diff --git a/docs/plex/cancel-server-activities.api.mdx b/docs/plex/cancel-server-activities.api.mdx new file mode 100644 index 0000000..6a64b96 --- /dev/null +++ b/docs/plex/cancel-server-activities.api.mdx @@ -0,0 +1,37 @@ +--- +id: cancel-server-activities +sidebar_label: Cancel Server Activities +hide_title: true +hide_table_of_contents: true +api: {"tags":["Activities"],"description":"Cancel Server Activities","operationId":"cancelServerActivities","parameters":[{"name":"activityUUID","description":"The UUID of the activity to cancel.","in":"path","schema":{"type":"string"},"example":"25b71ed5-0f9d-461c-baa7-d404e9e10d3e","required":true}],"responses":{"200":{"description":"The Server Activity was canceled","content":{"application/json":{"schema":{"type":"object","properties":{"MediaContainer":{"type":"object","properties":{"size":{"type":"number"},"Activity":{"type":"array","items":{"type":"object","properties":{"uuid":{"type":"string"},"type":{"type":"string"},"cancellable":{"type":"boolean"},"userID":{"type":"number"},"title":{"type":"string"},"subtitle":{"type":"string"},"progress":{"type":"number"},"Context":{"type":"object","properties":{"librarySectionID":{"type":"string"}}}}}}}}}}}}},"401":{"description":"Unauthorized - Returned if the X-Plex-Token is missing from the header or query."}},"method":"delete","path":"/activities/{activityUUID}","servers":[{"url":"{Protocol}://{Local IP}:{Port}","variables":{"Protocol":{"enum":["http","https"],"default":"http","description":"The protocl to use with your plex server"},"Local IP":{"default":"10.10.10.47","description":"The Local IP Address of your plex server"},"Port":{"default":"32400","description":"The port to access your plex server"}}}],"security":[{"PlexToken":[]}],"securitySchemes":{"PlexToken":{"type":"apiKey","in":"header","name":"X-Plex-Token"}},"info":{"title":"Plex-API","summary":"A Plex Media Server API Map","description":"An Open API Spec for interacting with Plex.tv and Plex Servers","version":"0.0.2","contact":{"name":"Luke Hagar","email":"Lukeslakemail@gmail.com","url":"https://www.LukeHagar.com"}},"postman":{"name":"Cancel Server Activities","description":{"content":"Cancel Server Activities","type":"text/plain"},"url":{"path":["activities",":activityUUID"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The UUID of the activity to cancel.","type":"text/plain"},"type":"any","value":"","key":"activityUUID"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE"}} +sidebar_class_name: "delete api-method" +info_path: docs/plex/plex-api +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import TabItem from "@theme/TabItem"; + +

Cancel Server Activities

+ + + + + +Cancel Server Activities + +
Path Parameters
+ +The Server Activity was canceled + +
Schema
    MediaContainer object
    Activity object[]
  • Array [
    • Context object
  • ]
+ +Unauthorized - Returned if the X-Plex-Token is missing from the header or query. + +
\ No newline at end of file diff --git a/docs/plex/checkingfor-updates.api.mdx b/docs/plex/checkingfor-updates.api.mdx new file mode 100644 index 0000000..3a88118 --- /dev/null +++ b/docs/plex/checkingfor-updates.api.mdx @@ -0,0 +1,33 @@ +--- +id: checkingfor-updates +sidebar_label: Checking for updates +hide_title: true +hide_table_of_contents: true +api: {"tags":["Updater"],"description":"Checking for updates","operationId":"checkingforUpdates","parameters":[{"name":"download","description":"Indicate that you want to start download any updates found.","required":false,"in":"query","schema":{"enum":[0,1]},"example":1}],"responses":{"200":{"description":""},"401":{"description":"Unauthorized - Returned if the X-Plex-Token is missing from the header or query."}},"method":"put","path":"/updater/check","servers":[{"url":"{Protocol}://{Local IP}:{Port}","variables":{"Protocol":{"enum":["http","https"],"default":"http","description":"The protocl to use with your plex server"},"Local IP":{"default":"10.10.10.47","description":"The Local IP Address of your plex server"},"Port":{"default":"32400","description":"The port to access your plex server"}}}],"security":[{"PlexToken":[]}],"securitySchemes":{"PlexToken":{"type":"apiKey","in":"header","name":"X-Plex-Token"}},"info":{"title":"Plex-API","summary":"A Plex Media Server API Map","description":"An Open API Spec for interacting with Plex.tv and Plex Servers","version":"0.0.2","contact":{"name":"Luke Hagar","email":"Lukeslakemail@gmail.com","url":"https://www.LukeHagar.com"}},"postman":{"name":"Checking for updates","description":{"content":"Checking for updates","type":"text/plain"},"url":{"path":["updater","check"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Indicate that you want to start download any updates found.","type":"text/plain"},"key":"download","value":""}],"variable":[]},"method":"PUT"}} +sidebar_class_name: "put api-method" +info_path: docs/plex/plex-api +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import TabItem from "@theme/TabItem"; + +

Checking for updates

+ + + + + +Checking for updates + +
Query Parameters
+ +Unauthorized - Returned if the X-Plex-Token is missing from the header or query. + +
\ No newline at end of file diff --git a/docs/plex/log-multiple-lines.api.mdx b/docs/plex/log-multiple-lines.api.mdx new file mode 100644 index 0000000..aa4c2ef --- /dev/null +++ b/docs/plex/log-multiple-lines.api.mdx @@ -0,0 +1,38 @@ +--- +id: log-multiple-lines +sidebar_label: Logging a multi-line message to the Plex Media Server log +hide_title: true +hide_table_of_contents: true +api: {"tags":["Log"],"description":"This endpoint will write multiple lines to the main Plex Media Server log in a single request. It takes a set of query strings as would normally sent to the above GET endpoint as a linefeed-separated block of POST data. The parameters for each query string match as above.\n","operationId":"logMultipleLines","responses":{"200":{"description":"Multi-Line Log Message Posted successfully"},"401":{"description":"Unauthorized - Returned if the X-Plex-Token is missing from the header or query."}},"method":"post","path":"/log","servers":[{"url":"{Protocol}://{Local IP}:{Port}","variables":{"Protocol":{"enum":["http","https"],"default":"http","description":"The protocl to use with your plex server"},"Local IP":{"default":"10.10.10.47","description":"The Local IP Address of your plex server"},"Port":{"default":"32400","description":"The port to access your plex server"}}}],"security":[{"PlexToken":[]}],"securitySchemes":{"PlexToken":{"type":"apiKey","in":"header","name":"X-Plex-Token"}},"info":{"title":"Plex-API","summary":"A Plex Media Server API Map","description":"An Open API Spec for interacting with Plex.tv and Plex Servers","version":"0.0.2","contact":{"name":"Luke Hagar","email":"Lukeslakemail@gmail.com","url":"https://www.LukeHagar.com"}},"postman":{"name":"Logging a multi-line message to the Plex Media Server log","description":{"content":"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.\n","type":"text/plain"},"url":{"path":["log"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"method":"POST"}} +sidebar_class_name: "post api-method" +info_path: docs/plex/plex-api +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import TabItem from "@theme/TabItem"; + +

Logging a multi-line message to the Plex Media Server log

+ + + + + +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. + + +
+ +Multi-Line Log Message Posted successfully + +
+ +Unauthorized - Returned if the X-Plex-Token is missing from the header or query. + +
\ No newline at end of file diff --git a/docs/plex/log.tag.mdx b/docs/plex/log.tag.mdx new file mode 100644 index 0000000..1885442 --- /dev/null +++ b/docs/plex/log.tag.mdx @@ -0,0 +1,21 @@ +--- +id: log +title: "Log" +description: "Log" +custom_edit_url: null +--- + + + +Submit logs to the Log Handler for Plex Media Server + + + + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` + \ No newline at end of file diff --git a/docs/plex/loga-line.api.mdx b/docs/plex/loga-line.api.mdx new file mode 100644 index 0000000..7468eb3 --- /dev/null +++ b/docs/plex/loga-line.api.mdx @@ -0,0 +1,38 @@ +--- +id: loga-line +sidebar_label: Logging a single-line message to the Plex Media Server log. +hide_title: true +hide_table_of_contents: true +api: {"tags":["Log"],"description":"This endpoint will write a single-line log message, including a level and source to the main Plex Media Server log.\n","operationId":"logaLine","parameters":[{"name":"level","description":"An integer log level to write to the PMS log with. \n(0: Error, 1: Warning, 2: Info, 3: Debug, 4: Verbose)\n","in":"query","schema":{"type":"number","enum":[0,1,2,3,4]},"required":true},{"name":"message","description":"The text of the message to write to the log.","in":"query","schema":{"type":"string","example":""},"required":true},{"name":"source","description":"a string indicating the source of the message.","in":"query","schema":{"type":"string","example":""},"required":true}],"responses":{"200":{"description":"Log Line submitted successfully"},"401":{"description":"Unauthorized - Returned if the X-Plex-Token is missing from the header or query."}},"method":"get","path":"/log","servers":[{"url":"{Protocol}://{Local IP}:{Port}","variables":{"Protocol":{"enum":["http","https"],"default":"http","description":"The protocl to use with your plex server"},"Local IP":{"default":"10.10.10.47","description":"The Local IP Address of your plex server"},"Port":{"default":"32400","description":"The port to access your plex server"}}}],"security":[{"PlexToken":[]}],"securitySchemes":{"PlexToken":{"type":"apiKey","in":"header","name":"X-Plex-Token"}},"info":{"title":"Plex-API","summary":"A Plex Media Server API Map","description":"An Open API Spec for interacting with Plex.tv and Plex Servers","version":"0.0.2","contact":{"name":"Luke Hagar","email":"Lukeslakemail@gmail.com","url":"https://www.LukeHagar.com"}},"postman":{"name":"Logging a single-line message to the Plex Media Server log.","description":{"content":"This endpoint will write a single-line log message, including a level and source to the main Plex Media Server log.\n","type":"text/plain"},"url":{"path":["log"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"(Required) An integer log level to write to the PMS log with. \n(0: Error, 1: Warning, 2: Info, 3: Debug, 4: Verbose)\n","type":"text/plain"},"key":"level","value":""},{"disabled":false,"description":{"content":"(Required) The text of the message to write to the log.","type":"text/plain"},"key":"message","value":""},{"disabled":false,"description":{"content":"(Required) a string indicating the source of the message.","type":"text/plain"},"key":"source","value":""}],"variable":[]},"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: docs/plex/plex-api +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import TabItem from "@theme/TabItem"; + +

Logging a single-line message to the Plex Media Server log.

+ + + + + +This endpoint will write a single-line log message, including a level and source to the main Plex Media Server log. + + +
Query Parameters
+ +Log Line submitted successfully + +
+ +Unauthorized - Returned if the X-Plex-Token is missing from the header or query. + +
\ No newline at end of file diff --git a/docs/plex/plex-api.info.mdx b/docs/plex/plex-api.info.mdx new file mode 100644 index 0000000..3a08b93 --- /dev/null +++ b/docs/plex/plex-api.info.mdx @@ -0,0 +1,23 @@ +--- +id: plex-api +sidebar_label: Introduction +sidebar_position: 0 +hide_title: true +--- + +import ApiLogo from "@theme/ApiLogo"; +import SchemaTabs from "@theme/SchemaTabs"; +import TabItem from "@theme/TabItem"; +import Export from "@theme/ApiDemoPanel/Export"; + +Version: 0.0.2 + + + +

Plex-API

+ + + +An Open API Spec for interacting with Plex.tv and Plex Servers + +

Authentication

Security Scheme Type:apiKey
Header parameter name:X-Plex-Token
\ No newline at end of file diff --git a/docs/plex/querying-update-status.api.mdx b/docs/plex/querying-update-status.api.mdx new file mode 100644 index 0000000..2fb7a50 --- /dev/null +++ b/docs/plex/querying-update-status.api.mdx @@ -0,0 +1,37 @@ +--- +id: querying-update-status +sidebar_label: Querying status of updates +hide_title: true +hide_table_of_contents: true +api: {"tags":["Updater"],"description":"Querying status of updates","operationId":"queryingUpdateStatus","responses":{"200":{"description":"The Server Updates"},"401":{"description":"Unauthorized - Returned if the X-Plex-Token is missing from the header or query."}},"method":"get","path":"/updater/status","servers":[{"url":"{Protocol}://{Local IP}:{Port}","variables":{"Protocol":{"enum":["http","https"],"default":"http","description":"The protocl to use with your plex server"},"Local IP":{"default":"10.10.10.47","description":"The Local IP Address of your plex server"},"Port":{"default":"32400","description":"The port to access your plex server"}}}],"security":[{"PlexToken":[]}],"securitySchemes":{"PlexToken":{"type":"apiKey","in":"header","name":"X-Plex-Token"}},"info":{"title":"Plex-API","summary":"A Plex Media Server API Map","description":"An Open API Spec for interacting with Plex.tv and Plex Servers","version":"0.0.2","contact":{"name":"Luke Hagar","email":"Lukeslakemail@gmail.com","url":"https://www.LukeHagar.com"}},"postman":{"name":"Querying status of updates","description":{"content":"Querying status of updates","type":"text/plain"},"url":{"path":["updater","status"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: docs/plex/plex-api +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import TabItem from "@theme/TabItem"; + +

Querying status of updates

+ + + + + +Querying status of updates + +
+ +The Server Updates + +
+ +Unauthorized - Returned if the X-Plex-Token is missing from the header or query. + +
\ No newline at end of file diff --git a/docs/plex/server-activities.api.mdx b/docs/plex/server-activities.api.mdx new file mode 100644 index 0000000..60efcf3 --- /dev/null +++ b/docs/plex/server-activities.api.mdx @@ -0,0 +1,37 @@ +--- +id: server-activities +sidebar_label: Server Activities +hide_title: true +hide_table_of_contents: true +api: {"tags":["Activities"],"description":"Server Activities","operationId":"serverActivities","responses":{"200":{"description":"The Server Activities","content":{"application/json":{"schema":{"type":"object","properties":{"MediaContainer":{"type":"object","properties":{"size":{"type":"number"},"Activity":{"type":"array","items":{"type":"object","properties":{"uuid":{"type":"string"},"type":{"type":"string"},"cancellable":{"type":"boolean"},"userID":{"type":"number"},"title":{"type":"string"},"subtitle":{"type":"string"},"progress":{"type":"number"},"Context":{"type":"object","properties":{"librarySectionID":{"type":"string"}}}}}}}}}}}}},"401":{"description":"Unauthorized - Returned if the X-Plex-Token is missing from the header or query."}},"method":"get","path":"/activities","servers":[{"url":"{Protocol}://{Local IP}:{Port}","variables":{"Protocol":{"enum":["http","https"],"default":"http","description":"The protocl to use with your plex server"},"Local IP":{"default":"10.10.10.47","description":"The Local IP Address of your plex server"},"Port":{"default":"32400","description":"The port to access your plex server"}}}],"security":[{"PlexToken":[]}],"securitySchemes":{"PlexToken":{"type":"apiKey","in":"header","name":"X-Plex-Token"}},"info":{"title":"Plex-API","summary":"A Plex Media Server API Map","description":"An Open API Spec for interacting with Plex.tv and Plex Servers","version":"0.0.2","contact":{"name":"Luke Hagar","email":"Lukeslakemail@gmail.com","url":"https://www.LukeHagar.com"}},"postman":{"name":"Server Activities","description":{"content":"Server Activities","type":"text/plain"},"url":{"path":["activities"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: docs/plex/plex-api +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import TabItem from "@theme/TabItem"; + +

Server Activities

+ + + + + +Server Activities + +
+ +The Server Activities + +
Schema
    MediaContainer object
    Activity object[]
  • Array [
    • Context object
  • ]
+ +Unauthorized - Returned if the X-Plex-Token is missing from the header or query. + +
\ No newline at end of file diff --git a/docs/plex/server-capabilities.api.mdx b/docs/plex/server-capabilities.api.mdx new file mode 100644 index 0000000..5ef244f --- /dev/null +++ b/docs/plex/server-capabilities.api.mdx @@ -0,0 +1,37 @@ +--- +id: server-capabilities +sidebar_label: Server Capabilities +hide_title: true +hide_table_of_contents: true +api: {"tags":["Server"],"description":"Server Capabilities","operationId":"serverCapabilities","responses":{"200":{"description":"The Server Capabilities","content":{"application/json":{"schema":{"type":"object","properties":{"MediaContainer":{"type":"object","properties":{"size":{"type":"number"},"allowCameraUpload":{"type":"boolean"},"allowChannelAccess":{"type":"boolean"},"allowMediaDeletion":{"type":"boolean"},"allowSharing":{"type":"boolean"},"allowSync":{"type":"boolean"},"allowTuners":{"type":"boolean"},"backgroundProcessing":{"type":"boolean"},"certificate":{"type":"boolean"},"companionProxy":{"type":"boolean"},"countryCode":{"type":"string"},"diagnostics":{"type":"string"},"eventStream":{"type":"boolean"},"friendlyName":{"type":"string"},"hubSearch":{"type":"boolean"},"itemClusters":{"type":"boolean"},"livetv":{"type":"number"},"machineIdentifier":{"type":"string"},"mediaProviders":{"type":"boolean"},"multiuser":{"type":"boolean"},"musicAnalysis":{"type":"number"},"myPlex":{"type":"boolean"},"myPlexMappingState":{"type":"string"},"myPlexSigninState":{"type":"string"},"myPlexSubscription":{"type":"boolean"},"myPlexUsername":{"type":"string"},"offlineTranscode":{"type":"number"},"ownerFeatures":{"type":"string"},"photoAutoTag":{"type":"boolean"},"platform":{"type":"string"},"platformVersion":{"type":"string"},"pluginHost":{"type":"boolean"},"pushNotifications":{"type":"boolean"},"readOnlyLibraries":{"type":"boolean"},"streamingBrainABRVersion":{"type":"number"},"streamingBrainVersion":{"type":"number"},"sync":{"type":"boolean"},"transcoderActiveVideoSessions":{"type":"number"},"transcoderAudio":{"type":"boolean"},"transcoderLyrics":{"type":"boolean"},"transcoderPhoto":{"type":"boolean"},"transcoderSubtitles":{"type":"boolean"},"transcoderVideo":{"type":"boolean"},"transcoderVideoBitrates":{"type":"string"},"transcoderVideoQualities":{"type":"string"},"transcoderVideoResolutions":{"type":"string"},"updatedAt":{"type":"number"},"updater":{"type":"boolean"},"version":{"type":"string"},"voiceSearch":{"type":"boolean"},"Directory":{"type":"array","items":{"type":"object","properties":{"count":{"type":"number"},"key":{"type":"string"},"title":{"type":"string"}}}}}}}}}}},"401":{"description":"Unauthorized - Returned if the X-Plex-Token is missing from the header or query."}},"method":"get","path":"/","servers":[{"url":"{Protocol}://{Local IP}:{Port}","variables":{"Protocol":{"enum":["http","https"],"default":"http","description":"The protocl to use with your plex server"},"Local IP":{"default":"10.10.10.47","description":"The Local IP Address of your plex server"},"Port":{"default":"32400","description":"The port to access your plex server"}}}],"security":[{"PlexToken":[]}],"securitySchemes":{"PlexToken":{"type":"apiKey","in":"header","name":"X-Plex-Token"}},"info":{"title":"Plex-API","summary":"A Plex Media Server API Map","description":"An Open API Spec for interacting with Plex.tv and Plex Servers","version":"0.0.2","contact":{"name":"Luke Hagar","email":"Lukeslakemail@gmail.com","url":"https://www.LukeHagar.com"}},"postman":{"name":"Server Capabilities","description":{"content":"Server Capabilities","type":"text/plain"},"url":{"path":[""],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} +sidebar_class_name: "get api-method" +info_path: docs/plex/plex-api +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import TabItem from "@theme/TabItem"; + +

Server Capabilities

+ + + + + +Server Capabilities + +
+ +The Server Capabilities + +
Schema
    MediaContainer object
    Directory object[]
  • Array [
  • ]
+ +Unauthorized - Returned if the X-Plex-Token is missing from the header or query. + +
\ No newline at end of file diff --git a/docs/plex/server.tag.mdx b/docs/plex/server.tag.mdx new file mode 100644 index 0000000..4b37690 --- /dev/null +++ b/docs/plex/server.tag.mdx @@ -0,0 +1,21 @@ +--- +id: server +title: "Server" +description: "Server" +custom_edit_url: null +--- + + + +Operations against the Plex Media Server System. + + + + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` + \ No newline at end of file diff --git a/docs/plex/sidebar.js b/docs/plex/sidebar.js new file mode 100644 index 0000000..0d74cc4 --- /dev/null +++ b/docs/plex/sidebar.js @@ -0,0 +1 @@ +module.exports = [{"type":"doc","id":"plex/plex-api"},{"type":"category","label":"Activities","link":{"type":"doc","id":"plex/activities"},"collapsed":false,"items":[{"type":"doc","id":"plex/server-activities","label":"Server Activities","className":"api-method get"},{"type":"doc","id":"plex/cancel-server-activities","label":"Cancel Server Activities","className":"api-method delete"}]},{"type":"category","label":"Butler","link":{"type":"doc","id":"plex/butler"},"collapsed":false,"items":[{"type":"doc","id":"plex/start-all-butler-tasks","label":"Start all Butler tasks","className":"api-method post"},{"type":"doc","id":"plex/stop-all-butler-tasks","label":"Stop all Butler tasks","className":"api-method delete"},{"type":"doc","id":"plex/start-a-butler-tasks","label":"Start a single Butler task","className":"api-method post"},{"type":"doc","id":"plex/stop-a-butler-tasks","label":"Stop a single Butler task","className":"api-method delete"}]},{"type":"category","label":"Server","link":{"type":"doc","id":"plex/server"},"collapsed":false,"items":[{"type":"doc","id":"plex/server-capabilities","label":"Server Capabilities","className":"api-method get"}]},{"type":"category","label":"Updater","link":{"type":"doc","id":"plex/updater"},"collapsed":false,"items":[{"type":"doc","id":"plex/querying-update-status","label":"Querying status of updates","className":"api-method get"},{"type":"doc","id":"plex/checkingfor-updates","label":"Checking for updates","className":"api-method put"},{"type":"doc","id":"plex/applying-updates","label":"Applying updates","className":"api-method put"}]},{"type":"category","label":"Log","link":{"type":"doc","id":"plex/log"},"collapsed":false,"items":[{"type":"doc","id":"plex/loga-line","label":"Logging a single-line message to the Plex Media Server log.","className":"api-method get"},{"type":"doc","id":"plex/log-multiple-lines","label":"Logging a multi-line message to the Plex Media Server log","className":"api-method post"}]}]; \ No newline at end of file diff --git a/docs/plex/start-a-butler-tasks.api.mdx b/docs/plex/start-a-butler-tasks.api.mdx new file mode 100644 index 0000000..ba4450c --- /dev/null +++ b/docs/plex/start-a-butler-tasks.api.mdx @@ -0,0 +1,46 @@ +--- +id: start-a-butler-tasks +sidebar_label: Start a single Butler task +hide_title: true +hide_table_of_contents: true +api: {"tags":["Butler"],"description":"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:\n1. Any tasks not scheduled to run on the current day will be skipped.\n2. 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.\n3. 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.\n4. If we are outside the configured window, the task will start immediately.\n","operationId":"startAButlerTasks","parameters":[{"name":"taskName","description":"the name of the task to be started.","in":"path","schema":{"type":"string","enum":["BackupDatabase","BuildGracenoteCollections","CheckForUpdates","CleanOldBundles","CleanOldCacheFiles","DeepMediaAnalysis","GenerateAutoTags","GenerateChapterThumbs","GenerateMediaIndexFiles","OptimizeDatabase","RefreshLibraries","RefreshLocalMedia","RefreshPeriodicMetadata","UpgradeMediaAnalysis"]},"required":true}],"responses":{"200":{"description":"The task was started successfully"},"202":{"description":"The task was already running."},"401":{"description":"Unauthorized - Returned if the X-Plex-Token is missing from the header or query."}},"method":"post","path":"/butler/{taskName}","servers":[{"url":"{Protocol}://{Local IP}:{Port}","variables":{"Protocol":{"enum":["http","https"],"default":"http","description":"The protocl to use with your plex server"},"Local IP":{"default":"10.10.10.47","description":"The Local IP Address of your plex server"},"Port":{"default":"32400","description":"The port to access your plex server"}}}],"security":[{"PlexToken":[]}],"securitySchemes":{"PlexToken":{"type":"apiKey","in":"header","name":"X-Plex-Token"}},"info":{"title":"Plex-API","summary":"A Plex Media Server API Map","description":"An Open API Spec for interacting with Plex.tv and Plex Servers","version":"0.0.2","contact":{"name":"Luke Hagar","email":"Lukeslakemail@gmail.com","url":"https://www.LukeHagar.com"}},"postman":{"name":"Start a single Butler task","description":{"content":"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:\n1. Any tasks not scheduled to run on the current day will be skipped.\n2. 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.\n3. 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.\n4. If we are outside the configured window, the task will start immediately.\n","type":"text/plain"},"url":{"path":["butler",":taskName"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) the name of the task to be started.","type":"text/plain"},"type":"any","value":"","key":"taskName"}]},"method":"POST"}} +sidebar_class_name: "post api-method" +info_path: docs/plex/plex-api +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import TabItem from "@theme/TabItem"; + +

Start a single Butler 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. + + +
Path Parameters
+ +The task was started successfully + +
+ +The task was already running. + +
+ +Unauthorized - Returned if the X-Plex-Token is missing from the header or query. + +
\ No newline at end of file diff --git a/docs/plex/start-all-butler-tasks.api.mdx b/docs/plex/start-all-butler-tasks.api.mdx new file mode 100644 index 0000000..b1af142 --- /dev/null +++ b/docs/plex/start-all-butler-tasks.api.mdx @@ -0,0 +1,42 @@ +--- +id: start-all-butler-tasks +sidebar_label: Start all Butler tasks +hide_title: true +hide_table_of_contents: true +api: {"tags":["Butler"],"description":"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:\n1. Any tasks not scheduled to run on the current day will be skipped.\n2. 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.\n3. 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.\n4. If we are outside the configured window, the task will start immediately.\n","operationId":"startAllButlerTasks","responses":{"200":{"description":"All tasks were started"},"401":{"description":"Unauthorized - Returned if the X-Plex-Token is missing from the header or query."}},"method":"post","path":"/butler","servers":[{"url":"{Protocol}://{Local IP}:{Port}","variables":{"Protocol":{"enum":["http","https"],"default":"http","description":"The protocl to use with your plex server"},"Local IP":{"default":"10.10.10.47","description":"The Local IP Address of your plex server"},"Port":{"default":"32400","description":"The port to access your plex server"}}}],"security":[{"PlexToken":[]}],"securitySchemes":{"PlexToken":{"type":"apiKey","in":"header","name":"X-Plex-Token"}},"info":{"title":"Plex-API","summary":"A Plex Media Server API Map","description":"An Open API Spec for interacting with Plex.tv and Plex Servers","version":"0.0.2","contact":{"name":"Luke Hagar","email":"Lukeslakemail@gmail.com","url":"https://www.LukeHagar.com"}},"postman":{"name":"Start all Butler tasks","description":{"content":"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:\n1. Any tasks not scheduled to run on the current day will be skipped.\n2. 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.\n3. 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.\n4. If we are outside the configured window, the task will start immediately.\n","type":"text/plain"},"url":{"path":["butler"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"method":"POST"}} +sidebar_class_name: "post api-method" +info_path: docs/plex/plex-api +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import TabItem from "@theme/TabItem"; + +

Start all Butler 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. + + +
+ +All tasks were started + +
+ +Unauthorized - Returned if the X-Plex-Token is missing from the header or query. + +
\ No newline at end of file diff --git a/docs/plex/stop-a-butler-tasks.api.mdx b/docs/plex/stop-a-butler-tasks.api.mdx new file mode 100644 index 0000000..b7e0187 --- /dev/null +++ b/docs/plex/stop-a-butler-tasks.api.mdx @@ -0,0 +1,42 @@ +--- +id: stop-a-butler-tasks +sidebar_label: Stop a single Butler task +hide_title: true +hide_table_of_contents: true +api: {"tags":["Butler"],"description":"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.\n","operationId":"stopAButlerTasks","parameters":[{"name":"taskName","description":"The name of the task to be started.","in":"path","schema":{"type":"string","enum":["BackupDatabase","BuildGracenoteCollections","CheckForUpdates","CleanOldBundles","CleanOldCacheFiles","DeepMediaAnalysis","GenerateAutoTags","GenerateChapterThumbs","GenerateMediaIndexFiles","OptimizeDatabase","RefreshLibraries","RefreshLocalMedia","RefreshPeriodicMetadata","UpgradeMediaAnalysis"]},"required":true}],"responses":{"200":{"description":"The task was stopped"},"401":{"description":"Unauthorized - Returned if the X-Plex-Token is missing from the header or query."},"404":{"description":"The task was not running"}},"method":"delete","path":"/butler/{taskName}","servers":[{"url":"{Protocol}://{Local IP}:{Port}","variables":{"Protocol":{"enum":["http","https"],"default":"http","description":"The protocl to use with your plex server"},"Local IP":{"default":"10.10.10.47","description":"The Local IP Address of your plex server"},"Port":{"default":"32400","description":"The port to access your plex server"}}}],"security":[{"PlexToken":[]}],"securitySchemes":{"PlexToken":{"type":"apiKey","in":"header","name":"X-Plex-Token"}},"info":{"title":"Plex-API","summary":"A Plex Media Server API Map","description":"An Open API Spec for interacting with Plex.tv and Plex Servers","version":"0.0.2","contact":{"name":"Luke Hagar","email":"Lukeslakemail@gmail.com","url":"https://www.LukeHagar.com"}},"postman":{"name":"Stop a single Butler task","description":{"content":"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.\n","type":"text/plain"},"url":{"path":["butler",":taskName"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The name of the task to be started.","type":"text/plain"},"type":"any","value":"","key":"taskName"}]},"method":"DELETE"}} +sidebar_class_name: "delete api-method" +info_path: docs/plex/plex-api +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import TabItem from "@theme/TabItem"; + +

Stop a single Butler 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. + + +
Path Parameters
+ +The task was stopped + +
+ +Unauthorized - Returned if the X-Plex-Token is missing from the header or query. + +
+ +The task was not running + +
\ No newline at end of file diff --git a/docs/plex/stop-all-butler-tasks.api.mdx b/docs/plex/stop-all-butler-tasks.api.mdx new file mode 100644 index 0000000..9d3de88 --- /dev/null +++ b/docs/plex/stop-all-butler-tasks.api.mdx @@ -0,0 +1,38 @@ +--- +id: stop-all-butler-tasks +sidebar_label: Stop all Butler tasks +hide_title: true +hide_table_of_contents: true +api: {"tags":["Butler"],"description":"This endpoint will stop all currently running tasks and remove any scheduled tasks from the queue.\n","operationId":"stopAllButlerTasks","responses":{"200":{"description":"All tasks were stopped"},"401":{"description":"Unauthorized - Returned if the X-Plex-Token is missing from the header or query."}},"method":"delete","path":"/butler","servers":[{"url":"{Protocol}://{Local IP}:{Port}","variables":{"Protocol":{"enum":["http","https"],"default":"http","description":"The protocl to use with your plex server"},"Local IP":{"default":"10.10.10.47","description":"The Local IP Address of your plex server"},"Port":{"default":"32400","description":"The port to access your plex server"}}}],"security":[{"PlexToken":[]}],"securitySchemes":{"PlexToken":{"type":"apiKey","in":"header","name":"X-Plex-Token"}},"info":{"title":"Plex-API","summary":"A Plex Media Server API Map","description":"An Open API Spec for interacting with Plex.tv and Plex Servers","version":"0.0.2","contact":{"name":"Luke Hagar","email":"Lukeslakemail@gmail.com","url":"https://www.LukeHagar.com"}},"postman":{"name":"Stop all Butler tasks","description":{"content":"This endpoint will stop all currently running tasks and remove any scheduled tasks from the queue.\n","type":"text/plain"},"url":{"path":["butler"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"method":"DELETE"}} +sidebar_class_name: "delete api-method" +info_path: docs/plex/plex-api +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import TabItem from "@theme/TabItem"; + +

Stop all Butler tasks

+ + + + + +This endpoint will stop all currently running tasks and remove any scheduled tasks from the queue. + + +
+ +All tasks were stopped + +
+ +Unauthorized - Returned if the X-Plex-Token is missing from the header or query. + +
\ No newline at end of file diff --git a/docs/plex/updater.tag.mdx b/docs/plex/updater.tag.mdx new file mode 100644 index 0000000..a6376a8 --- /dev/null +++ b/docs/plex/updater.tag.mdx @@ -0,0 +1,22 @@ +--- +id: updater +title: "Updater" +description: "Updater" +custom_edit_url: null +--- + + + +This describes the API for searching and applying updates to the Plex Media Server. +Updates to the status can be observed via the Event API. + + + + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` + \ No newline at end of file