Pulsarr

Create approval request

POST
/v1/approval/requests

Create a new approval request for content routing

Authorization

headerX-API-Key<token>

API key authentication using X-API-Key header

Request Body

Fields for creating an approval request

application/json
  1. body

Fields for creating an approval request

userId*number
contentType*ContentType

Media kind, movie or show

Value in"movie""show"
contentTitle*string
Length1 <= length <= 255
contentKey*string
Length1 <= length <= 255
contentGuids?array<string>
routerDecision*

Router outcome for a request, holding the routing used on approval

routerRuleId?number
approvalReason?string
triggeredBy*ApprovalTrigger

What caused a request to need approval

Value in"quota_exceeded""router_rule""manual_flag""content_criteria"
expiresAt?string

Response Body

Default Response

application/json
  1. response

A single approval request returned by a read or write

success*boolean
message*string
approvalRequest*

An approval request with its proposed routing and expiry

Example Request
curl -X POST 'http://localhost:3003/v1/approval/requests' \  -H 'Content-Type: application/json' \  -d '{  "userId": 0,  "contentType": "movie",  "contentTitle": "string",  "contentKey": "string",  "routerDecision": {    "action": "route"  },  "triggeredBy": "quota_exceeded"}'
Example Response
{  "success": true,  "message": "string",  "approvalRequest": {    "id": 0,    "userId": 0,    "userName": "string",    "contentType": "movie",    "contentTitle": "string",    "contentKey": "string",    "contentGuids": [      "string"    ],    "thumb": "string",    "proposedRouterDecision": {      "action": "route",      "routing": {        "instanceId": 0,        "instanceType": "radarr",        "qualityProfile": 0,        "rootFolder": "string",        "tags": [          "string"        ],        "priority": 0,        "searchOnAdd": true,        "seasonMonitoring": "all",        "seriesType": "standard",        "minimumAvailability": "announced",        "monitor": "movieOnly",        "syncedInstances": [          0        ],        "ruleId": 0      },      "approval": {        "reason": "string",        "triggeredBy": "quota_exceeded",        "data": {          "quotaType": "daily",          "quotaUsage": 0,          "quotaLimit": 0,          "criteriaType": "string",          "criteriaValue": "string",          "ruleId": 0,          "autoApprove": true        },        "proposedRouting": {          "instanceId": 0,          "instanceType": "radarr",          "qualityProfile": 0,          "rootFolder": "string",          "tags": [            "string"          ],          "priority": 0,          "searchOnAdd": true,          "seasonMonitoring": "all",          "seriesType": "standard",          "minimumAvailability": "announced",          "monitor": "movieOnly",          "syncedInstances": [            0          ],          "ruleId": 0        },        "additionalRouting": [          {            "instanceId": 0,            "instanceType": "radarr",            "qualityProfile": 0,            "rootFolder": "string",            "tags": [              "string"            ],            "priority": 0,            "searchOnAdd": true,            "seasonMonitoring": "all",            "seriesType": "standard",            "minimumAvailability": "announced",            "monitor": "movieOnly",            "syncedInstances": [              0            ],            "ruleId": 0          }        ]      }    },    "routerRuleId": 0,    "triggeredBy": "quota_exceeded",    "approvalReason": "string",    "status": "pending",    "approvedBy": 0,    "approvalNotes": "string",    "expiresAt": "string",    "isExpired": true,    "expirationStatus": "active",    "expirationDisplayText": "string",    "timeUntilExpiration": 0,    "createdAt": "string",    "updatedAt": "string"  }}