Skip to content

Get Server Configuration

Returns a server configuration.

Request

HTTP Request

GET /node/api/configuration

Permissions

manage-configuration

Path parameters

No parameters required.

Request body

The request body is empty.

Response

Work in Progress

This topic is a work in progress and may be incomplete.

Examples

Request examples

login=<...>
password=<...>
saymon_hostname=<...>
url=https://$saymon_hostname/node/api/configuration

curl -X GET $url -u $login:$password

let login = <...>
let password = <...>
let saymonHostname = <...>
let path = "/node/api/configuration";
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 path = "/node/api/configuration";
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 = <...>
url = "https://" + saymon_hostname + "/node/api/configuration"

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

Response example

{
    "server": {
        "history_update_period": 120000,
        "event_log_max_bytes": "1 G",
        "default_result_timeout": 120000,
        "email": {
            "disabled": true,
            "transport": {
                "service": "Gmail",
                "auth": {
                    "user": "my_gmail_address@gmail.com",
                    "pass": "my_gmail_password"
                }
            },
            "fields": {
                "from": "my_gmail_address@gmail.com",
                "to": "notif_recipient_address@company.com"
            },
            "max_json_length": 1000
        },
        "user": {}
    }
}