API Reference

API Reference

All endpoints return JSON. The server runs on port 8080 by default.

---

Scenario Execution

Method	Endpoint	Description
POST	/api/run_scenario	Run a scenario by name or inline steps
POST	/run_scenario	Run a scenario (legacy)
POST	/start	Start tool execution
POST	/stop	Stop running execution
POST	/start_scenario	Start a named scenario
POST	/save_scenario	Save a scenario to disk
GET	/list_scenarios	List saved scenario files
GET	/load_scenario/<name>	Load a scenario by name

---

Settings

Method	Endpoint	Description
GET	/api/settings	Get current settings
POST	/api/settings	Update settings

---

GPIO

Method	Endpoint	Description
GET	/gpio_config	Get GPIO pin configuration
POST	/gpio_config	Update GPIO pin configuration
POST	/gpio_test	Test a GPIO pin

---

Network

Method	Endpoint	Description
GET	/local_cidr	Get local network CIDR
GET	/network_interfaces	List network interfaces

---

Logs

Method	Endpoint	Description
GET	/fetch_logs	Fetch execution logs

---

WiFi Pwn Module

Interfaces & Monitor Mode

Method	Endpoint	Description
GET	/api/wifi/interfaces	List wireless interfaces
POST	/api/wifi/monitor	Enable/disable monitor mode

Monitor mode request body:

{
  "action": "enable",
  "interface": "wlan0"
}

Scanning

Method	Endpoint	Description
POST	/api/wifi/scan	Scan for networks

Request body:

{
  "duration": 15
}

Response includes: array of networks with essid, bssid, channel, power, encryption, clients.

Deauth & Capture

Method	Endpoint	Description
POST	/api/wifi/deauth	Deauth + capture handshake

Request body:

{
  "bssid": "AA:BB:CC:DD:EE:FF",
  "channel": 6,
  "essid": "TargetNetwork",
  "duration": 30,
  "clients": ["11:22:33:44:55:66"]
}

Handshakes

Method	Endpoint	Description
GET	/api/wifi/handshakes	List captured handshakes
POST	/api/wifi/submit	Submit a handshake to WPA-SEC
GET	/api/wifi/results	Check WPA-SEC for cracked passwords

Submit request body:

{
  "bssid": "AA:BB:CC:DD:EE:FF"
}

Results query parameter: ?key=YOUR_WPASEC_KEY

Auto Hunt

Method	Endpoint	Description
POST	/api/wifi/auto	Start/stop auto-hunt mode
POST	/api/wifi/stop	Stop all WiFi operations

Auto hunt request body:

{
  "action": "start",
  "interface": "wlan0"
}

AP Whitelist

Method	Endpoint	Description
POST	/api/wifi/whitelist	Add/remove BSSID from whitelist

Request body:

{
  "action": "add",
  "bssid": "AA:BB:CC:DD:EE:FF"
}

Action can be "add" or "remove". Returns the updated whitelist array.

Spectrum Scanner

Method	Endpoint	Description
POST	/api/wifi/spectrum/start	Start live spectrum scanning
POST	/api/wifi/spectrum/stop	Stop spectrum scanning
GET	/api/wifi/spectrum/data	Get current spectrum readings

Status

Method	Endpoint	Description
GET	/api/wifi/status	Get full WiFi module status

Response includes: is_running, monitor_iface, networks, handshakes, whitelist, spectrum_running.

---

WebSocket Events

OctapusPrime uses Socket.IO for real-time communication:

Event	Direction	Description
output	Server → Client	Tool execution output lines
wifi	Server → Client	WiFi module log messages
progress	Server → Client	Scan progress updates