Update Notification Template

Update an existing notification template

Updates an existing notification template.
NOTE: Limit for selected Resource Kinds count is 30.
NOTE: Limit for selected Stats count is 30.

Request

URI

PUT

https://{api_host}/suite-api/api/notifications/templates

COPY

Request Body

Notification template as payload

notification-template of type(s) application/json

Required

Show optional properties

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

"{\n  \"templateId\" : \"a8107b20-0a38-4d7c-8292-dae0e5ca9f49\",\n  \"pluginTypeId\" : \"WebhookPlugin\",\n  \"name\" : \"Template\",\n  \"description\" : \"WebhookPlugin Description\",\n  \"contentConfigs\" : [ {\n    \"baseResourceKindKeyStats\" : {\n      \"resourceKindKey\" : {\n        \"resourceKind\" : \"Resource kind\",\n        \"adapterKind\" : \"Adapter kind\"\n      },\n      \"stats\" : [ \"Property key\", \"Stat key\" ]\n    },\n    \"ancestorResourceKindKeys\" : [ {\n      \"resourceKindKey\" : {\n        \"resourceKind\" : \"Ancestor Resource kind\",\n        \"adapterKind\" : \"Ancestor Adapter kind\"\n      },\n      \"stats\" : [ \"Ancestor Stat Key\", \"Ancestor Property Key\" ]\n    } ],\n    \"descendantResourceKindKeys\" : [ {\n      \"resourceKindKey\" : {\n        \"resourceKind\" : \"Descendant Resource kind\",\n        \"adapterKind\" : \"Descendant Adapter kind\"\n      },\n      \"stats\" : [ \"Descendant Property Key\", \"Descendant Stat Key\" ]\n    } ]\n  } ],\n  \"formattingTemplate\" : {\n    \"type\" : \"WEBHOOK_TEMPLATE\",\n    \"newAlertTemplate\" : {\n      \"endpoint\" : \"/endpoint\",\n      \"headers\" : [ {\n        \"key\" : \"Content-type\",\n        \"value\" : \"application/json\"\n      }, {\n        \"key\" : \"Header Key\",\n        \"value\" : \"Header Value\"\n      } ],\n      \"method\" : \"POST\",\n      \"payload\" : \"{\\\"startDate\\\":\\\"${CREATE_TIME}\\\"}\"\n    }\n  },\n  \"templateType\" : \"ALERT\"\n}"

integer As int32 As int32

attachedRuleCount

Optional

Attached rule count of the Notification template

array of object

contentConfigs

Optional

A set of template content configs

string

description

Optional

Description of the Notification template

boolean

editable

Optional

Indicates whether the template is editable or not

object

formattingTemplate

Optional

Formatting template

string

lastModifiedBy

Optional

Latest user UUID which modified the template

integer As int64 As int64

lastModifiedOn

Optional

Last time the template is modified

string

name

Required

Name of the Notification template

string

pluginTypeId

Required

Notification template type

string

templateId

Optional

Notification template identifier

array of object

templateProperties

Optional

Collection of template properties. Applicable only for WebhookPlugin and EmailPlugin.

string

templateType

Optional

Notification Template Type

Possible values are : ALERT, ACTION, UNKNOWN,

Authentication

This operation uses the following authentication methods.

Token-based-authorization

Responses

200

The updated notification template

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

"{\n  \"templateId\" : \"a8107b20-0a38-4d7c-8292-dae0e5ca9f49\",\n  \"pluginTypeId\" : \"WebhookPlugin\",\n  \"name\" : \"Template\",\n  \"description\" : \"WebhookPlugin Description\",\n  \"contentConfigs\" : [ {\n    \"baseResourceKindKeyStats\" : {\n      \"resourceKindKey\" : {\n        \"resourceKind\" : \"Resource kind\",\n        \"adapterKind\" : \"Adapter kind\"\n      },\n      \"stats\" : [ \"Property key\", \"Stat key\" ]\n    },\n    \"ancestorResourceKindKeys\" : [ {\n      \"resourceKindKey\" : {\n        \"resourceKind\" : \"Ancestor Resource kind\",\n        \"adapterKind\" : \"Ancestor Adapter kind\"\n      },\n      \"stats\" : [ \"Ancestor Stat Key\", \"Ancestor Property Key\" ]\n    } ],\n    \"descendantResourceKindKeys\" : [ {\n      \"resourceKindKey\" : {\n        \"resourceKind\" : \"Descendant Resource kind\",\n        \"adapterKind\" : \"Descendant Adapter kind\"\n      },\n      \"stats\" : [ \"Descendant Property Key\", \"Descendant Stat Key\" ]\n    } ]\n  } ],\n  \"formattingTemplate\" : {\n    \"type\" : \"WEBHOOK_TEMPLATE\",\n    \"newAlertTemplate\" : {\n      \"endpoint\" : \"/endpoint\",\n      \"headers\" : [ {\n        \"key\" : \"Content-type\",\n        \"value\" : \"application/json\"\n      }, {\n        \"key\" : \"Header Key\",\n        \"value\" : \"Header Value\"\n      } ],\n      \"method\" : \"POST\",\n      \"payload\" : \"{\\\"startDate\\\":\\\"${CREATE_TIME}\\\"}\"\n    }\n  },\n  \"templateType\" : \"ALERT\"\n}"

integer As int32 As int32

attachedRuleCount

Optional

Attached rule count of the Notification template

array of object

contentConfigs

Optional

A set of template content configs

string

description

Optional

Description of the Notification template

boolean

editable

Optional

Indicates whether the template is editable or not

object

formattingTemplate

Optional

Formatting template

string

lastModifiedBy

Optional

Latest user UUID which modified the template

integer As int64 As int64

lastModifiedOn

Optional

Last time the template is modified

string

name

Required

Name of the Notification template

string

pluginTypeId

Required

Notification template type

string

templateId

Optional

Notification template identifier

array of object

templateProperties

Optional

Collection of template properties. Applicable only for WebhookPlugin and EmailPlugin.

string

templateType

Optional

Notification Template Type

Possible values are : ALERT, ACTION, UNKNOWN,

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/notifications/templates

On This Page

Description

Request

Request Body

Authentication

Response

200 Response Body

Notifications Operations

GET

Get All Notification Rules

POST

Create Notification Plugin Rule