Retrieving Information about Available Binaries

GET /binaries

Get the list of available binaries on Smart Beat Manager:

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

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
binary	string	Binary name
groups	string array	Array of groups where this binary is present
connectedclients	int	Number of connected Smart Beat instances

Supported Errors

Status	Error content	Error description
400	Binaries not found	Binary list is empty
500	<response write error>	Internal server error

Examples

Example output parameters:

[
   {
        "binary": "filebeat-oss-7.10.2-linux-x86_64.tar.gz",
        "groups": [
            "nginx_test",
            "alert_test"
        ],
        "connectedclients": 2
    },
    {
        "binary": "filebeat-oss-7.10.2-windows-x86_64.zip",
        "groups": [
            "scriptbeat_exchange"
        ],
        "connectedclients": 1
    },
    {
        "binary": "metricbeat-oss-7.10.2-windows-x86_64.zip",
        "groups": null,
        "connectedclients": 0
    }
]

GET /binaries/<binary name>

Get information about a specific binary:

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

Header Input Parameters

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

Output Parameters

A JSON object with the following fields:

Name	Type	Description
binary	string	Binary name
groups	string array	Array of groups where this binary is present
connectedclients	object array	Connected Smart Beat instances

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
400	Binary not found	Binary with this name was not found
500	<response write error>	Internal server error

Examples

Example output parameters:

{
    "binary": "scriptbeat-1.0.0-windows-x86_64.zip",
    "groups": [
        "scriptbeat_exchange",
        "scriptbeat_active_directory",
        "scriptbeat_active_directory_second",
        "msca"
    ],
    "connectedclients": [
        {
            "ip": "172.16.0.1",
            "hostname": "AD-test",
            "dns": "test.local.",
            "guid": "84fb9a1b-620a-81af-bea091af9b73",
            "system": "windows",
            "timestamp": "2023-01-01 00:00:44"
        },
        {
            "ip": "172.1.10.1",
            "hostname": "MSCA-test",
            "dns": "test.local.",
            "guid": "934c96f5-f58a-8779-10b2187ad416",
            "system": "windows",
            "timestamp": "2023-01-01 00:00:46"
        }
   ]
}