🛡️ USOD API Documentation

Unified Security Operations Dashboard - AI-Powered Threat Detection with Blockchain

API Server Online
Version 2.0.0
12/6/2025, 2:57:09 AM

📊 Total Endpoints

59
Across 9 categories

💾 Database

Connected
MongoDB Connection

⚡ Uptime

809929s
Server running

🔧 Node.js

v20.19.6
Runtime version
🏥 Health Check 📋 API Info (JSON) 🔙 Legacy View 🌐 Frontend Dashboard

▼ 🔐 Authentication & Security

User authentication, session management, and security controls

/api/auth
POST /api/auth/login
User login with credentials
POST /api/auth/register
Register new user account
POST /api/auth/logout
User logout and session cleanup
POST /api/auth/refresh
Refresh JWT access token
GET /api/auth/session-status
Check current session status
GET /api/auth/security/stats
Get security statistics
POST /api/auth/security/block-ip
Block an IP address

▼ 🔗 Blockchain & Threat Verification

Immutable threat logging with SHA256 cryptographic verification

/api/blockchain
GET /api/blockchain/health
Check blockchain service health status
GET /api/blockchain/statistics 🔒 Auth
Get blockchain statistics (logs, transactions, block height)
GET /api/blockchain/threats 🔒 Auth
Query all threat logs from blockchain
GET /api/blockchain/threats/:logId 🔒 Auth
Get specific threat log by ID
POST /api/blockchain/threats/:logId/verify 🔒 Auth
Verify threat log integrity with SHA256 hash comparison
GET /api/blockchain/threats/type/:type 🔒 Auth
Query threats by type (network_threat, security_event, etc.)
POST /api/blockchain/threats 🔒 Auth
Create new threat log on blockchain

▼ 🌐 Network Monitoring & AI Detection

Real-time network threat detection with AI/ML models

/api/network
POST /api/network/start-monitoring 🔒 Auth
Start real-time network packet capture and analysis
POST /api/network/stop-monitoring 🔒 Auth
Stop network monitoring session
GET /api/network/threats 🔒 Auth
Get detected network threats with pagination
GET /api/network/statistics 🔒 Auth
Get monitoring statistics (packets, threats, uptime)
POST /api/network/upload-pcap 🔒 Auth
Upload PCAP file for offline analysis
GET /api/network/status 🔒 Auth
Get current monitoring status
GET /api/network/stream
Server-Sent Events stream for real-time threats

▼ 📊 Data & Analytics

Dashboard data, statistics, and security analytics

/api/data
GET /api/data/dashboard-stats
Get dashboard statistics (security score, threats, users)
GET /api/data/security-events
Get recent security events
GET /api/data/login-attempts
Get login attempt history

▼ 📝 Security Logs Management

CRUD operations for security logs and audit trails

/api/logs
GET /api/logs
Get all security logs with pagination and filtering
GET /api/logs/statistics
Get log statistics by status and severity
POST /api/logs
Create new security log entry
PUT /api/logs/:id/status
Update log status (resolved, investigating, etc.)

▼ 📥 Multi-Platform Data Ingestion

Ingest logs from desktop and mobile applications

/api/ingest
POST /api/ingest/log 🔑 API Key
Ingest single log entry from external platform
POST /api/ingest/logs 🔑 API Key
Bulk ingest multiple logs at once

▼ 💾 Backup & Restore

Database backup and restoration operations

/api/backup
POST /api/backup/full
Create full database backup
GET /api/backup/list
List all available backups
POST /api/backup/restore/:backupName
Restore from backup file

▼ 👥 User Management

User accounts, roles, and profile management

/api/users
GET /api/users/users 🔒 Auth
List all users (admin only)
POST /api/users/create 🔒 Auth
Create new user account (admin)
POST /api/users/change-password 🔒 Auth
Change user password
DELETE /api/users/users/:userId 🔒 Auth
Delete user account (admin)

▼ 📡 Real-time Streaming

Server-Sent Events for real-time updates

/api/stream
GET /api/stream/logs
Subscribe to real-time security log events
© 2025 | Unified Security Operations Dashboard
Frontend Dashboard | Health Check | API Info (JSON)