trigger.create

Description

object trigger.create(object/array triggers)

This method allows to create new triggers.

This method is only available to Admin and Super admin user types. Permissions to call the method can be revoked in user role settings. See User roles for more information.

Parameters

(object/array) Triggers to create.

Additionally to the standard trigger properties the method accepts the following parameters.

Parameter Type Description
dependencies array Triggers that the trigger is dependent on.

The triggers must have only the triggerid property defined.
tags array Trigger tags.

The trigger expression has to be given in its expanded form.

Return values

(object) Returns an object containing the IDs of the created triggers under the triggerids property. The order of the returned IDs matches the order of the passed triggers.

Examples

Creating a trigger

Create a trigger with a single trigger dependency.

Request:

{
           "jsonrpc": "2.0",
           "method": "trigger.create",
           "params": [
               {
                   "description": "Processor load is too high on {HOST.NAME}",
                   "expression": "last(/Linux server/system.cpu.load[percpu,avg1])>5",
                   "dependencies": [
                       {
                           "triggerid": "17367"
                       }
                   ]
               },
               {
                   "description": "Service status",
                   "expression": "length(last(/Linux server/log[/var/log/system,Service .* has stopped]))<>0",
                   "dependencies": [
                       {
                           "triggerid": "17368"
                       }
                   ],
                   "tags": [
                       {
                           "tag": "service",
                           "value": "{{ITEM.VALUE}.regsub(\"Service (.*) has stopped\", \"\\1\")}"
                       },
                       {
                           "tag": "error",
                           "value": ""
                       }
                   ]
               }
           ],
           "id": 1
       }
Copy
✔ Copied

Response:

{
           "jsonrpc": "2.0",
           "result": {
               "triggerids": [
                   "17369",
                   "17370"
               ]
           },
           "id": 1
       }
Copy
✔ Copied

Source

CTrigger::create() in ui/include/classes/api/services/CTrigger.php.

To toggle search highlight, press Ctrl+Alt+H
Have an improvement suggestion for this page? Select the text that could be improved and press Ctrl+Enter to send it to the editors.