mirror of
https://github.com/LukeHagar/plex-mintlify-docs.git
synced 2025-12-06 04:20:40 +00:00
Saving progress
This commit is contained in:
3
api-reference/activities/cancel-server-activities.mdx
Normal file
3
api-reference/activities/cancel-server-activities.mdx
Normal file
@@ -0,0 +1,3 @@
|
||||
---
|
||||
openapi: delete /activities/{activityUUID}
|
||||
---
|
||||
3
api-reference/activities/get-server-activities.mdx
Normal file
3
api-reference/activities/get-server-activities.mdx
Normal file
@@ -0,0 +1,3 @@
|
||||
---
|
||||
openapi: get /activities
|
||||
---
|
||||
3
api-reference/authentication/get-a-transient-token.mdx
Normal file
3
api-reference/authentication/get-a-transient-token.mdx
Normal file
@@ -0,0 +1,3 @@
|
||||
---
|
||||
openapi: get /security/token
|
||||
---
|
||||
@@ -0,0 +1,3 @@
|
||||
---
|
||||
openapi: get /security/resources
|
||||
---
|
||||
3
api-reference/butler/get-butler-tasks.mdx
Normal file
3
api-reference/butler/get-butler-tasks.mdx
Normal file
@@ -0,0 +1,3 @@
|
||||
---
|
||||
openapi: get /butler
|
||||
---
|
||||
3
api-reference/butler/start-a-single-butler-task.mdx
Normal file
3
api-reference/butler/start-a-single-butler-task.mdx
Normal file
@@ -0,0 +1,3 @@
|
||||
---
|
||||
openapi: post /butler/{taskName}
|
||||
---
|
||||
3
api-reference/butler/start-all-butler-tasks.mdx
Normal file
3
api-reference/butler/start-all-butler-tasks.mdx
Normal file
@@ -0,0 +1,3 @@
|
||||
---
|
||||
openapi: post /butler
|
||||
---
|
||||
3
api-reference/butler/stop-a-single-butler-task.mdx
Normal file
3
api-reference/butler/stop-a-single-butler-task.mdx
Normal file
@@ -0,0 +1,3 @@
|
||||
---
|
||||
openapi: delete /butler/{taskName}
|
||||
---
|
||||
3
api-reference/butler/stop-all-butler-tasks.mdx
Normal file
3
api-reference/butler/stop-all-butler-tasks.mdx
Normal file
@@ -0,0 +1,3 @@
|
||||
---
|
||||
openapi: delete /butler
|
||||
---
|
||||
@@ -1,4 +0,0 @@
|
||||
---
|
||||
title: 'Create Plant'
|
||||
openapi: 'POST /plants'
|
||||
---
|
||||
@@ -1,4 +0,0 @@
|
||||
---
|
||||
title: 'Delete Plant'
|
||||
openapi: 'DELETE /plants/{id}'
|
||||
---
|
||||
@@ -1,4 +0,0 @@
|
||||
---
|
||||
title: 'Get Plants'
|
||||
openapi: 'GET /plants'
|
||||
---
|
||||
3
api-reference/hubs/get-global-hubs.mdx
Normal file
3
api-reference/hubs/get-global-hubs.mdx
Normal file
@@ -0,0 +1,3 @@
|
||||
---
|
||||
openapi: get /hubs
|
||||
---
|
||||
3
api-reference/hubs/get-library-specific-hubs.mdx
Normal file
3
api-reference/hubs/get-library-specific-hubs.mdx
Normal file
@@ -0,0 +1,3 @@
|
||||
---
|
||||
openapi: get /hubs/sections/{sectionId}
|
||||
---
|
||||
@@ -1,33 +0,0 @@
|
||||
---
|
||||
title: 'Introduction'
|
||||
description: 'Example section for showcasing API endpoints'
|
||||
---
|
||||
|
||||
<Note>
|
||||
If you're not looking to build API reference documentation, you can delete
|
||||
this section by removing the api-reference folder.
|
||||
</Note>
|
||||
|
||||
## Welcome
|
||||
|
||||
There are two ways to build API documentation: [OpenAPI](https://mintlify.com/docs/api-playground/openapi/setup) and [MDX components](https://mintlify.com/docs/api-playground/mdx/configuration). For the starter kit, we are using the following OpenAPI specification.
|
||||
|
||||
<Card
|
||||
title="Plant Store Endpoints"
|
||||
icon="leaf"
|
||||
href="https://github.com/mintlify/starter/blob/main/api-reference/openapi.json"
|
||||
>
|
||||
View the OpenAPI specification file
|
||||
</Card>
|
||||
|
||||
## Authentication
|
||||
|
||||
All API endpoints are authenticated using Bearer tokens and picked up from the specification file.
|
||||
|
||||
```json
|
||||
"security": [
|
||||
{
|
||||
"bearerAuth": []
|
||||
}
|
||||
]
|
||||
```
|
||||
3
api-reference/library/delete-library-section.mdx
Normal file
3
api-reference/library/delete-library-section.mdx
Normal file
@@ -0,0 +1,3 @@
|
||||
---
|
||||
openapi: delete /library/sections/{sectionId}
|
||||
---
|
||||
3
api-reference/library/get-all-libraries.mdx
Normal file
3
api-reference/library/get-all-libraries.mdx
Normal file
@@ -0,0 +1,3 @@
|
||||
---
|
||||
openapi: get /library/sections
|
||||
---
|
||||
3
api-reference/library/get-hash-value.mdx
Normal file
3
api-reference/library/get-hash-value.mdx
Normal file
@@ -0,0 +1,3 @@
|
||||
---
|
||||
openapi: get /library/hashes
|
||||
---
|
||||
3
api-reference/library/get-items-children.mdx
Normal file
3
api-reference/library/get-items-children.mdx
Normal file
@@ -0,0 +1,3 @@
|
||||
---
|
||||
openapi: get /library/metadata/{ratingKey}/children
|
||||
---
|
||||
3
api-reference/library/get-items-metadata.mdx
Normal file
3
api-reference/library/get-items-metadata.mdx
Normal file
@@ -0,0 +1,3 @@
|
||||
---
|
||||
openapi: get /library/metadata/{ratingKey}
|
||||
---
|
||||
3
api-reference/library/get-library-details.mdx
Normal file
3
api-reference/library/get-library-details.mdx
Normal file
@@ -0,0 +1,3 @@
|
||||
---
|
||||
openapi: get /library/sections/{sectionId}
|
||||
---
|
||||
3
api-reference/library/get-library-items.mdx
Normal file
3
api-reference/library/get-library-items.mdx
Normal file
@@ -0,0 +1,3 @@
|
||||
---
|
||||
openapi: get /library/sections/{sectionId}/{tag}
|
||||
---
|
||||
3
api-reference/library/get-on-deck.mdx
Normal file
3
api-reference/library/get-on-deck.mdx
Normal file
@@ -0,0 +1,3 @@
|
||||
---
|
||||
openapi: get /library/onDeck
|
||||
---
|
||||
3
api-reference/library/get-recently-added.mdx
Normal file
3
api-reference/library/get-recently-added.mdx
Normal file
@@ -0,0 +1,3 @@
|
||||
---
|
||||
openapi: get /library/recentlyAdded
|
||||
---
|
||||
3
api-reference/library/refresh-library.mdx
Normal file
3
api-reference/library/refresh-library.mdx
Normal file
@@ -0,0 +1,3 @@
|
||||
---
|
||||
openapi: get /library/sections/{sectionId}/refresh
|
||||
---
|
||||
3
api-reference/library/search-library.mdx
Normal file
3
api-reference/library/search-library.mdx
Normal file
@@ -0,0 +1,3 @@
|
||||
---
|
||||
openapi: get /library/sections/{sectionId}/search
|
||||
---
|
||||
3
api-reference/log/enabling-papertrail.mdx
Normal file
3
api-reference/log/enabling-papertrail.mdx
Normal file
@@ -0,0 +1,3 @@
|
||||
---
|
||||
openapi: get /log/networked
|
||||
---
|
||||
3
api-reference/log/logging-a-multi-line-message.mdx
Normal file
3
api-reference/log/logging-a-multi-line-message.mdx
Normal file
@@ -0,0 +1,3 @@
|
||||
---
|
||||
openapi: post /log
|
||||
---
|
||||
3
api-reference/log/logging-a-single-line-message.mdx
Normal file
3
api-reference/log/logging-a-single-line-message.mdx
Normal file
@@ -0,0 +1,3 @@
|
||||
---
|
||||
openapi: get /log
|
||||
---
|
||||
3
api-reference/media/mark-media-played.mdx
Normal file
3
api-reference/media/mark-media-played.mdx
Normal file
@@ -0,0 +1,3 @@
|
||||
---
|
||||
openapi: get /:/scrobble
|
||||
---
|
||||
3
api-reference/media/mark-media-unplayed.mdx
Normal file
3
api-reference/media/mark-media-unplayed.mdx
Normal file
@@ -0,0 +1,3 @@
|
||||
---
|
||||
openapi: get /:/unscrobble
|
||||
---
|
||||
3
api-reference/media/update-media-play-progress.mdx
Normal file
3
api-reference/media/update-media-play-progress.mdx
Normal file
@@ -0,0 +1,3 @@
|
||||
---
|
||||
openapi: post /:/progress
|
||||
---
|
||||
3
api-reference/playlists/adding-to-a-playlist.mdx
Normal file
3
api-reference/playlists/adding-to-a-playlist.mdx
Normal file
@@ -0,0 +1,3 @@
|
||||
---
|
||||
openapi: put /playlists/{playlistID}/items
|
||||
---
|
||||
3
api-reference/playlists/create-a-playlist.mdx
Normal file
3
api-reference/playlists/create-a-playlist.mdx
Normal file
@@ -0,0 +1,3 @@
|
||||
---
|
||||
openapi: post /playlists
|
||||
---
|
||||
3
api-reference/playlists/delete-playlist-contents.mdx
Normal file
3
api-reference/playlists/delete-playlist-contents.mdx
Normal file
@@ -0,0 +1,3 @@
|
||||
---
|
||||
openapi: delete /playlists/{playlistID}/items
|
||||
---
|
||||
3
api-reference/playlists/deletes-a-playlist.mdx
Normal file
3
api-reference/playlists/deletes-a-playlist.mdx
Normal file
@@ -0,0 +1,3 @@
|
||||
---
|
||||
openapi: delete /playlists/{playlistID}
|
||||
---
|
||||
3
api-reference/playlists/get-all-playlists.mdx
Normal file
3
api-reference/playlists/get-all-playlists.mdx
Normal file
@@ -0,0 +1,3 @@
|
||||
---
|
||||
openapi: get /playlists
|
||||
---
|
||||
3
api-reference/playlists/retrieve-playlist-contents.mdx
Normal file
3
api-reference/playlists/retrieve-playlist-contents.mdx
Normal file
@@ -0,0 +1,3 @@
|
||||
---
|
||||
openapi: get /playlists/{playlistID}/items
|
||||
---
|
||||
3
api-reference/playlists/retrieve-playlist.mdx
Normal file
3
api-reference/playlists/retrieve-playlist.mdx
Normal file
@@ -0,0 +1,3 @@
|
||||
---
|
||||
openapi: get /playlists/{playlistID}
|
||||
---
|
||||
3
api-reference/playlists/update-a-playlist.mdx
Normal file
3
api-reference/playlists/update-a-playlist.mdx
Normal file
@@ -0,0 +1,3 @@
|
||||
---
|
||||
openapi: put /playlists/{playlistID}
|
||||
---
|
||||
3
api-reference/playlists/upload-playlist.mdx
Normal file
3
api-reference/playlists/upload-playlist.mdx
Normal file
@@ -0,0 +1,3 @@
|
||||
---
|
||||
openapi: post /playlists/upload
|
||||
---
|
||||
3
api-reference/plex/get-a-pin.mdx
Normal file
3
api-reference/plex/get-a-pin.mdx
Normal file
@@ -0,0 +1,3 @@
|
||||
---
|
||||
openapi: post /pins
|
||||
---
|
||||
3
api-reference/plex/get-access-token.mdx
Normal file
3
api-reference/plex/get-access-token.mdx
Normal file
@@ -0,0 +1,3 @@
|
||||
---
|
||||
openapi: get /pins/{pinID}
|
||||
---
|
||||
3
api-reference/search/get-search-results.mdx
Normal file
3
api-reference/search/get-search-results.mdx
Normal file
@@ -0,0 +1,3 @@
|
||||
---
|
||||
openapi: get /search
|
||||
---
|
||||
3
api-reference/search/perform-a-search.mdx
Normal file
3
api-reference/search/perform-a-search.mdx
Normal file
@@ -0,0 +1,3 @@
|
||||
---
|
||||
openapi: get /hubs/search
|
||||
---
|
||||
3
api-reference/search/perform-a-voice-search.mdx
Normal file
3
api-reference/search/perform-a-voice-search.mdx
Normal file
@@ -0,0 +1,3 @@
|
||||
---
|
||||
openapi: get /hubs/search/voice
|
||||
---
|
||||
3
api-reference/server/get-a-resized-photo.mdx
Normal file
3
api-reference/server/get-a-resized-photo.mdx
Normal file
@@ -0,0 +1,3 @@
|
||||
---
|
||||
openapi: get /photo/:/transcode
|
||||
---
|
||||
3
api-reference/server/get-available-clients.mdx
Normal file
3
api-reference/server/get-available-clients.mdx
Normal file
@@ -0,0 +1,3 @@
|
||||
---
|
||||
openapi: get /clients
|
||||
---
|
||||
3
api-reference/server/get-devices.mdx
Normal file
3
api-reference/server/get-devices.mdx
Normal file
@@ -0,0 +1,3 @@
|
||||
---
|
||||
openapi: get /devices
|
||||
---
|
||||
3
api-reference/server/get-myplex-account.mdx
Normal file
3
api-reference/server/get-myplex-account.mdx
Normal file
@@ -0,0 +1,3 @@
|
||||
---
|
||||
openapi: get /myplex/account
|
||||
---
|
||||
3
api-reference/server/get-server-identity.mdx
Normal file
3
api-reference/server/get-server-identity.mdx
Normal file
@@ -0,0 +1,3 @@
|
||||
---
|
||||
openapi: get /identity
|
||||
---
|
||||
3
api-reference/server/get-server-list.mdx
Normal file
3
api-reference/server/get-server-list.mdx
Normal file
@@ -0,0 +1,3 @@
|
||||
---
|
||||
openapi: get /servers
|
||||
---
|
||||
3
api-reference/server/get-server-preferences.mdx
Normal file
3
api-reference/server/get-server-preferences.mdx
Normal file
@@ -0,0 +1,3 @@
|
||||
---
|
||||
openapi: get /:/prefs
|
||||
---
|
||||
3
api-reference/server/server-capabilities.mdx
Normal file
3
api-reference/server/server-capabilities.mdx
Normal file
@@ -0,0 +1,3 @@
|
||||
---
|
||||
openapi: get /
|
||||
---
|
||||
3
api-reference/sessions/get-active-sessions.mdx
Normal file
3
api-reference/sessions/get-active-sessions.mdx
Normal file
@@ -0,0 +1,3 @@
|
||||
---
|
||||
openapi: get /status/sessions
|
||||
---
|
||||
3
api-reference/sessions/get-session-history.mdx
Normal file
3
api-reference/sessions/get-session-history.mdx
Normal file
@@ -0,0 +1,3 @@
|
||||
---
|
||||
openapi: get /status/sessions/history/all
|
||||
---
|
||||
3
api-reference/sessions/get-transcode-sessions.mdx
Normal file
3
api-reference/sessions/get-transcode-sessions.mdx
Normal file
@@ -0,0 +1,3 @@
|
||||
---
|
||||
openapi: get /transcode/sessions
|
||||
---
|
||||
3
api-reference/sessions/stop-a-transcode-session.mdx
Normal file
3
api-reference/sessions/stop-a-transcode-session.mdx
Normal file
@@ -0,0 +1,3 @@
|
||||
---
|
||||
openapi: delete /transcode/sessions/{sessionKey}
|
||||
---
|
||||
3
api-reference/statistics/get-media-statistics.mdx
Normal file
3
api-reference/statistics/get-media-statistics.mdx
Normal file
@@ -0,0 +1,3 @@
|
||||
---
|
||||
openapi: get /statistics/media
|
||||
---
|
||||
3
api-reference/updater/apply-updates.mdx
Normal file
3
api-reference/updater/apply-updates.mdx
Normal file
@@ -0,0 +1,3 @@
|
||||
---
|
||||
openapi: put /updater/apply
|
||||
---
|
||||
3
api-reference/updater/checking-for-updates.mdx
Normal file
3
api-reference/updater/checking-for-updates.mdx
Normal file
@@ -0,0 +1,3 @@
|
||||
---
|
||||
openapi: put /updater/check
|
||||
---
|
||||
3
api-reference/updater/querying-status-of-updates.mdx
Normal file
3
api-reference/updater/querying-status-of-updates.mdx
Normal file
@@ -0,0 +1,3 @@
|
||||
---
|
||||
openapi: get /updater/status
|
||||
---
|
||||
@@ -0,0 +1,3 @@
|
||||
---
|
||||
openapi: get /:/timeline
|
||||
---
|
||||
3
api-reference/video/start-universal-transcode.mdx
Normal file
3
api-reference/video/start-universal-transcode.mdx
Normal file
@@ -0,0 +1,3 @@
|
||||
---
|
||||
openapi: get /video/:/transcode/universal/start.mpd
|
||||
---
|
||||
Reference in New Issue
Block a user