Update Alert Plugin

Before updating a notification plugin, the plugin should be disabled. During the update process
if there are any untrusted certificates returned by the server the patchAlertPlugin call should be made.
Once the update is successfully completed, use modifyAlertPluginState API to enable the plugin.

Request

URI

PUT

https://{api_host}/suite-api/api/alertplugins

COPY

Request Body

The NotificationPlugin to create, including plugin type and configuration details

notification-plugin of type(s) application/json

Required

Show optional properties

{
    "pluginTypeId": "string",
    "name": "string"
}

"{\n  \"pluginTypeId\" : \"StandardEmailPlugin\",\n  \"pluginId\" : \"18589dea-9999-1234-abba-f1ee73004dac\",\n  \"name\" : \"Notification Plugin Updated Sample\",\n  \"description\" : \"Where to notify Example\",\n  \"version\" : 140592123,\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

Authentication

This operation uses the following authentication methods.

Token-based-authorization

Responses

200

The updated Notification Plugin Instance

Returns notification-plugin of type(s) application/json

"{\n  \"pluginTypeId\" : \"StandardEmailPlugin\",\n  \"pluginId\" : \"18589dea-9999-1234-abba-f1ee73004dac\",\n  \"name\" : \"Notification Plugin Updated Sample\",\n  \"description\" : \"Where to notify Example\",\n  \"version\" : 140592123,\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 -X PUT -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"name:"string","pluginTypeId:"string"}' https://{api_host}/suite-api/api/alertplugins

On This Page

Description

Request

Request Body

Authentication

Response

200 Response Body

Alert Plugins Operations

GET

Get Alert Plugins Of Type

PUT

Update Alert Plugin