Pulsarr

Create Radarr instance

POST
/v1/radarr/instances

Create a new Radarr instance configuration

Authorization

headerX-API-Key<token>

API key authentication using X-API-Key header

Request Body

A new Radarr instance, omitted settings take their defaults

application/json
  1. body

A new Radarr 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
searchOnAdd?boolean
Defaulttrue
minimumAvailability?RadarrMinimumAvailability

Release stage at which Radarr considers a movie available

Default"released"
Value in"announced""inCinemas""released"
monitor?RadarrMonitor

What Radarr monitors when adding a movie

Default"movieOnly"
Value in"movieOnly""movieAndCollection""none"
tags?array<string>
Default[]
isDefault?boolean
Defaultfalse
syncedInstances?array<number>
skipDefaultRoutingWhenNoMatch?boolean
Defaultfalse

Response Body

Default Response

application/json
  1. response

Id of the newly created Radarr instance

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