Get Link’s Config Log

Returns a link’s config log.

Request

HTTP Request

GET /node/api/links/:id/config-log

Path parameters

Parameter Type Description

id

String
required

The ID of a link whose config log should be retrieved.

Query parameters

Parameter Type Description

from

Integer

A lower-bound timestamp for config log records.

inverse

String

Whether to inverse the order of config log records.

limit

String

The maximum number of records to be retrieved.

skip

String

The number of the first records to be skipped.

to

Integer

An upper-bound timestamp for config log records.

Request body

The request body is empty.

Response

Returns an array of configuration changes for a specified link. See the Configuration files and directories modifications wiki page for more information.

Each configuration change has the following fields:

Field Type Description

id

String

ID of the change.

timestamp

Integer

The time of the change.

content

String

Encoded configuration change.

contentEncoding

String

Encoding of the configuration change. Supports GZIP_BASE64 encoding.

Example

Request

  • Bash

  • JavaScript

  • NodeJS

  • Python

login=<...>
password=<...>
saymon_hostname=<...>
link_id=<...>
url=https://$saymon_hostname/node/api/links/$link_id/config-log

curl -X GET $url -u $login:$password
let login = <...>
let password = <...>
let saymonHostname = <...>
let linkId = <...>
let path = "/node/api/links/" + linkId + "/config-log";
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 linkId = <...>
let path = "/node/api/links/" + linkId + "/config-log";
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 = <...>
link_id = <...>
url = "https://" + saymon_hostname + "/node/api/links/" + \
    link_id + "/config-log";

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

Response

[
    {
        "timestamp": 1445261129000,
        "content": "H4sIAAAAAAAAAO09bVsbOZJ/RQO558nMxK8YsOHDPTa2E3ZJYLGZmeww52vcst2h36a7DSaT7G+..."
        "contentEncoding": "GZIP_BASE64",
        "id": "56a73ad4645c0d7f7a13c572"
    },
{
        "timestamp": 1455885355000,
        "content": "H4sIAAAAAAAAAO09/XfbOI7/CifpvteZqT/jJHbywz1/ttlNm2zszE53MudTJNpWo6+R5MTptPu3\r\nHwCSMiXRidtu7927c2biyAQIkABIAgSp/rlX46ldC+ZusNo7..."
        "contentEncoding": "GZIP_BASE64",
        "id": "56b2051e424be4b806a45c29"
    },
]

See Also