Get Alert Plugins Of Type

Get Alert Plugins Of Type

Get Notification Plugins, optionally filtered for a specific type

Request
URI
GET
https://{api_host}/suite-api/api/alertplugins
COPY
Query Parameters
string
pluginTypeId
Optional

The notification type

Authentication
This operation uses the following authentication methods.
Responses
200

List containing Notification Plugins

Returns notification-plugins of type(s) application/json 
"{\n  \"notificationPluginInstances\" : [ {\n    \"pluginTypeId\" : \"StandardEmailPlugin\",\n    \"pluginId\" : \"edd3eea1-b610-44b1-8b98-106d88fb0c02\",\n    \"name\" : \"Notification Plugin Sample\",\n    \"description\" : \"Where to notify Example\",\n    \"configValues\" : [ {\n      \"name\" : \"IS_SECURE_CONNECTION\",\n      \"value\" : \"true\"\n    }, {\n      \"name\" : \"SMTP_HOST\",\n      \"value\" : \"10.118.48.101\"\n    }, {\n      \"name\" : \"SMTP_PORT\",\n      \"value\" : \"25\"\n    }, {\n      \"name\" : \"senderEmailAddress\",\n      \"value\" : \"[email protected]\"\n    }, {\n      \"name\" : \"senderName\",\n      \"value\" : \"Somebody\"\n    } ]\n  }, {\n    \"pluginTypeId\" : \"StandardEmailPlugin\",\n    \"pluginId\" : \"c2bf5fcf-cd77-4b31-b0cd-24cdb4631808\",\n    \"name\" : \"Notification Plugin Sample\",\n    \"description\" : \"Where to notify Example\",\n    \"configValues\" : [ {\n      \"name\" : \"IS_SECURE_CONNECTION\",\n      \"value\" : \"true\"\n    }, {\n      \"name\" : \"SMTP_HOST\",\n      \"value\" : \"10.118.48.101\"\n    }, {\n      \"name\" : \"SMTP_PORT\",\n      \"value\" : \"25\"\n    }, {\n      \"name\" : \"senderEmailAddress\",\n      \"value\" : \"[email protected]\"\n    }, {\n      \"name\" : \"senderName\",\n      \"value\" : \"Somebody\"\n    } ]\n  } ]\n}"
array of object
notificationPluginInstances
Optional

Collection of notification plugin instances


Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/suite-api/api/alertplugins
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