Skip to content

Get-StarrQueueDetail

SYNOPSIS

Retrieves queue details from a Starr instance.

SYNTAX

Named (Default)

Get-StarrQueueDetail [-InstanceName <string>] [-Application <string>] [-MovieId <int>]
 [-IncludeMovie <bool>] [-SeriesId <int>] [-EpisodeIdFilter <int[]>] [-IncludeSeries <bool>]
 [-IncludeEpisode <bool>]

Explicit

Get-StarrQueueDetail -Url <string> -ApiKey <string> [-Application <string>] [-MovieId <int>]
 [-IncludeMovie <bool>] [-SeriesId <int>] [-EpisodeIdFilter <int[]>] [-IncludeSeries <bool>]
 [-IncludeEpisode <bool>]

DESCRIPTION

This function retrieves detailed download-queue records.

EXAMPLES

EXAMPLE 1

Get-StarrQueueDetail

EXAMPLE 2

Get-StarrQueueDetail -InstanceName 'Main'

EXAMPLE 3

Get-StarrQueueDetail -Url 'http://localhost:7878' -ApiKey 'example-api-key'

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: ''

-Application

The expected application type. Use an application-specific queue-detail command for a narrower parameter surface.

Type: System.String
DefaultValue: ''
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: ''

-IncludeEpisode

Includes episode 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: ''

-IncludeMovie

Includes movie 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: ''

-MovieId

The Radarr movie 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: ''

-SeriesId

The Sonarr series 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: ''

-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

None.

You cannot pipe objects to this function.

OUTPUTS

PSStarr.QueueDetail

This function returns response objects retrieved from the Starr API.

NOTES

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

https://github.com/angrycuban13/PSStarr/blob/main/PSStarr/Source/Public/General/Get-StarrQueueDetail.ps1