Public/SSL/Remove-StatusCakeHelperSSLTest.ps1
|
<# .SYNOPSIS Remove a StatusCake SSL Test .DESCRIPTION Deletes a StatusCake SSL Test using the supplied ID. .PARAMETER APICredential Credentials to access StatusCake API .PARAMETER Domain Name of the test to retrieve .PARAMETER ID Test ID to retrieve .PARAMETER PassThru Return the object that is removed .EXAMPLE C:\PS>Remove-StatusCakeHelperSSLTest -ID 123456 Remove the SSL Test with ID 123456 #> function Remove-StatusCakeHelperSSLTest { [CmdletBinding(PositionalBinding=$false,SupportsShouldProcess=$true)] Param( [ValidateNotNullOrEmpty()] [System.Management.Automation.PSCredential] $APICredential = (Get-StatusCakeHelperAPIAuth), [Parameter(ParameterSetName = "ID")] [int]$ID, [Parameter(ParameterSetName = "Domain")] [ValidatePattern('^((https):\/\/)([a-zA-Z0-9\-]+(\.[a-zA-Z]+)+.*)$|^(?!^.*,$)')] [string]$Domain, [switch]$PassThru ) $checkParams = @{} if($Domain) { $checkParams.Add("Domain",$Domain) } else { $checkParams.Add("ID",$ID) } $sslTest = Get-StatusCakeHelperSSLTest -APICredential $APICredential @checkParams if($sslTest) { if($sslTest.GetType().Name -eq 'Object[]') { Write-Error "Multiple SSL Tests found with domain [$Domain]. Please remove the SSL test by ID" Return $null } $ID = $sslTest.id } else { Write-Error "Unable to find SSL Test with name [$Domain]" Return $null } $requestParams = @{ uri = "https://app.statuscake.com/API/SSL/Update?id=$ID" Headers = @{"Username"=$APICredential.Username;"API"=$APICredential.GetNetworkCredential().password} UseBasicParsing = $true method = "Delete" } if( $pscmdlet.ShouldProcess("StatusCake API", "Remove StatusCake SSL Test") ) { $response = Invoke-RestMethod @requestParams $requestParams = @{} if($response.Success -ne "True") { Write-Error "$($response.Message) [$($response.Issues)]" } elseif($PassThru) { Return $sslTest } } } |