Rust API client for overseerr

This is the documentation for the Overseerr 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 Overseerr.

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: v1.34.0
• Package version: 0.1.1
• Generator version: 7.15.0
• Build package: org.openapitools.codegen.languages.RustClientCodegen

Installation

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

overseerr = { path = "./overseerr" }

Documentation for API Endpoints

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

AuthApi | create_auth_local | POST /auth/local | Sign in using a local account AuthApi | create_auth_logout | POST /auth/logout | Sign out and clear session cookie AuthApi | create_auth_plex | POST /auth/plex | Sign in using a Plex token AuthApi | get_auth_me | GET /auth/me | Get logged-in user CollectionApi | get_collection_by_collection_id | GET /collection/{collectionId} | Get collection details IssueApi | create_issue | POST /issue | Create new issue IssueApi | create_issue_by_status | POST /issue/{issueId}/{status} | Update an issue's status IssueApi | create_issue_comment | POST /issue/{issueId}/comment | Create a comment IssueApi | delete_issue | DELETE /issue/{issueId} | Delete issue IssueApi | delete_issue_comment | DELETE /issueComment/{commentId} | Delete issue comment IssueApi | get_issue | GET /issue | Get all issues IssueApi | get_issue_by_issue_id | GET /issue/{issueId} | Get issue IssueApi | get_issue_comment_by_comment_id | GET /issueComment/{commentId} | Get issue comment IssueApi | get_issue_count | GET /issue/count | Gets issue counts IssueApi | update_issue_comment | PUT /issueComment/{commentId} | Update issue comment MediaApi | create_media_by_status | POST /media/{mediaId}/{status} | Update media status MediaApi | delete_media | DELETE /media/{mediaId} | Delete media item MediaApi | get_media | GET /media | Get media MediaApi | get_media_watch_data | GET /media/{mediaId}/watch_data | Get watch data MoviesApi | get_movie_by_movie_id | GET /movie/{movieId} | Get movie details MoviesApi | get_movie_ratings | GET /movie/{movieId}/ratings | Get movie ratings MoviesApi | get_movie_ratingscombined | GET /movie/{movieId}/ratingscombined | Get RT and IMDB movie ratings combined MoviesApi | get_movie_recommendations | GET /movie/{movieId}/recommendations | Get recommended movies MoviesApi | get_movie_similar | GET /movie/{movieId}/similar | Get similar movies OtherApi | get_keyword_by_keyword_id | GET /keyword/{keywordId} | Get keyword OtherApi | list_watchproviders_movies | GET /watchproviders/movies | Get watch provider movies OtherApi | list_watchproviders_regions | GET /watchproviders/regions | Get watch provider regions OtherApi | list_watchproviders_tv | GET /watchproviders/tv | Get watch provider series PersonApi | get_person_by_person_id | GET /person/{personId} | Get person details PersonApi | get_person_combined_credits | GET /person/{personId}/combined_credits | Get combined credits PublicApi | get_status | GET /status | Get Overseerr status PublicApi | get_status_appdata | GET /status/appdata | Get application data volume status RequestApi | create_request | POST /request | Create new request RequestApi | create_request_by_status | POST /request/{requestId}/{status} | Update a request's status RequestApi | create_request_retry | POST /request/{requestId}/retry | Retry failed request RequestApi | delete_request | DELETE /request/{requestId} | Delete request RequestApi | get_request | GET /request | Get all requests RequestApi | get_request_by_request_id | GET /request/{requestId} | Get MediaRequest RequestApi | get_request_count | GET /request/count | Gets request counts RequestApi | update_request | PUT /request/{requestId} | Update MediaRequest SearchApi | get_discover_keyword_movies | GET /discover/keyword/{keywordId}/movies | Get movies from keyword SearchApi | get_discover_movies | GET /discover/movies | Discover movies SearchApi | get_discover_movies_genre_by_genre_id | GET /discover/movies/genre/{genreId} | Discover movies by genre SearchApi | get_discover_movies_language_by_language | GET /discover/movies/language/{language} | Discover movies by original language SearchApi | get_discover_movies_studio_by_studio_id | GET /discover/movies/studio/{studioId} | Discover movies by studio SearchApi | get_discover_movies_upcoming | GET /discover/movies/upcoming | Upcoming movies SearchApi | get_discover_trending | GET /discover/trending | Trending movies and TV SearchApi | get_discover_tv | GET /discover/tv | Discover TV shows SearchApi | get_discover_tv_genre_by_genre_id | GET /discover/tv/genre/{genreId} | Discover TV shows by genre SearchApi | get_discover_tv_language_by_language | GET /discover/tv/language/{language} | Discover TV shows by original language SearchApi | get_discover_tv_network_by_network_id | GET /discover/tv/network/{networkId} | Discover TV shows by network SearchApi | get_discover_tv_upcoming | GET /discover/tv/upcoming | Discover Upcoming TV shows SearchApi | get_discover_watchlist | GET /discover/watchlist | Get the Plex watchlist. SearchApi | get_search | GET /search | Search for movies, TV shows, or people SearchApi | get_search_company | GET /search/company | Search for companies SearchApi | get_search_keyword | GET /search/keyword | Search for keywords SearchApi | list_discover_genreslider_movie | GET /discover/genreslider/movie | Get genre slider data for movies SearchApi | list_discover_genreslider_tv | GET /discover/genreslider/tv | Get genre slider data for TV series ServiceApi | get_service_radarr_by_radarr_id | GET /service/radarr/{radarrId} | Get Radarr server quality profiles and root folders ServiceApi | get_service_sonarr_by_sonarr_id | GET /service/sonarr/{sonarrId} | Get Sonarr server quality profiles and root folders ServiceApi | list_service_radarr | GET /service/radarr | Get non-sensitive Radarr server list ServiceApi | list_service_sonarr | GET /service/sonarr | Get non-sensitive Sonarr server list ServiceApi | list_service_sonarr_lookup_by_tmdb_id | GET /service/sonarr/lookup/{tmdbId} | Get series from Sonarr SettingsApi | create_cache_flush | POST /settings/cache/{cacheId}/flush | Flush a specific cache SettingsApi | create_discover | POST /settings/discover | Batch update all sliders. SettingsApi | create_discover_add | POST /settings/discover/add | Add a new slider SettingsApi | create_initialize | POST /settings/initialize | Initialize application SettingsApi | create_jobs_cancel | POST /settings/jobs/{jobId}/cancel | Cancel a specific job SettingsApi | create_jobs_run | POST /settings/jobs/{jobId}/run | Invoke a specific job SettingsApi | create_jobs_schedule | POST /settings/jobs/{jobId}/schedule | Modify job schedule SettingsApi | create_main | POST /settings/main | Update main settings SettingsApi | create_main_regenerate | POST /settings/main/regenerate | Get main settings with newly-generated API key SettingsApi | create_notifications_discord | POST /settings/notifications/discord | Update Discord notification settings SettingsApi | create_notifications_email | POST /settings/notifications/email | Update email notification settings SettingsApi | create_notifications_gotify | POST /settings/notifications/gotify | Update Gotify notification settings SettingsApi | create_notifications_lunasea | POST /settings/notifications/lunasea | Update LunaSea notification settings SettingsApi | create_notifications_pushbullet | POST /settings/notifications/pushbullet | Update Pushbullet notification settings SettingsApi | create_notifications_pushover | POST /settings/notifications/pushover | Update Pushover notification settings SettingsApi | create_notifications_slack | POST /settings/notifications/slack | Update Slack notification settings SettingsApi | create_notifications_telegram | POST /settings/notifications/telegram | Update Telegram notification settings SettingsApi | create_notifications_webhook | POST /settings/notifications/webhook | Update webhook notification settings SettingsApi | create_notifications_webpush | POST /settings/notifications/webpush | Update Web Push notification settings SettingsApi | create_plex | POST /settings/plex | Update Plex settings SettingsApi | create_plex_sync | POST /settings/plex/sync | Start full Plex library scan SettingsApi | create_radarr | POST /settings/radarr | Create Radarr instance SettingsApi | create_sonarr | POST /settings/sonarr | Create Sonarr instance SettingsApi | create_tautulli | POST /settings/tautulli | Update Tautulli settings SettingsApi | delete_discover | DELETE /settings/discover/{sliderId} | Delete slider by ID SettingsApi | delete_radarr | DELETE /settings/radarr/{radarrId} | Delete Radarr instance SettingsApi | delete_sonarr | DELETE /settings/sonarr/{sonarrId} | Delete Sonarr instance SettingsApi | get_about | GET /settings/about | Get server stats SettingsApi | get_cache | GET /settings/cache | Get a list of active caches SettingsApi | get_discover_reset | GET /settings/discover/reset | Reset all discover sliders SettingsApi | get_main | GET /settings/main | Get main settings SettingsApi | get_notifications_discord | GET /settings/notifications/discord | Get Discord notification settings SettingsApi | get_notifications_email | GET /settings/notifications/email | Get email notification settings SettingsApi | get_notifications_gotify | GET /settings/notifications/gotify | Get Gotify notification settings SettingsApi | get_notifications_lunasea | GET /settings/notifications/lunasea | Get LunaSea notification settings SettingsApi | get_notifications_pushbullet | GET /settings/notifications/pushbullet | Get Pushbullet notification settings SettingsApi | get_notifications_pushover | GET /settings/notifications/pushover | Get Pushover notification settings SettingsApi | get_notifications_slack | GET /settings/notifications/slack | Get Slack notification settings SettingsApi | get_notifications_telegram | GET /settings/notifications/telegram | Get Telegram notification settings SettingsApi | get_notifications_webhook | GET /settings/notifications/webhook | Get webhook notification settings SettingsApi | get_notifications_webpush | GET /settings/notifications/webpush | Get Web Push notification settings SettingsApi | get_plex | GET /settings/plex | Get Plex settings SettingsApi | get_plex_sync | GET /settings/plex/sync | Get status of full Plex library scan SettingsApi | get_public | GET /settings/public | Get public settings SettingsApi | get_tautulli | GET /settings/tautulli | Get Tautulli settings SettingsApi | list_discover | GET /settings/discover | Get all discover sliders SettingsApi | list_jobs | GET /settings/jobs | Get scheduled jobs SettingsApi | list_logs | GET /settings/logs | Returns logs SettingsApi | list_notifications_pushover_sounds | GET /settings/notifications/pushover/sounds | Get Pushover sounds SettingsApi | list_plex_devices_servers | GET /settings/plex/devices/servers | Gets the user's available Plex servers SettingsApi | list_plex_library | GET /settings/plex/library | Get Plex libraries SettingsApi | list_plex_users | GET /settings/plex/users | Get Plex users SettingsApi | list_radarr | GET /settings/radarr | Get Radarr settings SettingsApi | list_radarr_profiles | GET /settings/radarr/{radarrId}/profiles | Get available Radarr profiles SettingsApi | list_sonarr | GET /settings/sonarr | Get Sonarr settings SettingsApi | test_notifications_discord | POST /settings/notifications/discord/test | Test Discord settings SettingsApi | test_notifications_email | POST /settings/notifications/email/test | Test email settings SettingsApi | test_notifications_gotify | POST /settings/notifications/gotify/test | Test Gotify settings SettingsApi | test_notifications_lunasea | POST /settings/notifications/lunasea/test | Test LunaSea settings SettingsApi | test_notifications_pushbullet | POST /settings/notifications/pushbullet/test | Test Pushbullet settings SettingsApi | test_notifications_pushover | POST /settings/notifications/pushover/test | Test Pushover settings SettingsApi | test_notifications_slack | POST /settings/notifications/slack/test | Test Slack settings SettingsApi | test_notifications_telegram | POST /settings/notifications/telegram/test | Test Telegram settings SettingsApi | test_notifications_webhook | POST /settings/notifications/webhook/test | Test webhook settings SettingsApi | test_notifications_webpush | POST /settings/notifications/webpush/test | Test Web Push settings SettingsApi | test_radarr | POST /settings/radarr/test | Test Radarr configuration SettingsApi | test_sonarr | POST /settings/sonarr/test | Test Sonarr configuration SettingsApi | update_discover | PUT /settings/discover/{sliderId} | Update a single slider SettingsApi | update_radarr | PUT /settings/radarr/{radarrId} | Update Radarr instance SettingsApi | update_sonarr | PUT /settings/sonarr/{sonarrId} | Update Sonarr instance TmdbApi | get_network_by_network_id | GET /network/{networkId} | Get TV network details TmdbApi | get_studio_by_studio_id | GET /studio/{studioId} | Get movie studio details TmdbApi | list_backdrops | GET /backdrops | Get backdrops of trending items TmdbApi | list_genres_movie | GET /genres/movie | Get list of official TMDB movie genres TmdbApi | list_genres_tv | GET /genres/tv | Get list of official TMDB movie genres TmdbApi | list_languages | GET /languages | Languages supported by TMDB TmdbApi | list_regions | GET /regions | Regions supported by TMDB TvApi | get_tv_by_tv_id | GET /tv/{tvId} | Get TV details TvApi | get_tv_ratings | GET /tv/{tvId}/ratings | Get TV ratings TvApi | get_tv_recommendations | GET /tv/{tvId}/recommendations | Get recommended TV series TvApi | get_tv_season_by_season_id | GET /tv/{tvId}/season/{seasonId} | Get season details and episode list TvApi | get_tv_similar | GET /tv/{tvId}/similar | Get similar TV series UsersApi | create_auth_reset_password | POST /auth/reset-password | Send a reset password email UsersApi | create_auth_reset_password_by_guid | POST /auth/reset-password/{guid} | Reset the password for a user UsersApi | create_user | POST /user | Create new user UsersApi | create_user_import_from_plex | POST /user/import-from-plex | Import all users from Plex UsersApi | create_user_register_push_subscription | POST /user/registerPushSubscription | Register a web push /user/registerPushSubscription UsersApi | create_user_settings_main | POST /user/{userId}/settings/main | Update general settings for a user UsersApi | create_user_settings_notifications | POST /user/{userId}/settings/notifications | Update notification settings for a user UsersApi | create_user_settings_password | POST /user/{userId}/settings/password | Update password for a user UsersApi | create_user_settings_permissions | POST /user/{userId}/settings/permissions | Update permission settings for a user UsersApi | delete_user | DELETE /user/{userId} | Delete user by ID UsersApi | delete_user_push_subscription | DELETE /user/{userId}/pushSubscription/{key} | Delete user push subscription by key UsersApi | get_user | GET /user | Get all users UsersApi | get_user_by_user_id | GET /user/{userId} | Get user by ID UsersApi | get_user_push_subscription_by_key | GET /user/{userId}/pushSubscription/{key} | Get web push notification settings for a user UsersApi | get_user_push_subscriptions | GET /user/{userId}/pushSubscriptions | Get all web push notification settings for a user UsersApi | get_user_quota | GET /user/{userId}/quota | Get quotas for a specific user UsersApi | get_user_requests | GET /user/{userId}/requests | Get requests for a specific user UsersApi | get_user_settings_main | GET /user/{userId}/settings/main | Get general settings for a user UsersApi | get_user_settings_notifications | GET /user/{userId}/settings/notifications | Get notification settings for a user UsersApi | get_user_settings_password | GET /user/{userId}/settings/password | Get password page informatiom UsersApi | get_user_settings_permissions | GET /user/{userId}/settings/permissions | Get permission settings for a user UsersApi | get_user_watch_data | GET /user/{userId}/watch_data | Get watch data UsersApi | get_user_watchlist | GET /user/{userId}/watchlist | Get the Plex watchlist for a specific user UsersApi | put_user | PUT /user | Update batch of users UsersApi | update_user | PUT /user/{userId} | Update a user by user ID

