Developers API

setAlertMatrix

Creates / updates an Alert Group, specifying the matrix of alert recipients at each escalation level.

The matrix is provided in JSON serialized format. It contains a series of contact-channels, each containing an array of alert levels:

{"<ContactChannelID>": [AlertLevel 1, AlertLevel 2], "<ContactChannelID>": [AlertLevel 5], ...}

You can specify an empty matrix with: '[]' or '{}'.

This JSON string is of the same format returned by the getAlertMatrix API command.

Request Parameters

Parameter Data Type Description Required Default
matrix string A JSON-string representation of the matrix. Required -
groupid integer The id of the alert group you want to set Optional
mode enum Deprecated. GROUP should always be used. Optional GROUP
hostid integer Deprecated. Use groupid instead. Optional

Response Data

Response Variable Data Type Description
errorcode integer Returns an errorcode of 0 if call is successful.
Try it out with the API Explorer:

Your API Key

API command to be called

Desired response format

A JSON-string representation of the matrix. (string)

The id of the alert group you want to set (integer)

Deprecated. GROUP should always be used. (enum, optional, default = GROUP)

Deprecated. Use groupid instead. (integer)