Skip to content

Get-WETStatus

SYNOPSIS

Retrieve the status of the WET API.

SYNTAX

Get-WETStatus [[-Report] <String>] [[-Credential] <PSCredential>] [<CommonParameters>]

DESCRIPTION

This function retrieves the status of the WET API by sending a request to the specified status endpoint. It supports two report types: "Am-I-up" and "About". Optionally, credentials can be provided for authentication.

EXAMPLES

EXAMPLE 1

Get-WETStatus -Report "Am-I-up"

Retrieves the "Am-I-up" status report from the WET API.

EXAMPLE 2

Get-WETStatus -Report "About" -Credential (Get-Credential)

Retrieves the "About" status report from the WET API using the specified credentials.

PARAMETERS

-Report

The type of status report to retrieve. Valid values are "Am-I-up" or "About". Defaults to "About".

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 1
Default value: About
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False

-Credential

The PSCredential object to use for authentication. If not provided, default credentials will be used.

Type: PSCredential
Parameter Sets: (All)
Aliases:

Required: False
Position: 11
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

OUTPUTS

NOTES