Volant
HomeDocsAPI Reference
HomeDocsAPI Reference
  1. deployment
  • 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. deployment

List deployments

GET
/api/v1/deployments

Request

None

Responses

🟢200OK
application/json
Array of deployments
Body

🟢200Success
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/api/v1/deployments'
Response Response Example
[
    {
        "config": {
            "api": {
                "host": "string",
                "port": "string"
            },
            "cloud_init": {
                "datasource": "string",
                "meta_data": {
                    "content": "string",
                    "inline": true,
                    "path": "string"
                },
                "network_config": {
                    "content": "string",
                    "inline": true,
                    "path": "string"
                },
                "seed_mode": "string",
                "user_data": {
                    "content": "string",
                    "inline": true,
                    "path": "string"
                }
            },
            "expose": [
                {
                    "host_port": 0,
                    "name": "string",
                    "port": 0,
                    "protocol": "string"
                }
            ],
            "initramfs": {
                "checksum": "string",
                "url": "string"
            },
            "kernel_cmdline": "string",
            "kernel_override": "string",
            "manifest": {
                "actions": {
                    "property1": {
                        "description": "string",
                        "method": "string",
                        "path": "string",
                        "timeout_ms": 0
                    },
                    "property2": {
                        "description": "string",
                        "method": "string",
                        "path": "string",
                        "timeout_ms": 0
                    }
                },
                "cloud_init": {
                    "datasource": "string",
                    "meta_data": {
                        "content": "string",
                        "inline": true,
                        "path": "string"
                    },
                    "network_config": {
                        "content": "string",
                        "inline": true,
                        "path": "string"
                    },
                    "seed_mode": "string",
                    "user_data": {
                        "content": "string",
                        "inline": true,
                        "path": "string"
                    }
                },
                "devices": {
                    "allowlist": [
                        "string"
                    ],
                    "pci_passthrough": [
                        "string"
                    ]
                },
                "disks": [
                    {
                        "checksum": "string",
                        "format": "string",
                        "name": "string",
                        "readonly": true,
                        "source": "string",
                        "target": "string"
                    }
                ],
                "enabled": true,
                "health_check": {
                    "endpoint": "string",
                    "timeout_ms": 0
                },
                "image": "string",
                "image_digest": "string",
                "initramfs": {
                    "checksum": "string",
                    "url": "string"
                },
                "labels": {
                    "property1": "string",
                    "property2": "string"
                },
                "name": "string",
                "network": {
                    "auto_assign": true,
                    "gateway": "string",
                    "mode": "string",
                    "subnet": "string"
                },
                "openapi": "string",
                "resources": {
                    "cpu_cores": 0,
                    "memory_mb": 0
                },
                "rootfs": {
                    "checksum": "string",
                    "format": "string",
                    "url": "string"
                },
                "runtime": "string",
                "schema_version": "string",
                "version": "string",
                "workload": {
                    "base_url": "string",
                    "entrypoint": [
                        "string"
                    ],
                    "env": {
                        "property1": "string",
                        "property2": "string"
                    },
                    "type": "string",
                    "workdir": "string"
                }
            },
            "metadata": {
                "property1": null,
                "property2": null
            },
            "network": {
                "auto_assign": true,
                "gateway": "string",
                "mode": "string",
                "subnet": "string"
            },
            "plugin": "string",
            "resources": {
                "cpu_cores": 0,
                "memory_mb": 0
            },
            "rootfs": {
                "checksum": "string",
                "format": "string",
                "url": "string"
            },
            "runtime": "string"
        },
        "created_at": "2019-08-24T14:15:22Z",
        "desired_replicas": 0,
        "name": "string",
        "ready_replicas": 0,
        "updated_at": "2019-08-24T14:15:22Z"
    }
]
Modified at 2025-10-05 14:31:30
Previous
Set plugin enabled status
Next
Create deployment
Built with