Get Incident by ID

Returns an incident with the specified ID.

Request

HTTP Request

GET /node/api/incidents/:id

Path parameters

Parameter Type Description

id

String
required

The ID of an incident to be retrieved.

Request body

The request body is empty.

Response

Returns the specified incident in the JSON format. See the Incident model for more information.

Example

Request

  • Bash

  • JavaScript

  • NodeJS

  • Python

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

curl -X GET $url -u $login:$password
let login = <...>
let password = <...>
let saymonHostname = <...>
let incidentId = <...>
let path = "/node/api/incidents/" + incidentId;
let auth = "Basic " + btoa(login + ":" + password);

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

let requestOptions = {
    method: "GET",
    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 incidentId = <...>
let path = "/node/api/incidents/" + incidentId;
let auth = "Basic " + Buffer.from(login + ":" + password).toString("base64");

let options = {
    "method": "GET",
    "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 = <...>
incident_id = <...>
url = "https://" + saymon_hostname + "/node/api/incidents/" + \
    incident_id

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

Response

{
    "id": "5db1a690502dd473e8bcba0e",
    "entityId": "58023c993f8d78c75f98c203",
    "entityType": 1,
    "type": 1,
    "parentChainId": "58023c993f8d78c75f98c203",
    "state": 4,
    "data": "{...}",
    "text": "Incident text",
    "localTimestamp": null,
    "timestamp": 1571923600018,
    "lastState": 4,
    "reason": {
        "code": 3
    }
}

See Also