Documentation For Models

• Cast

• Collection

• Company

• CreateAuthLocalRequest

• CreateAuthLogout2XxResponse

• CreateAuthPlexRequest

• CreateAuthResetPasswordByGuidRequest

• CreateAuthResetPasswordRequest

• CreateDiscoverAddRequest

• CreateIssueCommentRequest

• CreateIssueRequest

• CreateJobsScheduleRequest

• CreateMediaByStatusRequest

• CreatePlexSyncRequest

• CreateRequestRequest

• CreateRequestRequestSeasons

• CreateUserImportFromPlexRequest

• CreateUserRegisterPushSubscriptionRequest

• CreateUserRequest

• CreateUserSettingsMainRequest

• CreateUserSettingsPasswordRequest

• CreateUserSettingsPermissionsRequest

• CreditCast

• CreditCrew

• Crew

• DiscordSettings

• DiscordSettingsOptions

• DiscoverSlider

• Episode

• ExternalIds

• Genre

• GetAbout2XxResponse

• GetCache2XxResponse

• GetCache2XxResponseApiCachesInner

• GetCache2XxResponseApiCachesInnerStats

• GetCache2XxResponseImageCache

• GetCache2XxResponseImageCacheTmdb

• GetDiscoverMovies2XxResponse

• GetDiscoverMoviesGenreByGenreId2XxResponse

