• Logo
    Canonical LXD
  • ubuntu.com/lxd
  • More resources
    • Install LXD
    • Manage LXD
    • Forum
    • GitHub
Contents Menu Expand Light mode Dark mode Auto light/dark mode
Canonical LXD documentation
  • LXD
  • Tutorials
    • First steps with LXD
  • How-to guides
    • Clustering
      • Configure networks
      • Configure storage
      • Form a cluster
      • Manage a cluster
      • Manage instances
      • Recover a cluster
      • Set up cluster groups
    • Getting started
      • Access the documentation
      • Access the UI
      • Contribute to LXD
      • Get support
      • Initialize LXD
      • Install LXD
    • Images
      • Associate profiles
      • Copy and import images
      • Create images
      • Manage images
      • Use remote images
    • Instances
      • Access files
      • Access the console
      • Add a routed NIC to a VM
      • Back up instances
      • Configure instances
      • Create instances
      • Manage instances
      • Run commands
      • Troubleshoot errors
      • Use cloud-init
      • Use profiles
    • LXD server and client
      • Add command aliases
      • Add remote servers
      • Configure the LXD server
      • Expose LXD to the network
    • Migration
      • Import existing machines
      • Migrate from LXC
      • Move instances
    • Networking
      • Configure a network
      • Configure as BGP server
      • Configure forwards
      • Configure network ACLs
      • Configure network zones
      • Create a network
      • Display IPAM information
      • Configure your firewall
      • Integrate with resolved
      • Configure load balancers
      • Configure peer routing
      • Set up OVN
    • Production setup
      • Back up a server
      • Benchmark performance
      • Increase bandwidth
      • Monitor metrics
      • Recover instances
    • Projects
      • Confine projects to users
      • Create and configure
      • Work with projects
    • Storage
      • Back up a volume
      • Create an instance in a pool
      • Manage buckets
      • Manage pools
      • Manage volumes
      • Move or copy a volume
    • Troubleshooting
      • Configure your firewall
      • Debug LXD
      • Frequently asked
      • Troubleshoot instances
  • Explanation
    • About authentication
    • About clustering
    • About containers and VMs
    • About images
    • About instances
    • About lxd and lxc
    • About networking
    • About performance tuning
    • About projects
    • About security
    • About storage
    • About the LXD database
  • Reference
    • Architectures
    • Cluster member configuration
    • Configuration option index
    • Container environment
    • Image format
    • Instance configuration
      • 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
      • Instance options
      • Instance properties
      • Units for storage and network limits
    • Internals
      • Daemon behavior
      • Environment variables
      • System call interception
      • User namespace setup
    • Man pages
      • lxc
    • Networks
      • Bridge network
      • OVN network
      • Macvlan network
      • Physical network
      • SR-IOV network
    • Production server settings
    • Project configuration
    • Provided metrics
    • Remote image servers
    • Requirements
    • REST API
      • Events API documentation
      • Instance API
      • Main API documentation
      • Main API extensions
      • Main API specification
    • Server configuration
    • Storage drivers
      • Btrfs - btrfs
      • CephFS - cephfs
      • Ceph Object - cephobject
      • Ceph RBD - ceph
      • Directory - dir
      • LVM - lvm
      • ZFS - zfs
    • Community image server
    • Project repository
  • Switch to topical navigation
  v: latest
Versions
latest
stable-5.0
stable-4.0
Downloads
pdf
On Read the Docs
Project Home
Builds
Back to top
Edit this page

REST API¶

  • Events API documentation
  • Instance API
  • Main API documentation
  • Main API extensions
  • Main API specification

Related topics¶

How-to guides:

  • LXD server and client

Explanation:

  • About lxd and lxc

  • About the LXD database

Next
Events
Previous
Requirements
Copyright © 2014-2023 LXD contributors
Last updated on Oct 02, 2023
Show source
Ask a question on Discourse
Open a GitHub issue for this page
Edit this page on GitHub
Contents
  • REST API
    • Related topics
Related links
  • Directly interacting with the LXD API | Ubuntu