Get-StarrRadarrCredit
SYNOPSIS
Retrieves Radarr credits from a Starr instance.
SYNTAX
Named (Default)
Get-StarrRadarrCredit [-InstanceName <string>] [-CreditId <int>] [-MovieId <int>]
[-MovieMetadataId <int>]
Explicit
Get-StarrRadarrCredit -Url <string> -ApiKey <string> [-CreditId <int>] [-MovieId <int>]
[-MovieMetadataId <int>]
DESCRIPTION
This function retrieves Radarr credits.
EXAMPLES
EXAMPLE 1
EXAMPLE 2
EXAMPLE 3
EXAMPLE 4
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: ''
-CreditId
The positive Credit 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: ''
-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. 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: ''
-MovieMetadataId
The Radarr movie metadata 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
System.Object
This function accepts objects with an Id property representing a Radarr movie.
OUTPUTS
PSStarr.Radarr.Credit
This function returns response objects retrieved from the Starr API.
NOTES
RELATED LINKS
https://psstarr.xyz/command-reference/commands/Get-StarrRadarrCredit/