Retrieving a list of required apps and binaries

GET /app/list

Retrieves a list of all required apps and binaries:

curl -k -XGET https://<SAF BM IP-address>:7767/app/list

Input Parameters (Headers)

Name	Type	Description
СlientIP	string	IP address of the host from which the request originates

Input Parameters (Body)

Name	Type	Description
ip	string	IP address of the host from which the request originates
dns	string	DNS of the host from which the request originates
hostname	string	Hostname of the host from which the request originates
system	string	Operating system of the host from which the request originates
guid	string	Unique identifier of the SAF Beat from which the request originates

Output Parameters

Two arrays of objects in JSON format.

Each object consists of the following parameters:

Name	Type	Description
app	string	Name of the app/binary
hash	string	SHA256 hash sum of the archive containing the app/binary
path	string	Extraction path for the app/binary on the host
exist	bool	Presence status of the app/binary on the SAF Beat Manager

warning

If the field exist=false, the extraction path and hash sum will be empty.

Supported Errors

Status	Error Content	Description
400	<syntax error>	Syntax error in the request body
400	Wrong json fields	Incorrect field name or missing required field
500	<error writing response to request>	Internal SAF Beat Manager error
400	No groups, apps or binaries with data in body	Absence of SAF Beat in groups

Examples

Input parameters example:

{
    "ip": "133.133.133.133",
    "dns": "google",
    "hostname": "coolHost",
    "system": "windows-amd64",
    "guid": "1231"
}

Output parameters example:

{
    "apps": [    
        {
            "app": "filebeat",
            "hash": "e19832acb3f21ec9d156f760cffb71cdda08a6e42ae5f202fbb997136f663a87",
            "path": "./config/apps",
            "exist": true
        },
        {
            "app": "metricbeat",
            "hash": "f16090242040ef6e8fd15eff5cb844753960239dc889026ca0fdbb503b9618c1",
            "path": "./config/apps",
            "exist": true
        }
    ],
    "binaries": [
        {
            "app": "filebeat-oss-7.10.2-linux-x86_64.tar.gz",
            "hash": "d8191733ef9e6705b317be2b1cbb2ab0538779b7ff059fdba88d036c447a0123",
            "path": "./bin",
            "exist": true
        }
    ]
}