Skip to main content

API Reference (Working Summary)

Scope​

This page is a practical endpoint map for POC and early integration work.

Auth Endpoints​

  • POST /api/v1/auth/login
  • POST /api/v1/auth/refresh
  • POST /api/v1/auth/logout
  • GET /api/v1/auth/sessions
  • DELETE /api/v1/auth/sessions/{id}

Scan Endpoints​

  • POST /api/v1/orgs/{org_id}/scans
  • GET /api/v1/orgs/{org_id}/scans
  • GET /api/v1/orgs/{org_id}/scans/{id}
  • PATCH /api/v1/orgs/{org_id}/scans/{id}
  • POST /api/v1/orgs/{org_id}/scans/{id}/cancel
  • GET /api/v1/orgs/{org_id}/scans/{id}/stats
  • GET /api/v1/orgs/{org_id}/scans/{id}/findings

Report Endpoints​

  • POST /api/v1/orgs/{org_id}/reports
  • GET /api/v1/orgs/{org_id}/reports
  • GET /api/v1/orgs/{org_id}/reports/{id}
  • GET /api/v1/orgs/{org_id}/reports/{id}/download
  • GET /api/v1/orgs/{org_id}/reports/{id}/stream

System Endpoints​

  • GET /health
  • GET /api/v1/system/state

Request Notes​

  • Scan create requires target and scan_type.
  • Report create requires name, template_type, format.
  • Organization-scoped endpoints require valid org membership.

Next Action​

Use this page with Quick Start for first integration run.