Skip to content

PSStarr

PSStarr is a PowerShell 7 client module for Radarr, Sonarr, and Prowlarr.

Requirements

  • PowerShell 7.0 or later
  • Radarr, Sonarr, or Prowlarr
  • An API key for the application

Install PSStarr

Install-Module -Name PSStarr -Repository PSGallery
Import-Module -Name PSStarr

Save a connection

This example saves a Radarr connection.

Set-PSStarrInstance -Name 'RadarrMain' -Application Radarr -Url 'https://radarr.example.com' -ApiKey (Read-Host -Prompt 'Enter your Radarr API key')

Note

By default, Windows encrypts the API key for the current user and host with DPAPI.

For portable encryption, set PSSTARR_AES_KEY to a Base64-encoded 32-byte key.

Test the connection

Get-StarrSystemStatus -InstanceName 'RadarrMain'

See the command reference for all supported commands.