Set Link’s Stat Metadata

Sets stat metadata for a link.

Request

HTTP Request

POST /node/api/links/:id/stat/meta

Permissions

linkPermissions + (modify-links | manage-links)

Path parameters

Parameter Type Description

id

String
required

The ID of a link for which stat metadata should be set.

Request body

Request body contains new metadata for the specified link. See the Stat Metadata model for more information.

{
    "packetsTransmitted": {
        "changeRate": "ALWAYS"
    },
    "packetsReceived": {
        "changeRate": "ALWAYS"
    }
}

Response

The response body is empty.

Example

Request

Bash
JavaScript
NodeJS
Python

login=<...>
password=<...>
saymon_hostname=<...>
link_id=<...>
url=https://$saymon_hostname/node/api/links/$link_id/stat/meta

curl -X POST $url -u $login:$password \
    -H "Content-Type: application/json" \
    -d @- <<EOF
{
    "packetsTransmitted": {
        "changeRate": "ALWAYS"
    },
    "packetsReceived": {
        "changeRate": "ALWAYS"
    }
}
EOF

let login = <...>
let password = <...>
let saymonHostname = <...>
let linkId = <...>
let path = "/node/api/links/" + linkId + "/stat/meta";
let auth = "Basic " + btoa(login + ":" + password);

let headers = new Headers();
headers.append("Authorization", auth);
headers.append("Content-Type", "application/json");

let data = JSON.stringify({
    "packetsTransmitted": {
        "changeRate": "ALWAYS"
    },
    "packetsReceived": {
        "changeRate": "ALWAYS"
    }
});

let requestOptions = {
    method: "POST",
    headers: headers,
    body: data
};

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 + "/stat/meta";
let auth = "Basic " + Buffer.from(login + ":" + password).toString("base64");

let options = {
    "method": "POST",
    "hostname": saymonHostname,
    "headers": {
        "Authorization": auth,
        "Content-Type": "application/json"
    },
    "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);
    });
});

let data = JSON.stringify({
    "packetsTransmitted": {
        "changeRate": "ALWAYS"
    },
    "packetsReceived": {
        "changeRate": "ALWAYS"
    }
});

req.write(data);
req.end();

import requests

login = <...>
password = <...>
saymon_hostname = <...>
link_id = <...>
url = "https://" + saymon_hostname + "/node/api/links/" + \
    link_id + "/stat/meta";

body = {
    "packetsTransmitted": {
        "changeRate": "ALWAYS"
    },
    "packetsReceived": {
        "changeRate": "ALWAYS"
    }
}

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

See Also