Clear all incidents

Clears all incidents in the system and moves them into the incident history list.

Request

HTTP Request

POST /node/api/incidents/clear

Request body

You can optionally specify the filter in the request body. The system will clear only the alarms fitting the criteria. You can find more information on the filter format used in this request on the Incident Filters page.

The filter is specified in the search field. For example, the request with the following body will clear all alarms generated by objects with the Antenna class.

{
   "search": {
      "filter": [
         "classId",
         "34"
      ]
   }
}

Response

The response body is empty.

When you execute this request, the state of all cleared incidents is set to 3 (Cleared) and the clearTimestamp field is added to each incident record.

This request doesn’t immediately move cleared incidents to the incident history. It marks them as cleared and lets a server move it after a period of time. This period is specified in the server configuration’s incident_timeout variable. During this period you can Undo Clear.

Incidents keep their IDs when moved to incident history.

Example of an affected record:

Before
After

{
    "id": "62ff3cca7d19dd1100f43d7f",
    "entityId": 112,
    "entityType": 1,
    "type": 1,
    "lastState": 4,
    "localTimestamp": 1660894410845,
    "parentChainId": 112,
    "reason": {
        "code": 10
    },
    "state": 4,
    "text": "No Data",
    "timestamp": 1660894410845
}

{
    "id": "62ff3cca7d19dd1100f43d7f",
    "entityId": 112,
    "entityType": 1,
    "type": 1,
    "lastState": 4,
    "localTimestamp": 1660894410845,
    "parentChainId": 112,
    "reason": {
        "code": 10
    },
    "state": 3,
    "text": "No Data",
    "timestamp": 1660894410845,
    "clearTimestamp": 1666687954577
}

Example

Request

Bash
JavaScript
NodeJS
Python

login=<...>
password=<...>
saymon_hostname=<...>
url=https://$saymon_hostname/node/api/incidents/clear

curl -X POST $url -u $login:$password

let login = <...>
let password = <...>
let saymonHostname = <...>
let path = "/node/api/incidents/clear";
let auth = "Basic " + btoa(login + ":" + password);

let headers = new Headers();
headers.append("Authorization", auth);

let requestOptions = {
    method: "POST",
    headers: headers
};

fetch(saymonHostname + path, requestOptions)
    .then(response => response.text())
    .then(result => console.log(result))
    .catch(error => console.log("error", error));

const http = require("http");

let login = <...>
let password = <...>
let saymonHostname = <...>
let path = "/node/api/incidents/clear";
let auth = "Basic " + Buffer.from(login + ":" + password).toString("base64");

let options = {
    "method": "POST",
    "hostname": saymonHostname,
    "headers": {
        Authorization: auth
    },
    "path": path
};

let req = http.request(options, function (res) {
    let chunks = [];

    res.on("data", function (chunk) {
        chunks.push(chunk);
    });

    res.on("end", function (chunk) {
        let body = Buffer.concat(chunks);
        console.log(body.toString());
    });

    res.on("error", function (error) {
        console.error(error);
    });
});

req.end();

import requests

login = <...>
password = <...>
saymon_hostname = <...>
url = "https://" + saymon_hostname + "/node/api/incidents/clear"

response = requests.request("POST", url, auth=(login, password))
print(response.text)