• Logo
    MAAS
  • canonical.com/maas
  • More resources
    • Discourse
    • GitHub
    • Release information
Contents Menu Expand Light mode Dark mode Auto light/dark, in light mode Auto light/dark, in dark mode Skip to content
MAAS documentation
MAAS documentation
  • Home
  • Tutorial
    • Harden a MAAS test controller
  • How-to guides
    • Get started
      • Install MAAS
      • Configure MAAS
      • Configure PostgreSQL for remote connections
    • Back up MAAS
    • Upgrade MAAS
    • Manage networks
    • Manage network services
    • Manage switches
    • Manage machines
    • Manage deployment scripts
    • Manage machine groups
    • Manage images
    • Build Ubuntu images
    • Build custom images
    • Manage high-availability
    • Use logging
    • Monitor MAAS
    • Enhance MAAS security
    • Activate MAAS hardening
    • Harden a rack controller
    • Resolve hardening violations
    • Enable FIPS mode on a MAAS controller
    • Adopt FIPS mode on an existing deployment
    • Manage trusted SSH host keys
    • Deploy a real-time kernel
    • Deploy a FIPS kernel
    • Deploy DGX machines
    • Set up air-gapped MAAS
    • Script MAAS with Python
    • Prepare a DPU
    • Deploy DPUs
    • Deploy DPUs without BMC
    • Deploy a host-DPU pair
    • Single Sign-On
    • User groups and entitlements
  • Reference
    • API reference
      • API login
      • API profile
      • API v2 Reference
    • CLI reference
      • account
      • apikey
      • bcache
      • bcache-cache-set
      • block-device
      • boot-resource
      • boot-resource-file-upload
      • boot-source
      • boot-source-selection
      • changepassword
      • commissioning-script
      • config
      • config-hardening
      • config-tls
      • config-vault
      • createadmin
      • device
      • dhcpsnippet
      • discovery
      • dnsresource
      • dnsresource-record
      • domain
      • event
      • fabric
      • file
      • init
      • interface
      • ipaddress
      • iprange
      • license-key
      • list
      • login
      • logout
      • maas
      • machine
      • migrate
      • msm
      • network
      • node
      • node-device
      • node-result
      • node-script
      • node-script-result
      • notification
      • oidc-provider
      • package-repository
      • partition
      • rack-controller
      • raid
      • refresh
      • region-controller
      • reserved-ip
      • resource-pool
      • space
      • sshkey
      • sslkey
      • static-route
      • status
      • subnet
      • tag
      • user
      • user-group
      • version
      • vlan
      • vmfs-datastore
      • volume-group
      • zone
    • Configuration guides
      • Installation requirements
      • Cloud-init
      • Configuration tables
      • FIPS mode reference
      • Hardware test scripts
      • Logging
      • Metrics
      • Power drivers
      • Security hardening reference
      • Storage
      • Terraform
      • Troubleshooting
  • Explanation
    • Machine basics
    • The machine life-cycle
    • Commissioning machines
    • Commissioning scripts
    • Machine customization
    • Deploying machines
    • Deploying running machines
    • Deployment scripts
    • Machine groups
    • Networking
    • Controllers
    • Images
    • Performance
    • Events
    • Logging
      • Contextual Logging
      • Security Logging
    • Security
    • FIPS mode and security hardening
Back to top

API reference¶

The MAAS API provides programmatic access to all MAAS functionality. Every feature available in the UI is also accessible through the API.

Getting started¶

  • Learn how to login to the MAAS API

  • Manage your API profile

API v2 reference¶

The complete MAAS API v2 reference documentation is automatically generated from the OpenAPI specification:

  • API v2 endpoints

© 2026 CC-BY-SA, Canonical Ltd.
Last updated on Apr 23, 2026
Manage your tracker settings
Contents
  • API reference
    • Getting started
    • API v2 reference