Loading

API Reference

Complete REST API documentation for the Navil Cloud platform.

Base URL: https://api.navil.ai — All endpoints return JSON. Auth via JWT or API Key header.

Authentication

Navil uses two authentication methods depending on the endpoint:

JWT Bearer Token

Used for dashboard and management endpoints. Obtained via login.

Authorization: Bearer eyJhbGci...

API Key

Used for agent telemetry and node registration.

Authorization: Bearer navil_live_...

Endpoints

Cloud — requires navil.ai sign-in (Clerk SSO)Agent — uses API key from local Navil instance

Authentication

Authenticate via Clerk SSO (cloud dashboard) or API key (agent telemetry).

POST /v1/auth/registerPOST /v1/auth/login

Telemetry & Threat Intel

Submit security events from local Navil instances and fetch the global threat intelligence feed.

POST /v1/telemetry/syncGET /v1/threat-intel/patterns

API Key Management

Create, list, and revoke API keys for your organization.

POST /v1/org/keysDELETE /v1/org/keys/:idGET /v1/org/agents

Agent Nodes

Register agent nodes and maintain heartbeat connections.

POST /v1/nodes/registerPOST /v1/nodes/:id/heartbeat

Organization & Dashboard

Manage your organization profile, webhook URLs, and view dashboard stats. Requires Clerk SSO.

GET /v1/org/mePATCH /v1/org/meGET /v1/org/stats

Team Members

List members, send invitations, and manage team access. Requires Clerk SSO.

GET /v1/org/membersPOST /v1/org/invitesDELETE /v1/org/members/:id

Analytics

Query time-series event data and top threat breakdowns across all agents.

GET /v1/org/analytics/timeseriesGET /v1/org/analytics/top-threats

Example Request

cURL

curl -X POST https://api.navil.ai/v1/auth/login \
  -H "Content-Type: application/json" \
  -d '{"email": "admin@acme.io", "password": "secure_password"}'

Previous

Radar

Next

Authentication