Pulsarr

Create router rule

POST
/v1/content-router/rules

Create a new content router rule with specified conditions and targets

Authorization

headerX-API-Key<token>

API key authentication using X-API-Key header

Request Body

Full router rule payload used to create a rule

application/json
  1. body

Full router rule payload used to create a rule

name*string
Length1 <= length
target_type*InstanceType

Arr instance kind, radarr or sonarr

Value in"radarr""sonarr"
target_instance_id*|null
condition?|
root_folder?|null
quality_profile?number||null
tags?array<string>
order?integer

Left out, the rule is placed after every existing rule of its type

Range1 <= value <= 100
enabled?boolean
search_on_add?boolean|null
season_monitoring?||

Sonarr rules only - season monitoring mode applied when adding series. Sending this for Radarr rules returns a 400 error.

series_type?|

Sonarr rules only - series type applied when adding series. Sending this for Radarr rules returns a 400 error.

monitor?|

Radarr rules only - monitor mode applied when adding movies. Sending this for Sonarr rules returns a 400 error.

always_require_approval?boolean
bypass_user_quotas?boolean
approval_reason?string
exclude_from_routing?boolean

Response Body

Default Response

application/json
  1. response

Response carrying a single router rule

success*boolean
message*string
rule*

A stored content router rule

Example Request
curl -X POST 'http://localhost:3003/v1/content-router/rules' \  -H 'Content-Type: application/json' \  -d '{  "name": "string",  "target_type": "radarr",  "target_instance_id": 1}'
Example Response
{  "success": true,  "message": "string",  "rule": {    "name": "string",    "target_type": "radarr",    "target_instance_id": 1,    "condition": {      "field": "string",      "operator": "equals",      "value": "string",      "negate": false    },    "root_folder": "string",    "quality_profile": 0,    "tags": [      "string"    ],    "order": 0,    "enabled": true,    "search_on_add": true,    "season_monitoring": "all",    "series_type": "standard",    "monitor": "movieOnly",    "always_require_approval": true,    "bypass_user_quotas": true,    "approval_reason": "string",    "exclude_from_routing": true,    "id": 0,    "created_at": "string",    "updated_at": "string"  }}