PSStarr Module
Description
PSStarr is a PowerShell client module for Radarr, Sonarr, and Prowlarr.
PSStarr
Get-PSStarrInstance
Retrieves saved PSStarr instances without exposing API keys.
Get-StarrApiInfo
Retrieves API information from a Starr instance.
Get-StarrApplicationConfiguration
Retrieves application configuration from a Starr application.
Get-StarrAutoTagging
Retrieves auto-tagging configurations from a Starr instance.
Get-StarrAutoTaggingSchema
Retrieves auto-tagging schemas from a Starr instance.
Get-StarrBackup
Retrieves system backups from a Starr instance.
Get-StarrBlocklist
Retrieves blocklist records from a Starr instance.
Get-StarrCalendar
Retrieves calendar records from a Starr instance.
Get-StarrCommand
Retrieves commands from a Starr instance.
Get-StarrCustomFilter
Retrieves custom filter settings from Radarr or Sonarr.
Get-StarrCustomFormat
Retrieves custom formats from a Starr instance.
Get-StarrCustomFormatSchema
Retrieves custom-format schemas from a Starr instance.
Get-StarrDelayProfile
Retrieves delay profile settings from Radarr or Sonarr.
Get-StarrDiskSpace
Retrieves disk-space information from a Starr instance.
Get-StarrDownloadClient
Retrieves download clients from a Starr instance.
Get-StarrDownloadClientSchema
Retrieves download-client schemas from a Starr instance.
Get-StarrHealth
Retrieves health information from a Starr instance.
Get-StarrHistory
Retrieves history from a Starr instance.
Get-StarrImportList
Retrieves import list settings from Radarr or Sonarr.
Get-StarrImportListSchema
Retrieves import list schemas from Radarr or Sonarr.
Get-StarrIndexer
Retrieves indexers from a Starr instance.
Get-StarrIndexerFlag
Retrieves indexer flags from Radarr or Sonarr.
Get-StarrIndexerSchema
Retrieves indexer schemas from a Starr instance.
Get-StarrLanguage
Retrieves language settings from Radarr or Sonarr.
Get-StarrLogEntry
Retrieves application log records from a Starr instance.
Get-StarrMetadataProvider
Retrieves metadata provider settings from Radarr or Sonarr.
Get-StarrMetadataProviderSchema
Retrieves metadata provider schemas from Radarr or Sonarr.
Get-StarrNotification
Retrieves notifications from a Starr instance.
Get-StarrNotificationSchema
Retrieves notification schemas from a Starr instance.
Get-StarrPing
Retrieves a ping response from a Starr application.
Get-StarrProwlarrApplication
Retrieves applications configured for synchronization from Prowlarr.
Get-StarrProwlarrApplicationSchema
Retrieves supported Prowlarr application-integration definitions.
Get-StarrProwlarrAppProfile
Retrieves Prowlarr application profiles.
Get-StarrProwlarrAppProfileSchema
Retrieves the Prowlarr application-profile schema.
Get-StarrProwlarrDevelopmentConfiguration
Retrieves Prowlarr development settings.
Get-StarrProwlarrHistory
Retrieves Prowlarr history.
Get-StarrProwlarrIndexer
Retrieves every configured Prowlarr indexer or one indexer by ID.
Get-StarrProwlarrIndexerCategory
Retrieves categories exposed by configured Prowlarr indexers.
Get-StarrProwlarrIndexerProxy
Retrieves Prowlarr IndexerProxy resources.
Get-StarrProwlarrIndexerProxySchema
Retrieves Prowlarr IndexerProxySchema resources.
Get-StarrProwlarrIndexerStatistic
Retrieves Prowlarr indexer statistics results.
Get-StarrProwlarrIndexerStatus
Retrieves Prowlarr indexer failure and backoff records.
Get-StarrProwlarrSearch
Retrieves Prowlarr search results.
Get-StarrQualityDefinition
Retrieves quality definition settings from Radarr or Sonarr.
Get-StarrQualityDefinitionLimit
Retrieves quality definition limits from Radarr or Sonarr.
Get-StarrQualityProfile
Retrieves quality profiles from a Starr instance.
Get-StarrQualityProfileSchema
Retrieves quality-profile schemas from a Starr instance.
Get-StarrQueue
Retrieves queue records from a Starr instance.
Get-StarrQueueDetail
Retrieves queue details from a Starr instance.
Get-StarrQueueStatus
Retrieves queue status from a Starr instance.
Get-StarrRadarrAlternativeTitle
Retrieves Radarr alternative titles.
Get-StarrRadarrBlocklist
Retrieves Radarr blocklist records.
Get-StarrRadarrCalendar
Retrieves Radarr calendar records.
Get-StarrRadarrCollection
Retrieves Radarr collections from a Starr instance.
Get-StarrRadarrCredit
Retrieves Radarr credits from a Starr instance.
Get-StarrRadarrCutoff
Retrieves Radarr cutoff-unmet records using the legacy command name.
Get-StarrRadarrCutoffUnmet
Retrieves Radarr movies that have not met their quality cutoff.
Get-StarrRadarrExtraFile
Retrieves Radarr extra-file records.
Get-StarrRadarrHistory
Retrieves Radarr history.
Get-StarrRadarrImportListExclusion
Retrieves Radarr import-list exclusions.
Get-StarrRadarrImportListMovie
Retrieves Radarr import list movie results.
Get-StarrRadarrManualImport
Retrieves Radarr manual import results.
Get-StarrRadarrMissing
Retrieves Radarr missing records from a Starr instance.
Get-StarrRadarrMovie
Retrieves Radarr movies from a Starr instance.
Get-StarrRadarrMovieFile
Retrieves Radarr movie files from a Starr instance.
Get-StarrRadarrMovieFolder
Retrieves Radarr movie folder results.
Get-StarrRadarrMovieLookup
Searches Radarr metadata providers for movies to add.
Get-StarrRadarrNamingExample
Retrieves Radarr naming example results.
Get-StarrRadarrParse
Retrieves Radarr parse results.
Get-StarrRadarrQueue
Retrieves the Radarr download queue.
Get-StarrRadarrQueueDetail
Retrieves Radarr queue details.
Get-StarrRadarrRelease
Retrieves Radarr release results.
Get-StarrRadarrRenamePreview
Retrieves Radarr rename results.
Get-StarrReleaseProfile
Retrieves release profile settings from Radarr or Sonarr.
Get-StarrRemotePathMapping
Retrieves remote-path mappings from a Starr instance.
Get-StarrRootFolder
Retrieves root folders from a Starr instance.
Get-StarrSonarrBlocklist
Retrieves Sonarr blocklist records.
Get-StarrSonarrCalendar
Retrieves Sonarr calendar records.
Get-StarrSonarrCalendarEntry
Retrieves Sonarr calendar episode.
Get-StarrSonarrCutoff
Retrieves Sonarr cutoff-unmet records using the legacy command name.
Get-StarrSonarrCutoffUnmet
Retrieves Sonarr episodes that have not met their quality cutoff.
Get-StarrSonarrEpisode
Retrieves Sonarr episodes from a Starr instance.
Get-StarrSonarrEpisodeFile
Retrieves Sonarr episode files from a Starr instance.
Get-StarrSonarrHistory
Retrieves Sonarr history.
Get-StarrSonarrImportListExclusion
Retrieves Sonarr import-list exclusions.
Get-StarrSonarrManualImport
Retrieves Sonarr manual-import candidates.
Get-StarrSonarrMissing
Retrieves Sonarr missing records from a Starr instance.
Get-StarrSonarrNamingExample
Retrieves Sonarr filename examples.
Get-StarrSonarrParse
Retrieves Sonarr parsed release information.
Get-StarrSonarrQueue
Retrieves the Sonarr download queue.
Get-StarrSonarrQueueDetail
Retrieves Sonarr queue details.
Get-StarrSonarrRelease
Retrieves Sonarr release search results.
Get-StarrSonarrRenamePreview
Retrieves Sonarr episode-file rename previews.
Get-StarrSonarrSeries
Retrieves Sonarr series from a Starr instance.
Get-StarrSonarrSeriesFolder
Retrieves Sonarr calculated series folder name.
Get-StarrSonarrSeriesLookup
Searches Sonarr metadata providers for series to add.
Get-StarrSystemStatus
Retrieves system status information from a Starr instance.
Get-StarrTag
Retrieves tags from a Starr instance.
Get-StarrTagDetail
Retrieves tag usage records using the legacy command name.
Get-StarrTagUsage
Retrieves resources associated with application tags.
Get-StarrTask
Retrieves system tasks from a Starr instance.
Get-StarrUpdate
Retrieves available updates from a Starr instance.
Invoke-StarrApiRequest
Sends an authenticated request to a Starr application API.
Invoke-StarrCommand
Submits an application command to Radarr or Sonarr.
New-StarrTag
Creates an application tag in Radarr or Sonarr.
Remove-PSStarrInstance
Removes a saved Starr instance.
Remove-StarrTag
Removes an application tag from Radarr or Sonarr.
Set-PSStarrInstance
Creates or updates a saved PSStarr instance.
Set-StarrRadarrCollectionMonitoring
Changes Radarr collection monitoring.
Set-StarrRadarrMovieTag
Adds or removes tags on Radarr movies.
Set-StarrSonarrSeriesTag
Adds or removes tags on Sonarr series.
Start-StarrCommand
Submits an application command using the legacy command name.
Start-StarrRadarrCollectionRefresh
Starts refreshing selected Radarr collections.
Start-StarrRadarrMovieFileRename
Starts renaming selected Radarr movie files.
Start-StarrRadarrMovieFolderRename
Starts renaming selected Radarr movie folders.
Start-StarrRadarrMovieRefresh
Starts metadata refreshes for selected Radarr movies.
Start-StarrRadarrMovieRename
Starts renaming files for selected Radarr movies.
Start-StarrRadarrMovieRescan
Starts rescanning a Radarr movie folder.
Start-StarrRadarrMovieSearch
Starts a Radarr search for selected movies.
Start-StarrSonarrEpisodeFileRename
Starts renaming selected Sonarr episode files.
Start-StarrSonarrEpisodeSearch
Starts a Sonarr search for selected episodes.
Start-StarrSonarrSeasonSearch
Starts a Sonarr search for one season.
Start-StarrSonarrSeriesFolderRename
Starts renaming selected Sonarr series folders.
Start-StarrSonarrSeriesRefresh
Starts metadata refreshes for selected Sonarr series.
Start-StarrSonarrSeriesRescan
Starts rescanning a Sonarr series folder.
Start-StarrSonarrSeriesSearch
Starts a Sonarr search for selected series.
RELATED LINKS
https://psstarr.xyz/command-reference/
https://github.com/angrycuban13/PSStarr/blob/main/PSStarr/Source/PSStarr.psd1