• Logo
    LXD
  • canonical.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
  • LXD
  • Tutorials
    • First steps with LXD
    • Getting started with the UI
  • How-to guides
    • Getting started
      • Install LXD
      • Initialize LXD
      • Manage the snap
      • Access the UI
      • Access documentation
      • Get support
      • Contribute to LXD
    • LXD server and client
      • Expose LXD to the network
      • Configure the LXD server
      • Add remote servers
      • Add command aliases
    • Instances
      • Create instances
      • Configure instances
      • Manage instances
      • Use profiles
      • Troubleshoot errors
      • Access files
      • Access the console
      • Run commands
      • Use cloud-init
      • Add a routed NIC to a VM
      • Back up instances
      • Move instances
      • Import existing machines
      • Migrate from LXC
    • Images
      • Use remote images
      • Manage images
      • Associate profiles
      • Copy and import images
      • Create images
    • Projects
      • Create and configure
      • Work with projects
      • Confine projects to users
    • Storage
      • Manage pools
      • Manage volumes
      • Manage buckets
      • Create an instance in a pool
      • Back up a volume
      • Move or copy a volume
    • Networking
      • Create a network
      • Configure a network
      • Configure as BGP server
      • Configure network ACLs
      • Configure forwards
      • Configure network zones
      • Configure your firewall
      • Integrate with resolved
      • Set up OVN
      • Configure load balancers
      • Configure peer routing
      • Display IPAM information
    • Troubleshooting
      • Configure your firewall
      • Troubleshoot instances
      • Troubleshoot Dqlite
      • Debug LXD
      • Frequently asked
    • Clustering
      • Form a cluster
      • Manage a cluster
      • Configure networks
      • Configure storage
      • Manage instances
      • Set up cluster groups
      • Recover a cluster
    • Production setup
      • Benchmark performance
      • Increase bandwidth
      • Monitor metrics
      • Send logs to Loki
      • Set up Grafana
      • Back up a server
      • Recover instances
  • Explanation
    • About lxd and lxc
    • About containers and VMs
    • About images
    • About storage
    • About networking
    • About the LXD database
    • About lxc show and info
    • About authentication
    • About authorization
    • About projects
    • About clustering
    • About performance tuning
    • About security
  • Reference
    • Requirements
    • Architectures
    • Remote image servers
    • Image format
    • Guest OS compatibility
    • Container environment
    • Configuration option index
    • Server configuration
    • 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
    • Preseed YAML file fields
    • Project configuration
    • Storage drivers
      • Btrfs - btrfs
      • CephFS - cephfs
      • Ceph Object - cephobject
      • Ceph RBD - ceph
      • Dell PowerFlex - powerflex
      • Directory - dir
      • LVM - lvm
      • ZFS - zfs
    • Networks
      • Bridge network
      • OVN network
      • Macvlan network
      • Physical network
      • SR-IOV network
    • Cluster configuration
    • Production server settings
    • Provided metrics
    • Permissions
    • REST API
      • Main API documentation
      • Main API specification
      • Main API extensions
      • Events API documentation
      • Instance API
    • Man pages
      • lxc
    • Internals
      • Environment variables
      • UEFI variables for VMs
      • Daemon behavior
      • System call interception
      • User namespace setup
    • Project repository
    • Image server
Back to top
View this page

REST API¶

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

Related topics¶

How-to guides:

  • LXD server and client

Explanation:

  • About lxd and lxc

  • About the LXD database

Next
REST API
Previous
Permissions
Copyright © 2014-2024 LXD contributors
Last updated on Oct 30, 2024
Show source
Thanks to the 2 contributors!
  • Ruth Fuchss
  • Stéphane Graber
Ask a question on Discourse
Ask a question on Matrix
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