#api-client #api-bindings #api-wrapper #generator #open-api #language #sonarr

sonarr-api-rs

Rust API wrapper for Sonarr

1 stable release

3.0.0 Jul 31, 2024

#500 in Web programming

Download history 233/week @ 2024-07-29 186/week @ 2024-08-05 23/week @ 2024-08-12 10/week @ 2024-08-26

222 downloads per month

GPL-3.0 license

1MB
16K SLoC

Rust API client for openapi

Sonarr API docs - The v3 API docs apply to both v3 and v4 versions of Sonarr. Some functionality may only be available in v4 of the Sonarr application.

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: 3.0.0
  • Package version: 3.0.0
  • Generator version: 7.7.0
  • Build package: org.openapitools.codegen.languages.RustClientCodegen

Installation

Add the following to Cargo.toml under [dependencies]:

sonarr-api-rs = "*"

Documentation for API Endpoints

All URIs are relative to http://localhost:8989

Class Method HTTP request Description
ApiInfoApi api_get GET /api
AuthenticationApi login_post POST /login
AuthenticationApi logout_get GET /logout
AutoTaggingApi api_v3_autotagging_get GET /api/v3/autotagging
AutoTaggingApi api_v3_autotagging_id_delete DELETE /api/v3/autotagging/{id}
AutoTaggingApi api_v3_autotagging_id_get GET /api/v3/autotagging/{id}
AutoTaggingApi api_v3_autotagging_id_put PUT /api/v3/autotagging/{id}
AutoTaggingApi api_v3_autotagging_post POST /api/v3/autotagging
AutoTaggingApi api_v3_autotagging_schema_get GET /api/v3/autotagging/schema
BackupApi api_v3_system_backup_get GET /api/v3/system/backup
BackupApi api_v3_system_backup_id_delete DELETE /api/v3/system/backup/{id}
BackupApi api_v3_system_backup_restore_id_post POST /api/v3/system/backup/restore/{id}
BackupApi api_v3_system_backup_restore_upload_post POST /api/v3/system/backup/restore/upload
BlocklistApi api_v3_blocklist_bulk_delete DELETE /api/v3/blocklist/bulk
BlocklistApi api_v3_blocklist_get GET /api/v3/blocklist
BlocklistApi api_v3_blocklist_id_delete DELETE /api/v3/blocklist/{id}
CalendarApi api_v3_calendar_get GET /api/v3/calendar
CalendarApi api_v3_calendar_id_get GET /api/v3/calendar/{id}
CalendarFeedApi feed_v3_calendar_sonarr_ics_get GET /feed/v3/calendar/sonarr.ics
CommandApi api_v3_command_get GET /api/v3/command
CommandApi api_v3_command_id_delete DELETE /api/v3/command/{id}
CommandApi api_v3_command_id_get GET /api/v3/command/{id}
CommandApi api_v3_command_post POST /api/v3/command
CustomFilterApi api_v3_customfilter_get GET /api/v3/customfilter
CustomFilterApi api_v3_customfilter_id_delete DELETE /api/v3/customfilter/{id}
CustomFilterApi api_v3_customfilter_id_get GET /api/v3/customfilter/{id}
CustomFilterApi api_v3_customfilter_id_put PUT /api/v3/customfilter/{id}
CustomFilterApi api_v3_customfilter_post POST /api/v3/customfilter
CustomFormatApi api_v3_customformat_get GET /api/v3/customformat
CustomFormatApi api_v3_customformat_id_delete DELETE /api/v3/customformat/{id}
CustomFormatApi api_v3_customformat_id_get GET /api/v3/customformat/{id}
CustomFormatApi api_v3_customformat_id_put PUT /api/v3/customformat/{id}
CustomFormatApi api_v3_customformat_post POST /api/v3/customformat
CustomFormatApi api_v3_customformat_schema_get GET /api/v3/customformat/schema
CutoffApi api_v3_wanted_cutoff_get GET /api/v3/wanted/cutoff
CutoffApi api_v3_wanted_cutoff_id_get GET /api/v3/wanted/cutoff/{id}
DelayProfileApi api_v3_delayprofile_get GET /api/v3/delayprofile
DelayProfileApi api_v3_delayprofile_id_delete DELETE /api/v3/delayprofile/{id}
DelayProfileApi api_v3_delayprofile_id_get GET /api/v3/delayprofile/{id}
DelayProfileApi api_v3_delayprofile_id_put PUT /api/v3/delayprofile/{id}
DelayProfileApi api_v3_delayprofile_post POST /api/v3/delayprofile
DelayProfileApi api_v3_delayprofile_reorder_id_put PUT /api/v3/delayprofile/reorder/{id}
DiskSpaceApi api_v3_diskspace_get GET /api/v3/diskspace
DownloadClientApi api_v3_downloadclient_action_name_post POST /api/v3/downloadclient/action/{name}
DownloadClientApi api_v3_downloadclient_bulk_delete DELETE /api/v3/downloadclient/bulk
DownloadClientApi api_v3_downloadclient_bulk_put PUT /api/v3/downloadclient/bulk
DownloadClientApi api_v3_downloadclient_get GET /api/v3/downloadclient
DownloadClientApi api_v3_downloadclient_id_delete DELETE /api/v3/downloadclient/{id}
DownloadClientApi api_v3_downloadclient_id_get GET /api/v3/downloadclient/{id}
DownloadClientApi api_v3_downloadclient_id_put PUT /api/v3/downloadclient/{id}
DownloadClientApi api_v3_downloadclient_post POST /api/v3/downloadclient
DownloadClientApi api_v3_downloadclient_schema_get GET /api/v3/downloadclient/schema
DownloadClientApi api_v3_downloadclient_test_post POST /api/v3/downloadclient/test
DownloadClientApi api_v3_downloadclient_testall_post POST /api/v3/downloadclient/testall
DownloadClientConfigApi api_v3_config_downloadclient_get GET /api/v3/config/downloadclient
DownloadClientConfigApi api_v3_config_downloadclient_id_get GET /api/v3/config/downloadclient/{id}
DownloadClientConfigApi api_v3_config_downloadclient_id_put PUT /api/v3/config/downloadclient/{id}
EpisodeApi api_v3_episode_get GET /api/v3/episode
EpisodeApi api_v3_episode_id_get GET /api/v3/episode/{id}
EpisodeApi api_v3_episode_id_put PUT /api/v3/episode/{id}
EpisodeApi api_v3_episode_monitor_put PUT /api/v3/episode/monitor
EpisodeFileApi api_v3_episodefile_bulk_delete DELETE /api/v3/episodefile/bulk
EpisodeFileApi api_v3_episodefile_bulk_put PUT /api/v3/episodefile/bulk
EpisodeFileApi api_v3_episodefile_editor_put PUT /api/v3/episodefile/editor
EpisodeFileApi api_v3_episodefile_get GET /api/v3/episodefile
EpisodeFileApi api_v3_episodefile_id_delete DELETE /api/v3/episodefile/{id}
EpisodeFileApi api_v3_episodefile_id_get GET /api/v3/episodefile/{id}
EpisodeFileApi api_v3_episodefile_id_put PUT /api/v3/episodefile/{id}
FileSystemApi api_v3_filesystem_get GET /api/v3/filesystem
FileSystemApi api_v3_filesystem_mediafiles_get GET /api/v3/filesystem/mediafiles
FileSystemApi api_v3_filesystem_type_get GET /api/v3/filesystem/type
HealthApi api_v3_health_get GET /api/v3/health
HistoryApi api_v3_history_failed_id_post POST /api/v3/history/failed/{id}
HistoryApi api_v3_history_get GET /api/v3/history
HistoryApi api_v3_history_series_get GET /api/v3/history/series
HistoryApi api_v3_history_since_get GET /api/v3/history/since
HostConfigApi api_v3_config_host_get GET /api/v3/config/host
HostConfigApi api_v3_config_host_id_get GET /api/v3/config/host/{id}
HostConfigApi api_v3_config_host_id_put PUT /api/v3/config/host/{id}
ImportListApi api_v3_importlist_action_name_post POST /api/v3/importlist/action/{name}
ImportListApi api_v3_importlist_bulk_delete DELETE /api/v3/importlist/bulk
ImportListApi api_v3_importlist_bulk_put PUT /api/v3/importlist/bulk
ImportListApi api_v3_importlist_get GET /api/v3/importlist
ImportListApi api_v3_importlist_id_delete DELETE /api/v3/importlist/{id}
ImportListApi api_v3_importlist_id_get GET /api/v3/importlist/{id}
ImportListApi api_v3_importlist_id_put PUT /api/v3/importlist/{id}
ImportListApi api_v3_importlist_post POST /api/v3/importlist
ImportListApi api_v3_importlist_schema_get GET /api/v3/importlist/schema
ImportListApi api_v3_importlist_test_post POST /api/v3/importlist/test
ImportListApi api_v3_importlist_testall_post POST /api/v3/importlist/testall
ImportListConfigApi api_v3_config_importlist_get GET /api/v3/config/importlist
ImportListConfigApi api_v3_config_importlist_id_get GET /api/v3/config/importlist/{id}
ImportListConfigApi api_v3_config_importlist_id_put PUT /api/v3/config/importlist/{id}
ImportListExclusionApi api_v3_importlistexclusion_get GET /api/v3/importlistexclusion
ImportListExclusionApi api_v3_importlistexclusion_id_delete DELETE /api/v3/importlistexclusion/{id}
ImportListExclusionApi api_v3_importlistexclusion_id_get GET /api/v3/importlistexclusion/{id}
ImportListExclusionApi api_v3_importlistexclusion_id_put PUT /api/v3/importlistexclusion/{id}
ImportListExclusionApi api_v3_importlistexclusion_paged_get GET /api/v3/importlistexclusion/paged
ImportListExclusionApi api_v3_importlistexclusion_post POST /api/v3/importlistexclusion
IndexerApi api_v3_indexer_action_name_post POST /api/v3/indexer/action/{name}
IndexerApi api_v3_indexer_bulk_delete DELETE /api/v3/indexer/bulk
IndexerApi api_v3_indexer_bulk_put PUT /api/v3/indexer/bulk
IndexerApi api_v3_indexer_get GET /api/v3/indexer
IndexerApi api_v3_indexer_id_delete DELETE /api/v3/indexer/{id}
IndexerApi api_v3_indexer_id_get GET /api/v3/indexer/{id}
IndexerApi api_v3_indexer_id_put PUT /api/v3/indexer/{id}
IndexerApi api_v3_indexer_post POST /api/v3/indexer
IndexerApi api_v3_indexer_schema_get GET /api/v3/indexer/schema
IndexerApi api_v3_indexer_test_post POST /api/v3/indexer/test
IndexerApi api_v3_indexer_testall_post POST /api/v3/indexer/testall
IndexerConfigApi api_v3_config_indexer_get GET /api/v3/config/indexer
IndexerConfigApi api_v3_config_indexer_id_get GET /api/v3/config/indexer/{id}
IndexerConfigApi api_v3_config_indexer_id_put PUT /api/v3/config/indexer/{id}
IndexerFlagApi api_v3_indexerflag_get GET /api/v3/indexerflag
LanguageApi api_v3_language_get GET /api/v3/language
LanguageApi api_v3_language_id_get GET /api/v3/language/{id}
LanguageProfileApi api_v3_languageprofile_get GET /api/v3/languageprofile
LanguageProfileApi api_v3_languageprofile_id_delete DELETE /api/v3/languageprofile/{id}
LanguageProfileApi api_v3_languageprofile_id_get GET /api/v3/languageprofile/{id}
LanguageProfileApi api_v3_languageprofile_id_put PUT /api/v3/languageprofile/{id}
LanguageProfileApi api_v3_languageprofile_post POST /api/v3/languageprofile
LanguageProfileSchemaApi api_v3_languageprofile_schema_get GET /api/v3/languageprofile/schema
LocalizationApi api_v3_localization_get GET /api/v3/localization
LocalizationApi api_v3_localization_id_get GET /api/v3/localization/{id}
LocalizationApi api_v3_localization_language_get GET /api/v3/localization/language
LogApi api_v3_log_get GET /api/v3/log
LogFileApi api_v3_log_file_filename_get GET /api/v3/log/file/{filename}
LogFileApi api_v3_log_file_get GET /api/v3/log/file
ManualImportApi api_v3_manualimport_get GET /api/v3/manualimport
ManualImportApi api_v3_manualimport_post POST /api/v3/manualimport
MediaCoverApi api_v3_mediacover_series_id_filename_get GET /api/v3/mediacover/{seriesId}/{filename}
MediaManagementConfigApi api_v3_config_mediamanagement_get GET /api/v3/config/mediamanagement
MediaManagementConfigApi api_v3_config_mediamanagement_id_get GET /api/v3/config/mediamanagement/{id}
MediaManagementConfigApi api_v3_config_mediamanagement_id_put PUT /api/v3/config/mediamanagement/{id}
MetadataApi api_v3_metadata_action_name_post POST /api/v3/metadata/action/{name}
MetadataApi api_v3_metadata_get GET /api/v3/metadata
MetadataApi api_v3_metadata_id_delete DELETE /api/v3/metadata/{id}
MetadataApi api_v3_metadata_id_get GET /api/v3/metadata/{id}
MetadataApi api_v3_metadata_id_put PUT /api/v3/metadata/{id}
MetadataApi api_v3_metadata_post POST /api/v3/metadata
MetadataApi api_v3_metadata_schema_get GET /api/v3/metadata/schema
MetadataApi api_v3_metadata_test_post POST /api/v3/metadata/test
MetadataApi api_v3_metadata_testall_post POST /api/v3/metadata/testall
MissingApi api_v3_wanted_missing_get GET /api/v3/wanted/missing
MissingApi api_v3_wanted_missing_id_get GET /api/v3/wanted/missing/{id}
NamingConfigApi api_v3_config_naming_examples_get GET /api/v3/config/naming/examples
NamingConfigApi api_v3_config_naming_get GET /api/v3/config/naming
NamingConfigApi api_v3_config_naming_id_get GET /api/v3/config/naming/{id}
NamingConfigApi api_v3_config_naming_id_put PUT /api/v3/config/naming/{id}
NotificationApi api_v3_notification_action_name_post POST /api/v3/notification/action/{name}
NotificationApi api_v3_notification_get GET /api/v3/notification
NotificationApi api_v3_notification_id_delete DELETE /api/v3/notification/{id}
NotificationApi api_v3_notification_id_get GET /api/v3/notification/{id}
NotificationApi api_v3_notification_id_put PUT /api/v3/notification/{id}
NotificationApi api_v3_notification_post POST /api/v3/notification
NotificationApi api_v3_notification_schema_get GET /api/v3/notification/schema
NotificationApi api_v3_notification_test_post POST /api/v3/notification/test
NotificationApi api_v3_notification_testall_post POST /api/v3/notification/testall
ParseApi api_v3_parse_get GET /api/v3/parse
PingApi ping_get GET /ping
PingApi ping_head HEAD /ping
QualityDefinitionApi api_v3_qualitydefinition_get GET /api/v3/qualitydefinition
QualityDefinitionApi api_v3_qualitydefinition_id_get GET /api/v3/qualitydefinition/{id}
QualityDefinitionApi api_v3_qualitydefinition_id_put PUT /api/v3/qualitydefinition/{id}
QualityDefinitionApi api_v3_qualitydefinition_update_put PUT /api/v3/qualitydefinition/update
QualityProfileApi api_v3_qualityprofile_get GET /api/v3/qualityprofile
QualityProfileApi api_v3_qualityprofile_id_delete DELETE /api/v3/qualityprofile/{id}
QualityProfileApi api_v3_qualityprofile_id_get GET /api/v3/qualityprofile/{id}
QualityProfileApi api_v3_qualityprofile_id_put PUT /api/v3/qualityprofile/{id}
QualityProfileApi api_v3_qualityprofile_post POST /api/v3/qualityprofile
QualityProfileSchemaApi api_v3_qualityprofile_schema_get GET /api/v3/qualityprofile/schema
QueueApi api_v3_queue_bulk_delete DELETE /api/v3/queue/bulk
QueueApi api_v3_queue_get GET /api/v3/queue
QueueApi api_v3_queue_id_delete DELETE /api/v3/queue/{id}
QueueActionApi api_v3_queue_grab_bulk_post POST /api/v3/queue/grab/bulk
QueueActionApi api_v3_queue_grab_id_post POST /api/v3/queue/grab/{id}
QueueDetailsApi api_v3_queue_details_get GET /api/v3/queue/details
QueueStatusApi api_v3_queue_status_get GET /api/v3/queue/status
ReleaseApi api_v3_release_get GET /api/v3/release
ReleaseApi api_v3_release_post POST /api/v3/release
ReleaseProfileApi api_v3_releaseprofile_get GET /api/v3/releaseprofile
ReleaseProfileApi api_v3_releaseprofile_id_delete DELETE /api/v3/releaseprofile/{id}
ReleaseProfileApi api_v3_releaseprofile_id_get GET /api/v3/releaseprofile/{id}
ReleaseProfileApi api_v3_releaseprofile_id_put PUT /api/v3/releaseprofile/{id}
ReleaseProfileApi api_v3_releaseprofile_post POST /api/v3/releaseprofile
ReleasePushApi api_v3_release_push_post POST /api/v3/release/push
RemotePathMappingApi api_v3_remotepathmapping_get GET /api/v3/remotepathmapping
RemotePathMappingApi api_v3_remotepathmapping_id_delete DELETE /api/v3/remotepathmapping/{id}
RemotePathMappingApi api_v3_remotepathmapping_id_get GET /api/v3/remotepathmapping/{id}
RemotePathMappingApi api_v3_remotepathmapping_id_put PUT /api/v3/remotepathmapping/{id}
RemotePathMappingApi api_v3_remotepathmapping_post POST /api/v3/remotepathmapping
RenameEpisodeApi api_v3_rename_get GET /api/v3/rename
RootFolderApi api_v3_rootfolder_get GET /api/v3/rootfolder
RootFolderApi api_v3_rootfolder_id_delete DELETE /api/v3/rootfolder/{id}
RootFolderApi api_v3_rootfolder_id_get GET /api/v3/rootfolder/{id}
RootFolderApi api_v3_rootfolder_post POST /api/v3/rootfolder
SeasonPassApi api_v3_seasonpass_post POST /api/v3/seasonpass
SeriesApi api_v3_series_get GET /api/v3/series
SeriesApi api_v3_series_id_delete DELETE /api/v3/series/{id}
SeriesApi api_v3_series_id_get GET /api/v3/series/{id}
SeriesApi api_v3_series_id_put PUT /api/v3/series/{id}
SeriesApi api_v3_series_post POST /api/v3/series
SeriesEditorApi api_v3_series_editor_delete DELETE /api/v3/series/editor
SeriesEditorApi api_v3_series_editor_put PUT /api/v3/series/editor
SeriesImportApi api_v3_series_import_post POST /api/v3/series/import
SeriesLookupApi api_v3_series_lookup_get GET /api/v3/series/lookup
StaticResourceApi content_path_get GET /content/{path}
StaticResourceApi login_get GET /login
StaticResourceApi path_get GET /{path}
StaticResourceApi root_get GET /
SystemApi api_v3_system_restart_post POST /api/v3/system/restart
SystemApi api_v3_system_routes_duplicate_get GET /api/v3/system/routes/duplicate
SystemApi api_v3_system_routes_get GET /api/v3/system/routes
SystemApi api_v3_system_shutdown_post POST /api/v3/system/shutdown
SystemApi api_v3_system_status_get GET /api/v3/system/status
TagApi api_v3_tag_get GET /api/v3/tag
TagApi api_v3_tag_id_delete DELETE /api/v3/tag/{id}
TagApi api_v3_tag_id_get GET /api/v3/tag/{id}
TagApi api_v3_tag_id_put PUT /api/v3/tag/{id}
TagApi api_v3_tag_post POST /api/v3/tag
TagDetailsApi api_v3_tag_detail_get GET /api/v3/tag/detail
TagDetailsApi api_v3_tag_detail_id_get GET /api/v3/tag/detail/{id}
TaskApi api_v3_system_task_get GET /api/v3/system/task
TaskApi api_v3_system_task_id_get GET /api/v3/system/task/{id}
UiConfigApi api_v3_config_ui_get GET /api/v3/config/ui
UiConfigApi api_v3_config_ui_id_get GET /api/v3/config/ui/{id}
UiConfigApi api_v3_config_ui_id_put PUT /api/v3/config/ui/{id}
UpdateApi api_v3_update_get GET /api/v3/update
UpdateLogFileApi api_v3_log_file_update_filename_get GET /api/v3/log/file/update/{filename}
UpdateLogFileApi api_v3_log_file_update_get GET /api/v3/log/file/update

Documentation For Models

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

cargo doc --open

Author

Dependencies

~7–19MB
~283K SLoC