Sign in
settings

Update Radarr instance

Updates an existing Radarr instance with the provided values.

put/settings/radarr/{radarrId}

Request

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

Path parameters

radarrIdinteger required

Radarr instance ID

Request body

idnumber
namestring required
hostnamestring required
portnumber required
apiKeystring required
useSslboolean required
baseUrlstring
activeProfileIdnumber required
activeProfileNamestring required
activeDirectorystring required
is4kboolean required
minimumAvailabilitystring required
isDefaultboolean required
externalUrlstring
syncEnabledboolean
preventSearchboolean

Example request

{
  "name": "Radarr Main",
  "hostname": "127.0.0.1",
  "port": 7878,
  "apiKey": "exampleapikey",
  "activeProfileId": 1,
  "activeProfileName": "720p/1080p",
  "activeDirectory": "/movies",
  "minimumAvailability": "In Cinema",
  "externalUrl": "http://radarr.example.com"
}

Response

Radarr instance updated

idnumber
namestring required
hostnamestring required
portnumber required
apiKeystring required
useSslboolean required
baseUrlstring
activeProfileIdnumber required
activeProfileNamestring required
activeDirectorystring required
is4kboolean required
minimumAvailabilitystring required
isDefaultboolean required
externalUrlstring
syncEnabledboolean
preventSearchboolean

Example response

{
  "name": "Radarr Main",
  "hostname": "127.0.0.1",
  "port": 7878,
  "apiKey": "exampleapikey",
  "activeProfileId": 1,
  "activeProfileName": "720p/1080p",
  "activeDirectory": "/movies",
  "minimumAvailability": "In Cinema",
  "externalUrl": "http://radarr.example.com"
}

Changes