Get Alert Plugin Instance
Get Notification Plugin specified by Plugin ID
Request
URI
GET
https://{api_host}/suite-api/api/alertplugins/{pluginId}
COPY
Path Parameters
string
pluginId
Required
The identifier for the plugin instance
Responses
200
List containing Notification Plugins
Returns
notification-plugin
of type(s)
application/json
"{\n \"pluginTypeId\" : \"StandardEmailPlugin\",\n \"pluginId\" : \"e6babe2e-ccdc-44f8-ac8a-783824f9ea02\",\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}"
string
pluginTypeId
Required
The plugin type identifier
string As uuid
As uuid
pluginId
Optional
The Plugin Id, cannot be null during update operations
string
name
Required
The name for the configuration
string
description
Optional
The description for the configuration
boolean
enabled
Optional
A read-only property whose value is set by the system
array of
object
configValues
Optional
The list of name value pairs for Plugin configuration
array of
object
certificates
Optional
Any set of untrusted certificates returned by the adapter source
Code Samples
COPY
curl -H 'Authorization: <value>' https://{api_host}/suite-api/api/alertplugins/{pluginId}
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