Retrieving Information about Current Groups

GET /serverclasses

Get the list of available groups on Smart Beat Manager:

curl -k -XGET https://<SBM_HOST>:7769/serverclasses

Header Input Parameters

Name	Type	Description
Authorization	string	Base64 login and password for Smart Beat Manager authorization

Output Parameters

Array of JSON objects.

Each object contains the following parameters:

Name	Type	Description
name	string	Group name
filters	string array	Filter list (criteria for Smart Beat membership in this group)
systems	string array	List of operating systems this group is intended for
connectedclients	string	Number of Smart Beat instances connected to this group

Supported Errors

{
    "name": "linux",
    "filters": [
        "137.12.23.9",
        "146.34.32.1",
        "133.133.133.130"
    ],
    "apps": [
        "filebeat",
        "scriptbeat"
    ],
     "systems": [
        "linux"
    ],
	"connectedclients": 5
}

GET /serverclasses/<group name>

Get detailed information about a specific group:

curl -k -XGET https://<SBM_HOST>:7769/serverclasses/<group name>

Header Input Parameters

Name	Type	Description
Authorization	string	Base64 login and password for Smart Beat Manager authorization

Output Parameters

Array of JSON objects.

Each object contains the following parameters:

Name	Type	Description
name	string	Group name
filters	string array	Filter list (criteria for Smart Beat membership in this group)
systems	string array	List of operating systems this group is intended for
connectedclients	object array	Connected Smart Beat instances in this group

Objects in the connectedclients array have the following structure:

Name	Type	Description
ip	string	Smart Beat IP address
dns	string	Smart Beat DNS
hostname	string	Smart Beat hostname
system	string	Smart Beat operating system
guid	string	Unique Smart Beat identifier
timestamp	string	Smart Beat last connection time

Supported Errors

Status	Error content	Error description
500	<response write error>	Internal server error
400	Group not exist	Group with the name from URL does not exist

Examples

Example output parameters:

{
    "name": "137",
    "filters": [
        "172.17.0.137"
    ],
    "apps": [
        "filebeat_1"
    ],
    "systems": ["windows"],
    "connectedclients": [
        {
            "ip": "172.17.0.137",
            "hostname": "Test-Windows",
            "dns": "Test-WINDOWS",
            "guid": "4a8cd520-8218-4614-a810-a4bd5da307ce",
            "system": "windows",
            "timestamp": "2020-01-01 00:00:35"
        }
    ]
}