Skip to content

Get-StarrSonarrEpisode

SYNOPSIS

Retrieves Sonarr episodes from a Starr instance.

SYNTAX

Named (Default)

Get-StarrSonarrEpisode [-InstanceName <string>] [-EpisodeId <int>] [-SeriesId <int>]
 [-SeasonNumber <int>] [-EpisodeIdFilter <int[]>] [-EpisodeFileId <int>] [-IncludeSeries <bool>]
 [-IncludeEpisodeFile <bool>] [-IncludeImages <bool>]

Explicit

Get-StarrSonarrEpisode -Url <string> -ApiKey <string> [-EpisodeId <int>] [-SeriesId <int>]
 [-SeasonNumber <int>] [-EpisodeIdFilter <int[]>] [-EpisodeFileId <int>] [-IncludeSeries <bool>]
 [-IncludeEpisodeFile <bool>] [-IncludeImages <bool>]

DESCRIPTION

This function retrieves Sonarr episodes. Specify EpisodeId, SeriesId, EpisodeIdFilter, or EpisodeFileId to select the episodes.

EXAMPLES

EXAMPLE 1

Get-StarrSonarrEpisode -EpisodeId 456

EXAMPLE 2

Get-StarrSonarrEpisode -InstanceName 'Main' -SeriesId 123

EXAMPLE 3

Get-StarrSonarrEpisode -Url 'http://localhost:8989' -ApiKey 'example-api-key' -EpisodeIdFilter 456,789

EXAMPLE 4

Get-StarrSonarrSeries -SeriesId 123 | Get-StarrSonarrEpisode

PARAMETERS

-ApiKey

The API key used to authenticate with the Starr instance.

Type: System.String
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: Explicit
  Position: Named
  IsRequired: true
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-EpisodeFileId

The Sonarr episode-file identifier used to filter results.

Type: System.Int32
DefaultValue: 0
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-EpisodeId

The positive Episode resource identifier used for an individual lookup.

Type: System.Int32
DefaultValue: 0
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-EpisodeIdFilter

The Sonarr episode identifiers used to filter results.

Type: System.Int32[]
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-IncludeEpisodeFile

Includes episode-file data when true.

Type: System.Boolean
DefaultValue: False
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-IncludeImages

Includes image data when true.

Type: System.Boolean
DefaultValue: False
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-IncludeSeries

Includes series data when true.

Type: System.Boolean
DefaultValue: False
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-InstanceName

The optional name of a saved Starr instance. When omitted, the only matching instance is used.

Type: System.String
DefaultValue: ''
SupportsWildcards: false
Aliases:
- Name
ParameterSets:
- Name: Named
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-SeasonNumber

The Sonarr season number used to filter results.

Type: System.Int32
DefaultValue: 0
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-SeriesId

The Sonarr series identifier used to filter results. This parameter accepts an Id property from the pipeline.

Type: System.Int32
DefaultValue: 0
SupportsWildcards: false
Aliases:
- Id
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: true
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-Url

The absolute base URL of the Starr instance.

Type: System.String
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: Explicit
  Position: Named
  IsRequired: true
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

System.Object

This function accepts objects with an Id property representing a Sonarr series.

OUTPUTS

PSStarr.Sonarr.Episode

This function returns response objects retrieved from the Starr API.

NOTES

https://psstarr.xyz/command-reference/commands/Get-StarrSonarrEpisode/

https://github.com/angrycuban13/PSStarr/blob/main/PSStarr/Source/Public/Sonarr/Get-StarrSonarrEpisode.ps1