Match

Resolve human-readable entity names to Recorded Future entity IDs using fuzzy matching, with an optional type filter to narrow results to specific entity categories.

What this endpoint does

This endpoint resolves human-readable entity names to Recorded Future entity IDs using fuzzy name matching. It is the primary way to find entity IDs when you know a name (such as "Log4Shell", "AsyncRAT", or "8.8.8.8") but need the corresponding RF entity ID required by other API endpoints. The optional type filter narrows results to specific entity types — without it, results can span vulnerabilities, malware, IPs, usernames, products, and more. Use the returned entity IDs with the Entity: Lookup endpoint to retrieve identity metadata, with type-specific lookup endpoints (such as IP Address: Lookup or Vulnerability: Lookup) for full enrichment, or with the Detection Rules: Search endpoint's entities filter to find associated detection rules.

Response data

The response is a JSON array of matched entity objects, ranked by match quality (best match first). Each object contains id (the Recorded Future entity ID), name (the entity's display name, which may differ from the search term — for example, searching "Log4Shell" returns CVE-2021-44228), and type (the entity classification such as CyberVulnerability, Malware, IpAddress, or InternetDomainName). Results are capped at the limit value (default 10, maximum 100).

Body Params
string
required

This mandatory free text search field is used to match against entity names.

type
array of strings

An array of types is optional. If in use, the Match operation will only try to match on entities that meet any of the "type" criteria. See the list of Available Entity Types.

type
integer
1 to 100
Defaults to 10

This optional field is used to limit the max number of responses returned (maximum 100).

Responses

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