Volant
HomeDocsAPI Reference
HomeDocsAPI Reference
  1. status
  • health
    • Health check
      GET
  • status
    • System status summary
      GET
  • system
    • Get system information
      GET
  • events
    • Stream VM lifecycle events
      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
  • plugins
    • List plugins
      GET
    • Install plugin
      POST
    • Remove plugin
      DELETE
    • Get plugin
      GET
    • Set plugin enabled status
      POST
  • deployment
    • List deployments
      GET
    • Create deployment
      POST
    • Delete deployment
      DELETE
    • Get deployment
      GET
    • Scale deployment
      PATCH
  • 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
  • mcp
    • Model Context Protocol endpoint
  1. status

System status summary

GET
/api/v1/system/status

Request

None

Responses

🟢200OK
application/json
Current VM count and resource usage
Body

🟢200Success
🔴500Internal Server Error
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/api/v1/system/status'
Response Response Example
200 - Example 1
{
    "cpu_percent": 0,
    "mem_percent": 0,
    "vm_count": 0
}
Modified at 2025-10-05 14:31:30
Previous
Health check
Next
Get system information
Built with