Skip to content

Search Objects

Searches for objects matching specified criteria.

Request

HTTP Request

POST /node/api/objects/search

Permissions

objectPermissions

Path parameters

No parameters required.

Body parameters

Work in Progress

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

Request body

{
    "search": {
        "name": {
            "$regex": "cpu",
            "$options": "i"
        }
    }
}

Response

Field Type Description
objects Array<Object> An array of objects that match the specified search criteria.

Examples

Request examples

The following examples show how to perform a case-insensitive search of all objects named "CPU":

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

curl -X POST $url -u $login:$password \
    -H "Content-Type: application/json" \
    -d @- <<EOF
{
    "search": {
        "name": {
            "$regex": "cpu",
            "$options": "i"
        }
    }
}
EOF
let login = <...>
let password = <...>
let saymonHostname = <...>
let path = "/node/api/objects/search";
let auth = "Basic " + btoa(login + ":" + password);

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

let data = JSON.stringify({
    "search": {
        "name": {
            "$regex": "cpu",
            "$options": "i"
        }
    }
});

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/objects/search";
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({
    "search": {
        "name": {
            "$regex": "cpu",
            "$options": "i"
        }
    }
});

req.write(data);
req.end();
import requests
import json

login = <...>
password = <...>
saymon_hostname = <...>
url = "https://" + saymon_hostname + "/node/api/objects/search"

body = {
    "search": {
        "name": {
            "$regex": "cpu",
            "$options": "i"
        }
    }
}

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

Response example

[
    {
        "name": "CPU",
        "discovery_id": "192.168.1.82-CPU",
        "object_groups": [],
        "geoposition": [],
        "child_ref_ids": [],
        "child_link_ids": [],
        "child_ids": [],
        "parent_id": "5e21b85b308c3c66d64e07bc",
        "weight": 1,
        "tags": [],
        "last_state_update": 1583141090805,
        "updated": 1583916836283,
        "created": 1579268187099,
        "state_id": 7,
        "class_id": 4,
        "operations": [
            ...
        ],
        "properties": [
            {
                "name": "AgentId",
                "value": "5e21b85b308c3c66d64e07c8",
                "type_id": 8,
                "id": "5e21b85b308c3c66d64e07d5"
            },
            ...
        ],
        "manual_state": null,
        "owner_id": "5e21b752308c3c66d64e072c",
        "id": "5e21b85b308c3c66d64e07d2"
    },
    ...
]