Get-StarrProwlarrIndexer

SYNOPSIS

Retrieves every configured Prowlarr indexer or one indexer by ID.

SYNTAX

Named (Default)

Get-StarrProwlarrIndexer [-InstanceName <string>] [-IndexerId <int>]

Explicit

Get-StarrProwlarrIndexer -Url <string> -ApiKey <string> [-IndexerId <int>]

DESCRIPTION

This function retrieves configured Prowlarr indexers, regardless of failure state. Use Get-StarrProwlarrIndexerStatus to retrieve failure states. Recognizable provider credentials are redacted.

EXAMPLES

EXAMPLE 1

Get-StarrProwlarrIndexer -InstanceName ProwlarrMain

EXAMPLE 2

Get-StarrProwlarrIndexer -Url 'http://localhost:9696' -ApiKey 'example-api-key' -IndexerId 4

PARAMETERS

-ApiKey

The API key used to authenticate.

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

-IndexerId

The positive identifier of one configured indexer.

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

-InstanceName

The optional saved Prowlarr instance name. The matching instance is inferred when omitted.

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

-Url

The absolute Prowlarr base URL.

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.Prowlarr.Indexer

This function returns sanitized Prowlarr indexer resources.

NOTES

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

https://github.com/angrycuban13/PSStarr/blob/main/PSStarr/Source/Public/Prowlarr/Get-StarrProwlarrIndexer.ps1