object event.acknowledge(object/array parameters)
This method allows to update events. The following update actions can be performed:
Only trigger events can be updated.
Only problem events can be updated.
Read/Write rights for trigger are required to close the event or to change event's severity.
To close an event, manual close should be allowed in the trigger.
This method is available to users of any type. Permissions to call the method can be revoked in user role settings. See User roles for more information.
(object/array)
Parameters containing the IDs of the events and update operations that should be performed.
Parameter | Type | Description |
---|---|---|
eventids | ID/array | IDs of the events to acknowledge. Parameter behavior: - required |
action | integer | Event update action(s). This is a bitmask field, any combination of possible bitmap values is acceptable. Possible bitmap values: 1 - close problem; 2 - acknowledge event; 4 - add message; 8 - change severity; 16 - unacknowledge event; 32 - suppress event; 64 - unsuppress event; 128 - change event rank to cause; 256 - change event rank to symptom. Parameter behavior: - required |
cause_eventid | ID | Cause event ID. Parameter behavior: - required if action contains the "change event rank to symptom" bit |
message | string | Text of the message. Parameter behavior: - required if action contains the "add message" bit |
severity | integer | New severity for events. Possible values: 0 - not classified; 1 - information; 2 - warning; 3 - average; 4 - high; 5 - disaster. Parameter behavior: - required if action contains the "change severity" bit |
suppress_until | integer | Unix timestamp until which event must be suppressed. If set to "0", the suppression will be indefinite. Parameter behavior: - required if action contains the "suppress event" bit |
(object)
Returns an object containing the IDs of the updated events under the eventids
property.
Acknowledge a single event and leave a message.
{
"jsonrpc": "2.0",
"method": "event.acknowledge",
"params": {
"eventids": "20427",
"action": 6,
"message": "Problem resolved."
},
"id": 1
}
Response:
Change severity for multiple events and leave a message.
{
"jsonrpc": "2.0",
"method": "event.acknowledge",
"params": {
"eventids": ["20427", "20428"],
"action": 12,
"message": "Maintenance required to fix it.",
"severity": 4
},
"id": 1
}
Response:
CEvent::acknowledge() in ui/include/classes/api/services/CEvent.php.