• LXD-UI logo
    Canonical LXD
  • ubuntu.com/lxd
  • More resources
    • Install LXD
    • Manage LXD
    • Forum
    • GitHub
Contents Menu Expand Light mode Dark mode Auto light/dark, in light mode Auto light/dark, in dark mode Skip to content
LXD documentation
  • LXD
  • Getting started
    • About containers and VMs
    • Requirements
    • Install LXD
    • Initialize LXD
    • Frequently asked
    • Contributing
    • Support
  • Security
    • About security
    • Remote API authentication
    • Expose LXD to the network
  • Instances
    • About instances
    • Create instances
    • Manage instances
    • Configure instances
    • Create snapshots
    • Use profiles
    • Use cloud-init
    • Run commands
    • Access the console
    • Access files
    • Add a routed NIC to a VM
    • Troubleshoot errors
    • Instance configuration
      • Instance properties
      • Instance options
      • Devices
        • Standard devices
        • Type: none
        • Type: nic
        • Type: disk
        • Type: unix-char
        • Type: unix-block
        • Type: usb
        • Type: gpu
        • Type: infiniband
        • Type: proxy
        • Type: unix-hotplug
        • Type: tpm
        • Type: pci
      • Units for storage and network limits
  • Images
    • About images
    • Use remote images
    • Manage images
    • Copy and import images
    • Create images
    • Associate profiles
    • Remote image servers
    • Image format
  • Storage
    • About storage
    • Manage pools
    • Create an instance in a pool
    • Manage volumes
    • Move or copy a volume
    • Back up a volume
    • Storage drivers
      • Directory - dir
      • Btrfs - btrfs
      • LVM - lvm
      • ZFS - zfs
      • Ceph RBD - ceph
      • CephFS - cephfs
  • Networking
    • About networking
    • Create and configure a network
    • Configure network ACLs
    • Configure network forwards
    • Configure network zones
    • Configure LXD as BGP server
    • Display LXD IPAM information
    • Bridge network
      • Integrate with resolved
      • Configure your firewall
    • OVN network
      • Set up OVN
      • Create routing relationships
    • External networks
      • Macvlan network
      • SR-IOV network
      • Physical network
  • Clustering
    • About clustering
    • Form a cluster
    • Manage a cluster
    • Recover a cluster
    • Manage instances
    • Configure storage
    • Configure networks
    • Set up cluster groups
    • Cluster member configuration
  • Manage LXD
    • Server configuration
    • Projects
    • Remotes
    • Performance tuning
      • Benchmark performance
      • Increase bandwidth
      • Server settings
    • Backups
    • Migration
      • Move instances
      • Import existing machines
      • Migrate from LXC
    • Architectures
  • REST API
    • Main API documentation
    • Main API specification
    • Main API extensions
    • Instance API documentation
    • Events API documentation
    • Metrics API documentation
  • Internals & debugging
    • Container environment
    • Daemon behavior
    • Database
    • Debugging
    • Environment variables
    • System call interception
    • User namespace setup
  • External resources
    • Project repository
    • Image server
Back to top
View this page

REST APIΒΆ

  • Main API documentation
  • Main API specification
  • Main API extensions
  • Instance API documentation
  • Events API documentation
  • Metrics API documentation
Next
REST API
Previous
Architectures
Copyright © 2014-2024 LXD contributors
Last updated on Nov 19, 2024
Show source
Ask a question
Open an issue
Edit on GitHub
Related links
  • Directly interacting with the LXD API