Get-StarrProwlarrIndexerProxySchema
SYNOPSIS
Retrieves Prowlarr IndexerProxySchema resources.
SYNTAX
Named (Default)
Explicit
DESCRIPTION
This function retrieves schemas for Prowlarr indexer proxies. It redacts provider secrets. Do not use returned objects for updates.
EXAMPLES
EXAMPLE 1
EXAMPLE 2
PARAMETERS
-ApiKey
The API key used to authenticate with the 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: ''
-InstanceName
The saved Prowlarr instance name. 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: ''
-Url
The absolute base URL of the 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.Prowlarr.ProviderSchema
This function returns deserialized Prowlarr IndexerProxySchema resources with provider secrets redacted.
NOTES
RELATED LINKS
https://psstarr.xyz/command-reference/commands/Get-StarrProwlarrIndexerProxySchema/