Clear Incident
Clear an incident with the given ID and move it into the incident history list.
Request
HTTP Request
Path parameters
Parameter | Type | Description |
---|---|---|
id | Stringrequired |
The ID of an incident to be cleared. |
Request body
The request body is empty.
Response
The response body is empty.
When you execute this request, the specified incident's state
is set to 3
(Cleared) and the clearTimestamp
field is added.
This request doesn't immediately move the specified incident to the incident history. It marks it 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.
Example
Request
let login = <...>
let password = <...>
let incidentId = <...>
let saymonHostname = <...>
let path = "/node/api/incidents/" + incidentId + "/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 incidentId = <...>
let saymonHostname = <...>
let path = "/node/api/incidents/" + incidentId + "/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();