Skip to content

V1sion API

Network discovery, topology sessions, SSH enrichment, routing, and Bra1n integration.

Required scope: v1sion:read or v1sion:write

Endpoints

Discovery

POST/api/v1sion/scanStart subnet scan
GET/api/v1sion/scan/:job_id/streamScan progress (SSE)
GET/api/v1sion/scan/:job_id/resultFinal scan result
DELETE/api/v1sion/scan/:job_idCancel scan
POST/api/v1sion/device/snmpSingle-IP SNMP identify

Sessions

GET/api/v1sion/sessionsList sessions
POST/api/v1sion/sessionsSave session
GET/api/v1sion/sessions/:idGet session
PATCH/api/v1sion/sessions/:idUpdate session
DELETE/api/v1sion/sessions/:idDelete session

Bra1n Integration

POST/api/v1sion/brain/linkLink device to Brain
POST/api/v1sion/brain/createCreate Brain entity
POST/api/v1sion/brain/bulk-createBulk create
POST/api/v1sion/brain/diffDiff analysis
POST/api/v1sion/brain/bulk-linkBulk link
POST/api/v1sion/brain/auto-matchAuto-match devices
GET/api/v1sion/brain/applicationsApplications
GET/api/v1sion/brain/endpointsEndpoints

Monitor Status

GET/api/v1sion/monitor/statusNode monitor status
GET/api/v1sion/monitor/status/by-ipStatus by IP

SSH Enrichment

POST/api/v1sion/enrich-sshStart SSH enrichment
GET/api/v1sion/enrich-ssh/:job_id/streamProgress (SSE)
GET/api/v1sion/ssh-targetsList SSH targets
POST/api/v1sion/ssh-targetsCreate target
PUT/api/v1sion/ssh-targets/:idUpdate target
DELETE/api/v1sion/ssh-targets/:idDelete target

Routes & Credentials

GET/api/v1sion/routesList routes
POST/api/v1sion/routesCreate route
PUT/api/v1sion/routes/:idUpdate route
DELETE/api/v1sion/routes/:idDelete route
GET/api/v1sion/credentialsGet credentials
POST/api/v1sion/credentialsSave credentials

Start Scan

POST/api/v1sion/scan

Request body:

json
{
  "subnet": "192.168.1.0/24",
  "community": "public",
  "snmp_version": "2c",
  "snmp_enabled": true,
  "credentials": [],
  "v3_params": {}
}

Response:

json
{ "job_id": "abc123", "subnet": "192.168.1.0/24" }

Scan Stream (SSE)

GET/api/v1sion/scan/:job_id/stream

Connect with EventSource:

js
const es = new EventSource('/api/v1sion/scan/abc123/stream')
es.onmessage = (e) => {
  const data = JSON.parse(e.data)
  console.log(data.type, data.progress)
}

Monitor Status (No Auth)

GET/api/v1sion/monitor/status

Returns monitor status for topology node badges. No authentication required — designed for fast polling from the topology canvas.

Released under the MIT License.