Skip to content

Repository files navigation

Rust API client for seerr

This is the documentation for the Seerr API backend.

Two primary authentication methods are supported:

  • Cookie Authentication: A valid sign-in to the /auth/plex or /auth/local will generate a valid authentication cookie.
  • API Key Authentication: Sign-in is also possible by passing an X-Api-Key header along with a valid API Key generated by Seerr.

Overview

This API client was generated by the OpenAPI Generator project. By using the openapi-spec from a remote server, you can easily generate an API client.

  • API version: v3.4.1
  • Package version: eerr-v0.2.0
  • Generator version: 7.24.0
  • Build package: org.openapitools.codegen.languages.RustClientCodegen

Installation

Put the package under your project folder in a directory named seerr and add the following to Cargo.toml under [dependencies]:

seerr = { path = "./seerr" }

Documentation for API Endpoints

All URIs are relative to http://localhost:5055/api/v1

ClassMethodHTTP requestDescription
AuthApicreate_auth_jellyfinPOST /auth/jellyfinSign in using a Jellyfin username and password
AuthApicreate_auth_jellyfin_quickconnect_authenticatePOST /auth/jellyfin/quickconnect/authenticateAuthenticate with Quick Connect
AuthApicreate_auth_jellyfin_quickconnect_initiatePOST /auth/jellyfin/quickconnect/initiateInitiate Jellyfin Quick Connect
AuthApicreate_auth_localPOST /auth/localSign in using a local account
AuthApicreate_auth_logoutPOST /auth/logoutSign out and clear session cookie
AuthApicreate_auth_plexPOST /auth/plexSign in using a Plex token
AuthApiget_auth_jellyfin_quickconnect_checkGET /auth/jellyfin/quickconnect/checkCheck Quick Connect authorization status
AuthApiget_auth_meGET /auth/meGet logged-in user
BlocklistApicreate_blacklistPOST /blacklistAdd media to blocklist
BlocklistApicreate_blocklistPOST /blocklistAdd media to blocklist
BlocklistApicreate_blocklist_collection_by_collection_idPOST /blocklist/collection/{collectionId}Add collection to blocklist
BlocklistApidelete_blacklistDELETE /blacklist/{tmdbId}Remove media from blocklist
BlocklistApidelete_blocklistDELETE /blocklist/{tmdbId}Remove media from blocklist
BlocklistApidelete_blocklist_collectionDELETE /blocklist/collection/{collectionId}Remove collection from blocklist
BlocklistApiget_blacklistGET /blacklistReturns blocklisted items
BlocklistApiget_blacklist_by_tmdb_idGET /blacklist/{tmdbId}Get media from blocklist
BlocklistApiget_blocklistGET /blocklistReturns blocklisted items
BlocklistApiget_blocklist_by_tmdb_idGET /blocklist/{tmdbId}Get media from blocklist
CollectionApiget_collection_by_collection_idGET /collection/{collectionId}Get collection details
IssueApicreate_issuePOST /issueCreate new issue
IssueApicreate_issue_by_statusPOST /issue/{issueId}/{status}Update an issue's status
IssueApicreate_issue_commentPOST /issue/{issueId}/commentCreate a comment
IssueApidelete_issueDELETE /issue/{issueId}Delete issue
IssueApidelete_issue_commentDELETE /issueComment/{commentId}Delete issue comment
IssueApiget_issueGET /issueGet all issues
IssueApiget_issue_by_issue_idGET /issue/{issueId}Get issue
IssueApiget_issue_comment_by_comment_idGET /issueComment/{commentId}Get issue comment
IssueApiget_issue_countGET /issue/countGets issue counts
IssueApiupdate_issue_commentPUT /issueComment/{commentId}Update issue comment
MediaApicreate_media_by_statusPOST /media/{mediaId}/{status}Update media status
MediaApidelete_mediaDELETE /media/{mediaId}Delete media item
MediaApidelete_media_fileDELETE /media/{mediaId}/fileDelete media file
MediaApiget_mediaGET /mediaGet media
MediaApiget_media_watch_dataGET /media/{mediaId}/watch_dataGet watch data
MoviesApiget_movie_by_movie_idGET /movie/{movieId}Get movie details
MoviesApiget_movie_ratingsGET /movie/{movieId}/ratingsGet movie ratings
MoviesApiget_movie_ratingscombinedGET /movie/{movieId}/ratingscombinedGet RT and IMDB movie ratings combined
MoviesApiget_movie_recommendationsGET /movie/{movieId}/recommendationsGet recommended movies
MoviesApiget_movie_similarGET /movie/{movieId}/similarGet similar movies
OtherApiget_certifications_movieGET /certifications/movieGet movie certifications
OtherApiget_certifications_tvGET /certifications/tvGet TV certifications
OtherApiget_keyword_by_keyword_idGET /keyword/{keywordId}Get keyword
OtherApilist_watchproviders_moviesGET /watchproviders/moviesGet watch provider movies
OtherApilist_watchproviders_regionsGET /watchproviders/regionsGet watch provider regions
OtherApilist_watchproviders_tvGET /watchproviders/tvGet watch provider series
OverrideruleApicreate_overriderulePOST /overrideRuleCreate override rule
OverrideruleApidelete_overrideruleDELETE /overrideRule/{ruleId}Delete override rule by ID
OverrideruleApilist_overrideruleGET /overrideRuleGet override rules
OverrideruleApiupdate_overriderulePUT /overrideRule/{ruleId}Update override rule
PersonApiget_person_by_person_idGET /person/{personId}Get person details
PersonApiget_person_combined_creditsGET /person/{personId}/combined_creditsGet combined credits
PublicApiget_statusGET /statusGet Seerr status
PublicApiget_status_appdataGET /status/appdataGet application data volume status
RequestApicreate_requestPOST /requestCreate new request
RequestApicreate_request_by_statusPOST /request/{requestId}/{status}Update a request's status
RequestApicreate_request_retryPOST /request/{requestId}/retryRetry failed request
RequestApidelete_requestDELETE /request/{requestId}Delete request
RequestApiget_requestGET /requestGet all requests
RequestApiget_request_by_request_idGET /request/{requestId}Get MediaRequest
RequestApiget_request_countGET /request/countGets request counts
RequestApiupdate_requestPUT /request/{requestId}Update MediaRequest
SearchApiget_discover_keyword_moviesGET /discover/keyword/{keywordId}/moviesGet movies from keyword
SearchApiget_discover_moviesGET /discover/moviesDiscover movies
SearchApiget_discover_movies_genre_by_genre_idGET /discover/movies/genre/{genreId}Discover movies by genre
SearchApiget_discover_movies_language_by_languageGET /discover/movies/language/{language}Discover movies by original language
SearchApiget_discover_movies_studio_by_studio_idGET /discover/movies/studio/{studioId}Discover movies by studio
SearchApiget_discover_movies_upcomingGET /discover/movies/upcomingUpcoming movies
SearchApiget_discover_trendingGET /discover/trendingTrending movies and TV
SearchApiget_discover_tvGET /discover/tvDiscover TV shows
SearchApiget_discover_tv_genre_by_genre_idGET /discover/tv/genre/{genreId}Discover TV shows by genre
SearchApiget_discover_tv_language_by_languageGET /discover/tv/language/{language}Discover TV shows by original language
SearchApiget_discover_tv_network_by_network_idGET /discover/tv/network/{networkId}Discover TV shows by network
SearchApiget_discover_tv_upcomingGET /discover/tv/upcomingDiscover Upcoming TV shows
SearchApiget_discover_watchlistGET /discover/watchlistGet the Plex watchlist.
SearchApiget_searchGET /searchSearch for movies, TV shows, or people
SearchApiget_search_companyGET /search/companySearch for companies
SearchApiget_search_keywordGET /search/keywordSearch for keywords
SearchApilist_discover_genreslider_movieGET /discover/genreslider/movieGet genre slider data for movies
SearchApilist_discover_genreslider_tvGET /discover/genreslider/tvGet genre slider data for TV series
ServiceApiget_service_radarr_by_radarr_idGET /service/radarr/{radarrId}Get Radarr server quality profiles and root folders
ServiceApiget_service_sonarr_by_sonarr_idGET /service/sonarr/{sonarrId}Get Sonarr server quality profiles and root folders
ServiceApilist_service_radarrGET /service/radarrGet non-sensitive Radarr server list
ServiceApilist_service_sonarrGET /service/sonarrGet non-sensitive Sonarr server list
ServiceApilist_service_sonarr_lookup_by_tmdb_idGET /service/sonarr/lookup/{tmdbId}Get series from Sonarr
SettingsApicreate_cache_dns_flushPOST /settings/cache/dns/{dnsEntry}/flushFlush a specific DNS cache entry
SettingsApicreate_cache_flushPOST /settings/cache/{cacheId}/flushFlush a specific cache
SettingsApicreate_discoverPOST /settings/discoverBatch update all sliders.
SettingsApicreate_discover_addPOST /settings/discover/addAdd a new slider
SettingsApicreate_initializePOST /settings/initializeInitialize application
SettingsApicreate_jellyfinPOST /settings/jellyfinUpdate Jellyfin settings
SettingsApicreate_jellyfin_syncPOST /settings/jellyfin/syncStart full Jellyfin library sync
SettingsApicreate_jobs_cancelPOST /settings/jobs/{jobId}/cancelCancel a specific job
SettingsApicreate_jobs_runPOST /settings/jobs/{jobId}/runInvoke a specific job
SettingsApicreate_jobs_schedulePOST /settings/jobs/{jobId}/scheduleModify job schedule
SettingsApicreate_mainPOST /settings/mainUpdate main settings
SettingsApicreate_main_regeneratePOST /settings/main/regenerateGet main settings with newly-generated API key
SettingsApicreate_networkPOST /settings/networkUpdate network settings
SettingsApicreate_notifications_discordPOST /settings/notifications/discordUpdate Discord notification settings
SettingsApicreate_notifications_emailPOST /settings/notifications/emailUpdate email notification settings
SettingsApicreate_notifications_gotifyPOST /settings/notifications/gotifyUpdate Gotify notification settings
SettingsApicreate_notifications_ntfyPOST /settings/notifications/ntfyUpdate ntfy.sh notification settings
SettingsApicreate_notifications_pushbulletPOST /settings/notifications/pushbulletUpdate Pushbullet notification settings
SettingsApicreate_notifications_pushoverPOST /settings/notifications/pushoverUpdate Pushover notification settings
SettingsApicreate_notifications_slackPOST /settings/notifications/slackUpdate Slack notification settings
SettingsApicreate_notifications_telegramPOST /settings/notifications/telegramUpdate Telegram notification settings
SettingsApicreate_notifications_webhookPOST /settings/notifications/webhookUpdate webhook notification settings
SettingsApicreate_notifications_webpushPOST /settings/notifications/webpushUpdate Web Push notification settings
SettingsApicreate_plexPOST /settings/plexUpdate Plex settings
SettingsApicreate_plex_syncPOST /settings/plex/syncStart full Plex library scan
SettingsApicreate_radarrPOST /settings/radarrCreate Radarr instance
SettingsApicreate_sonarrPOST /settings/sonarrCreate Sonarr instance
SettingsApicreate_tautulliPOST /settings/tautulliUpdate Tautulli settings
SettingsApidelete_discoverDELETE /settings/discover/{sliderId}Delete slider by ID
SettingsApidelete_radarrDELETE /settings/radarr/{radarrId}Delete Radarr instance
SettingsApidelete_sonarrDELETE /settings/sonarr/{sonarrId}Delete Sonarr instance
SettingsApiget_aboutGET /settings/aboutGet server stats
SettingsApiget_cacheGET /settings/cacheGet a list of active caches
SettingsApiget_discover_resetGET /settings/discover/resetReset all discover sliders
SettingsApiget_jellyfinGET /settings/jellyfinGet Jellyfin settings
SettingsApiget_jellyfin_syncGET /settings/jellyfin/syncGet status of full Jellyfin library sync
SettingsApiget_mainGET /settings/mainGet main settings
SettingsApiget_metadatasGET /settings/metadatasGet Metadata settings
SettingsApiget_networkGET /settings/networkGet network settings
SettingsApiget_notifications_discordGET /settings/notifications/discordGet Discord notification settings
SettingsApiget_notifications_emailGET /settings/notifications/emailGet email notification settings
SettingsApiget_notifications_gotifyGET /settings/notifications/gotifyGet Gotify notification settings
SettingsApiget_notifications_ntfyGET /settings/notifications/ntfyGet ntfy.sh notification settings
SettingsApiget_notifications_pushbulletGET /settings/notifications/pushbulletGet Pushbullet notification settings
SettingsApiget_notifications_pushoverGET /settings/notifications/pushoverGet Pushover notification settings
SettingsApiget_notifications_slackGET /settings/notifications/slackGet Slack notification settings
SettingsApiget_notifications_telegramGET /settings/notifications/telegramGet Telegram notification settings
SettingsApiget_notifications_webhookGET /settings/notifications/webhookGet webhook notification settings
SettingsApiget_notifications_webpushGET /settings/notifications/webpushGet Web Push notification settings
SettingsApiget_plexGET /settings/plexGet Plex settings
SettingsApiget_plex_syncGET /settings/plex/syncGet status of full Plex library scan
SettingsApiget_publicGET /settings/publicGet public settings
SettingsApiget_tautulliGET /settings/tautulliGet Tautulli settings
SettingsApilist_discoverGET /settings/discoverGet all discover sliders
SettingsApilist_jellyfin_libraryGET /settings/jellyfin/libraryGet Jellyfin libraries
SettingsApilist_jellyfin_usersGET /settings/jellyfin/usersGet Jellyfin Users
SettingsApilist_jobsGET /settings/jobsGet scheduled jobs
SettingsApilist_logsGET /settings/logsReturns logs
SettingsApilist_notifications_pushover_soundsGET /settings/notifications/pushover/soundsGet Pushover sounds
SettingsApilist_plex_devices_serversGET /settings/plex/devices/serversGets the user's available Plex servers
SettingsApilist_plex_libraryGET /settings/plex/libraryGet Plex libraries
SettingsApilist_plex_usersGET /settings/plex/usersGet Plex users
SettingsApilist_radarrGET /settings/radarrGet Radarr settings
SettingsApilist_radarr_profilesGET /settings/radarr/{radarrId}/profilesGet available Radarr profiles
SettingsApilist_sonarrGET /settings/sonarrGet Sonarr settings
SettingsApiput_metadatasPUT /settings/metadatasUpdate Metadata settings
SettingsApitest_metadatasPOST /settings/metadatas/testTest Provider configuration
SettingsApitest_notifications_discordPOST /settings/notifications/discord/testTest Discord settings
SettingsApitest_notifications_emailPOST /settings/notifications/email/testTest email settings
SettingsApitest_notifications_gotifyPOST /settings/notifications/gotify/testTest Gotify settings
SettingsApitest_notifications_ntfyPOST /settings/notifications/ntfy/testTest ntfy.sh settings
SettingsApitest_notifications_pushbulletPOST /settings/notifications/pushbullet/testTest Pushbullet settings
SettingsApitest_notifications_pushoverPOST /settings/notifications/pushover/testTest Pushover settings
SettingsApitest_notifications_slackPOST /settings/notifications/slack/testTest Slack settings
SettingsApitest_notifications_telegramPOST /settings/notifications/telegram/testTest Telegram settings
SettingsApitest_notifications_webhookPOST /settings/notifications/webhook/testTest webhook settings
SettingsApitest_notifications_webpushPOST /settings/notifications/webpush/testTest Web Push settings
SettingsApitest_radarrPOST /settings/radarr/testTest Radarr configuration
SettingsApitest_sonarrPOST /settings/sonarr/testTest Sonarr configuration
SettingsApiupdate_discoverPUT /settings/discover/{sliderId}Update a single slider
SettingsApiupdate_radarrPUT /settings/radarr/{radarrId}Update Radarr instance
SettingsApiupdate_sonarrPUT /settings/sonarr/{sonarrId}Update Sonarr instance
TmdbApiget_network_by_network_idGET /network/{networkId}Get TV network details
TmdbApiget_studio_by_studio_idGET /studio/{studioId}Get movie studio details
TmdbApilist_backdropsGET /backdropsGet backdrops of trending items
TmdbApilist_genres_movieGET /genres/movieGet list of official TMDB movie genres
TmdbApilist_genres_tvGET /genres/tvGet list of official TMDB movie genres
TmdbApilist_languagesGET /languagesLanguages supported by TMDB
TmdbApilist_regionsGET /regionsRegions supported by TMDB
TvApiget_tv_by_tv_idGET /tv/{tvId}Get TV details
TvApiget_tv_ratingsGET /tv/{tvId}/ratingsGet TV ratings
TvApiget_tv_recommendationsGET /tv/{tvId}/recommendationsGet recommended TV series
TvApiget_tv_season_by_season_numberGET /tv/{tvId}/season/{seasonNumber}Get season details and episode list
TvApiget_tv_similarGET /tv/{tvId}/similarGet similar TV series
UsersApicreate_auth_reset_passwordPOST /auth/reset-passwordSend a reset password email
UsersApicreate_auth_reset_password_by_guidPOST /auth/reset-password/{guid}Reset the password for a user
UsersApicreate_userPOST /userCreate new user
UsersApicreate_user_import_from_jellyfinPOST /user/import-from-jellyfinImport all users from Jellyfin
UsersApicreate_user_import_from_plexPOST /user/import-from-plexImport all users from Plex
UsersApicreate_user_register_push_subscriptionPOST /user/registerPushSubscriptionRegister a web push /user/registerPushSubscription
UsersApicreate_user_settings_linked_accounts_jellyfinPOST /user/{userId}/settings/linked-accounts/jellyfinLink the provided Jellyfin account to the current user
UsersApicreate_user_settings_linked_accounts_jellyfin_quickconnectPOST /user/{userId}/settings/linked-accounts/jellyfin/quickconnectLink Jellyfin/Emby account with Quick Connect
UsersApicreate_user_settings_linked_accounts_plexPOST /user/{userId}/settings/linked-accounts/plexLink the provided Plex account to the current user
UsersApicreate_user_settings_mainPOST /user/{userId}/settings/mainUpdate general settings for a user
UsersApicreate_user_settings_notificationsPOST /user/{userId}/settings/notificationsUpdate notification settings for a user
UsersApicreate_user_settings_passwordPOST /user/{userId}/settings/passwordUpdate password for a user
UsersApicreate_user_settings_permissionsPOST /user/{userId}/settings/permissionsUpdate permission settings for a user
UsersApidelete_userDELETE /user/{userId}Delete user by ID
UsersApidelete_user_push_subscriptionDELETE /user/{userId}/pushSubscription/{endpoint}Delete user push subscription by key
UsersApidelete_user_settings_linked_accounts_jellyfinDELETE /user/{userId}/settings/linked-accounts/jellyfinRemove the linked Jellyfin account for a user
UsersApidelete_user_settings_linked_accounts_plexDELETE /user/{userId}/settings/linked-accounts/plexRemove the linked Plex account for a user
UsersApiget_userGET /userGet all users
UsersApiget_user_by_user_idGET /user/{userId}Get user by ID
UsersApiget_user_jellyfin_by_jellyfin_user_idGET /user/jellyfin/{jellyfinUserId}Get user by Jellyfin user ID
UsersApiget_user_push_subscription_by_endpointGET /user/{userId}/pushSubscription/{endpoint}Get web push notification settings for a user
UsersApiget_user_push_subscriptionsGET /user/{userId}/pushSubscriptionsGet all web push notification settings for a user
UsersApiget_user_quotaGET /user/{userId}/quotaGet quotas for a specific user
UsersApiget_user_requestsGET /user/{userId}/requestsGet requests for a specific user
UsersApiget_user_settings_mainGET /user/{userId}/settings/mainGet general settings for a user
UsersApiget_user_settings_notificationsGET /user/{userId}/settings/notificationsGet notification settings for a user
UsersApiget_user_settings_passwordGET /user/{userId}/settings/passwordGet password page informatiom
UsersApiget_user_settings_permissionsGET /user/{userId}/settings/permissionsGet permission settings for a user
UsersApiget_user_watch_dataGET /user/{userId}/watch_dataGet watch data
UsersApiget_user_watchlistGET /user/{userId}/watchlistGet the Plex watchlist for a specific user
UsersApiput_userPUT /userUpdate batch of users
UsersApiupdate_userPUT /user/{userId}Update a user by user ID
WatchlistApicreate_watchlistPOST /watchlistAdd media to watchlist
WatchlistApidelete_watchlistDELETE /watchlist/{tmdbId}Delete watchlist item

Documentation For Models

To get access to the crate's generated documentation, use:

cargo doc --open

Author

About

rust SDK for Seerr

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages