Create Alert Plugin

If the Notification plugin is a standard email plugin, then any untrusted certificates from the secure SMTP server
is returned as part of the response, the api client should invoke a PATCH call to store these certificates.
By default the notification plugin is in disabled state after being created.
Use the modifyAlertPluginState API to enable the plugin.

Request

URI

POST

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  \"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

Authentication

This operation uses the following authentication methods.

Token-based-authorization

Responses

201

Created Notification Plugin Instance

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

"{\n  \"pluginTypeId\" : \"StandardEmailPlugin\",\n  \"pluginId\" : \"88361bc9-e614-4acb-b890-3b310b91bb93\",\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  \"certificates\" : [ {\n    \"thumbprint\" : \"d404c045-abcf-4978-8d97-c90e764174e0\",\n    \"certificateDetails\" : \"Issued: vmware , expiry:10/01/2014\"\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 POST -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

201 Response Body

Alert Plugins Operations

GET

Get Alert Plugins Of Type

PUT

Update Alert Plugin