Skip to content

REST API

Endpoints

MethodEndpointDescription
GET/api/healthServer status
POST/api/scan/uploadScan a ZIP file
POST/api/scan/directoryScan a local directory
GET/api/scan/historySession scan history
GET/api/scan/:scanIdFull scan report
DELETE/api/scan/:scanIdDelete a scan

Example - Health check

bash
curl http://localhost:3001/api/health
json
{
  "status": "ok",
  "version": "1.0.0",
  "service": "SAP DevSec Scanner",
  "lang": "en"
}

Example - Scan a ZIP

bash
curl -X POST http://localhost:3001/api/scan/upload \
  -F "project=@my-project.zip"

Example - Scan a directory

bash
curl -X POST http://localhost:3001/api/scan/directory \
  -H "Content-Type: application/json" \
  -d '{"dirPath": "/home/user/my-project", "projectName": "my-project"}'

Report structure

json
{
  "scanId": "uuid",
  "projectName": "my-fiori-app",
  "projectTypes": ["UI5", "CAP"],
  "scannedAt": "2026-06-25T10:00:00.000Z",
  "riskScore": 73,
  "riskLevel": "MEDIUM",
  "summary": {
    "critical": 0, "high": 2, "medium": 3, "low": 5
  }
}

Open-source project - Apache-2.0 license