Set Object's Stat Metadata

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

Sets object's stat metadata.

Permissions: objectPermissions + (modify-objects | manage-objects).

Request parameters

Path parameters

Parameter

Type

Description

id

string required

The ID of an object whose stat metadata should be set.

Response description

The response body is empty.

Request examples

Given below is an example of a request body representing stat metadata in the JSON format:

body.json
{
"percentageUsage": {
"wait": {
"type": "PERCENTILE",
"changeRate": "ALWAYS"
},
"system": {
"type": "PERCENTILE",
"changeRate": "ALWAYS"
},
"user": {
"type": "PERCENTILE",
"changeRate": "ALWAYS"
},
"nice": {
"type": "PERCENTILE",
"changeRate": "ALWAYS"
}
}
}

Provided the content is saved in a file named body.json, a request can be done like this:

Bash
NodeJS
Python
Bash
login=<your_login>
password=<your_password>
saymon_hostname=<your_saymon_hostname>
object_id=<your_object_id>
url=https://$saymon_hostname/node/api/objects/$object_id/stat/meta
curl -X POST $url -u $login:$password \
-H "Content-Type: application/json" \
--data @/path/to/body.json
NodeJS
const http = require("http");
let login = <your_login>
let password = <your_password>
let saymon_hostname = <your_saymon_hostname>
let object_id = <your_object_id>
let path = "/node/api/objects/" + object_id + "/stat/meta";
let auth = "Basic " + Buffer.from(login + ":" + password).toString("base64");
let options = {
"method": "POST",
"hostname": saymon_hostname,
"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({
"percentageUsage": {
"wait": {
"type": "PERCENTILE",
"changeRate": "ALWAYS"
},
"system": {
"type": "PERCENTILE",
"changeRate": "ALWAYS"
},
"user": {
"type": "PERCENTILE",
"changeRate": "ALWAYS"
},
"nice": {
"type": "PERCENTILE",
"changeRate": "ALWAYS"
}
}
});
req.write(data);
req.end();
Python
import requests
import json
login = <your_login>
password = <your_password>
saymon_hostname = <your_saymon_hostname>
object_id = <your_object_id>
url = "https://" + saymon_hostname + "/node/api/objects/" + \
object_id + "/stat/meta";
with open("/path/to/body.json", "r") as f:
body = json.load(f)
response = requests.request("POST", url, json=body, auth=(login, password))
print(response.text)