Test Alert Plugin Using POST

Test Alert Plugin Using POST

Test existing Notification Plugin Instance connectivity

Request
URI
POST
https://{api_host}/api/alertplugins/{pluginId}/test
COPY
Path Parameters
string
pluginId
Required

The identifier of the plugin instance

Query Parameters
string
templateId
Optional

Notification template identifier


Authentication
This operation uses the following authentication methods.
Responses
200

Test connection successfully

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.