API Documentation

Integrate WisPanel with your applications using our comprehensive REST API.

Base URL

https://your-server-ip:2083/api/v1

All API endpoints are relative to this base URL.

Security API

Security API

Four subsystems, each with its own doc. License: Pro/Enterprise. Base: /api/v1/security/module.

Module status — GET /api/v1/security/module/status

Response 200 (verified live):

{ "licensed": false, "license_tier": "free",
  "scanner_ready": true, "ratelimit_active": true,
  "realtime_scan_enabled": true, "watched_paths": 429,
  "threats_today": 0, "blocked_today": 0 }

GET | PUT /api/v1/security/module/config; POST /api/v1/security/challenge/verify.

Subsystem Doc Base
Malware Scanner Malware Scanner /security/module/scanner
Tamper Protection Tamper Protection /security/module/tamper
Firewall (CSF + basic) Firewall — CSF & Basic /csf, /firewall
SSH / WAF / Rate Limit SSH, WAF & Rate Limit /security/module/{ssh,modsecurity,ratelimit}

Rate Limiting

API requests are limited to 60 requests per minute per API token.

  • X-RateLimit-Limit: Maximum requests per minute
  • X-RateLimit-Remaining: Remaining requests
  • X-RateLimit-Reset: Unix timestamp when limit resets