How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Plex Subscriptions API

Subscriptions determine which media will be recorded and the criteria for selecting an airing when multiple are available

Plex Subscriptions API is one of 31 APIs that Plex publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Subscription. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 10 operations across 7 paths, and defines 13 schemas. It is described by OpenAPI 3.2.0, at version 1.2.2 .

Requests are made against a single base URL, https://{IP-description}.{identifier}.plex.direct:{port}.

10 operations 7 paths 13 schemas 2 DELETE4 GET2 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.2.2
Base URL
https://1-2-3-4.0123456789abcdef0123456789abcdef.plex.direct:32400
Authentication
API Key
License
Resource Areas
1

Authentication & Security 1

Plex Subscriptions API declares 1 security scheme for authenticating requests. An API key is passed in the header as X-Plex-Token (user_token). By default, every request must be authenticated.

  • user_token — The token which identifies the user accessing the PMS. This is typically provided to the client by plex.tv. This can be either a traditional access token or a…

Paths & Operations 10

Across 7 paths, the API surfaces 10 operations — 2 DELETE, 4 GET, 2 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Subscriptions 10

Subscriptions determine which media will be recorded and the criteria for selecting an airing when multiple are available

DELETE
/media/grabbers/operations/{operationId}
Cancel an existing grab
mediaGrabberDeleteOperationsOperation 1 param → 200403404
GET
/media/subscriptions
Get all subscriptions
mediaSubscriptionsGetSlash 2 params → 200403
POST
/media/subscriptions
Create a subscription
mediaSubscriptionsPostSlash 6 params → 200400403409
POST
/media/subscriptions/process
Process all subscriptions
mediaSubscriptionsPostProcess → 200403
GET
/media/subscriptions/{subscriptionId}
Get a single subscription
mediaSubscriptionsGetSubscription 3 params → 200400403404
DELETE
/media/subscriptions/{subscriptionId}
Delete a subscription
mediaSubscriptionsDeleteSubscription 1 param → 200400403404
PUT
/media/subscriptions/{subscriptionId}
Edit a subscription
mediaSubscriptionsPutSubscription 2 params → 200400403404
PUT
/media/subscriptions/{subscriptionId}/move
Re-order a subscription
mediaSubscriptionsPutSubscriptionMove 2 params → 200400403404
GET
/media/subscriptions/scheduled
Get all scheduled recordings
mediaSubscriptionsGetScheduled → 200403
GET
/media/subscriptions/template
Get the subscription template
mediaSubscriptionsGetTemplate 1 param → 200403

Schemas 13

The contract defines 13 schemas that model the data the API accepts and returns. The most detailed are metadata (67 properties), stream (29 properties), media (18 properties), mediaSubscription (16 properties). Each schema is shown below with its type and property counts.

MediaContainer
object
4 properties
mediaContainerWithSubscription
object
1 property
mediaGrabOperation
object
A media grab opration represents a scheduled or active recording of media
11 properties
mediaSubscription
object
A media subscription contains a representation of metadata desired to be recorded
16 properties
directory
object
15 properties
image
object
Images such as movie posters and background artwork are represented by Image elements.
3 properties
part
object
Part represents a particular file or "part" of a media item. The part is the playable unit of the media hierarchy. Suppose that a movie library contains a movi…
11 properties
sort
metadata
object
Items in a library are referred to as "metadata items." These metadata items are distinct from "media items" which represent actual instances of media that can…
67 properties
stream
object
Stream represents a particular stream from a media item, such as the video stream, audio stream, or subtitle stream. The stream may either be part of the file…
29 properties
media
object
Media represents an one or more media files (parts) and is a child of a metadata item. There aren't necessarily any guaranteed attributes on media elements sin…
18 properties
filter
tag
object
A variety of extra information about a metadata item is included as tags. These tags use their own element names such as Genre, Writer, Directory, and Role. In…
10 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

plex-subscriptions-api-openapi.yml Raw ↑

Other APIs Plex publishes across the network.

Plex Account and Authentication API
Plex MCP Server
Plex Activities API
Plex Butler API
Plex Collections API
Plex Content API
Plex Devices API
Plex Download Queue API
Plex DV Rs API
Plex EPG API
Plex Events API
Plex General API
Where this information came from

This is an independent, third-party profile of Plex Subscriptions API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.