Sonarr MCP server
Allows interaction with a Sonarr instance via its full v3 API, providing tools for managing series, episodes, episode files, queue, history, calendar, quality profiles, custom formats, indexers, download clients, notifications, and system configuration.
Click on "Deploy Server".
Wait a few minutes for the server to deploy. Once ready, it will show a "Started" state.
In the chat, type
@followed by the MCP server name and your instructions, e.g., "@Sonarr MCP server Add the TV show 'Severance' to my library and search for available episodes."
That's it! The server will respond to your query, and you can continue using it as needed.
Here is a step-by-step guide with screenshots.
Sonarr MCP server
Run Sonarr from Claude.ai and Claude Code. All 234 operations of the v3 API are tools, generated from Sonarr's own OpenAPI document. Not a curated subset: every endpoint Sonarr's web interface can reach, this can reach.
Using this server with a paid AI service costs money. Tool definitions and results are billed as input tokens, and an agent can call tools repeatedly on its own. You are responsible for every charge, so set spending limits with your provider. The author accepts no liability for any costs. SeeDISCLAIMER.md.
Why not the other options
Measured against Sonarr.Api.V3/openapi.json, which has 162 paths and 234 non-HEAD operations:
Server | Sonarr tools | Coverage |
| 17 | 7 % |
| 8 | 3 % |
| unified verbs across 10 services | partial |
This one | 234 | 100 % |
The others hand-write a tool per endpoint they happened to need, so they cover series, queue and calendar and stop there. Nothing else exposes customformat, releaseprofile, delayprofile, autotagging, importlistexclusion, manualimport, seasonpass, remotepathmapping or qualitydefinition at all.
Related MCP server: sonarr-mcp
How it stays complete
src/sonarr_mcp/tools.py is generated, not written:
curl -o openapi.json https://raw.githubusercontent.com/Sonarr/Sonarr/develop/src/Sonarr.Api.V3/openapi.json
python scripts/generate_tools.py openapi.json src/sonarr_mcp/tools.pyA test compares every generated call against every operation in the spec, in both directions. An endpoint Sonarr adds and this misses fails the build; so does a tool pointing at an endpoint the spec does not define.
Tool names
Verb first, derived from the method and path, so the name says what it does:
Pattern | Meaning | Example |
| Read a collection |
|
| Read one record |
|
| POST |
|
| PUT |
|
| DELETE |
|
234 tools is a lot to put in front of a model at once. If your client supports tool filtering, narrow it to the groups you use.
What is covered
All 69 resource groups: series, episode, episodefile, seasonpass, queue, history, blocklist, calendar, wanted, command, release, manualimport, rename, parse, indexer, indexerflag, downloadclient, importlist, importlistexclusion, qualityprofile, qualitydefinition, customformat, customfilter, releaseprofile, delayprofile, autotagging, notification, metadata, tag, rootfolder, remotepathmapping, language, localization, mediacover, filesystem, diskspace, health, log, update, backup, system and the config endpoints.
Setup
git clone https://github.com/rollecode/sonarr-mcp.git
cd sonarr-mcp
uv venv && uv pip install -e .export SONARR_URL=http://127.0.0.1:8989
export SONARR_API_KEY=... # Settings, General, SecurityClaude Code
claude mcp add sonarr -- /path/to/sonarr-mcp/.venv/bin/sonarr-mcpWriting records
Sonarr replaces a record on PUT rather than merging, so read it first, change the fields you want and send the whole object back as body. For a new resource, list_*_schema returns the shape it expects.
Hosting it
Running it over HTTP puts it in reach of Claude.ai as a custom connector, and of Claude Code on other machines. Three tiers, the same shape the other servers in this family use:
Tier | Port | What it does |
| 8520 | The server. No login of its own, never exposed |
nginx | 8521 | Front door, behind a Cloudflare Tunnel |
| 8522 | OAuth 2.1 sign-in, or a fixed bearer token |
npm install
node set-password.js 'a password for the sign-in page'
printf 'SONARR_URL=...\n' > ~/.config/sonarr-mcp/env
chmod 600 ~/.config/sonarr-mcp/envCopy systemd/*.service into /etc/systemd/system/, replacing YOUR_USER and the ISSUER hostname, then:
sudo systemctl enable --now sonarr-mcp sonarr-mcp-authPoint nginx/sonarr-mcp.conf at your own hostname and send the tunnel at 127.0.0.1:8521.
Environment the server itself reads: SONARR_URL, SONARR_API_KEY. The sign-in page carries the Sonarr mark and accent colour, set through APP_NAME, APP_ACCENT and APP_BLURB in the auth unit.
Claude.ai
Settings, Connectors, Add custom connector, URL https://sonarr-mcp.your-domain/mcp, client ID and secret blank. The sign-in page asks for the password set above. Connectors belong to the account, so adding it once covers mobile too.
Development
uv pip install -e . pytest ruff
.venv/bin/python -m pytest tests
.venv/bin/ruff check .Available Tools
235 toolscreate_autotaggingBIdempotent
Create AutoTagging.
POST /api/v3/autotagging
Args: body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.
Inputs: body (required). Returns: result
create_commandBIdempotent
Create Command.
POST /api/v3/command
Args: body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.
Inputs: body (required). Returns: result
create_customfilterBIdempotent
Create CustomFilter.
POST /api/v3/customfilter
Args: body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.
Inputs: body (required). Returns: result
create_customformatAIdempotent
Create CustomFormat.
POST /api/v3/customformat
Args: body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.
Inputs: body (required). Returns: result
create_delayprofileCIdempotent
Create DelayProfile.
POST /api/v3/delayprofile
Args: body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.
Inputs: body (required). Returns: result
create_downloadclientBIdempotent
Create DownloadClient.
POST /api/v3/downloadclient
Args: body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects. force_save: Query parameter.
Inputs: body (required), force_save. Returns: result
create_downloadclient_action_by_nameCIdempotent
Create DownloadClient.
POST /api/v3/downloadclient/action/{name}
Args: name: Path parameter. body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.
Inputs: body (required), name (required). Returns: result
create_downloadclient_testDIdempotent
Create DownloadClient.
POST /api/v3/downloadclient/test
Args: body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects. force_test: Query parameter.
Inputs: body (required), force_test. Returns: result
create_downloadclient_testallDIdempotent
Create DownloadClient.
POST /api/v3/downloadclient/testall
Inputs: no named parameters. Returns: result
create_history_failed_by_idCIdempotent
Create History.
POST /api/v3/history/failed/{id}
Args: id: Path parameter.
Inputs: id (required). Returns: result
create_importlistCIdempotent
Create ImportList.
POST /api/v3/importlist
Args: body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects. force_save: Query parameter.
Inputs: body (required), force_save. Returns: result
create_importlist_action_by_nameCIdempotent
Create ImportList.
POST /api/v3/importlist/action/{name}
Args: name: Path parameter. body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.
Inputs: body (required), name (required). Returns: result
create_importlistexclusionBIdempotent
Create ImportListExclusion.
POST /api/v3/importlistexclusion
Args: body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.
Inputs: body (required). Returns: result
create_importlist_testCIdempotent
Create ImportList.
POST /api/v3/importlist/test
Args: body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects. force_test: Query parameter.
Inputs: body (required), force_test. Returns: result
create_importlist_testallCIdempotent
Create ImportList.
POST /api/v3/importlist/testall
Inputs: no named parameters. Returns: result
create_indexerCIdempotent
Create Indexer.
POST /api/v3/indexer
Args: body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects. force_save: Query parameter.
Inputs: body (required), force_save. Returns: result
create_indexer_action_by_nameCIdempotent
Create Indexer.
POST /api/v3/indexer/action/{name}
Args: name: Path parameter. body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.
Inputs: body (required), name (required). Returns: result
create_indexer_testCIdempotent
Create Indexer.
POST /api/v3/indexer/test
Args: body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects. force_test: Query parameter.
Inputs: body (required), force_test. Returns: result
create_indexer_testallDIdempotent
Create Indexer.
POST /api/v3/indexer/testall
Inputs: no named parameters. Returns: result
create_languageprofileBIdempotent
Create LanguageProfile.
POST /api/v3/languageprofile
Args: body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.
Inputs: body (required). Returns: result
create_loginCIdempotent
Create Authentication.
POST /login
Args: body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects. return_url: Query parameter.
Inputs: body (required), return_url. Returns: result
create_manualimportCIdempotent
Create ManualImport.
POST /api/v3/manualimport
Args: body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.
Inputs: body (required). Returns: result
create_metadataCIdempotent
Create Metadata.
POST /api/v3/metadata
Args: body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects. force_save: Query parameter.
Inputs: body (required), force_save. Returns: result
create_metadata_action_by_nameBIdempotent
Create Metadata.
POST /api/v3/metadata/action/{name}
Args: name: Path parameter. body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.
Inputs: body (required), name (required). Returns: result
create_metadata_testCIdempotent
Create Metadata.
POST /api/v3/metadata/test
Args: body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects. force_test: Query parameter.
Inputs: body (required), force_test. Returns: result
create_metadata_testallCIdempotent
Create Metadata.
POST /api/v3/metadata/testall
Inputs: no named parameters. Returns: result
create_notificationCIdempotent
Create Notification.
POST /api/v3/notification
Args: body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects. force_save: Query parameter.
Inputs: body (required), force_save. Returns: result
create_notification_action_by_nameBIdempotent
Create Notification.
POST /api/v3/notification/action/{name}
Args: name: Path parameter. body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.
Inputs: body (required), name (required). Returns: result
create_notification_testDIdempotent
Create Notification.
POST /api/v3/notification/test
Args: body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects. force_test: Query parameter.
Inputs: body (required), force_test. Returns: result
create_notification_testallDIdempotent
Create Notification.
POST /api/v3/notification/testall
Inputs: no named parameters. Returns: result
create_qualityprofileBIdempotent
Create QualityProfile.
POST /api/v3/qualityprofile
Args: body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.
Inputs: body (required). Returns: result
create_queue_grab_bulkCIdempotent
Create QueueAction.
POST /api/v3/queue/grab/bulk
Args: body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.
Inputs: body (required). Returns: result
create_queue_grab_by_idDIdempotent
Create QueueAction.
POST /api/v3/queue/grab/{id}
Args: id: Path parameter.
Inputs: id (required). Returns: result
create_releaseAIdempotent
Create Release.
POST /api/v3/release
Args: body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.
Inputs: body (required). Returns: result
create_releaseprofileAIdempotent
Create ReleaseProfile.
POST /api/v3/releaseprofile
Args: body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.
Inputs: body (required). Returns: result
create_release_pushBIdempotent
Create ReleasePush.
POST /api/v3/release/push
Args: body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.
Inputs: body (required). Returns: result
create_remotepathmappingAIdempotent
Create RemotePathMapping.
POST /api/v3/remotepathmapping
Args: body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.
Inputs: body (required). Returns: result
create_rootfolderBIdempotent
Create RootFolder.
POST /api/v3/rootfolder
Args: body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.
Inputs: body (required). Returns: result
create_seasonpassBIdempotent
Create SeasonPass.
POST /api/v3/seasonpass
Args: body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.
Inputs: body (required). Returns: result
create_seriesCIdempotent
Create Series.
POST /api/v3/series
Args: body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.
Inputs: body (required). Returns: result
create_series_importBIdempotent
Create SeriesImport.
POST /api/v3/series/import
Args: body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.
Inputs: body (required). Returns: result
create_system_backup_restore_by_idDIdempotent
Create Backup.
POST /api/v3/system/backup/restore/{id}
Args: id: Path parameter.
Inputs: id (required). Returns: result
create_system_backup_restore_uploadCIdempotent
Create Backup.
POST /api/v3/system/backup/restore/upload
Inputs: no named parameters. Returns: result
create_system_restartCIdempotent
Create System.
POST /api/v3/system/restart
Inputs: no named parameters. Returns: result
create_system_shutdownCIdempotent
Create System.
POST /api/v3/system/shutdown
Inputs: no named parameters. Returns: result
create_tagBIdempotent
Create Tag.
POST /api/v3/tag
Args: body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.
Inputs: body (required). Returns: result
delete_autotagging_by_idCDestructiveIdempotent
Delete AutoTagging.
DELETE /api/v3/autotagging/{id}
Args: id: Path parameter.
Inputs: id (required). Returns: result
delete_blocklist_bulkCDestructiveIdempotent
Delete Blocklist.
DELETE /api/v3/blocklist/bulk
Args: body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.
Inputs: body. Returns: result
delete_blocklist_by_idCDestructiveIdempotent
Delete Blocklist.
DELETE /api/v3/blocklist/{id}
Args: id: Path parameter.
Inputs: id (required). Returns: result
delete_command_by_idBDestructiveIdempotent
Delete Command.
DELETE /api/v3/command/{id}
Args: id: Path parameter.
Inputs: id (required). Returns: result
delete_customfilter_by_idCDestructiveIdempotent
Delete CustomFilter.
DELETE /api/v3/customfilter/{id}
Args: id: Path parameter.
Inputs: id (required). Returns: result
delete_customformat_bulkCDestructiveIdempotent
Delete CustomFormat.
DELETE /api/v3/customformat/bulk
Args: body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.
Inputs: body. Returns: result
delete_customformat_by_idCDestructiveIdempotent
Delete CustomFormat.
DELETE /api/v3/customformat/{id}
Args: id: Path parameter.
Inputs: id (required). Returns: result
delete_delayprofile_by_idDDestructiveIdempotent
Delete DelayProfile.
DELETE /api/v3/delayprofile/{id}
Args: id: Path parameter.
Inputs: id (required). Returns: result
delete_downloadclient_bulkCDestructiveIdempotent
Delete DownloadClient.
DELETE /api/v3/downloadclient/bulk
Args: body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.
Inputs: body. Returns: result
delete_downloadclient_by_idCDestructiveIdempotent
Delete DownloadClient.
DELETE /api/v3/downloadclient/{id}
Args: id: Path parameter.
Inputs: id (required). Returns: result
delete_episodefile_bulkCDestructiveIdempotent
Delete EpisodeFile.
DELETE /api/v3/episodefile/bulk
Args: body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.
Inputs: body. Returns: result
delete_episodefile_by_idCDestructiveIdempotent
Delete EpisodeFile.
DELETE /api/v3/episodefile/{id}
Args: id: Path parameter.
Inputs: id (required). Returns: result
delete_importlist_bulkCDestructiveIdempotent
Delete ImportList.
DELETE /api/v3/importlist/bulk
Args: body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.
Inputs: body. Returns: result
delete_importlist_by_idBDestructiveIdempotent
Delete ImportList.
DELETE /api/v3/importlist/{id}
Args: id: Path parameter.
Inputs: id (required). Returns: result
delete_importlistexclusion_bulkCDestructiveIdempotent
Delete ImportListExclusion.
DELETE /api/v3/importlistexclusion/bulk
Args: body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.
Inputs: body. Returns: result
delete_importlistexclusion_by_idCDestructiveIdempotent
Delete ImportListExclusion.
DELETE /api/v3/importlistexclusion/{id}
Args: id: Path parameter.
Inputs: id (required). Returns: result
delete_indexer_bulkCDestructiveIdempotent
Delete Indexer.
DELETE /api/v3/indexer/bulk
Args: body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.
Inputs: body. Returns: result
delete_indexer_by_idCDestructiveIdempotent
Delete Indexer.
DELETE /api/v3/indexer/{id}
Args: id: Path parameter.
Inputs: id (required). Returns: result
delete_languageprofile_by_idCDestructiveIdempotent
Delete LanguageProfile.
DELETE /api/v3/languageprofile/{id}
Args: id: Path parameter.
Inputs: id (required). Returns: result
delete_metadata_by_idCDestructiveIdempotent
Delete Metadata.
DELETE /api/v3/metadata/{id}
Args: id: Path parameter.
Inputs: id (required). Returns: result
delete_notification_by_idCDestructiveIdempotent
Delete Notification.
DELETE /api/v3/notification/{id}
Args: id: Path parameter.
Inputs: id (required). Returns: result
delete_qualityprofile_by_idCDestructiveIdempotent
Delete QualityProfile.
DELETE /api/v3/qualityprofile/{id}
Args: id: Path parameter.
Inputs: id (required). Returns: result
delete_queue_bulkCDestructiveIdempotent
Delete Queue.
DELETE /api/v3/queue/bulk
Args: body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects. remove_from_client: Query parameter. blocklist: Query parameter. skip_redownload: Query parameter. change_category: Query parameter.
Inputs: body, blocklist, change_category, skip_redownload, +1 more. Returns: result
delete_queue_by_idCDestructiveIdempotent
Delete Queue.
DELETE /api/v3/queue/{id}
Args: id: Path parameter. remove_from_client: Query parameter. blocklist: Query parameter. skip_redownload: Query parameter. change_category: Query parameter.
Inputs: id (required), blocklist, change_category, skip_redownload, +1 more. Returns: result
delete_releaseprofile_by_idADestructiveIdempotent
Delete ReleaseProfile.
DELETE /api/v3/releaseprofile/{id}
Args: id: Path parameter.
Inputs: id (required). Returns: result
delete_remotepathmapping_by_idCDestructiveIdempotent
Delete RemotePathMapping.
DELETE /api/v3/remotepathmapping/{id}
Args: id: Path parameter.
Inputs: id (required). Returns: result
delete_rootfolder_by_idBDestructiveIdempotent
Delete RootFolder.
DELETE /api/v3/rootfolder/{id}
Args: id: Path parameter.
Inputs: id (required). Returns: result
delete_series_by_idCDestructiveIdempotent
Delete Series.
DELETE /api/v3/series/{id}
Args: id: Path parameter. delete_files: Query parameter. add_import_list_exclusion: Query parameter.
Inputs: id (required), delete_files, add_import_list_exclusion. Returns: result
delete_series_editorCDestructiveIdempotent
Delete SeriesEditor.
DELETE /api/v3/series/editor
Args: body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.
Inputs: body. Returns: result
delete_system_backup_by_idCDestructiveIdempotent
Delete Backup.
DELETE /api/v3/system/backup/{id}
Args: id: Path parameter.
Inputs: id (required). Returns: result
delete_tag_by_idCDestructiveIdempotent
Delete Tag.
DELETE /api/v3/tag/{id}
Args: id: Path parameter.
Inputs: id (required). Returns: result
get_autotagging_by_idCRead-onlyIdempotent
Read AutoTagging.
GET /api/v3/autotagging/{id}
Args: id: Path parameter.
Inputs: id (required). Returns: result
get_by_pathCRead-onlyIdempotent
Read StaticResource.
GET /{path}
Args: path: Path parameter.
Inputs: path (required). Returns: result
get_calendar_by_idCRead-onlyIdempotent
Read Calendar.
GET /api/v3/calendar/{id}
Args: id: Path parameter.
Inputs: id (required). Returns: result
get_command_by_idCRead-onlyIdempotent
Read Command.
GET /api/v3/command/{id}
Args: id: Path parameter.
Inputs: id (required). Returns: result
get_config_downloadclient_by_idCRead-onlyIdempotent
Read DownloadClientConfig.
GET /api/v3/config/downloadclient/{id}
Args: id: Path parameter.
Inputs: id (required). Returns: result
get_config_host_by_idBRead-onlyIdempotent
Read HostConfig.
GET /api/v3/config/host/{id}
Args: id: Path parameter.
Inputs: id (required). Returns: result
get_config_importlist_by_idCRead-onlyIdempotent
Read ImportListConfig.
GET /api/v3/config/importlist/{id}
Args: id: Path parameter.
Inputs: id (required). Returns: result
get_config_indexer_by_idARead-onlyIdempotent
Read IndexerConfig.
GET /api/v3/config/indexer/{id}
Args: id: Path parameter.
Inputs: id (required). Returns: result
get_config_mediamanagement_by_idARead-onlyIdempotent
Read MediaManagementConfig.
GET /api/v3/config/mediamanagement/{id}
Args: id: Path parameter.
Inputs: id (required). Returns: result
get_config_naming_by_idCRead-onlyIdempotent
Read NamingConfig.
GET /api/v3/config/naming/{id}
Args: id: Path parameter.
Inputs: id (required). Returns: result
get_config_ui_by_idBRead-onlyIdempotent
Read UiConfig.
GET /api/v3/config/ui/{id}
Args: id: Path parameter.
Inputs: id (required). Returns: result
get_content_by_pathCRead-onlyIdempotent
Read StaticResource.
GET /content/{path}
Args: path: Path parameter.
Inputs: path (required). Returns: result
get_customfilter_by_idARead-onlyIdempotent
Read CustomFilter.
GET /api/v3/customfilter/{id}
Args: id: Path parameter.
Inputs: id (required). Returns: result
get_customformat_by_idBRead-onlyIdempotent
Read CustomFormat.
GET /api/v3/customformat/{id}
Args: id: Path parameter.
Inputs: id (required). Returns: result
get_delayprofile_by_idBRead-onlyIdempotent
Read DelayProfile.
GET /api/v3/delayprofile/{id}
Args: id: Path parameter.
Inputs: id (required). Returns: result
get_downloadclient_by_idBRead-onlyIdempotent
Read DownloadClient.
GET /api/v3/downloadclient/{id}
Args: id: Path parameter.
Inputs: id (required). Returns: result
get_episode_by_idCRead-onlyIdempotent
Read Episode.
GET /api/v3/episode/{id}
Args: id: Path parameter.
Inputs: id (required). Returns: result
get_episodefile_by_idARead-onlyIdempotent
Read EpisodeFile.
GET /api/v3/episodefile/{id}
Args: id: Path parameter.
Inputs: id (required). Returns: result
get_importlist_by_idCRead-onlyIdempotent
Read ImportList.
GET /api/v3/importlist/{id}
Args: id: Path parameter.
Inputs: id (required). Returns: result
get_importlistexclusion_by_idBRead-onlyIdempotent
Read ImportListExclusion.
GET /api/v3/importlistexclusion/{id}
Args: id: Path parameter.
Inputs: id (required). Returns: result
get_indexer_by_idCRead-onlyIdempotent
Read Indexer.
GET /api/v3/indexer/{id}
Args: id: Path parameter.
Inputs: id (required). Returns: result
get_language_by_idARead-onlyIdempotent
Read Language.
GET /api/v3/language/{id}
Args: id: Path parameter.
Inputs: id (required). Returns: result
get_languageprofile_by_idCRead-onlyIdempotent
Read LanguageProfile.
GET /api/v3/languageprofile/{id}
Args: id: Path parameter.
Inputs: id (required). Returns: result
get_localization_by_idCRead-onlyIdempotent
Read Localization.
GET /api/v3/localization/{id}
Args: id: Path parameter.
Inputs: id (required). Returns: result
get_log_file_by_filenameBRead-onlyIdempotent
Read LogFile.
GET /api/v3/log/file/{filename}
Args: filename: Path parameter.
Inputs: filename (required). Returns: result
get_log_file_update_by_filenameCRead-onlyIdempotent
Read UpdateLogFile.
GET /api/v3/log/file/update/{filename}
Args: filename: Path parameter.
Inputs: filename (required). Returns: result
get_mediacover_by_series_id_by_filenameCRead-onlyIdempotent
Read MediaCover.
GET /api/v3/mediacover/{seriesId}/{filename}
Args: series_id: Path parameter. filename: Path parameter.
Inputs: filename (required), series_id (required). Returns: result
get_metadata_by_idBRead-onlyIdempotent
Read Metadata.
GET /api/v3/metadata/{id}
Args: id: Path parameter.
Inputs: id (required). Returns: result
get_notification_by_idBRead-onlyIdempotent
Read Notification.
GET /api/v3/notification/{id}
Args: id: Path parameter.
Inputs: id (required). Returns: result
get_qualitydefinition_by_idARead-onlyIdempotent
Read QualityDefinition.
GET /api/v3/qualitydefinition/{id}
Args: id: Path parameter.
Inputs: id (required). Returns: result
get_qualityprofile_by_idCRead-onlyIdempotent
Read QualityProfile.
GET /api/v3/qualityprofile/{id}
Args: id: Path parameter.
Inputs: id (required). Returns: result
get_releaseprofile_by_idARead-onlyIdempotent
Read ReleaseProfile.
GET /api/v3/releaseprofile/{id}
Args: id: Path parameter.
Inputs: id (required). Returns: result
get_remotepathmapping_by_idBRead-onlyIdempotent
Read RemotePathMapping.
GET /api/v3/remotepathmapping/{id}
Args: id: Path parameter.
Inputs: id (required). Returns: result
get_result_pageARead-onlyIdempotent
Read more of a result that was too large to return in one piece.
Any tool whose answer is too large returns its first page with a
paging block. Pass that block's result_id here. Nothing is fetched
again: the stored result is paged, filtered and narrowed.
Args:
result_id: From the paging block of the earlier answer.
offset: First item to return, usually the previous next_offset.
limit: At most this many items. Fewer come back if they would not fit.
fields: Only these keys of each item. Dots reach nested keys, such as
"statistics.sizeOnDisk". The paging.fields list shows what exists.
match: Keep only items whose field contains this text, ignoring case,
for example {"title": "alien", "year": "1979"}.
path: Which list to page when the result holds several, as named in
paging.lists. Defaults to the largest.
Inputs: result_id (required), path, limit, match, +2 more. Returns: result
get_rootfolder_by_idCRead-onlyIdempotent
Read RootFolder.
GET /api/v3/rootfolder/{id}
Args: id: Path parameter.
Inputs: id (required). Returns: result
get_series_by_idCRead-onlyIdempotent
Read Series.
GET /api/v3/series/{id}
Args: id: Path parameter. include_season_images: Query parameter.
Inputs: id (required), include_season_images. Returns: result
get_series_by_id_folderDRead-onlyIdempotent
Read SeriesFolder.
GET /api/v3/series/{id}/folder
Args: id: Path parameter.
Inputs: id (required). Returns: result
get_system_task_by_idBRead-onlyIdempotent
Read Task.
GET /api/v3/system/task/{id}
Args: id: Path parameter.
Inputs: id (required). Returns: result
get_tag_by_idCRead-onlyIdempotent
Read Tag.
GET /api/v3/tag/{id}
Args: id: Path parameter.
Inputs: id (required). Returns: result
get_tag_detail_by_idCRead-onlyIdempotent
Read TagDetails.
GET /api/v3/tag/detail/{id}
Args: id: Path parameter.
Inputs: id (required). Returns: result
get_wanted_cutoff_by_idBRead-onlyIdempotent
Read Cutoff.
GET /api/v3/wanted/cutoff/{id}
Args: id: Path parameter.
Inputs: id (required). Returns: result
get_wanted_missing_by_idCRead-onlyIdempotent
Read Missing.
GET /api/v3/wanted/missing/{id}
Args: id: Path parameter.
Inputs: id (required). Returns: result
list_apiBRead-onlyIdempotent
Read ApiInfo.
GET /api
Inputs: no named parameters. Returns: result
list_autotaggingARead-onlyIdempotent
Read AutoTagging.
GET /api/v3/autotagging
Inputs: no named parameters. Returns: result
list_autotagging_schemaBRead-onlyIdempotent
Read AutoTagging.
GET /api/v3/autotagging/schema
Inputs: no named parameters. Returns: result
list_blocklistCRead-onlyIdempotent
Read Blocklist.
GET /api/v3/blocklist
Args: page: Query parameter. page_size: Query parameter. sort_key: Query parameter. sort_direction: Query parameter. series_ids: Query parameter. protocols: Query parameter.
Inputs: page, sort_key, page_size, protocols, +2 more. Returns: result
list_calendarCRead-onlyIdempotent
Read Calendar.
GET /api/v3/calendar
Args: start: Query parameter. end: Query parameter. unmonitored: Query parameter. include_series: Query parameter. include_episode_file: Query parameter. include_episode_images: Query parameter. tags: Query parameter.
Inputs: end, tags, start, unmonitored, +3 more. Returns: result
list_commandBRead-onlyIdempotent
Read Command.
GET /api/v3/command
Inputs: no named parameters. Returns: result
list_config_downloadclientARead-onlyIdempotent
Read DownloadClientConfig.
GET /api/v3/config/downloadclient
Inputs: no named parameters. Returns: result
list_config_hostARead-onlyIdempotent
Read HostConfig.
GET /api/v3/config/host
Inputs: no named parameters. Returns: result
list_config_importlistARead-onlyIdempotent
Read ImportListConfig.
GET /api/v3/config/importlist
Inputs: no named parameters. Returns: result
list_config_indexerARead-onlyIdempotent
Read IndexerConfig.
GET /api/v3/config/indexer
Inputs: no named parameters. Returns: result
list_config_mediamanagementBRead-onlyIdempotent
Read MediaManagementConfig.
GET /api/v3/config/mediamanagement
Inputs: no named parameters. Returns: result
list_config_namingBRead-onlyIdempotent
Read NamingConfig.
GET /api/v3/config/naming
Inputs: no named parameters. Returns: result
list_config_naming_examplesDRead-onlyIdempotent
Read NamingConfig.
GET /api/v3/config/naming/examples
Args: rename_episodes: Query parameter. replace_illegal_characters: Query parameter. colon_replacement_format: Query parameter. custom_colon_replacement_format: Query parameter. multi_episode_style: Query parameter. standard_episode_format: Query parameter. daily_episode_format: Query parameter. anime_episode_format: Query parameter. series_folder_format: Query parameter. season_folder_format: Query parameter. specials_folder_format: Query parameter. id: Query parameter. resource_name: Query parameter.
Inputs: id, resource_name, rename_episodes, multi_episode_style, +9 more. Returns: result
list_config_uiARead-onlyIdempotent
Read UiConfig.
GET /api/v3/config/ui
Inputs: no named parameters. Returns: result
list_customfilterARead-onlyIdempotent
Read CustomFilter.
GET /api/v3/customfilter
Inputs: no named parameters. Returns: result
list_customformatBRead-onlyIdempotent
Read CustomFormat.
GET /api/v3/customformat
Inputs: no named parameters. Returns: result
list_customformat_schemaBRead-onlyIdempotent
Read CustomFormat.
GET /api/v3/customformat/schema
Inputs: no named parameters. Returns: result
list_delayprofileBRead-onlyIdempotent
Read DelayProfile.
GET /api/v3/delayprofile
Inputs: no named parameters. Returns: result
list_diskspaceBRead-onlyIdempotent
Read DiskSpace.
GET /api/v3/diskspace
Inputs: no named parameters. Returns: result
list_downloadclientARead-onlyIdempotent
Read DownloadClient.
GET /api/v3/downloadclient
Inputs: no named parameters. Returns: result
list_downloadclient_schemaBRead-onlyIdempotent
Read DownloadClient.
GET /api/v3/downloadclient/schema
Inputs: no named parameters. Returns: result
list_episodeCRead-onlyIdempotent
Read Episode.
GET /api/v3/episode
Args: series_id: Query parameter. season_number: Query parameter. episode_ids: Query parameter. episode_file_id: Query parameter. include_series: Query parameter. include_episode_file: Query parameter. include_images: Query parameter.
Inputs: series_id, episode_ids, season_number, include_images, +3 more. Returns: result
list_episodefileCRead-onlyIdempotent
Read EpisodeFile.
GET /api/v3/episodefile
Args: series_id: Query parameter. episode_file_ids: Query parameter.
Inputs: series_id, episode_file_ids. Returns: result
list_feed_v3_calendar_sonarr_icsCRead-onlyIdempotent
Read CalendarFeed.
GET /feed/v3/calendar/sonarr.ics
Args: past_days: Query parameter. future_days: Query parameter. tags: Query parameter. unmonitored: Query parameter. premieres_only: Query parameter. as_all_day: Query parameter.
Inputs: tags, past_days, as_all_day, future_days, +2 more. Returns: result
list_filesystemCRead-onlyIdempotent
Read FileSystem.
GET /api/v3/filesystem
Args: path: Query parameter. include_files: Query parameter. allow_folders_without_trailing_slashes: Query parameter.
Inputs: path, include_files, allow_folders_without_trailing_slashes. Returns: result
list_filesystem_mediafilesCRead-onlyIdempotent
Read FileSystem.
GET /api/v3/filesystem/mediafiles
Args: path: Query parameter.
Inputs: path. Returns: result
list_filesystem_typeCRead-onlyIdempotent
Read FileSystem.
GET /api/v3/filesystem/type
Args: path: Query parameter.
Inputs: path. Returns: result
list_healthARead-onlyIdempotent
Read Health.
GET /api/v3/health
Inputs: no named parameters. Returns: result
list_historyCRead-onlyIdempotent
Read History.
GET /api/v3/history
Args: page: Query parameter. page_size: Query parameter. sort_key: Query parameter. sort_direction: Query parameter. include_series: Query parameter. include_episode: Query parameter. event_type: Query parameter. episode_id: Query parameter. download_id: Query parameter. series_ids: Query parameter. languages: Query parameter. quality: Query parameter.
Inputs: page, quality, sort_key, languages, +8 more. Returns: result
list_history_seriesCRead-onlyIdempotent
Read History.
GET /api/v3/history/series
Args: series_id: Query parameter. season_number: Query parameter. event_type: Query parameter. include_series: Query parameter. include_episode: Query parameter.
Inputs: series_id, event_type, season_number, include_series, +1 more. Returns: result
list_history_sinceDRead-onlyIdempotent
Read History.
GET /api/v3/history/since
Args: date: Query parameter. event_type: Query parameter. include_series: Query parameter. include_episode: Query parameter.
Inputs: date, event_type, include_series, include_episode. Returns: result
list_importlistBRead-onlyIdempotent
Read ImportList.
GET /api/v3/importlist
Inputs: no named parameters. Returns: result
list_importlistexclusionBRead-onlyIdempotent
Read ImportListExclusion.
GET /api/v3/importlistexclusion
Inputs: no named parameters. Returns: result
list_importlistexclusion_pagedBRead-onlyIdempotent
Read ImportListExclusion.
GET /api/v3/importlistexclusion/paged
Args: page: Query parameter. page_size: Query parameter. sort_key: Query parameter. sort_direction: Query parameter.
Inputs: page, sort_key, page_size, sort_direction. Returns: result
list_importlist_schemaARead-onlyIdempotent
Read ImportList.
GET /api/v3/importlist/schema
Inputs: no named parameters. Returns: result
list_indexerCRead-onlyIdempotent
Read Indexer.
GET /api/v3/indexer
Inputs: no named parameters. Returns: result
list_indexerflagBRead-onlyIdempotent
Read IndexerFlag.
GET /api/v3/indexerflag
Inputs: no named parameters. Returns: result
list_indexer_schemaBRead-onlyIdempotent
Read Indexer.
GET /api/v3/indexer/schema
Inputs: no named parameters. Returns: result
list_languageBRead-onlyIdempotent
Read Language.
GET /api/v3/language
Inputs: no named parameters. Returns: result
list_languageprofileBRead-onlyIdempotent
Read LanguageProfile.
GET /api/v3/languageprofile
Inputs: no named parameters. Returns: result
list_languageprofile_schemaARead-onlyIdempotent
Read LanguageProfileSchema.
GET /api/v3/languageprofile/schema
Inputs: no named parameters. Returns: result
list_localizationARead-onlyIdempotent
Read Localization.
GET /api/v3/localization
Inputs: no named parameters. Returns: result
list_localization_languageCRead-onlyIdempotent
Read Localization.
GET /api/v3/localization/language
Inputs: no named parameters. Returns: result
list_logCRead-onlyIdempotent
Read Log.
GET /api/v3/log
Args: page: Query parameter. page_size: Query parameter. sort_key: Query parameter. sort_direction: Query parameter. level: Query parameter.
Inputs: page, level, sort_key, page_size, +1 more. Returns: result
list_log_fileBRead-onlyIdempotent
Read LogFile.
GET /api/v3/log/file
Inputs: no named parameters. Returns: result
list_log_file_updateBRead-onlyIdempotent
Read UpdateLogFile.
GET /api/v3/log/file/update
Inputs: no named parameters. Returns: result
list_loginCRead-onlyIdempotent
Read StaticResource.
GET /login
Inputs: no named parameters. Returns: result
list_logoutBRead-onlyIdempotent
Read Authentication.
GET /logout
Inputs: no named parameters. Returns: result
list_manualimportCRead-onlyIdempotent
Read ManualImport.
GET /api/v3/manualimport
Args: folder: Query parameter. download_id: Query parameter. series_id: Query parameter. season_number: Query parameter. filter_existing_files: Query parameter.
Inputs: folder, series_id, download_id, season_number, +1 more. Returns: result
list_metadataBRead-onlyIdempotent
Read Metadata.
GET /api/v3/metadata
Inputs: no named parameters. Returns: result
list_metadata_schemaCRead-onlyIdempotent
Read Metadata.
GET /api/v3/metadata/schema
Inputs: no named parameters. Returns: result
list_notificationARead-onlyIdempotent
Read Notification.
GET /api/v3/notification
Inputs: no named parameters. Returns: result
list_notification_schemaCRead-onlyIdempotent
Read Notification.
GET /api/v3/notification/schema
Inputs: no named parameters. Returns: result
list_parseCRead-onlyIdempotent
Read Parse.
GET /api/v3/parse
Args: title: Query parameter. path: Query parameter.
Inputs: path, title. Returns: result
list_pingBRead-onlyIdempotent
Read Ping.
GET /ping
Inputs: no named parameters. Returns: result
list_qualitydefinitionBRead-onlyIdempotent
Read QualityDefinition.
GET /api/v3/qualitydefinition
Inputs: no named parameters. Returns: result
list_qualitydefinition_limitsBRead-onlyIdempotent
Read QualityDefinition.
GET /api/v3/qualitydefinition/limits
Inputs: no named parameters. Returns: result
list_qualityprofileARead-onlyIdempotent
Read QualityProfile.
GET /api/v3/qualityprofile
Inputs: no named parameters. Returns: result
list_qualityprofile_schemaBRead-onlyIdempotent
Read QualityProfileSchema.
GET /api/v3/qualityprofile/schema
Inputs: no named parameters. Returns: result
list_queueCRead-onlyIdempotent
Read Queue.
GET /api/v3/queue
Args: page: Query parameter. page_size: Query parameter. sort_key: Query parameter. sort_direction: Query parameter. include_unknown_series_items: Query parameter. include_series: Query parameter. include_episode: Query parameter. series_ids: Query parameter. protocol: Query parameter. languages: Query parameter. quality: Query parameter. status: Query parameter.
Inputs: page, status, quality, protocol, +8 more. Returns: result
list_queue_detailsCRead-onlyIdempotent
Read QueueDetails.
GET /api/v3/queue/details
Args: series_id: Query parameter. episode_ids: Query parameter. include_series: Query parameter. include_episode: Query parameter.
Inputs: series_id, episode_ids, include_series, include_episode. Returns: result
list_queue_statusBRead-onlyIdempotent
Read QueueStatus.
GET /api/v3/queue/status
Inputs: no named parameters. Returns: result
list_releaseBRead-onlyIdempotent
Read Release.
GET /api/v3/release
Args: series_id: Query parameter. episode_id: Query parameter. season_number: Query parameter.
Inputs: series_id, episode_id, season_number. Returns: result
list_releaseprofileARead-onlyIdempotent
Read ReleaseProfile.
GET /api/v3/releaseprofile
Inputs: no named parameters. Returns: result
list_remotepathmappingARead-onlyIdempotent
Read RemotePathMapping.
GET /api/v3/remotepathmapping
Inputs: no named parameters. Returns: result
list_renameCRead-onlyIdempotent
Read RenameEpisode.
GET /api/v3/rename
Args: series_id: Query parameter. season_number: Query parameter.
Inputs: series_id, season_number. Returns: result
list_rootDRead-onlyIdempotent
Read StaticResource.
GET /
Args: path: Path parameter.
Inputs: path (required). Returns: result
list_rootfolderARead-onlyIdempotent
Read RootFolder.
GET /api/v3/rootfolder
Inputs: no named parameters. Returns: result
list_seriesCRead-onlyIdempotent
Read Series.
GET /api/v3/series
Args: tvdb_id: Query parameter. include_season_images: Query parameter.
Inputs: tvdb_id, include_season_images. Returns: result
list_series_lookupDRead-onlyIdempotent
Read SeriesLookup.
GET /api/v3/series/lookup
Args: term: Query parameter.
Inputs: term. Returns: result
list_system_backupARead-onlyIdempotent
Read Backup.
GET /api/v3/system/backup
Inputs: no named parameters. Returns: result
list_system_routesCRead-onlyIdempotent
Read System.
GET /api/v3/system/routes
Inputs: no named parameters. Returns: result
list_system_routes_duplicateCRead-onlyIdempotent
Read System.
GET /api/v3/system/routes/duplicate
Inputs: no named parameters. Returns: result
list_system_statusBRead-onlyIdempotent
Read System.
GET /api/v3/system/status
Inputs: no named parameters. Returns: result
list_system_taskARead-onlyIdempotent
Read Task.
GET /api/v3/system/task
Inputs: no named parameters. Returns: result
list_tagCRead-onlyIdempotent
Read Tag.
GET /api/v3/tag
Inputs: no named parameters. Returns: result
list_tag_detailCRead-onlyIdempotent
Read TagDetails.
GET /api/v3/tag/detail
Inputs: no named parameters. Returns: result
list_updateCRead-onlyIdempotent
Read Update.
GET /api/v3/update
Inputs: no named parameters. Returns: result
list_wanted_cutoffCRead-onlyIdempotent
Read Cutoff.
GET /api/v3/wanted/cutoff
Args: page: Query parameter. page_size: Query parameter. sort_key: Query parameter. sort_direction: Query parameter. include_series: Query parameter. include_episode_file: Query parameter. include_images: Query parameter. monitored: Query parameter.
Inputs: page, sort_key, monitored, page_size, +4 more. Returns: result
list_wanted_missingDRead-onlyIdempotent
Read Missing.
GET /api/v3/wanted/missing
Args: page: Query parameter. page_size: Query parameter. sort_key: Query parameter. sort_direction: Query parameter. include_series: Query parameter. include_images: Query parameter. monitored: Query parameter.
Inputs: page, sort_key, monitored, page_size, +3 more. Returns: result
update_autotagging_by_idBIdempotent
Update AutoTagging.
PUT /api/v3/autotagging/{id}
Args: id: Path parameter. body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.
Inputs: id (required), body (required). Returns: result
update_config_downloadclient_by_idAIdempotent
Update DownloadClientConfig.
PUT /api/v3/config/downloadclient/{id}
Args: id: Path parameter. body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.
Inputs: id (required), body (required). Returns: result
update_config_host_by_idAIdempotent
Update HostConfig.
PUT /api/v3/config/host/{id}
Args: id: Path parameter. body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.
Inputs: id (required), body (required). Returns: result
update_config_importlist_by_idAIdempotent
Update ImportListConfig.
PUT /api/v3/config/importlist/{id}
Args: id: Path parameter. body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.
Inputs: id (required), body (required). Returns: result
update_config_indexer_by_idAIdempotent
Update IndexerConfig.
PUT /api/v3/config/indexer/{id}
Args: id: Path parameter. body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.
Inputs: id (required), body (required). Returns: result
update_config_mediamanagement_by_idBIdempotent
Update MediaManagementConfig.
PUT /api/v3/config/mediamanagement/{id}
Args: id: Path parameter. body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.
Inputs: id (required), body (required). Returns: result
update_config_naming_by_idBIdempotent
Update NamingConfig.
PUT /api/v3/config/naming/{id}
Args: id: Path parameter. body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.
Inputs: id (required), body (required). Returns: result
update_config_ui_by_idAIdempotent
Update UiConfig.
PUT /api/v3/config/ui/{id}
Args: id: Path parameter. body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.
Inputs: id (required), body (required). Returns: result
update_customfilter_by_idCIdempotent
Update CustomFilter.
PUT /api/v3/customfilter/{id}
Args: id: Path parameter. body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.
Inputs: id (required), body (required). Returns: result
update_customformat_bulkCIdempotent
Update CustomFormat.
PUT /api/v3/customformat/bulk
Args: body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.
Inputs: body (required). Returns: result
update_customformat_by_idAIdempotent
Update CustomFormat.
PUT /api/v3/customformat/{id}
Args: id: Path parameter. body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.
Inputs: id (required), body (required). Returns: result
update_delayprofile_by_idAIdempotent
Update DelayProfile.
PUT /api/v3/delayprofile/{id}
Args: id: Path parameter. body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.
Inputs: id (required), body (required). Returns: result
update_delayprofile_reorder_by_idCIdempotent
Update DelayProfile.
PUT /api/v3/delayprofile/reorder/{id}
Args: id: Path parameter. after: Query parameter.
Inputs: id (required), after. Returns: result
update_downloadclient_bulkCIdempotent
Update DownloadClient.
PUT /api/v3/downloadclient/bulk
Args: body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.
Inputs: body (required). Returns: result
update_downloadclient_by_idAIdempotent
Update DownloadClient.
PUT /api/v3/downloadclient/{id}
Args: id: Path parameter. body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects. force_save: Query parameter.
Inputs: id (required), body (required), force_save. Returns: result
update_episode_by_idAIdempotent
Update Episode.
PUT /api/v3/episode/{id}
Args: id: Path parameter. body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.
Inputs: id (required), body (required). Returns: result
update_episodefile_bulkBIdempotent
Update EpisodeFile.
PUT /api/v3/episodefile/bulk
Args: body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.
Inputs: body (required). Returns: result
update_episodefile_by_idBIdempotent
Update EpisodeFile.
PUT /api/v3/episodefile/{id}
Args: id: Path parameter. body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.
Inputs: id (required), body (required). Returns: result
update_episodefile_editorCIdempotent
Update EpisodeFile.
PUT /api/v3/episodefile/editor
Args: body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.
Inputs: body (required). Returns: result
update_episode_monitorBIdempotent
Update Episode.
PUT /api/v3/episode/monitor
Args: body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects. include_images: Query parameter.
Inputs: body (required), include_images. Returns: result
update_importlist_bulkCIdempotent
Update ImportList.
PUT /api/v3/importlist/bulk
Args: body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.
Inputs: body (required). Returns: result
update_importlist_by_idAIdempotent
Update ImportList.
PUT /api/v3/importlist/{id}
Args: id: Path parameter. body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects. force_save: Query parameter.
Inputs: id (required), body (required), force_save. Returns: result
update_importlistexclusion_by_idCIdempotent
Update ImportListExclusion.
PUT /api/v3/importlistexclusion/{id}
Args: id: Path parameter. body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.
Inputs: id (required), body (required). Returns: result
update_indexer_bulkBIdempotent
Update Indexer.
PUT /api/v3/indexer/bulk
Args: body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.
Inputs: body (required). Returns: result
update_indexer_by_idBIdempotent
Update Indexer.
PUT /api/v3/indexer/{id}
Args: id: Path parameter. body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects. force_save: Query parameter.
Inputs: id (required), body (required), force_save. Returns: result
update_languageprofile_by_idBIdempotent
Update LanguageProfile.
PUT /api/v3/languageprofile/{id}
Args: id: Path parameter. body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.
Inputs: id (required), body (required). Returns: result
update_metadata_by_idCIdempotent
Update Metadata.
PUT /api/v3/metadata/{id}
Args: id: Path parameter. body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects. force_save: Query parameter.
Inputs: id (required), body (required), force_save. Returns: result
update_notification_by_idAIdempotent
Update Notification.
PUT /api/v3/notification/{id}
Args: id: Path parameter. body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects. force_save: Query parameter.
Inputs: id (required), body (required), force_save. Returns: result
update_qualitydefinition_by_idAIdempotent
Update QualityDefinition.
PUT /api/v3/qualitydefinition/{id}
Args: id: Path parameter. body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.
Inputs: id (required), body (required). Returns: result
update_qualitydefinition_updateCIdempotent
Update QualityDefinition.
PUT /api/v3/qualitydefinition/update
Args: body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.
Inputs: body (required). Returns: result
update_qualityprofile_by_idAIdempotent
Update QualityProfile.
PUT /api/v3/qualityprofile/{id}
Args: id: Path parameter. body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.
Inputs: id (required), body (required). Returns: result
update_releaseprofile_by_idAIdempotent
Update ReleaseProfile.
PUT /api/v3/releaseprofile/{id}
Args: id: Path parameter. body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.
Inputs: id (required), body (required). Returns: result
update_remotepathmapping_by_idCIdempotent
Update RemotePathMapping.
PUT /api/v3/remotepathmapping/{id}
Args: id: Path parameter. body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.
Inputs: id (required), body (required). Returns: result
update_series_by_idBIdempotent
Update Series.
PUT /api/v3/series/{id}
Args: id: Path parameter. body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects. move_files: Query parameter.
Inputs: id (required), body (required), move_files. Returns: result
update_series_editorCIdempotent
Update SeriesEditor.
PUT /api/v3/series/editor
Args: body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.
Inputs: body (required). Returns: result
update_tag_by_idBIdempotent
Update Tag.
PUT /api/v3/tag/{id}
Args: id: Path parameter. body: Request payload. Read the matching GET or the /schema endpoint first to see the fields this resource expects.
Inputs: id (required), body (required). Returns: result
Tool Schema Changelog
Recent tool additions, removals, and schema changes observed during successful MCP inspections.
Loading tool schema changelog…
TDQS
Scored across 235 tools
Most tools map to a distinct resource+action and are clearly separable (get_series_by_id vs list_series vs delete_series_by_id). However, clusters like create_indexer_test / create_indexer_testall / create_indexer_action_by_name, and the 'create_' prefix applied to non-create POSTs (create_system_restart, create_system_shutdown, create_release_push), create mild confusion about which endpoint does what.
An extremely systematic snake_case verb_noun convention is used throughout: get_/list_/create_/update_/delete_ + resource + suffix (_by_id, _bulk, _schema, _test, _testall). Deviations like get_result_page or get_by_path are rare and still readable.
235 tools is a near-verbatim dump of the entire Sonarr v3 REST surface, far beyond what an agent can select from reliably. Many are low-value variants (per-resource test/testall/action-by-name, config singletons, static-resource readers) that bloat the surface.
Coverage is essentially exhaustive: full CRUD across series, episodes, files, indexers, download clients, import lists, notifications, quality/language profiles, plus config, commands, history, wanted, calendar, backup and system endpoints. No obvious lifecycle gaps remain.
Maintenance
Related MCP Connectors
Every Canopy public API operation as a tool, run as you after a browser sign-in or on an API key.
Lets Claude, ChatGPT, and Muse read and update your beckett tasks, notes, calendar, and lists.
Manage Redbooth tasks, task lists, comments, tags and files from Claude and other AI assistants.
Connect ChatGPT or Claude to your CRM, store or shipping API. Keys stay out of the chat.
Related MCP Servers
- FlicenseBqualityDmaintenanceEnables AI assistants to manage TV series collections through Sonarr's API using natural language interactions. Supports searching, adding, updating, and deleting TV series with detailed control over quality profiles, season monitoring, and episode downloads.9-
- AlicenseBqualityCmaintenanceExposes the Sonarr v3 REST API as MCP tools, enabling LLMs to read and manage a Sonarr instance including series, episodes, downloads, history, and more. Supports both read and write operations, with destructive tools flagged.15MIT
- AlicenseBqualityBmaintenanceConnects AI agents to Sonarr, exposing 136 tools for managing a TV library — adding series, chasing missing episodes, fixing the download queue, tuning quality profiles, and diagnosing health issues.13612 npmMIT
- AlicenseCqualityBmaintenanceEnables running Overseerr or Jellyseerr from Claude.ai and Claude Code, with all 170 API operations exposed as tools for managing requests, settings, users, issues, and media services.171MIT