Documentation
Complete reference for the SentinelNexus API and platform capabilities.
Getting Started
Quick Start Guide
Set up your first scan in under 2 minutes.
Authentication
Google OAuth flow and session management.
API Overview
RESTful API endpoints and authentication.
Scan Engines
Code Scanner
120+ SAST rules for secrets, injections, and IaC.
Prompt Scanner
Jailbreak detection and prompt injection defense.
Text Scanner
PII detection with Luhn validation and IBAN checks.
API Reference
POST /api/v1/scans
Run a new security scan.
GET /api/v1/scans/:id
Retrieve scan results and findings.
GET /api/v1/dashboard/stats
Dashboard aggregation data.
POST /api/v1/reports/generate/:id
Generate a PDF report.
GET /api/v1/projects
List and manage projects.
GET /api/v1/notifications
List alert notifications.
Security
CVSS v3.1 Scoring
How we calculate base scores and severity labels.
Finding Deduplication
SHA-256 fingerprinting for duplicate detection.
CWE Mappings
Common Weakness Enumeration identifiers.
Quick Start
1. Sign in with your Google account at /login
2. Navigate to the Scanner page
3. Paste code, a prompt, or plain text and select the scan type
4. Click Run Scan — results appear in seconds with CVSS scores
5. Generate a PDF report from the results or view findings in the scan detail page
API Authentication
All API requests require authentication via access_token cookie (set during OAuth flow).
# Example: Run a scan
curl -X POST http://localhost:8000/api/v1/scans \
-H "Content-Type: application/json" \
-b "access_token=YOUR_JWT" \
-d '{"target": "test", "content": "password = secret123", "scan_type": "code"}'