Create Alert Plugin Using POST

Create Alert Plugin Using POST

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}/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

{
    "name": "string"
}
{
    "certificates": [
        {
            "certificateDetails": "string",
            "expires": "string",
            "issuedBy": "string",
            "issuedTo": "string",
            "thumbprint": "string"
        }
    ],
    "configValues": [
        {
            "name": "string",
            "value": "string"
        }
    ],
    "description": "string",
    "enabled": false,
    "name": "string",
    "pluginId": "string",
    "pluginTypeId": "string",
    "version": 0
}
certificates
Optional

Any set of untrusted certificates returned by the adapter source

array of name-value
configValues
Optional

The list of name value pairs for Plugin configuration

string
description
Optional

The description for the configuration

boolean
enabled
Optional

A read-only property whose value is set by the system

string
name
Required

The name for the configuration

string As uuid As uuid
pluginId
Optional

The Plugin Id, cannot be null during update operations

string
pluginTypeId
Optional

The plugin type identifier

integer As int64 As int64
version
Optional

A read-only version identifier. This value will be returned after getting an existing configuration. And the correct value is necessary to update an existing configuration.

Authentication
This operation uses the following authentication methods.
Responses
201

Created Notification Plugin Instance

Returns notification-plugin of type(s) application/json
{
    "certificates": [
        {
            "certificateDetails": "string",
            "expires": "string",
            "issuedBy": "string",
            "issuedTo": "string",
            "thumbprint": "string"
        }
    ],
    "configValues": [
        {
            "name": "string",
            "value": "string"
        }
    ],
    "description": "string",
    "enabled": false,
    "name": "string",
    "pluginId": "string",
    "pluginTypeId": "string",
    "version": 0
}
certificates
Optional

Any set of untrusted certificates returned by the adapter source

array of name-value
configValues
Optional

The list of name value pairs for Plugin configuration

string
description
Optional

The description for the configuration

boolean
enabled
Optional

A read-only property whose value is set by the system

string
name
Required

The name for the configuration

string As uuid As uuid
pluginId
Optional

The Plugin Id, cannot be null during update operations

string
pluginTypeId
Optional

The plugin type identifier

integer As int64 As int64
version
Optional

A read-only version identifier. This value will be returned after getting an existing configuration. And the correct value is necessary to update an existing configuration.