Delete Alert Plugin

Delete Alert Plugin

The field checkDependencies is added to preserve the initial behavior. By default it is set to false.

Case 1: When checkDependencies is false, the API has the following behavior:
Dependent Notification Rules are cascade deleted.
Dependent Report Schedules are unreferenced.
Dependent Tenant Email Configurations are always checked. If any then deletion is failed.

Case 2: When checkDependencies is true, the API has the following behavior:
All dependencies are checked. If any then deletion is failed.

To successfully delete the notification plugin, all conflicting dependencies must be removed.

Request
URI
DELETE
https://{api_host}/suite-api/api/alertplugins/{pluginId}
COPY
Path Parameters
string
pluginId
Required

The identifier of the plugin instance

Query Parameters
boolean
checkDependencies
Optional
Constraints: default: false

Flag to check plugin dependencies

Authentication
This operation uses the following authentication methods.
Responses
204

The notification plugin is deleted successfully

Operation doesn't return any data structure

Code Samples
COPY
                    curl -X DELETE -H 'Authorization: <value>' https://{api_host}/suite-api/api/alertplugins/{pluginId}
On This Page
Alert Plugins Operations
GET
Get Alert Plugins Of Type
PUT
Update Alert Plugin
POST
Create Alert Plugin
PATCH
Patch Alert Plugin
PUT
Modify Alert Plugin State
POST
Test Alert Plugin
GET
Get Alert Plugin Instance
DELETE
Delete Alert Plugin
GET
Get Rules Of Plugin
GET
Get Alert Plugin Types
GET
Get Alert Plugin Type With Id