Pulsarr

Create Sonarr instance

POST
/v1/sonarr/instances

Create a new Sonarr instance configuration

Authorization

headerX-API-Key<token>

API key authentication using X-API-Key header

Request Body

A new Sonarr instance, omitted settings take their defaults

application/json
  1. body

A new Sonarr instance, omitted settings take their defaults

name*string
Length1 <= length
baseUrl*string
apiKey*string
Length1 <= length
qualityProfile?string|number|null
rootFolder?string|null
bypassIgnored?boolean
Defaultfalse
seasonMonitoring?|

A SonarrSeasonMonitoring option, or a legacy value already stored on the record

Default"all"
monitorNewItems?SonarrMonitorNewItems

Whether Sonarr monitors seasons added to a series later

Default"all"
Value in"all""none"
searchOnAdd?boolean
Defaulttrue
createSeasonFolders?boolean
Defaultfalse
tags?array<string>
Default[]
isDefault?boolean
Defaultfalse
syncedInstances?array<number>
seriesType?SonarrSeriesType

How Sonarr numbers episodes when adding a series

Default"standard"
Value in"standard""anime""daily"
skipDefaultRoutingWhenNoMatch?boolean
Defaultfalse

Response Body

Default Response

application/json
  1. response

Id of the newly created Sonarr instance

id*integer
Range0 < value <= 9007199254740991
Example Request
curl -X POST 'http://localhost:3003/v1/sonarr/instances' \  -H 'Content-Type: application/json' \  -d '{  "name": "string",  "baseUrl": "string",  "apiKey": "string"}'
Example Response
{  "id": 1}