Retrieving Information About Connected SAF Beats

GET /clients

Get a list of SAF Beats connected to the SAF Beat Manager:

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

Get information about a specific SAF Beat:

curl -k -XGET https://<SAF BM IP-address>:7769/clients/<guid SAFB>

Input Parameters (Headers)

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

Output Parameters

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
groups	string array	Array of groups the SAF Beat belongs to
apps	string array	Array of applications assigned to the SAF Beat
errors	object	Error structure

The errors structure is as follows:

Name	Type	Description
status	bool	Error presence status
guid	string	SAF Beat unique identifier
errortimestamp	string	Error submission timestamp
errors	object array	Array of error objects

Objects in the errors array have the following structure:

Name	Type	Description
app	string	Name of the resource with which errors occurred
apperrors	string array	Error details

Supported Errors

Status	Error Content	Description
400	Non connected clients yet	No SAF Beats are connected yet
500	<error writing response to request>	Internal server error

Examples

Output parameters example for the /clients request:

[
    {
        "ip": "133.133.133.132",
        "hostname": "coolHost",
        "dns": "google",
        "guid": "1231",
        "system": "windows-amd64",
        "timestamp": "2020-10-21 19:14:07",
	    "groups": [
                "android",
                "windows",
        ],
             "apps": [
                "examplebeat_1"
        ]	,
	     "errors": {
                "status": false,
                "errors": null,
                "errortimestamp": ""
        }
    },
    {
        "ip": "133.133.133.133",
        "hostname": "coolHost",
        "dns": "google",
        "guid": "1232",
        "system": "windows-amd64",
        "timestamp": "2020-10-21 19:14:55",
	      "groups": [
            "linux",
            "ios"
        ],
		"apps": [
            "filebeat_1"
        ],
		"errors": {
            "status": true,
            "errors": [
                {
                    "app": "filebeat",
                    "apperrors": [
                        "error1",
                        "error2"
                    ]
                },
                {
                    "app": "examplebeat",
                    "apperrors": [
                        "error3",
                        "error4"
                    ]
                }
            ],
            "errortimestamp": "2020-11-09 17:05:30"
        }
    }
]

Output parameters example for the /clients/1231 request:

{
    "ip": "133.133.133.132",
    "hostname": "coolHost",
    "dns": "google",
    "guid": "1231",
    "system": "windows-amd64",
    "timestamp": "2020-10-21 19:14:07",
	    "groups": [
            "android",
            "windows",
        ],
        "apps": [
            "examplebeat_1"
        ],
	    "errors": {
            "status": false,
            "errors": null,
            "errortimestamp": ""
        }
}