Volant
HomeDocsAPI Reference
HomeDocsAPI Reference
  1. status
  • health
    • Health check
      GET
  • system
    • Get system information
      GET
  • status
    • System status summary
      GET
    • System summary for dashboards
      GET
  • vm
    • List VMs
      GET
    • Create VM
      POST
    • Destroy VM
      DELETE
    • Fetch VM by name
      GET
    • Get VM configuration
      GET
    • Update VM configuration
      PATCH
    • Get VM configuration history
      GET
    • Get VM plugin OpenAPI spec
      GET
    • Restart a VM
      POST
    • Start a stopped VM
      POST
    • Stop a running VM
      POST
    • WebSocket console for VM
      GET
  • deployment
    • List deployments
      GET
    • Create deployment
      POST
    • Delete deployment
      DELETE
    • Get deployment
      GET
    • Scale deployment
      PATCH
  • plugins
    • List plugins
      GET
    • Install plugin
      POST
    • Remove plugin
      DELETE
    • Get plugin
      GET
    • Delete plugin artifacts
      DELETE
    • List plugin artifacts
      GET
    • Create or update a plugin artifact
      POST
    • Get a plugin artifact by name and version
      GET
    • Set plugin enabled status
      POST
  • vfio
    • Bind devices to vfio-pci
    • Get VFIO group paths
    • Get VFIO device information
    • Check IOMMU groups
    • Unbind devices from vfio-pci
    • Validate VFIO devices
  • events
    • Stream VM lifecycle events
  • mcp
    • Model Context Protocol endpoint
  1. status

System summary for dashboards

GET
/api/v1/system/summary

Request

None

Responses

🟢200OK
application/json
Counts and plugin info
Body

🟢200Success
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/api/v1/system/summary'
Response Response Example
{
    "by_runtime": {
        "property1": 0,
        "property2": 0
    },
    "by_status": {
        "property1": 0,
        "property2": 0
    },
    "enabled_plugins": 0,
    "plugins": [
        {
            "enabled": true,
            "name": "string",
            "version": "string"
        }
    ],
    "total_plugins": 0,
    "total_vms": 0
}
Modified at 2025-10-07 03:36:01
Previous
System status summary
Next
List VMs
Built with