• GetDiscoverMoviesLanguageByLanguage2XxResponse

• GetDiscoverMoviesStudioByStudioId2XxResponse

• GetDiscoverTv2XxResponse

• GetDiscoverTvGenreByGenreId2XxResponse

• GetDiscoverTvLanguageByLanguage2XxResponse

• GetDiscoverTvNetworkByNetworkId2XxResponse

• GetIssue2XxResponse

• GetIssueCount2XxResponse

• GetMedia2XxResponse

• GetMediaWatchData2XxResponse

• GetMediaWatchData2XxResponseData

• GetMovieRatings2XxResponse

• GetMovieRatingscombined2XxResponse

• GetMovieRatingscombined2XxResponseImdb

• GetPersonCombinedCredits2XxResponse

• GetPlexSync2XxResponse

• GetRequestCount2XxResponse

• GetSearch2XxResponse

• GetSearch2XxResponseResultsInner

• GetSearchCompany2XxResponse

• GetSearchKeyword2XxResponse

• GetServiceRadarrByRadarrId2XxResponse

• GetServiceSonarrBySonarrId2XxResponse

• GetStatus2XxResponse

• GetStatusAppdata2XxResponse

• GetTvRatings2XxResponse

• GetUser2XxResponse

• GetUserPushSubscriptions2XxResponse

