Get-StarrPing

SYNOPSIS

Retrieves a ping response from a Starr application.

SYNTAX

Named (Default)

Get-StarrPing [-InstanceName <string>] [-Application <string>]

Explicit

Get-StarrPing -Url <string> -ApiKey <string> [-Application <string>]

DESCRIPTION

This function retrieves the application ping response.

EXAMPLES

EXAMPLE 1

Get-StarrPing -InstanceName 'Main'

EXAMPLE 2

Get-StarrPing -Url 'http://localhost:8989' -ApiKey 'example-api-key'

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

-Application

The expected application type. This filters inferred instances and validates named or explicit targets.

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

-InstanceName

The saved instance name. When omitted, the only configured 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.Ping

This function returns deserialized ping response.

NOTES

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

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