Search for Malware entities based on a filter

Find malware families and tools by name or filter criteria; malware entities do not have risk scores.

What this endpoint does

Searches for malware family and tool entities in the Recorded Future knowledge base. Malware entities represent tracked families and tools — not individual file samples. Use freetext for name-based search. This is the primary way to discover malware entity IDs for use in Malware: Lookup and Malware: Lookup Extension. Unlike IOC entities, malware entities do not have risk scores — do not request the risk field. Use categories for classification labels instead.

Response data

Returns matching malware entities with any enrichment fields you specified — enough to identify which malware families match your search and get their IDs for deeper lookups. Paginated with offset-based pagination; limit max 1,000 and limit + from cannot exceed 1,000. Results are under data.results, with counts as a sibling of data. The limit parameter has a default value of 10. The intention is to use pagination to get further results. Though limit can be set to higher values, depending on which fields are used for enrichment, this might result in slower queries and possibly even time outs.

Query Params
string

Freetext

string

The enrichment fields requested for the entities returned. Several fields can be given as a comma separated string.

See https://docs.recordedfuture.com/reference/enrichment-field-attributes for a list of values.

enum

Annotates the response with additional metadata explaining the response data elements.

Allowed:
int32
≤ 1000

Maximum number of records returned,

int32
Defaults to 0

Offsets the pagination of the request. Note that there is a limit of returning only the top 10000 results from a search, meaning if limit plus from exceeds 10000, this will result in an Bad Request message.

string

Filters entities based on the download of the first reference which is taken into account during risk scoring of the entity. All Elasticsearch compatible date formats are valid.

string

Filters entities based on the download of the latest reference which is taken into account during risk scoring of the entity. All Elasticsearch compatible date formats are valid.

string

Filters entities based on presence in a single list. Requires the list ID, which can be found using the List API

enum

Sorts the search according to the chosen parameter. Results are sorted before pagination.

enum

The direction of the sorting by the orderBy parameter, ascending or descending.

Allowed:
string
deprecated
Response

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json