{"id":23286867,"url":"https://github.com/devopsarr/overseerr-py","last_synced_at":"2025-06-23T04:34:35.128Z","repository":{"id":200042154,"uuid":"704483486","full_name":"devopsarr/overseerr-py","owner":"devopsarr","description":null,"archived":false,"fork":false,"pushed_at":"2025-01-24T19:08:20.000Z","size":694,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-02-06T06:49:44.313Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/devopsarr.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-10-13T11:01:13.000Z","updated_at":"2025-01-24T18:54:21.000Z","dependencies_parsed_at":"2023-10-15T12:29:49.500Z","dependency_job_id":"6b2f137c-7e59-494b-aec3-3a460329a759","html_url":"https://github.com/devopsarr/overseerr-py","commit_stats":null,"previous_names":["devopsarr/overseerr-py"],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devopsarr%2Foverseerr-py","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devopsarr%2Foverseerr-py/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devopsarr%2Foverseerr-py/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devopsarr%2Foverseerr-py/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/devopsarr","download_url":"https://codeload.github.com/devopsarr/overseerr-py/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":238557020,"owners_count":19491945,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-12-20T02:14:56.854Z","updated_at":"2025-02-12T21:42:15.766Z","avatar_url":"https://github.com/devopsarr.png","language":"Python","readme":"# overseerr-py\nThis is the documentation for the Overseerr API backend.\n\nTwo primary authentication methods are supported:\n\n- **Cookie Authentication**: A valid sign-in to the `/auth/plex` or `/auth/local` will generate a valid authentication cookie.\n- **API Key Authentication**: Sign-in is also possible by passing an `X-Api-Key` header along with a valid API Key generated by Overseerr.\n\n\nThis Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:\n\n- API version: v1.33.2\n- Package version: 1.0.1 \u003c!--- x-release-please-version --\u003e\n- Generator version: 7.11.0\n- Build package: org.openapitools.codegen.languages.PythonClientCodegen\n\n## Requirements.\n\nPython 3.8+\n\n## Installation \u0026 Usage\n### pip install\n\nIf the python package is hosted on a repository, you can install directly using:\n\n```sh\npip install git+https://github.com/devopsarr/overseerr-py.git\n```\n(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/devopsarr/overseerr-py.git`)\n\nThen import the package:\n```python\nimport overseerr\n```\n\n### Setuptools\n\nInstall via [Setuptools](http://pypi.python.org/pypi/setuptools).\n\n```sh\npython setup.py install --user\n```\n(or `sudo python setup.py install` to install the package for all users)\n\nThen import the package:\n```python\nimport overseerr\n```\n\n### Tests\n\nExecute `pytest` to run the tests.\n\n## Getting Started\n\nPlease follow the [installation procedure](#installation--usage) and then run the following:\n\n```python\n\nimport overseerr\nfrom overseerr.rest import ApiException\nfrom pprint import pprint\n\n# Defining the host is optional and defaults to http://localhost:5055/api/v1\n# See configuration.py for a list of all supported configuration parameters.\nconfiguration = overseerr.Configuration(\n    host = \"http://localhost:5055/api/v1\"\n)\n\n\n\n# Enter a context with an instance of the API client\nwith overseerr.ApiClient(configuration) as api_client:\n    # Create an instance of the API class\n    api_instance = overseerr.AuthApi(api_client)\n    create_auth_local_request = overseerr.CreateAuthLocalRequest() # CreateAuthLocalRequest | \n\n    try:\n        # Sign in using a local account\n        api_response = api_instance.create_auth_local(create_auth_local_request)\n        print(\"The response of AuthApi-\u003ecreate_auth_local:\\n\")\n        pprint(api_response)\n    except ApiException as e:\n        print(\"Exception when calling AuthApi-\u003ecreate_auth_local: %s\\n\" % e)\n\n```\n\n## Documentation for API Endpoints\n\nAll URIs are relative to *http://localhost:5055/api/v1*\n\nClass | Method | HTTP request | Description\n------------ | ------------- | ------------- | -------------\n*AuthApi* | [**create_auth_local**](docs/AuthApi.md#create_auth_local) | **POST** /auth/local | Sign in using a local account\n*AuthApi* | [**create_auth_logout**](docs/AuthApi.md#create_auth_logout) | **POST** /auth/logout | Sign out and clear session cookie\n*AuthApi* | [**create_auth_plex**](docs/AuthApi.md#create_auth_plex) | **POST** /auth/plex | Sign in using a Plex token\n*AuthApi* | [**get_auth_me**](docs/AuthApi.md#get_auth_me) | **GET** /auth/me | Get logged-in user\n*CollectionApi* | [**get_collection_by_collection_id**](docs/CollectionApi.md#get_collection_by_collection_id) | **GET** /collection/{collectionId} | Get collection details\n*IssueApi* | [**create_issue**](docs/IssueApi.md#create_issue) | **POST** /issue | Create new issue\n*IssueApi* | [**create_issue_by_status**](docs/IssueApi.md#create_issue_by_status) | **POST** /issue/{issueId}/{status} | Update an issue\u0026#39;s status\n*IssueApi* | [**create_issue_comment**](docs/IssueApi.md#create_issue_comment) | **POST** /issue/{issueId}/comment | Create a comment\n*IssueApi* | [**delete_issue**](docs/IssueApi.md#delete_issue) | **DELETE** /issue/{issueId} | Delete issue\n*IssueApi* | [**delete_issue_comment**](docs/IssueApi.md#delete_issue_comment) | **DELETE** /issueComment/{commentId} | Delete issue comment\n*IssueApi* | [**get_issue**](docs/IssueApi.md#get_issue) | **GET** /issue | Get all issues\n*IssueApi* | [**get_issue_by_issue_id**](docs/IssueApi.md#get_issue_by_issue_id) | **GET** /issue/{issueId} | Get issue\n*IssueApi* | [**get_issue_comment_by_comment_id**](docs/IssueApi.md#get_issue_comment_by_comment_id) | **GET** /issueComment/{commentId} | Get issue comment\n*IssueApi* | [**get_issue_count**](docs/IssueApi.md#get_issue_count) | **GET** /issue/count | Gets issue counts\n*IssueApi* | [**update_issue_comment**](docs/IssueApi.md#update_issue_comment) | **PUT** /issueComment/{commentId} | Update issue comment\n*MediaApi* | [**create_media_by_status**](docs/MediaApi.md#create_media_by_status) | **POST** /media/{mediaId}/{status} | Update media status\n*MediaApi* | [**delete_media**](docs/MediaApi.md#delete_media) | **DELETE** /media/{mediaId} | Delete media item\n*MediaApi* | [**get_media**](docs/MediaApi.md#get_media) | **GET** /media | Get media\n*MediaApi* | [**get_media_watch_data**](docs/MediaApi.md#get_media_watch_data) | **GET** /media/{mediaId}/watch_data | Get watch data\n*MoviesApi* | [**get_movie_by_movie_id**](docs/MoviesApi.md#get_movie_by_movie_id) | **GET** /movie/{movieId} | Get movie details\n*MoviesApi* | [**get_movie_ratings**](docs/MoviesApi.md#get_movie_ratings) | **GET** /movie/{movieId}/ratings | Get movie ratings\n*MoviesApi* | [**get_movie_recommendations**](docs/MoviesApi.md#get_movie_recommendations) | **GET** /movie/{movieId}/recommendations | Get recommended movies\n*MoviesApi* | [**get_movie_similar**](docs/MoviesApi.md#get_movie_similar) | **GET** /movie/{movieId}/similar | Get similar movies\n*OtherApi* | [**get_keyword_by_keyword_id**](docs/OtherApi.md#get_keyword_by_keyword_id) | **GET** /keyword/{keywordId} | Get keyword\n*OtherApi* | [**list_watchproviders_movies**](docs/OtherApi.md#list_watchproviders_movies) | **GET** /watchproviders/movies | Get watch provider movies\n*OtherApi* | [**list_watchproviders_regions**](docs/OtherApi.md#list_watchproviders_regions) | **GET** /watchproviders/regions | Get watch provider regions\n*OtherApi* | [**list_watchproviders_tv**](docs/OtherApi.md#list_watchproviders_tv) | **GET** /watchproviders/tv | Get watch provider series\n*PersonApi* | [**get_person_by_person_id**](docs/PersonApi.md#get_person_by_person_id) | **GET** /person/{personId} | Get person details\n*PersonApi* | [**get_person_combined_credits**](docs/PersonApi.md#get_person_combined_credits) | **GET** /person/{personId}/combined_credits | Get combined credits\n*PublicApi* | [**get_status**](docs/PublicApi.md#get_status) | **GET** /status | Get Overseerr status\n*PublicApi* | [**get_status_appdata**](docs/PublicApi.md#get_status_appdata) | **GET** /status/appdata | Get application data volume status\n*RequestApi* | [**create_request**](docs/RequestApi.md#create_request) | **POST** /request | Create new request\n*RequestApi* | [**create_request_by_status**](docs/RequestApi.md#create_request_by_status) | **POST** /request/{requestId}/{status} | Update a request\u0026#39;s status\n*RequestApi* | [**create_request_retry**](docs/RequestApi.md#create_request_retry) | **POST** /request/{requestId}/retry | Retry failed request\n*RequestApi* | [**delete_request**](docs/RequestApi.md#delete_request) | **DELETE** /request/{requestId} | Delete request\n*RequestApi* | [**get_request**](docs/RequestApi.md#get_request) | **GET** /request | Get all requests\n*RequestApi* | [**get_request_by_request_id**](docs/RequestApi.md#get_request_by_request_id) | **GET** /request/{requestId} | Get MediaRequest\n*RequestApi* | [**get_request_count**](docs/RequestApi.md#get_request_count) | **GET** /request/count | Gets request counts\n*RequestApi* | [**update_request**](docs/RequestApi.md#update_request) | **PUT** /request/{requestId} | Update MediaRequest\n*SearchApi* | [**get_discover_keyword_movies**](docs/SearchApi.md#get_discover_keyword_movies) | **GET** /discover/keyword/{keywordId}/movies | Get movies from keyword\n*SearchApi* | [**get_discover_movies**](docs/SearchApi.md#get_discover_movies) | **GET** /discover/movies | Discover movies\n*SearchApi* | [**get_discover_movies_genre_by_genre_id**](docs/SearchApi.md#get_discover_movies_genre_by_genre_id) | **GET** /discover/movies/genre/{genreId} | Discover movies by genre\n*SearchApi* | [**get_discover_movies_language_by_language**](docs/SearchApi.md#get_discover_movies_language_by_language) | **GET** /discover/movies/language/{language} | Discover movies by original language\n*SearchApi* | [**get_discover_movies_studio_by_studio_id**](docs/SearchApi.md#get_discover_movies_studio_by_studio_id) | **GET** /discover/movies/studio/{studioId} | Discover movies by studio\n*SearchApi* | [**get_discover_movies_upcoming**](docs/SearchApi.md#get_discover_movies_upcoming) | **GET** /discover/movies/upcoming | Upcoming movies\n*SearchApi* | [**get_discover_trending**](docs/SearchApi.md#get_discover_trending) | **GET** /discover/trending | Trending movies and TV\n*SearchApi* | [**get_discover_tv**](docs/SearchApi.md#get_discover_tv) | **GET** /discover/tv | Discover TV shows\n*SearchApi* | [**get_discover_tv_genre_by_genre_id**](docs/SearchApi.md#get_discover_tv_genre_by_genre_id) | **GET** /discover/tv/genre/{genreId} | Discover TV shows by genre\n*SearchApi* | [**get_discover_tv_language_by_language**](docs/SearchApi.md#get_discover_tv_language_by_language) | **GET** /discover/tv/language/{language} | Discover TV shows by original language\n*SearchApi* | [**get_discover_tv_network_by_network_id**](docs/SearchApi.md#get_discover_tv_network_by_network_id) | **GET** /discover/tv/network/{networkId} | Discover TV shows by network\n*SearchApi* | [**get_discover_tv_upcoming**](docs/SearchApi.md#get_discover_tv_upcoming) | **GET** /discover/tv/upcoming | Discover Upcoming TV shows\n*SearchApi* | [**get_discover_watchlist**](docs/SearchApi.md#get_discover_watchlist) | **GET** /discover/watchlist | Get the Plex watchlist.\n*SearchApi* | [**get_search**](docs/SearchApi.md#get_search) | **GET** /search | Search for movies, TV shows, or people\n*SearchApi* | [**get_search_company**](docs/SearchApi.md#get_search_company) | **GET** /search/company | Search for companies\n*SearchApi* | [**get_search_keyword**](docs/SearchApi.md#get_search_keyword) | **GET** /search/keyword | Search for keywords\n*SearchApi* | [**list_discover_genreslider_movie**](docs/SearchApi.md#list_discover_genreslider_movie) | **GET** /discover/genreslider/movie | Get genre slider data for movies\n*SearchApi* | [**list_discover_genreslider_tv**](docs/SearchApi.md#list_discover_genreslider_tv) | **GET** /discover/genreslider/tv | Get genre slider data for TV series\n*ServiceApi* | [**get_service_radarr_by_radarr_id**](docs/ServiceApi.md#get_service_radarr_by_radarr_id) | **GET** /service/radarr/{radarrId} | Get Radarr server quality profiles and root folders\n*ServiceApi* | [**get_service_sonarr_by_sonarr_id**](docs/ServiceApi.md#get_service_sonarr_by_sonarr_id) | **GET** /service/sonarr/{sonarrId} | Get Sonarr server quality profiles and root folders\n*ServiceApi* | [**list_service_radarr**](docs/ServiceApi.md#list_service_radarr) | **GET** /service/radarr | Get non-sensitive Radarr server list\n*ServiceApi* | [**list_service_sonarr**](docs/ServiceApi.md#list_service_sonarr) | **GET** /service/sonarr | Get non-sensitive Sonarr server list\n*ServiceApi* | [**list_service_sonarr_lookup_by_tmdb_id**](docs/ServiceApi.md#list_service_sonarr_lookup_by_tmdb_id) | **GET** /service/sonarr/lookup/{tmdbId} | Get series from Sonarr\n*SettingsApi* | [**create_cache_flush**](docs/SettingsApi.md#create_cache_flush) | **POST** /settings/cache/{cacheId}/flush | Flush a specific cache\n*SettingsApi* | [**create_discover**](docs/SettingsApi.md#create_discover) | **POST** /settings/discover | Batch update all sliders.\n*SettingsApi* | [**create_discover_add**](docs/SettingsApi.md#create_discover_add) | **POST** /settings/discover/add | Add a new slider\n*SettingsApi* | [**create_initialize**](docs/SettingsApi.md#create_initialize) | **POST** /settings/initialize | Initialize application\n*SettingsApi* | [**create_jobs_cancel**](docs/SettingsApi.md#create_jobs_cancel) | **POST** /settings/jobs/{jobId}/cancel | Cancel a specific job\n*SettingsApi* | [**create_jobs_run**](docs/SettingsApi.md#create_jobs_run) | **POST** /settings/jobs/{jobId}/run | Invoke a specific job\n*SettingsApi* | [**create_jobs_schedule**](docs/SettingsApi.md#create_jobs_schedule) | **POST** /settings/jobs/{jobId}/schedule | Modify job schedule\n*SettingsApi* | [**create_main**](docs/SettingsApi.md#create_main) | **POST** /settings/main | Update main settings\n*SettingsApi* | [**create_main_regenerate**](docs/SettingsApi.md#create_main_regenerate) | **POST** /settings/main/regenerate | Get main settings with newly-generated API key\n*SettingsApi* | [**create_notifications_discord**](docs/SettingsApi.md#create_notifications_discord) | **POST** /settings/notifications/discord | Update Discord notification settings\n*SettingsApi* | [**create_notifications_email**](docs/SettingsApi.md#create_notifications_email) | **POST** /settings/notifications/email | Update email notification settings\n*SettingsApi* | [**create_notifications_gotify**](docs/SettingsApi.md#create_notifications_gotify) | **POST** /settings/notifications/gotify | Update Gotify notification settings\n*SettingsApi* | [**create_notifications_lunasea**](docs/SettingsApi.md#create_notifications_lunasea) | **POST** /settings/notifications/lunasea | Update LunaSea notification settings\n*SettingsApi* | [**create_notifications_pushbullet**](docs/SettingsApi.md#create_notifications_pushbullet) | **POST** /settings/notifications/pushbullet | Update Pushbullet notification settings\n*SettingsApi* | [**create_notifications_pushover**](docs/SettingsApi.md#create_notifications_pushover) | **POST** /settings/notifications/pushover | Update Pushover notification settings\n*SettingsApi* | [**create_notifications_slack**](docs/SettingsApi.md#create_notifications_slack) | **POST** /settings/notifications/slack | Update Slack notification settings\n*SettingsApi* | [**create_notifications_telegram**](docs/SettingsApi.md#create_notifications_telegram) | **POST** /settings/notifications/telegram | Update Telegram notification settings\n*SettingsApi* | [**create_notifications_webhook**](docs/SettingsApi.md#create_notifications_webhook) | **POST** /settings/notifications/webhook | Update webhook notification settings\n*SettingsApi* | [**create_notifications_webpush**](docs/SettingsApi.md#create_notifications_webpush) | **POST** /settings/notifications/webpush | Update Web Push notification settings\n*SettingsApi* | [**create_plex**](docs/SettingsApi.md#create_plex) | **POST** /settings/plex | Update Plex settings\n*SettingsApi* | [**create_plex_sync**](docs/SettingsApi.md#create_plex_sync) | **POST** /settings/plex/sync | Start full Plex library scan\n*SettingsApi* | [**create_radarr**](docs/SettingsApi.md#create_radarr) | **POST** /settings/radarr | Create Radarr instance\n*SettingsApi* | [**create_sonarr**](docs/SettingsApi.md#create_sonarr) | **POST** /settings/sonarr | Create Sonarr instance\n*SettingsApi* | [**create_tautulli**](docs/SettingsApi.md#create_tautulli) | **POST** /settings/tautulli | Update Tautulli settings\n*SettingsApi* | [**delete_discover**](docs/SettingsApi.md#delete_discover) | **DELETE** /settings/discover/{sliderId} | Delete slider by ID\n*SettingsApi* | [**delete_radarr**](docs/SettingsApi.md#delete_radarr) | **DELETE** /settings/radarr/{radarrId} | Delete Radarr instance\n*SettingsApi* | [**delete_sonarr**](docs/SettingsApi.md#delete_sonarr) | **DELETE** /settings/sonarr/{sonarrId} | Delete Sonarr instance\n*SettingsApi* | [**get_about**](docs/SettingsApi.md#get_about) | **GET** /settings/about | Get server stats\n*SettingsApi* | [**get_cache**](docs/SettingsApi.md#get_cache) | **GET** /settings/cache | Get a list of active caches\n*SettingsApi* | [**get_discover_reset**](docs/SettingsApi.md#get_discover_reset) | **GET** /settings/discover/reset | Reset all discover sliders\n*SettingsApi* | [**get_main**](docs/SettingsApi.md#get_main) | **GET** /settings/main | Get main settings\n*SettingsApi* | [**get_notifications_discord**](docs/SettingsApi.md#get_notifications_discord) | **GET** /settings/notifications/discord | Get Discord notification settings\n*SettingsApi* | [**get_notifications_email**](docs/SettingsApi.md#get_notifications_email) | **GET** /settings/notifications/email | Get email notification settings\n*SettingsApi* | [**get_notifications_gotify**](docs/SettingsApi.md#get_notifications_gotify) | **GET** /settings/notifications/gotify | Get Gotify notification settings\n*SettingsApi* | [**get_notifications_lunasea**](docs/SettingsApi.md#get_notifications_lunasea) | **GET** /settings/notifications/lunasea | Get LunaSea notification settings\n*SettingsApi* | [**get_notifications_pushbullet**](docs/SettingsApi.md#get_notifications_pushbullet) | **GET** /settings/notifications/pushbullet | Get Pushbullet notification settings\n*SettingsApi* | [**get_notifications_pushover**](docs/SettingsApi.md#get_notifications_pushover) | **GET** /settings/notifications/pushover | Get Pushover notification settings\n*SettingsApi* | [**get_notifications_slack**](docs/SettingsApi.md#get_notifications_slack) | **GET** /settings/notifications/slack | Get Slack notification settings\n*SettingsApi* | [**get_notifications_telegram**](docs/SettingsApi.md#get_notifications_telegram) | **GET** /settings/notifications/telegram | Get Telegram notification settings\n*SettingsApi* | [**get_notifications_webhook**](docs/SettingsApi.md#get_notifications_webhook) | **GET** /settings/notifications/webhook | Get webhook notification settings\n*SettingsApi* | [**get_notifications_webpush**](docs/SettingsApi.md#get_notifications_webpush) | **GET** /settings/notifications/webpush | Get Web Push notification settings\n*SettingsApi* | [**get_plex**](docs/SettingsApi.md#get_plex) | **GET** /settings/plex | Get Plex settings\n*SettingsApi* | [**get_plex_sync**](docs/SettingsApi.md#get_plex_sync) | **GET** /settings/plex/sync | Get status of full Plex library scan\n*SettingsApi* | [**get_public**](docs/SettingsApi.md#get_public) | **GET** /settings/public | Get public settings\n*SettingsApi* | [**get_tautulli**](docs/SettingsApi.md#get_tautulli) | **GET** /settings/tautulli | Get Tautulli settings\n*SettingsApi* | [**list_discover**](docs/SettingsApi.md#list_discover) | **GET** /settings/discover | Get all discover sliders\n*SettingsApi* | [**list_jobs**](docs/SettingsApi.md#list_jobs) | **GET** /settings/jobs | Get scheduled jobs\n*SettingsApi* | [**list_logs**](docs/SettingsApi.md#list_logs) | **GET** /settings/logs | Returns logs\n*SettingsApi* | [**list_plex_devices_servers**](docs/SettingsApi.md#list_plex_devices_servers) | **GET** /settings/plex/devices/servers | Gets the user\u0026#39;s available Plex servers\n*SettingsApi* | [**list_plex_library**](docs/SettingsApi.md#list_plex_library) | **GET** /settings/plex/library | Get Plex libraries\n*SettingsApi* | [**list_plex_users**](docs/SettingsApi.md#list_plex_users) | **GET** /settings/plex/users | Get Plex users\n*SettingsApi* | [**list_radarr**](docs/SettingsApi.md#list_radarr) | **GET** /settings/radarr | Get Radarr settings\n*SettingsApi* | [**list_radarr_profiles**](docs/SettingsApi.md#list_radarr_profiles) | **GET** /settings/radarr/{radarrId}/profiles | Get available Radarr profiles\n*SettingsApi* | [**list_sonarr**](docs/SettingsApi.md#list_sonarr) | **GET** /settings/sonarr | Get Sonarr settings\n*SettingsApi* | [**test_notifications_discord**](docs/SettingsApi.md#test_notifications_discord) | **POST** /settings/notifications/discord/test | Test Discord settings\n*SettingsApi* | [**test_notifications_email**](docs/SettingsApi.md#test_notifications_email) | **POST** /settings/notifications/email/test | Test email settings\n*SettingsApi* | [**test_notifications_gotify**](docs/SettingsApi.md#test_notifications_gotify) | **POST** /settings/notifications/gotify/test | Test Gotify settings\n*SettingsApi* | [**test_notifications_lunasea**](docs/SettingsApi.md#test_notifications_lunasea) | **POST** /settings/notifications/lunasea/test | Test LunaSea settings\n*SettingsApi* | [**test_notifications_pushbullet**](docs/SettingsApi.md#test_notifications_pushbullet) | **POST** /settings/notifications/pushbullet/test | Test Pushbullet settings\n*SettingsApi* | [**test_notifications_pushover**](docs/SettingsApi.md#test_notifications_pushover) | **POST** /settings/notifications/pushover/test | Test Pushover settings\n*SettingsApi* | [**test_notifications_slack**](docs/SettingsApi.md#test_notifications_slack) | **POST** /settings/notifications/slack/test | Test Slack settings\n*SettingsApi* | [**test_notifications_telegram**](docs/SettingsApi.md#test_notifications_telegram) | **POST** /settings/notifications/telegram/test | Test Telegram settings\n*SettingsApi* | [**test_notifications_webhook**](docs/SettingsApi.md#test_notifications_webhook) | **POST** /settings/notifications/webhook/test | Test webhook settings\n*SettingsApi* | [**test_notifications_webpush**](docs/SettingsApi.md#test_notifications_webpush) | **POST** /settings/notifications/webpush/test | Test Web Push settings\n*SettingsApi* | [**test_radarr**](docs/SettingsApi.md#test_radarr) | **POST** /settings/radarr/test | Test Radarr configuration\n*SettingsApi* | [**test_sonarr**](docs/SettingsApi.md#test_sonarr) | **POST** /settings/sonarr/test | Test Sonarr configuration\n*SettingsApi* | [**update_discover**](docs/SettingsApi.md#update_discover) | **PUT** /settings/discover/{sliderId} | Update a single slider\n*SettingsApi* | [**update_radarr**](docs/SettingsApi.md#update_radarr) | **PUT** /settings/radarr/{radarrId} | Update Radarr instance\n*SettingsApi* | [**update_sonarr**](docs/SettingsApi.md#update_sonarr) | **PUT** /settings/sonarr/{sonarrId} | Update Sonarr instance\n*TmdbApi* | [**get_network_by_network_id**](docs/TmdbApi.md#get_network_by_network_id) | **GET** /network/{networkId} | Get TV network details\n*TmdbApi* | [**get_studio_by_studio_id**](docs/TmdbApi.md#get_studio_by_studio_id) | **GET** /studio/{studioId} | Get movie studio details\n*TmdbApi* | [**list_backdrops**](docs/TmdbApi.md#list_backdrops) | **GET** /backdrops | Get backdrops of trending items\n*TmdbApi* | [**list_genres_movie**](docs/TmdbApi.md#list_genres_movie) | **GET** /genres/movie | Get list of official TMDB movie genres\n*TmdbApi* | [**list_genres_tv**](docs/TmdbApi.md#list_genres_tv) | **GET** /genres/tv | Get list of official TMDB movie genres\n*TmdbApi* | [**list_languages**](docs/TmdbApi.md#list_languages) | **GET** /languages | Languages supported by TMDB\n*TmdbApi* | [**list_regions**](docs/TmdbApi.md#list_regions) | **GET** /regions | Regions supported by TMDB\n*TvApi* | [**get_tv_by_tv_id**](docs/TvApi.md#get_tv_by_tv_id) | **GET** /tv/{tvId} | Get TV details\n*TvApi* | [**get_tv_ratings**](docs/TvApi.md#get_tv_ratings) | **GET** /tv/{tvId}/ratings | Get TV ratings\n*TvApi* | [**get_tv_recommendations**](docs/TvApi.md#get_tv_recommendations) | **GET** /tv/{tvId}/recommendations | Get recommended TV series\n*TvApi* | [**get_tv_season_by_season_id**](docs/TvApi.md#get_tv_season_by_season_id) | **GET** /tv/{tvId}/season/{seasonId} | Get season details and episode list\n*TvApi* | [**get_tv_similar**](docs/TvApi.md#get_tv_similar) | **GET** /tv/{tvId}/similar | Get similar TV series\n*UsersApi* | [**create_auth_reset_password**](docs/UsersApi.md#create_auth_reset_password) | **POST** /auth/reset-password | Send a reset password email\n*UsersApi* | [**create_auth_reset_password_by_guid**](docs/UsersApi.md#create_auth_reset_password_by_guid) | **POST** /auth/reset-password/{guid} | Reset the password for a user\n*UsersApi* | [**create_user**](docs/UsersApi.md#create_user) | **POST** /user | Create new user\n*UsersApi* | [**create_user_import_from_plex**](docs/UsersApi.md#create_user_import_from_plex) | **POST** /user/import-from-plex | Import all users from Plex\n*UsersApi* | [**create_user_register_push_subscription**](docs/UsersApi.md#create_user_register_push_subscription) | **POST** /user/registerPushSubscription | Register a web push /user/registerPushSubscription\n*UsersApi* | [**create_user_settings_main**](docs/UsersApi.md#create_user_settings_main) | **POST** /user/{userId}/settings/main | Update general settings for a user\n*UsersApi* | [**create_user_settings_notifications**](docs/UsersApi.md#create_user_settings_notifications) | **POST** /user/{userId}/settings/notifications | Update notification settings for a user\n*UsersApi* | [**create_user_settings_password**](docs/UsersApi.md#create_user_settings_password) | **POST** /user/{userId}/settings/password | Update password for a user\n*UsersApi* | [**create_user_settings_permissions**](docs/UsersApi.md#create_user_settings_permissions) | **POST** /user/{userId}/settings/permissions | Update permission settings for a user\n*UsersApi* | [**delete_user**](docs/UsersApi.md#delete_user) | **DELETE** /user/{userId} | Delete user by ID\n*UsersApi* | [**get_user**](docs/UsersApi.md#get_user) | **GET** /user | Get all users\n*UsersApi* | [**get_user_by_user_id**](docs/UsersApi.md#get_user_by_user_id) | **GET** /user/{userId} | Get user by ID\n*UsersApi* | [**get_user_quota**](docs/UsersApi.md#get_user_quota) | **GET** /user/{userId}/quota | Get quotas for a specific user\n*UsersApi* | [**get_user_requests**](docs/UsersApi.md#get_user_requests) | **GET** /user/{userId}/requests | Get requests for a specific user\n*UsersApi* | [**get_user_settings_main**](docs/UsersApi.md#get_user_settings_main) | **GET** /user/{userId}/settings/main | Get general settings for a user\n*UsersApi* | [**get_user_settings_notifications**](docs/UsersApi.md#get_user_settings_notifications) | **GET** /user/{userId}/settings/notifications | Get notification settings for a user\n*UsersApi* | [**get_user_settings_password**](docs/UsersApi.md#get_user_settings_password) | **GET** /user/{userId}/settings/password | Get password page informatiom\n*UsersApi* | [**get_user_settings_permissions**](docs/UsersApi.md#get_user_settings_permissions) | **GET** /user/{userId}/settings/permissions | Get permission settings for a user\n*UsersApi* | [**get_user_watch_data**](docs/UsersApi.md#get_user_watch_data) | **GET** /user/{userId}/watch_data | Get watch data\n*UsersApi* | [**get_user_watchlist**](docs/UsersApi.md#get_user_watchlist) | **GET** /user/{userId}/watchlist | Get the Plex watchlist for a specific user\n*UsersApi* | [**put_user**](docs/UsersApi.md#put_user) | **PUT** /user | Update batch of users\n*UsersApi* | [**update_user**](docs/UsersApi.md#update_user) | **PUT** /user/{userId} | Update a user by user ID\n\n\n## Documentation For Models\n\n - [Cast](docs/Cast.md)\n - [Collection](docs/Collection.md)\n - [Company](docs/Company.md)\n - [CreateAuthLocalRequest](docs/CreateAuthLocalRequest.md)\n - [CreateAuthLogout2XXResponse](docs/CreateAuthLogout2XXResponse.md)\n - [CreateAuthPlexRequest](docs/CreateAuthPlexRequest.md)\n - [CreateAuthResetPasswordByGuidRequest](docs/CreateAuthResetPasswordByGuidRequest.md)\n - [CreateAuthResetPasswordRequest](docs/CreateAuthResetPasswordRequest.md)\n - [CreateDiscoverAddRequest](docs/CreateDiscoverAddRequest.md)\n - [CreateIssueCommentRequest](docs/CreateIssueCommentRequest.md)\n - [CreateIssueRequest](docs/CreateIssueRequest.md)\n - [CreateJobsScheduleRequest](docs/CreateJobsScheduleRequest.md)\n - [CreateMediaByStatusRequest](docs/CreateMediaByStatusRequest.md)\n - [CreatePlexSyncRequest](docs/CreatePlexSyncRequest.md)\n - [CreateRequestRequest](docs/CreateRequestRequest.md)\n - [CreateRequestRequestSeasons](docs/CreateRequestRequestSeasons.md)\n - [CreateUserImportFromPlexRequest](docs/CreateUserImportFromPlexRequest.md)\n - [CreateUserRegisterPushSubscriptionRequest](docs/CreateUserRegisterPushSubscriptionRequest.md)\n - [CreateUserRequest](docs/CreateUserRequest.md)\n - [CreateUserSettingsMainRequest](docs/CreateUserSettingsMainRequest.md)\n - [CreateUserSettingsPasswordRequest](docs/CreateUserSettingsPasswordRequest.md)\n - [CreateUserSettingsPermissionsRequest](docs/CreateUserSettingsPermissionsRequest.md)\n - [CreditCast](docs/CreditCast.md)\n - [CreditCrew](docs/CreditCrew.md)\n - [Crew](docs/Crew.md)\n - [DiscordSettings](docs/DiscordSettings.md)\n - [DiscordSettingsOptions](docs/DiscordSettingsOptions.md)\n - [DiscoverSlider](docs/DiscoverSlider.md)\n - [Episode](docs/Episode.md)\n - [ExternalIds](docs/ExternalIds.md)\n - [Genre](docs/Genre.md)\n - [GetAbout2XXResponse](docs/GetAbout2XXResponse.md)\n - [GetCache2XXResponse](docs/GetCache2XXResponse.md)\n - [GetCache2XXResponseApiCachesInner](docs/GetCache2XXResponseApiCachesInner.md)\n - [GetCache2XXResponseApiCachesInnerStats](docs/GetCache2XXResponseApiCachesInnerStats.md)\n - [GetCache2XXResponseImageCache](docs/GetCache2XXResponseImageCache.md)\n - [GetCache2XXResponseImageCacheTmdb](docs/GetCache2XXResponseImageCacheTmdb.md)\n - [GetDiscoverMovies2XXResponse](docs/GetDiscoverMovies2XXResponse.md)\n - [GetDiscoverMoviesGenreByGenreId2XXResponse](docs/GetDiscoverMoviesGenreByGenreId2XXResponse.md)\n - [GetDiscoverMoviesLanguageByLanguage2XXResponse](docs/GetDiscoverMoviesLanguageByLanguage2XXResponse.md)\n - [GetDiscoverMoviesStudioByStudioId2XXResponse](docs/GetDiscoverMoviesStudioByStudioId2XXResponse.md)\n - [GetDiscoverTv2XXResponse](docs/GetDiscoverTv2XXResponse.md)\n - [GetDiscoverTvGenreByGenreId2XXResponse](docs/GetDiscoverTvGenreByGenreId2XXResponse.md)\n - [GetDiscoverTvLanguageByLanguage2XXResponse](docs/GetDiscoverTvLanguageByLanguage2XXResponse.md)\n - [GetDiscoverTvNetworkByNetworkId2XXResponse](docs/GetDiscoverTvNetworkByNetworkId2XXResponse.md)\n - [GetIssue2XXResponse](docs/GetIssue2XXResponse.md)\n - [GetIssueCount2XXResponse](docs/GetIssueCount2XXResponse.md)\n - [GetMedia2XXResponse](docs/GetMedia2XXResponse.md)\n - [GetMediaWatchData2XXResponse](docs/GetMediaWatchData2XXResponse.md)\n - [GetMediaWatchData2XXResponseData](docs/GetMediaWatchData2XXResponseData.md)\n - [GetMovieRatings2XXResponse](docs/GetMovieRatings2XXResponse.md)\n - [GetPersonCombinedCredits2XXResponse](docs/GetPersonCombinedCredits2XXResponse.md)\n - [GetPlexSync2XXResponse](docs/GetPlexSync2XXResponse.md)\n - [GetRequestCount2XXResponse](docs/GetRequestCount2XXResponse.md)\n - [GetSearch2XXResponse](docs/GetSearch2XXResponse.md)\n - [GetSearch2XXResponseResultsInner](docs/GetSearch2XXResponseResultsInner.md)\n - [GetSearchCompany2XXResponse](docs/GetSearchCompany2XXResponse.md)\n - [GetSearchKeyword2XXResponse](docs/GetSearchKeyword2XXResponse.md)\n - [GetServiceRadarrByRadarrId2XXResponse](docs/GetServiceRadarrByRadarrId2XXResponse.md)\n - [GetServiceSonarrBySonarrId2XXResponse](docs/GetServiceSonarrBySonarrId2XXResponse.md)\n - [GetStatus2XXResponse](docs/GetStatus2XXResponse.md)\n - [GetStatusAppdata2XXResponse](docs/GetStatusAppdata2XXResponse.md)\n - [GetTvRatings2XXResponse](docs/GetTvRatings2XXResponse.md)\n - [GetUser2XXResponse](docs/GetUser2XXResponse.md)\n - [GetUserQuota2XXResponse](docs/GetUserQuota2XXResponse.md)\n - [GetUserQuota2XXResponseMovie](docs/GetUserQuota2XXResponseMovie.md)\n - [GetUserRequests2XXResponse](docs/GetUserRequests2XXResponse.md)\n - [GetUserSettingsMain2XXResponse](docs/GetUserSettingsMain2XXResponse.md)\n - [GetUserSettingsPassword2XXResponse](docs/GetUserSettingsPassword2XXResponse.md)\n - [GetUserSettingsPermissions2XXResponse](docs/GetUserSettingsPermissions2XXResponse.md)\n - [GetUserWatchData2XXResponse](docs/GetUserWatchData2XXResponse.md)\n - [GetUserWatchlist2XXResponse](docs/GetUserWatchlist2XXResponse.md)\n - [GetUserWatchlist2XXResponseResultsInner](docs/GetUserWatchlist2XXResponseResultsInner.md)\n - [GotifySettings](docs/GotifySettings.md)\n - [GotifySettingsOptions](docs/GotifySettingsOptions.md)\n - [Issue](docs/Issue.md)\n - [IssueComment](docs/IssueComment.md)\n - [Job](docs/Job.md)\n - [Keyword](docs/Keyword.md)\n - [ListDiscoverGenresliderMovie2XXResponseInner](docs/ListDiscoverGenresliderMovie2XXResponseInner.md)\n - [ListGenresMovie2XXResponseInner](docs/ListGenresMovie2XXResponseInner.md)\n - [ListGenresTv2XXResponseInner](docs/ListGenresTv2XXResponseInner.md)\n - [ListLanguages2XXResponseInner](docs/ListLanguages2XXResponseInner.md)\n - [ListLogs2XXResponseInner](docs/ListLogs2XXResponseInner.md)\n - [ListPlexUsers2XXResponseInner](docs/ListPlexUsers2XXResponseInner.md)\n - [ListRegions2XXResponseInner](docs/ListRegions2XXResponseInner.md)\n - [LunaSeaSettings](docs/LunaSeaSettings.md)\n - [LunaSeaSettingsOptions](docs/LunaSeaSettingsOptions.md)\n - [MainSettings](docs/MainSettings.md)\n - [MediaInfo](docs/MediaInfo.md)\n - [MediaRequest](docs/MediaRequest.md)\n - [MediaRequestModifiedBy](docs/MediaRequestModifiedBy.md)\n - [MovieDetails](docs/MovieDetails.md)\n - [MovieDetailsCollection](docs/MovieDetailsCollection.md)\n - [MovieDetailsCredits](docs/MovieDetailsCredits.md)\n - [MovieDetailsProductionCountriesInner](docs/MovieDetailsProductionCountriesInner.md)\n - [MovieDetailsReleases](docs/MovieDetailsReleases.md)\n - [MovieDetailsReleasesResultsInner](docs/MovieDetailsReleasesResultsInner.md)\n - [MovieDetailsReleasesResultsInnerReleaseDatesInner](docs/MovieDetailsReleasesResultsInnerReleaseDatesInner.md)\n - [MovieResult](docs/MovieResult.md)\n - [Network](docs/Network.md)\n - [NotificationAgentTypes](docs/NotificationAgentTypes.md)\n - [NotificationEmailSettings](docs/NotificationEmailSettings.md)\n - [NotificationEmailSettingsOptions](docs/NotificationEmailSettingsOptions.md)\n - [PageInfo](docs/PageInfo.md)\n - [PersonDetails](docs/PersonDetails.md)\n - [PersonResult](docs/PersonResult.md)\n - [PersonResultKnownForInner](docs/PersonResultKnownForInner.md)\n - [PlexConnection](docs/PlexConnection.md)\n - [PlexDevice](docs/PlexDevice.md)\n - [PlexLibrary](docs/PlexLibrary.md)\n - [PlexSettings](docs/PlexSettings.md)\n - [ProductionCompany](docs/ProductionCompany.md)\n - [PublicSettings](docs/PublicSettings.md)\n - [PushbulletSettings](docs/PushbulletSettings.md)\n - [PushbulletSettingsOptions](docs/PushbulletSettingsOptions.md)\n - [PushoverSettings](docs/PushoverSettings.md)\n - [PushoverSettingsOptions](docs/PushoverSettingsOptions.md)\n - [PutUserRequest](docs/PutUserRequest.md)\n - [RadarrSettings](docs/RadarrSettings.md)\n - [RelatedVideo](docs/RelatedVideo.md)\n - [Season](docs/Season.md)\n - [ServarrTag](docs/ServarrTag.md)\n - [ServiceProfile](docs/ServiceProfile.md)\n - [SlackSettings](docs/SlackSettings.md)\n - [SlackSettingsOptions](docs/SlackSettingsOptions.md)\n - [SonarrSeries](docs/SonarrSeries.md)\n - [SonarrSeriesAddOptionsInner](docs/SonarrSeriesAddOptionsInner.md)\n - [SonarrSeriesImagesInner](docs/SonarrSeriesImagesInner.md)\n - [SonarrSeriesRatingsInner](docs/SonarrSeriesRatingsInner.md)\n - [SonarrSeriesSeasonsInner](docs/SonarrSeriesSeasonsInner.md)\n - [SonarrSettings](docs/SonarrSettings.md)\n - [SpokenLanguage](docs/SpokenLanguage.md)\n - [TautulliSettings](docs/TautulliSettings.md)\n - [TelegramSettings](docs/TelegramSettings.md)\n - [TelegramSettingsOptions](docs/TelegramSettingsOptions.md)\n - [TestRadarr2XXResponse](docs/TestRadarr2XXResponse.md)\n - [TestRadarrRequest](docs/TestRadarrRequest.md)\n - [TestSonarrRequest](docs/TestSonarrRequest.md)\n - [TvDetails](docs/TvDetails.md)\n - [TvDetailsContentRatings](docs/TvDetailsContentRatings.md)\n - [TvDetailsContentRatingsResultsInner](docs/TvDetailsContentRatingsResultsInner.md)\n - [TvDetailsCreatedByInner](docs/TvDetailsCreatedByInner.md)\n - [TvResult](docs/TvResult.md)\n - [UpdateDiscoverRequest](docs/UpdateDiscoverRequest.md)\n - [UpdateIssueCommentRequest](docs/UpdateIssueCommentRequest.md)\n - [UpdateRequestRequest](docs/UpdateRequestRequest.md)\n - [User](docs/User.md)\n - [UserSettings](docs/UserSettings.md)\n - [UserSettingsNotifications](docs/UserSettingsNotifications.md)\n - [WatchProviderDetails](docs/WatchProviderDetails.md)\n - [WatchProviderRegion](docs/WatchProviderRegion.md)\n - [WatchProvidersInner](docs/WatchProvidersInner.md)\n - [WebPushSettings](docs/WebPushSettings.md)\n - [WebhookSettings](docs/WebhookSettings.md)\n - [WebhookSettingsOptions](docs/WebhookSettingsOptions.md)\n\n\n\u003ca id=\"documentation-for-authorization\"\u003e\u003c/a\u003e\n## Documentation For Authorization\n\n\nAuthentication schemes defined for the API:\n\u003ca id=\"cookieAuth\"\u003e\u003c/a\u003e\n### cookieAuth\n\n- **Type**: API key\n- **API key parameter name**: connect.sid\n- **Location**: \n\n\u003ca id=\"apiKey\"\u003e\u003c/a\u003e\n### apiKey\n\n- **Type**: API key\n- **API key parameter name**: X-Api-Key\n- **Location**: HTTP header\n\n\n## Author\n\n\n\n\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdevopsarr%2Foverseerr-py","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdevopsarr%2Foverseerr-py","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdevopsarr%2Foverseerr-py/lists"}