API Endpoints Reference¶

Detailed REST API endpoint documentation.

Scan Endpoints¶

Start a new security scan.

Request:

{
  "targetUrl": "https://example.com",
  "scanMode": "BOTH"
}

Response:

{
  "scanId": "clx1a2b3c4d5e6f7g8h9",
  "status": "RUNNING",
  "targetUrl": "https://example.com"
}

Get scan status and results.

Response:

{
  "scanId": "clx1a2b3c4d5e6f7g8h9",
  "status": "COMPLETED",
  "score": 78,
  "vulnerabilities": [...]
}

Stream live logs via Server-Sent Events.

Usage:

const eventSource = new EventSource(`/api/scan/{scanId}/logs`);
eventSource.onmessage = (event) => {
  const log = JSON.parse(event.data);
};

See API Schemas for complete type definitions.