• GetUserQuota2XxResponse

• GetUserQuota2XxResponseMovie

• GetUserRequests2XxResponse

• GetUserSettingsMain2XxResponse

• GetUserSettingsPassword2XxResponse

• GetUserSettingsPermissions2XxResponse

• GetUserWatchData2XxResponse

• GetUserWatchlist2XxResponse

• GetUserWatchlist2XxResponseResultsInner

• GotifySettings

• GotifySettingsOptions

• Issue

• IssueComment

• Job

• Keyword

• ListDiscoverGenresliderMovie2XxResponseInner

• ListGenresMovie2XxResponseInner

• ListGenresTv2XxResponseInner

• ListLanguages2XxResponseInner

• ListLogs2XxResponseInner

• ListNotificationsPushoverSounds2XxResponseInner

• ListPlexUsers2XxResponseInner

• ListRegions2XxResponseInner

• LunaSeaSettings

• LunaSeaSettingsOptions

• MainSettings

• MediaInfo

• MediaRequest

• MediaRequestModifiedBy

• MovieDetails

• MovieDetailsCollection

• MovieDetailsCredits

• MovieDetailsProductionCountriesInner

• MovieDetailsReleases

• MovieDetailsReleasesResultsInner

• MovieDetailsReleasesResultsInnerReleaseDatesInner

