Patch Alert Plugin

Patch Alert Plugin

Patch a new Notification Plugin Instance

Request
URI
PATCH
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  \"certificates\" : [ {\n    \"thumbprint\" : \"6adbe62f-07c0-4533-af85-cc21125d2879\",\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

Authentication
This operation uses the following authentication methods.
Responses
200

Created Notification Plugin Instance

Returns notification-plugin of type(s) application/json 
"{\n  \"pluginTypeId\" : \"StandardEmailPlugin\",\n  \"pluginId\" : \"96b2a32a-0de0-406f-acba-77271a3d5f98\",\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 -X PATCH -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"name:"string","pluginTypeId:"string"}'
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