getBlocklistItems
This method lists all the hashes that are present in the blocklist.
Parameters
Parameter | Type | Optional | Description |
|---|---|---|---|
| String | Yes | When set, the method lists only the items in the Blocklist for the company with the provided ID. |
| Number | Yes | The results page number. The default value is 1. |
| Number | Yes | The number of items displayed in a page. The upper limit is 100 items per page. Default value: 30 items per page. |
Return value
items - the list of blocklist items. Each entry in the list has the following fields:
id, the ID of the hash item in the Blocklist.hashType, the algorithm used to obtain the hash. Possible values:1- SHA256,2- MD5hash, the hash value for a specific file.source, the source from where the hash entry hash originated. Possible values:1- Incident,2- Import,3- Manual.sourceInfo, the description of the item, as the user provided when adding the item to the Blocklist.filename, the name of file corresponding to the hash. This field is only displayed if this information exists.companyId, the ID of the company associated with this item in the Blocklist.
Example
Request:
{
"params": {
"companyId" : "5b680f6fb1a43d860a7b23c8"
},
"jsonrpc": "2.0",
"method": "getBlocklistItems",
"id": "0df7568c-59c1-48e0-a31b-18d83e6d9810"
} Response:
{
"id": "0df7568c-59c1-48e0-a31b-18d83e6d9810",
"jsonrpc": "2.0",
"result": {
"items": [
{
"companyId": "5b680f6fb1a43d860a7b23c8",
"hash": "098f6bcd4621d373cade4e832627b4f6",
"hashType": 2,
"id": "5b7ac19bb1a43dfb107b23c6",
"source": 3,
"sourceInfo": "Added from public API"
},
{
"companyId": "5b680f6fb1a43d860a7b23c8",
"filename": "file.txt",
"hash": "f696282aa4cd4f614aa995190cf442fe",
"hashType": 2,
"id": "5b7ac19bb1a43dfb107b23c7",
"source": 1,
"sourceInfo": "Added from incident 1"
}
],
"page": 1,
"pagesCount": 1,
"perPage": 30,
"total": 2
}
}