• MovieResult

• Network

• NotificationAgentTypes

• NotificationEmailSettings

• NotificationEmailSettingsOptions

• PageInfo

• PersonDetails

• PersonResult

• PersonResultKnownForInner

• PlexConnection

• PlexDevice

• PlexLibrary

• PlexSettings

• ProductionCompany

• PublicSettings

• PushbulletSettings

• PushbulletSettingsOptions

• PushoverSettings

• PushoverSettingsOptions

• PutUserRequest

• RadarrSettings

• RelatedVideo

• Season

• ServarrTag

• ServiceProfile

• SlackSettings

• SlackSettingsOptions

• SonarrSeries

• SonarrSeriesAddOptionsInner

• SonarrSeriesImagesInner

• SonarrSeriesRatingsInner

• SonarrSeriesSeasonsInner

• SonarrSettings

• SpokenLanguage

• TautulliSettings

• TelegramSettings

• TelegramSettingsOptions

• TestRadarr2XxResponse

• TestRadarrRequest

• TestSonarrRequest

• TvDetails

• TvDetailsContentRatings

• TvDetailsContentRatingsResultsInner

• TvDetailsCreatedByInner

• TvResult

• UpdateDiscoverRequest

• UpdateIssueCommentRequest

• UpdateRequestRequest

• User

• UserSettings

• UserSettingsNotifications

• WatchProviderDetails

• WatchProviderRegion

• WatchProvidersInner

• WebPushSettings

• WebhookSettings

• WebhookSettingsOptions

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

cargo doc --open

Author