Skip to content

Create Metric Token

Creates a new metric token that can be used to access the metric without authentication.

Request

HTTP Request

POST /node/api/metric-token

Path parameters

No parameters required.

Body parameters

Parameter Type Field
metric String The name of the metric for which to create a token.
entityId String The ID of the entity that has the specified metric.
entityType String The type of the entity that owns the specified metric. 1 is object, 2 is link.

Request body

{
    "entityId": "5e7dbc31f988c426bb372053",
    "entityType": 1,
    "metric": "averageCpuLoad"
}

Response

Response contains the information passed in the request body and the created metric token stored in the id field.

{
    "entityId": "5e21b85b308c3c66d64e07d2",
    "entityType": 1,
    "metric": "averageCpuLoad",
    "id": "83d62e15-628e-4ec7-8746-e6ff20ebdc11"
}

Example

Request

login=<...>
password=<...>
saymon_hostname=<...>
url=https://$saymon_hostname/node/api/metric-token

curl -X POST $url -u $login:$password \
    -H "Content-Type: application/json" \
    -d @- <<EOF 
    {
        "entityId": "5e21b85b308c3c66d64e07d2",
        "entityType": 1,
        "metric": "averageCpuLoad"
    }
    EOF

let login = <...>
let password = <...>
let saymonHostname = <...>
let path = "/node/api/metric-token";
let auth = "Basic " + btoa(login + ":" + password);

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

let data = JSON.stringify({
    "entityId": "5e7dbc31f988c426bb372053",
    "entityType": 1,
    "metric": "averageCpuLoad"
});

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 path = "/node/api/metric-token/";
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({
    "entityId": "5e7dbc31f988c426bb372053",
    "entityType": 1,
    "metric": "averageCpuLoad"
});

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

import requests

login = <...>
password = <...>
saymon_hostname = <...>
url = "https://" + saymon_hostname + "/node/api/metric-token"

body = {
    "entityId": "5e21b85b308c3c66d64e07d2",
    "entityType": 1,
    "metric": "averageCpuLoad"
}

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

Response

{
    "entityId": "5e21b85b308c3c66d64e07d2",
    "entityType": 1,
    "metric": "averageCpuLoad",
    "id": "83d62e15-628e-4ec7-8746-e6ff20ebdc11"
}