settings

Update Sonarr instance

Updates an existing Sonarr instance with the provided values.

put/settings/sonarr/{sonarrId}

Request

Base URL: http://localhost:5055/api/v1
URL: http://localhost:5055/api/v1/settings/sonarr/{sonarrId}
Auth: one of:
- API key in cookie connect.sid
- API key in header X-Api-Key

Path parameters

sonarrIdinteger required

Sonarr instance ID

Request body

idnumber

namestring required

hostnamestring required

portnumber required

apiKeystring required

useSslboolean required

baseUrlstring

activeProfileIdnumber required

activeProfileNamestring required

activeDirectorystring required

activeLanguageProfileIdnumber

activeAnimeProfileIdnumber nullable

activeAnimeLanguageProfileIdnumber nullable

activeAnimeProfileNamestring nullable

activeAnimeDirectorystring nullable

is4kboolean required

enableSeasonFoldersboolean required

isDefaultboolean required

externalUrlstring

syncEnabledboolean

preventSearchboolean

Example request

{
  "name": "Sonarr Main",
  "hostname": "127.0.0.1",
  "port": 8989,
  "apiKey": "exampleapikey",
  "activeProfileId": 1,
  "activeProfileName": "720p/1080p",
  "activeDirectory": "/tv/",
  "activeLanguageProfileId": 1,
  "activeAnimeProfileName": "720p/1080p",
  "externalUrl": "http://radarr.example.com"
}

Response

Sonarr instance updated