Sign in
settings

Test Sonarr configuration

Tests if the Sonarr configuration is valid. Returns profiles and root folders on success.

post/settings/sonarr/test

Request

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

Request body

hostnamestring required
portnumber required
apiKeystring required
useSslboolean required
baseUrlstring

Example request

{
  "hostname": "127.0.0.1",
  "port": 8989,
  "apiKey": "yourapikey"
}

Response

Succesfully connected to Sonarr instance

Example response

{
  "profiles": [
    {
      "id": 1,
      "name": "720p/1080p"
    }
  ]
}

Changes

No recorded changes to this operation across all 21 revisions of this API.