API Reference - mrhenrike/MikrotikAPI-BF GitHub Wiki
API Reference
Language: English · Português (pt-BR)
Complete reference for all CLI flags.
Target
| Flag |
Example |
Description |
-t / --target |
-t 192.168.88.1 |
Target IP or hostname |
-n / --network |
-n 192.168.1.0/24 |
Target network (used with --discover) |
-p / --port |
-p 8728 |
RouterOS API port (default: 8728) |
Credentials
| Flag |
Example |
Description |
-U / --user |
-U admin |
Single username |
-P / --pass |
-P admin |
Single password |
-u / --userlist |
-u users.txt |
Username wordlist file |
-p / --passlist |
-p passwords.txt |
Password wordlist file |
-d / --combo |
-d combos.txt |
Combo file (user:pass per line) |
Execution
| Flag |
Example |
Description |
--threads |
--threads 10 |
Concurrent threads (default: 5) |
--timeout |
--timeout 5 |
Connection timeout in seconds (default: 3) |
--delay |
--delay 1.0 |
Fixed delay between attempts (seconds) |
--delay-min |
--delay-min 1 |
Minimum delay (stealth mode) |
--delay-max |
--delay-max 5 |
Maximum delay (stealth mode) |
--progress |
--progress |
Show live progress bar with ETA |
--config |
--config config.yaml |
Load settings from YAML config file |
Stealth
| Flag |
Description |
--stealth |
Enable stealth mode (Fibonacci delays + UA rotation) |
--ua-rotation |
Enable User-Agent rotation only |
Discovery
| Flag |
Example |
Description |
--discover |
--discover |
Scan network for Mikrotik devices |
-n |
-n 192.168.1.0/24 |
Network to scan |
--fingerprint |
--fingerprint |
Device fingerprinting (no attack) |
--nvd |
--nvd |
CVE lookup via NVD API after fingerprint |
Sessions
| Flag |
Example |
Description |
--session |
--session my_test |
Named session (auto-saves progress) |
--resume |
--resume my_test |
Resume interrupted session |
Post-Login Validation
| Flag |
Example |
Description |
--validate |
--validate ftp,ssh,telnet |
Test services after successful login |
Proxy
| Flag |
Example |
Description |
--proxy |
--proxy socks5://127.0.0.1:9050 |
Proxy URI (socks5 or http) |
CVE / Exploit (v3.10.0+)
| Flag |
Example |
Description |
--scan-cve |
--scan-cve |
Standalone CVE vulnerability scan |
--all-cves |
--all-cves |
Show all CVEs (ignore version match) |
--run-exploit |
--run-exploit CVE-2018-14847 |
Run specific exploit PoC by ID |
--audit |
--audit |
8-phase automated security audit |
Export
| Flag |
Description |
--export-json |
Export results as JSON |
--export-csv |
Export results as CSV |
--export-xml |
Export results as XML |
--export-txt |
Export results as TXT |
--export sarif |
Export results as SARIF v2.1.0 (v3.10.0+) |
--export-all |
Export all formats at once |
--export-dir PATH |
Custom export directory (default: results/) |
--audit-report |
Generate professional PDF audit report |
Delay Profiles (v3.6.0+)
| Flag |
Description |
--delay-mode high |
0s delay — maximum speed |
--delay-mode balanced |
0.25s delay — default |
--delay-mode stealth |
1.0s delay — low-noise |
--delay-mode custom |
User-defined delay (use with -s) |
--high-threads |
Allow up to 300 threads |
Output / Verbosity
| Flag |
Description |
-v |
Verbose: show all attempts |
-vv |
Very verbose: show API protocol messages |
-vvv |
Debug: show raw bytes on the wire |
--version |
Show version and exit |
--check-config |
Validate config.json / config.yaml |
Return Codes
| Code |
Meaning |
0 |
Success — at least one valid credential found |
1 |
No credentials found |
2 |
Configuration/argument error |
3 |
Connection error (target unreachable) |
130 |
Interrupted by user (Ctrl+C) |
See also: Usage Examples · Features