neptune serve
Start the Neptune REST API server
neptune serve
Starts the Axum HTTP server with the REST API used by the CLI and web dashboard.
Usage
neptune serve [OPTIONS]Options
| Flag | Default | Description |
|---|---|---|
-p, --port <PORT> | 9090 | Port to listen on |
--host <HOST> | 0.0.0.0 | Host to bind to |
--data-dir <DIR> | ./neptune-data | Data directory for uploads and results |
--tls-cert <FILE> | TLS certificate PEM file (enables HTTPS) | |
--tls-key <FILE> | TLS private key PEM file |
--tls-cert and --tls-key must both be provided to enable HTTPS. If neither
is set, the server runs over plain HTTP.
Examples
# Start on default port
neptune serve
# Custom port and data directory
neptune serve --port 8080 --data-dir /var/neptune
# With TLS
neptune serve --tls-cert cert.pem --tls-key key.pemFeatures
- OpenAPI docs at
/api/v1/docsin debug/dev builds - Role-based authentication (admin, analyst, viewer)
- Rate limiting (configurable via
NEPTUNE_RATE_LIMIT_RPM) - S3-compatible storage (when
BUCKET_ENDPOINTis set) - Real-time SSE progress streaming for analysis jobs
- JSON structured logging (enabled by default for
serve)
See Configuration for all server environment variables.