YARA: scan files with a YARA rule
Scan files with a YARA rule.
1. Run the example
Download the YARA example. Extract it, install httpx, set your API URL and token, then run python client.py. The client uploads the included inputs, submits the command, and saves the result under results/RUN_ID.
2. Check the result
Read stdout for the matching rule and string locations. The example also shows a rule include.
Read the native exit code and cleanup status printed by the client. Read results and save reports explains the returned files.
3. Use your own inputs
Edit example.json to change the command arguments, requested outputs or deadline. Replace the files under inputs/ with your own data, keeping the staged paths aligned with the command. The client creates the artifact IDs for you; illustrative IDs shown here must not be copied into a live request.
Files used by this example
rules/main.yarrules/child.yarsamples/a.binsamples/b.bin
The example uses supplied files or the disposable execution environment. Nothing from the environment carries into a later run unless you request and reuse its output.
Commands, version and prerequisites
Qualified version: 4.5.4. Commands: yara, yarac.
Inspect GET /v1/tools/yara for the current installed version and readiness. The published snapshot has 2 functional case(s), plus timeout and cancellation checks. These examples demonstrate the native path; other flags and inputs are supported within the tool’s runtime limits.