Retrieving Information About Current Groups

GET /serverclasses

Get a list of available groups on the SAF Beat Manager:

curl -k -XGET https://<SAF BM IP-address>:7769/serverclasses

Input Parameters (Headers)

Name	Type	Description
Authorization	string	Login and password in base64 format for SAF Beat Manager authorization

Output Parameters

An array of objects in JSON format.

Each object consists of the following parameters:

Name	Type	Description
name	string	Group name
filters	string array	List of filters (data about which SAF Beats belong to this group)
systems	string array	List of operating systems for which this group is intended
connectedclients	string	Number of SAF Beats 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 more detailed information about a specific group:

curl -k -XGET https://<SAF BM IP-address>:7769/serverclasses/<group name>

Input Parameters (Headers)

Name	Type	Description
Authorization	string	Login and password in Base64 format for SAF Beat Manager authorization

Output Parameters

An array of objects in JSON format.

Each object consists of the following parameters:

Name	Type	Description
name	string	Group name
filters	string array	List of filters (data about which SAF Beats belong to this group)
systems	string array	List of operating systems for which this group is intended
connectedclients	object array	SAF Beat connected to this group

Objects in the connectedclients array have the following structure:

Name	Type	Description
ip	string	SAF Beat IP address
dns	string	SAF Beat DNS
hostname	string	SAF Beat hostname
system	string	SAF Beat operating system
guid	string	SAF Beat unique identifier
timestamp	string	SAF Beat last connection timestamp

Supported Errors

Status	Error Content	Description
500	<error writing response to request>	Internal server error
400	Group not exist	A group with the name specified in the URL does not exist

Examples

Output parameters example:

{
    "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"
        }
    ]
}