Pulsarr

Test Sonarr connection

POST
/v1/sonarr/test-connection

Test connectivity to a Sonarr instance with provided credentials

Authorization

headerX-API-Key<token>

API key authentication using X-API-Key header

Request Body

Radarr or Sonarr address and API key to check before saving

application/json
  1. body

Radarr or Sonarr address and API key to check before saving

baseUrl*string
apiKey*string
Length1 <= length

Response Body

Default Response

application/json
  1. response

Radarr or Sonarr connection test result, code is null on success

success*boolean
message*string
code*|null
Example Request
curl -X POST 'http://localhost:3003/v1/sonarr/test-connection' \  -H 'Content-Type: application/json' \  -d '{  "baseUrl": "string",  "apiKey": "string"}'
Example Response
{  "success": true,  "message": "string",  "code": "unreachable"}