Run your first check

Scan a small file with YARA in one complete Python example.

1. Set up your client

You need Python, an API base URL, and an owner-scoped API token. Get the URL and token from the person operating your deployment. Install httpx with python -m pip install httpx, then set SECURITY_RUN_URL and SECURITY_RUN_API_KEY in your terminal.

2. Run the example

Save the Python example as first_check.py and run python first_check.py. It creates a rule that looks for security.run, uploads the rule and sample, starts YARA, and waits for the result. You do not need to create input files first.

3. Check what happened

Expect a succeeded state, a native exit code of 0, and destroyed cleanup. The downloaded YARA output should contain example, the matched rule name. If any of these differ, use Fix a failed or stuck run.

4. Scan your own file

Replace b"hello security.run" with Path("your-file.bin").read_bytes() and add from pathlib import Path. Replace the rule bytes with your own rule file. Keep the staged filenames aligned with the names passed in args.

Next

Upload several files, pass flags and configuration, or try another tool.