@danimart1991/node-red-radarr-api

@danimart1991/node-red-radarr-api

A set of Node-RED nodes to use with Radarr API.

WARNING: This palette of nodes can leave the Radarr database inconsistent if not handled carefully. Take special care when applying values, for example: Assigning a non-existent Quality Profile to a Movie.

Install

As other custom nodes, the recommendation is to install using the "Manage Palettes" option in Node-RED.

Indeed, these nodes are available as individual npm package. This repository acts as an overall store for the nodes - and is not intended as a way to install them - unless you really do want some development.

$ npm install @danimart1991/node-red-radarr-api

Usage

All the nodes have a Server parameter that must be configured to work (see Config below).

Config

A configuration node that holds the credentials of a Radarr Server. All the nodes need this node to work.

Two parameters are required to properly configure this node:

• URL: It's the server's URL used to connect to Radarr Server, including http(s)://, port, and urlbase if required.
• API Key: The API Key generated by Radarr Server under Settings/General.

Nodes

Entity	Get	Post	Put	Delete
Command	✔	✔
History	✔
Indexer Test All	-	✔	-	-
Movie	✔
Movie Editor	-	-	✔
Movie File	✔

Log

In addition, all the nodes have a Log output that offers information on how the execution has worked.

{
    "payload": {
        "source": {
            "id": "0f12103e2251c436",
            "type": "radarr-api-movie-get"
        },
        "level": "Info",
        "message": "2084 Movie/s returned"
    },
    "_msgid": "4c1261a1eb9bfb44"
}

Property	Type	Description
payload.level	string	The log Level: Debug, Info, Warn, Error, Critical or Other.
payload.message	string	The log Message.
payload.source.id	string	The Id of the node that threw the log.
payload.source.type	string	The Type of the node that threw the log.
payload.source.name	string	The Name, if set, of the node that threw the log.

Author

Daniel Martin Gonzalez

License

Apache 2.0