Documentation
Web Security, Firewall, and Log API
RustMinerSystem safe-route, web-port, HTTPS, certificate, IP/wallet firewall, and log-query endpoints.
Web Security, Firewall, and Log API
These operations can change the backend address, restart services, or block access. Confirm the new endpoint first and never blacklist the current management address.
Web access settings
| Method | Path | Request/purpose |
|---|---|---|
| GET | /api/route |
Read the backend safe route. |
| POST | /api/route |
Save it with { "k": "new-route" }. |
| POST | /api/web/port/restart |
Change the web port with { "port": 8080 }. |
| GET | /api/web/tls |
Read backend HTTPS state. |
| POST | /api/web/tls/{flag} |
Set HTTPS; flag is 0 or 1. |
A safe-route, web-port, or HTTPS change can disconnect the request while the service restarts. Reconnect to the new address before declaring the operation failed.
Mining-port certificate
| Method | Path | Purpose |
|---|---|---|
| GET | /api/cert |
Read global mining-port certificate state. |
| POST | /api/cert/upload |
Upload the PEM certificate and private key. |
| GET | /api/cert/reset |
Restore the bundled certificate. |
{
"pem": "<URI-encode the certificate text, then Base64-encode it>",
"key": "<URI-encode the private-key text, then Base64-encode it>"
}
Never log this body. The reset changes state even though the current frontend calls it with GET.
IP blacklist
| Method | Path | Purpose |
|---|---|---|
| GET | /api/ip/blacklist |
Read the IP blacklist. |
| POST | /api/ip/blacklist/add |
Add one or more IPs. |
| POST | /api/ip/blacklist/delete |
Remove one or more IPs. |
| GET | /api/ip/coming |
Read IP access records from all ports. |
| GET | /api/ipblacklist/all/log |
Read blocked-IP events. |
Add/remove body:
{
"ips": ["192.0.2.10"]
}
Wallet blocklist and allowlist
| Method | Path | Purpose |
|---|---|---|
| GET | /api/wallet/blacklist |
Read the wallet blocklist. |
| POST | /api/wallet/blacklist/add |
Add a blocked wallet. |
| POST | /api/wallet/blacklist/delete |
Remove a blocked wallet. |
| GET | /api/wallet/whitelist |
Read the wallet allowlist. |
| POST | /api/wallet/whitelist/add |
Add an allowed wallet. |
| POST | /api/wallet/whitelist/delete |
Remove an allowed wallet. |
| GET | /api/bwlist/log |
Read wallet firewall match logs. |
The wallet APIs retain the historical ips field name:
{
"ips": ["<wallet or subaccount>"]
}
Program and operation logs
| Method | Path | Purpose |
|---|---|---|
| GET | /api/request/log |
Read backend operation logs. |
| GET | /api/running/log |
Read runtime logs. |
| GET | /api/error/log |
Read program error logs. |
| GET | /api/d/tl |
Read miner connection-trouble records. |
Logs can contain wallets, IPs, pool endpoints, and internal errors. Redact them before external display and tightly restrict log API access.
