API Documentation

Comprehensive REST API reference and interactive documentation

API Status

Online

API service is operational and responding

Total Endpoints

47

Available API endpoints across all services

API Version

v1.0

Current API version with full backward compatibility

Uptime

99.9%

Service availability over the last 30 days

Core API Endpoints

Essential endpoints for asset discovery and management

Endpoint / Description
Method
Auth
Rate Limit
Actions
POST /api/scan
Start a new network asset discovery scan
/api/scan
POST
API Key
10/hour
GET /api/scan/{id}/status
Check the status of a running scan operation
/api/scan/{scan_id}/status
GET
API Key
100/min
GET /api/assets
List all discovered network assets
/api/assets
GET
JWT
60/min
POST /api/users
Create a new user account in the system
/api/users
POST
Admin
20/hour
GET /api/dashboard/kpis
Retrieve key performance indicators for dashboard
/api/dashboard/kpis
GET
JWT
30/min

Authentication Examples

How to authenticate with the API using different methods

API Key Authentication

curl -X GET "https://api.example.com/api/assets" \ -H "Authorization: Bearer YOUR_API_KEY" \ -H "Content-Type: application/json"

JWT Token Authentication

curl -X POST "https://api.example.com/auth/login" \ -H "Content-Type: application/json" \ -d '{ "username_or_email": "your_email@example.com", "password": "your_password" }'

Starting a Network Scan

curl -X POST "https://api.example.com/api/scan" \ -H "Authorization: Bearer YOUR_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "targets": ["192.168.1.0/24"], "ports": "1-1000", "threads": 50 }'

Interactive API Explorer

Try out API endpoints with live documentation

Download OpenAPI Spec

Get the complete OpenAPI specification file

Generate API Keys

Create and manage your API authentication keys

Quick Actions