Clear and Remove Incident

Clear an incident with the given ID without moving it to the incident history.

Request

HTTP Request

POST /node/api/incidents/:id/clear-remove

Path parameters

Parameter Type Description

id

String
required

The ID of an incident to be cleared and removed.

Request body

The request body is empty.

Response

The response body is empty.

As with the Clear Incident request, the specified incident’s state is set to 3 (Cleared) and the clearTimestamp field is added.

In addition to that, incident stores the information about its removal in the removed field. This information includes the user who requested the removal (removed.userId) and the time of the removal request (removed.timestamp).

This request doesn’t immediately remove the specified incident from the list of active incidents. It marks it as cleared and lets a server remove 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 and Undo Remove.

  • 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,
    "removed": {
        "userId": "62c2f3ce80c8654892764d56",
        "timestamp": 1666693445786
    }
}

Example

Request

  • Bash

  • JavaScript

  • NodeJS

  • Python

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

curl -X POST $url -u $login:$password
let login = <...>
let password = <...>
let incidentId = <...>
let saymonHostname = <...>
let path = "/node/api/incidents/" + incidentId + "/clear-remove";
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 incidentId = <...>
let saymonHostname = <...>
let path = "/node/api/incidents/" + incidentId + "/clear-remove";
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 = <...>
incident_id = <...>
saymon_hostname = <...>
url = "https://" + saymon_hostname + "/node/api/incidents/" + \
    incident_id + "/clear-remove"

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

See Also