API Endpoints

Full interactive API documentation is available at /api/v1/docs in debug/dev builds of neptune serve. The endpoints below are a summary — see the OpenAPI spec for complete request/response schemas.

Jobs

Submit analysis job

POST /api/v1/analyze

Upload a firmware binary for analysis. Returns a job ID for tracking progress.

Role: Analyst or Admin

List jobs

GET /api/v1/jobs

List all analysis jobs with status and metadata.

Role: Viewer, Analyst, or Admin

Get job status

GET /api/v1/jobs/{id}

Get detailed status and results for a specific job.

Role: Viewer, Analyst, or Admin

Stream job progress

GET /api/v1/jobs/{id}/events

Server-Sent Events (SSE) stream of real-time analysis progress for one job.

Role: Viewer, Analyst, or Admin

Stream all job updates

GET /api/v1/events

Server-Sent Events (SSE) stream of job updates across the server.

Role: Viewer, Analyst, or Admin

Rerun job

POST /api/v1/jobs/{id}/rerun

Start a new analysis using the same uploaded binary and options.

Role: Analyst or Admin

Cancel, pause, or resume job

POST /api/v1/jobs/{id}/cancel
POST /api/v1/jobs/{id}/pause
POST /api/v1/jobs/{id}/resume

Control a running analysis job.

Role: Analyst or Admin

Results

Download SBOM

GET /api/v1/jobs/{id}/sbom?format={format}

Download the generated SBOM in the specified format (cyclonedx, spdx, vex, sarif, html, json).

Role: Viewer, Analyst, or Admin

Download HTML report

GET /api/v1/jobs/{id}/report

Download the generated HTML report.

Role: Viewer, Analyst, or Admin

Malware Analysis

Submit malware triage job

POST /api/v1/analyze-malware

Upload a binary sample for malware triage. Accepts multipart form data with binary (file), no_yara (optional), and no_capa (optional) fields. Returns a job ID.

Role: Analyst or Admin

Get malware triage result

GET /api/v1/jobs/{id}/malware

Get the malware triage result for a completed job, including YARA matches, capa detections, signal rankings, and behavior hypotheses.

Role: Viewer, Analyst, or Admin

Signatures

List signatures

GET /api/v1/signatures

Browse the signature database with filtering and pagination.

Role: Viewer, Analyst, or Admin

Signature metadata and updates

GET /api/v1/signatures/stats
GET /api/v1/signatures/manifest
GET /api/v1/signatures/download
GET /api/v1/signatures/check-update
POST /api/v1/signatures/import
POST /api/v1/signatures/sync
DELETE /api/v1/signatures/{id}

Manage local signature data and synchronize from the configured remote signature server.

Role: Read endpoints require Viewer, write endpoints require Analyst or Admin

Rebuild and Port

POST /api/v1/rebuild
GET /api/v1/rebuild/{id}
POST /api/v1/port
GET /api/v1/port/{id}

Start and inspect rebuild or cross-platform porting jobs.

Role: Start endpoints require Analyst or Admin; read endpoints require Viewer, Analyst, or Admin

Teams, Scheduling, Inventory, and Compliance

GET /api/v1/config
GET /api/v1/orgs
GET /api/v1/schedules
GET /api/v1/inventory
GET /api/v1/fleet/vulns
GET /api/v1/graph
GET /api/v1/policies
GET /api/v1/compliance/frameworks
POST /api/v1/ingest
POST /api/v1/policy/evaluate

The dashboard uses these endpoints for team management, scheduled scans, fleet inventory, graph views, policy evaluation, and compliance workflows.

Role: Read endpoints require Viewer, write endpoints require Analyst or Admin

Health

Health check

GET /api/v1/health

Returns server health status. No authentication required.

Endpoints

On this page