Public/Remove-MerakiOrganizationAlertsProfile.ps1
|
function Remove-MerakiOrganizationAlertsProfile { <# .SYNOPSIS Removes an alerts profile for a Meraki organization using the Meraki Dashboard API. .DESCRIPTION The Remove-MerakiOrganizationAlertsProfile function allows you to remove an alerts profile for a specified Meraki organization by providing the authentication token and profile ID. .PARAMETER AuthToken The authentication token (API key) required to access the Meraki Dashboard API. .PARAMETER AlertProfileId The ID of the alerts profile to be removed. .EXAMPLE Remove-MerakiOrganizationAlertsProfile -AuthToken "your-api-token" -AlertProfileId "1234567890" This example removes the alerts profile with ID "1234567890" from the Meraki organization. .NOTES The function requires the "Invoke-RestMethod" cmdlet to be available. The function returns the response from the API if the removal is successful, otherwise, it displays an error message. #> [CmdletBinding()] param ( [parameter(Mandatory=$true)] [string]$AuthToken, [parameter(Mandatory=$true)] [string]$AlertProfileId, [parameter(Mandatory=$false)] [string]$OrganizationID = (Get-OrgID -AuthToken $AuthToken) ) If($OrganizationID -eq "Multiple organizations found. Please specify an organization ID.") { Return "Multiple organizations found. Please specify an organization ID." } else { try { $header = @{ "X-Cisco-Meraki-API-Key" = $AuthToken "content-type" = "application/json; charset=utf-8" } $url = "https://api.meraki.com/api/v1/organizations/$OrganizationId/alerts/profiles/$AlertProfileId" $response = Invoke-RestMethod -Method Delete -Uri $url -Header $header -UserAgent "MerakiPowerShellModule/1.0.2 DocNougat" return $response } catch { Write-Debug $_ Throw $_ } } } |