mirror of
https://github.com/LukeHagar/plex-docs.git
synced 2025-12-06 12:37:45 +00:00
37 lines
7.2 KiB
Plaintext
37 lines
7.2 KiB
Plaintext
---
|
|
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"}}},{"url":"https://plex.tv/api/v2"}],"security":[{"PlexToken":[]}],"securitySchemes":{"PlexToken":{"type":"apiKey","in":"header","name":"X-Plex-Token"}},"info":{"title":"Plex-API","description":"An Open API Spec for interacting with Plex.tv and Plex Servers","version":"0.0.1","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";
|
|
|
|
<h1 className={"openapi__heading"}>Cancel Server Activities</h1>
|
|
|
|
<MethodEndpoint method={"delete"} path={"/activities/{activityUUID}"}></MethodEndpoint>
|
|
|
|
|
|
|
|
Cancel Server Activities
|
|
|
|
<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><strong>Path Parameters</strong></summary><div><ul><ParamsItem className={"paramsItem"} param={{"name":"activityUUID","description":"The UUID of the activity to cancel.","in":"path","schema":{"type":"string"},"example":"25b71ed5-0f9d-461c-baa7-d404e9e10d3e","required":true}}></ParamsItem></ul></div></details><div><div><ApiTabs><TabItem label={"200"} value={"200"}><div>
|
|
|
|
The Server Activity was canceled
|
|
|
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{"textAlign":"left"}}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><strong>MediaContainer</strong><span style={{"opacity":"0.6"}}> object</span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"size"} required={false} schemaName={"number"} qualifierMessage={undefined} schema={{"type":"number"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><strong>Activity</strong><span style={{"opacity":"0.6"}}> object[]</span></summary><div style={{"marginLeft":"1rem"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"uuid"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"cancellable"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean"}}></SchemaItem><SchemaItem collapsible={false} name={"userID"} required={false} schemaName={"number"} qualifierMessage={undefined} schema={{"type":"number"}}></SchemaItem><SchemaItem collapsible={false} name={"title"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"subtitle"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"progress"} required={false} schemaName={"number"} qualifierMessage={undefined} schema={{"type":"number"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><strong>Context</strong><span style={{"opacity":"0.6"}}> object</span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"librarySectionID"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string"}}></SchemaItem></div></details></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"MediaContainer\": {\n \"size\": 0,\n \"Activity\": [\n {\n \"uuid\": \"string\",\n \"type\": \"string\",\n \"cancellable\": true,\n \"userID\": 0,\n \"title\": \"string\",\n \"subtitle\": \"string\",\n \"progress\": 0,\n \"Context\": {\n \"librarySectionID\": \"string\"\n }\n }\n ]\n }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>
|
|
|
|
Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
|
|
|
|
</div><div></div></TabItem></ApiTabs></div></div> |