Neptune

API Authentication

Authenticating with the Neptune REST API

API Authentication

The Neptune REST API uses API key authentication with role-based access control.

Roles

RolePermissions
AdminFull access — manage jobs, view results, configure server
AnalystSubmit analysis jobs, view results
ViewerView results only

Usage

Pass your API key in the Authorization header:

curl -H "Authorization: Bearer <your-api-key>" \
  http://localhost:9090/api/v1/jobs

Configuration

Set role-specific keys via environment variables:

NEPTUNE_ADMIN_KEY=your-admin-key
NEPTUNE_ANALYST_KEY=your-analyst-key
NEPTUNE_VIEWER_KEY=your-viewer-key

If only NEPTUNE_API_KEY is set (legacy mode), it grants admin access.

On this page