مرجع APIAPI Reference

الفيروول الحقيقي = 57 خدمة مصغّرة (microservices) عبر 7 فئات، كلها خلف بوابة API واحدة على البورت 18000. كل خدمة تكشف REST كامل: مخططات Request/Response، أمثلة curl، أكواد الحالة، حدود المعدل، وأحداث WebSocket.The real firewall = 57 microservices across 7 categories, all behind a single API Gateway on port 18000. Each service exposes full REST: Request/Response schemas, curl examples, status codes, rate limits, and WebSocket events.

كتالوج الخدمات الحقيقي (57 خدمة)Real Service Catalog (57 services)

كل الخدمات تُنادى عبر البوابة https://<fw>:18000/api/v1/<service> (أو البورت المباشر للخدمة).

الفئة	الخدمات (البورت)
أمن الشبكة	Multi-WAN Manager (18083)، NAT Manager (18084)، Web Filter (18087)، DNS Filter (18099)، QoS Controller (18088)، VPN Service (18098)، DDoS Protection (18102)، WAF Service (18096)، Port Manager (18081)، Port Checker (18097)
كشف التهديدات والاستجابة	Threat Intelligence (18080)، SIEM (18100)، XDR Engine (18124)، Threat Hunter (18108)، Honeypot (18106)، Sandbox (18113)، EDR Bridge (18086)، DLP (18112)، Insider Risk (18126)، Email Security (18114)
الهوية والوصول	Auth Service (18085)، IdP/SSO (18103)، ZTNA (18117)، PAM (18120)، API Security (18119)
الامتثال والتحقيقات	Compliance Evidence (18132)، DFIR Toolkit (18133)، BAS (18135)، ASM (18134)، Vulnerability Scanner (18105)، Asset Inventory (18104)، Reports Engine (18089)، Privacy Vault (18125)
السحابة والحاويات والـOT	CSPM (18123)، CWPP (18122)، Container Security (18118)، OT/SCADA Security (18121)، Posture Engine (18107)
الذكاء الاصطناعي والأتمتة	المساعد الذكي العربي (18082)، AI Copilot (18129)، SOAR Engine (18127)، TIP (18128)، Topology (18110)، Notification (18095)، Push Hub (18111)، Realtime Hub (18090)، HA Orchestrator (18130)، OPNsense Bridge (18131)
خدمات المنصة	API Gateway (18000)، License (18092)، Billing (18093)، White-Label (18094)، Cloud Manager/MSP (18091)، Self-Service Portal (18109)، Marketplace (18115)، Academy (18116)

All services are called via the gateway https://<fw>:18000/api/v1/<service> (or the service's direct port).

Category	Services (port)
Network Security	Multi-WAN Manager (18083), NAT Manager (18084), Web Filter (18087), DNS Filter (18099), QoS Controller (18088), VPN Service (18098), DDoS Protection (18102), WAF (18096), Port Manager (18081), Port Checker (18097)
Threat Detection & Response	Threat Intelligence (18080), SIEM (18100), XDR Engine (18124), Threat Hunter (18108), Honeypot (18106), Sandbox (18113), EDR Bridge (18086), DLP (18112), Insider Risk (18126), Email Security (18114)
Identity & Access	Auth (18085), IdP/SSO (18103), ZTNA (18117), PAM (18120), API Security (18119)
Compliance & Forensics	Compliance Evidence (18132), DFIR Toolkit (18133), BAS (18135), ASM (18134), Vulnerability Scanner (18105), Asset Inventory (18104), Reports Engine (18089), Privacy Vault (18125)
Cloud, Container & OT	CSPM (18123), CWPP (18122), Container Security (18118), OT/SCADA Security (18121), Posture Engine (18107)
AI, Automation & Orchestration	Arabic AI Assistant (18082), AI Copilot (18129), SOAR Engine (18127), TIP (18128), Topology (18110), Notification (18095), Push Hub (18111), Realtime Hub (18090), HA Orchestrator (18130), OPNsense Bridge (18131)
Platform Services	API Gateway (18000), License (18092), Billing (18093), White-Label (18094), Cloud Manager/MSP (18091), Self-Service Portal (18109), Marketplace (18115), Academy (18116)

المصادقةAuthentication

REST عبر HTTPS. صادق باستخدام مفتاح API في ترويسة Authorization: Bearer <token>. تُصدَر الرموز من لوحة الإدارة وتخضع لصلاحيات RBAC. جميع الطلبات يجب أن تكون عبر TLS 1.2+.

REST over HTTPS. Authenticate with an API key in the Authorization: Bearer <token> header. Tokens are issued from the admin panel and honor RBAC scopes. All requests must use TLS 1.2+.

مثال — إنشاء قاعدة NATExample — Create a NAT rule

curl -X POST https://<fw>/api/v1/nat/rules \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"iface":"wan","proto":"tcp","dst_port":443,"target":"10.0.0.10:443"}'

يعيد 201 Created مع كائن القاعدة ومعرّفها.

curl -X POST https://<fw>/api/v1/nat/rules \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"iface":"wan","proto":"tcp","dst_port":443,"target":"10.0.0.10:443"}'

Returns 201 Created with the rule object and its id.

أكواد الحالة وحدود المعدلStatus Codes & Rate Limits

200/201 نجاح، 400 طلب غير صالح، 401 مصادقة، 403 صلاحية، 404 غير موجود، 429 تجاوز الحد. الحد الافتراضي 600 طلب/دقيقة لكل رمز، مع ترويسات X-RateLimit-Remaining.

200/201 success, 400 bad request, 401 auth, 403 forbidden, 404 not found, 429 rate-limited. Default limit is 600 req/min per token, with X-RateLimit-Remaining headers.

أحداث WebSocketWebSocket Events

اشترك في wss://<fw>/api/v1/stream لتلقّي أحداث حيّة: حالة الروابط (Multi-WAN)، تنبيهات EDR، تغيّرات الجلسات، وتبديل HA — بصيغة JSON مدفوعة لحظيًا.

Subscribe to wss://<fw>/api/v1/stream for live events: link status (Multi-WAN), EDR alerts, session changes, and HA failover — pushed as JSON in real time.

العودة إلى الوثائقBack to Docs