Configuration API

The configuration API is made available via the configuration endpoint of the Endpoint Security Server REST API. For complete details on how to interact with Endpoint Security Server API, please refer to FireEye document Endpoint Security REST API Guide Release 5.0.

UPLOAD API For Deny List

A FireEye Endpoint Security administrator can upload a list of hashes or list of filepaths to the Endpoint Server using the following API method.

Request

HTTP Verb	Path	Parameters
POST	hx/api/plugins/deny-list/v1/list/upload	-

Response

Type	Key	Notes
BODY (form data)	deny_list(mandatory)	value: file (denylist.csv: file to upload) Text parameters in form data: append: true/false (to append into an existing list or overwrite) type: file_hash/file_path defaultAction: Optional, Alert is chosen as the default action if not specified explicitly. default Comment: Optional, it is kept blank if not specified

Type

Key

Notes

BODY (form data)

deny_list(mandatory)

value: file (denylist.csv: file to upload)

Text parameters in form data:

append: true/false (to append into an existing list or overwrite)
type: file_hash/file_path
defaultAction: Optional, Alert is chosen as the default action if not specified explicitly.
default Comment: Optional, it is kept blank if not specified

Note

Use lower case values as they are case-sensitive.

EXPORT API for Deny List

HTTP Verb	Path	Parameters
GET	hx/api/plugins/deny-list/v1/list/export	Type: Query params action: alert/quarantine/block type: md5/sha256 list_type: file_hash/file_path

Note

Use lowercase values as they are case-sensitive.

Adding VirusTotal Queries

HTTP Verb	Path	Parameters
POST	hx/api/plugins/deny-list/v1/list/ thirdparty/configuration	-