Retrieving Information about Connected Smart Beat

GET /clients

Get the list of Smart Beat instances connected to Smart Beat Manager:

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

Get information about a specific Smart Beat:

curl -k -XGET https://<SBM_HOST>:7769/clients/<SB guid>

Header Input Parameters

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

Output Parameters

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
groups	string array	Array of groups that include this Smart Beat
apps	string array	Array of apps assigned to Smart Beat
errors	object	Error structure

The errors structure has the following format:

Name	Type	Description
status	bool	Error presence status
guid	string	Unique Smart Beat identifier
errortimestamp	string	Error sending time
errors	object array	Array of objects with errors

Objects in the errors array have the following format:

Name	Type	Description
app	string	Name of resource where errors occurred
apperrors	string array	Error content

Supported Errors

Status	Error content	Error description
400	Non connected clients yet	No connected Smart Beat yet
500	<response write error>	Internal server error

Examples

Example output for /clients:

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

Example output for /clients/1231:

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