VVMM API Usage Guide

Overview

This page documents which APIs the VVMM dashboard uses for each feature. All REST API endpoints require Bearer token authentication (the password from [auth] config).

      # Authentication header format

      Authorization: Bearer your-password

Dashboard Grid Page

The main dashboard page showing all agent cards with CPU, memory, and network stats.

REST APIs Used

GET /api/agents Fetch all agents with latest_report, metadata, status
POST /api/agents/create Create new agent (New Agent button)
POST /api/agents/{id}/delete Delete agent (✕ button on card)

WebSocket APIs Used

WS /ws/dashboard?password=xxx Real-time updates (snapshot, report, connected/disconnected)

Agent Detail Page

Clicked when viewing a specific agent's details.

System Overview Section

GET /api/agents Agent data from grid fetch (hostname, OS, kernel, uptime, IP, channel)
PUT /api/agents/{id}/metadata Edit agent metadata (✎ button)

CPU & Memory Section

GET /api/agents latest_report.cpu, latest_report.memory

History Charts Section

GET /api/agents/{id}/history Historical data points (1H/6H/24H/7D/90D)

Disks & Network Section

GET /api/agents latest_report.disks, latest_report.network

Remote Terminal Section

POST /api/exec Batch execute command (All/Group target)
POST /api/agents/{id}/exec Execute command on single agent (WebShell mode)
GET /api/groups List groups for target selector

File Transfer Section

POST /api/upload Upload file to agent(s)
POST /api/update-binary Update agent binary

Processes Section

GET /api/agents latest_report.processes (top processes)

Monitored Services Section

POST /api/agents/{id}/processes/control Start/Stop/Restart process
POST /api/agents/{id}/container-logs View Docker container logs (📋 button)

WebSocket Message Types

The dashboard WebSocket connection handles these message types:

Server → Client

WS snapshot Initial agent list on connect
WS report Real-time agent data update
WS connected Agent connected event
WS disconnected Agent disconnected event
WS command_result Command execution result
WS metadata_updated Agent metadata changed
WS container_logs_result Docker logs response
WS file_transfer_result File upload result
WS update_binary_result Binary update result

Integration Examples

Get All Agents with Status

      # List all agents with current metrics

      curl -H "Authorization: Bearer pass" \

        http://server/api/agents

Execute Command on All Agents

      # Run uptime on all connected agents

      curl -X POST http://server/api/exec \

        -H "Authorization: Bearer pass" \

        -H "Content-Type: application/json" \

        -d '{"command":"uptime","args":[]}'

Deploy Config to Production Group

      # Upload config file to all production agents

      curl -X POST http://server/api/upload \

        -H "Authorization: Bearer pass" \

        -H "Content-Type: application/json" \

        -d '{"filename":"app.conf","path":"/etc/app/config","content":"BASE64...","target":"group:production"}'

Monitor Docker Containers

      # Get all monitored processes across agents

      curl -H "Authorization: Bearer pass" \

        http://server/api/processes

Get Historical Metrics

      # Get last 24h of data for an agent

      curl -H "Authorization: Bearer pass" \

        http://server/api/agents/{id}/history?since=1234567890&max_points=500

All API Endpoints

System

GET /api/health - Health check

Authentication

GET /api/auth/verify - Verify password

Agents

GET /api/agents - List all
GET /api/agents/{id} - Get one
GET /api/agents/{id}/report - System report
PUT /api/agents/{id}/metadata - Update metadata
GET /api/groups - List groups

Execution

POST /api/agents/{id}/exec - Single agent
POST /api/exec - Batch (all/group/agent)

History

GET /api/agents/{id}/history - Historical data

File Transfer

POST /api/upload - Upload file
POST /api/update-binary - Update binary

Process Management

GET /api/agents/{id}/processes - List
POST /api/agents/{id}/processes/control - Control
GET /api/processes - All processes

Docker

POST /api/agents/{id}/container-logs - Logs

Deployment

POST /api/agents/create - Create
GET /api/agents/{id}/config - Config
POST /api/agents/{id}/regenerate-token - Token
POST /api/agents/{id}/delete - Delete

Installation

GET /install.sh - Install script
GET /download/package/{token} - Package
GET /download/config/{token} - Config
GET /download/agent - Binary