Get Link's State History

GET /node/api/links/:id/state-history

Returns a link's state history.
Permissions: linkPermissions.

Request parameters

Path parameters

Parameter
Type
Description
id
string
required
The ID of a link whose state history should be retrieved.

Query parameters

Parameter
Type
Description
from
integer
optional
A lower-bound timestamp for a link's state history records.
limit
string
optional
The maximum number of records to be retrieved.
skip
string
optional
The number of the first records to be skipped.
to
integer
optional
An upper-bound timestamp for a link's state history records.

Response description

...

Examples

Request examples

Bash
JavaScript
NodeJS
Python
1
login=<...>
2
password=<...>
3
saymon_hostname=<...>
4
link_id=<...>
5
url=https://$saymon_hostname/node/api/links/$link_id/state-history
6
7
curl -X GET $url -u $login:$password
Copied!
1
let login = <...>
2
let password = <...>
3
let saymonHostname = <...>
4
let linkId = <...>
5
let path = "/node/api/links/" + linkId + "/state-history";
6
let auth = "Basic " + btoa(login + ":" + password);
7
8
let headers = new Headers();
9
headers.append("Authorization", auth);
10
11
let requestOptions = {
12
method: "GET",
13
headers: headers
14
};
15
16
fetch(saymonHostname + path, requestOptions)
17
.then(response => response.text())
18
.then(result => console.log(result))
19
.catch(error => console.log("error", error));
Copied!
1
const http = require("http");
2
3
let login = <...>
4
let password = <...>
5
let saymonHostname = <...>
6
let linkId = <...>
7
let path = "/node/api/links/" + linkId + "/state-history";
8
let auth = "Basic " + Buffer.from(login + ":" + password).toString("base64");
9
10
let options = {
11
"method": "GET",
12
"hostname": saymonHostname,
13
"headers": {
14
"Authorization": auth
15
},
16
"path": path
17
};
18
19
let req = http.request(options, function (res) {
20
let chunks = [];
21
22
res.on("data", function (chunk) {
23
chunks.push(chunk);
24
});
25
26
res.on("end", function (chunk) {
27
let body = Buffer.concat(chunks);
28
console.log(body.toString());
29
});
30
31
res.on("error", function (error) {
32
console.error(error);
33
});
34
});
35
36
req.end();
Copied!
1
import requests
2
3
login = <...>
4
password = <...>
5
saymon_hostname = <...>
6
link_id = <...>
7
url = "https://" + saymon_hostname + "/node/api/links/" + \
8
link_id + "/state-history"
9
10
response = requests.request("GET", url, auth=(login, password))
11
print(response.text)
Copied!

Response example

1
[
2
{
3
"stateId": 1,
4
"timestamp": 1585053147052,
5
"id": "5e79fddb6ec5ea28e5105f66"
6
},
7
...
8
]
Copied!
Last modified 8mo ago