Canonical Snapcraft
Menu
  • Snap Store
  • About Snapcraft
  • Learn
    • Blog
    • Build
    • Docs
    • Tutorials
  • IoT
  • Forum
  • My account
    • My published snaps
    • My validation sets
    • My stores
    • Account details
    • Sign out
  • Sign in
Toggle side navigation
Toggle side navigation

Snap documentation

Use snaps

  • Snap tutorials
    • Get started
    • Install the daemon
      • AlmaLinux OS
      • Arch Linux
      • Debian
      • Elementary OS
      • Fedora
      • Linux Mint
      • Manjaro Linux
      • Raspberry Pi OS
      • openSUSE
      • Pop!_OS
      • Rocky Linux
      • Ubuntu
  • Snap how-to guides
    • Work with snaps
      • Manage updates
      • Connect interfaces
      • Configure snaps
      • Apps and aliases
    • Manage snaps
      • Create data snapshots
      • Use resource quotas
      • Disk space awareness
      • Set system options
      • Control services
      • Using components
      • Configure snaps with confdb
      • Manage validation sets
      • Snap deltas
      • Use the REST API
      • Use snapctl
    • Fix common issues
      • Test snapd fixes
      • Debug snaps
  • Snap reference
    • Operations
      • Glossary
      • System options
      • System architecture
      • Interfaces
        • Hardware interfaces
        • Media interfaces
        • Network interfaces
        • Security interfaces
        • System interfaces
        • Super-privileged interfaces
    • Administration
      • Network requirements
      • Distribution support
    • Development
      • Supported snap hooks
      • Services and daemons
      • Environment variables
      • REST API
        • snapd REST API
        • Error responses
      • YAML schemas
        • The snap format
        • The gadget snap
        • The kernel snap
    • Release notes
  • Snap explanation
    • How snaps work
      • Refresh awareness
      • Channels and tracks
      • Revisions
      • Transactional updates
      • Validation sets
      • Confdb configuration mechanism
      • Snap components
      • Snap performance
    • Interfaces
      • All about interfaces
      • Interface auto-connection
      • Interface hooks
    • Security
      • Security policies
      • Snap confinement
      • Classic confinement
      • Assertions
      • Snapd release process

Build snaps

Contribute to our docs

Snap reference

On this page

  • Operations
  • Administration
  • Development

This Reference section is for when you need to know which options can be used, what functions the API supports, which environment variables can be accessed and the contents of gadget.yaml.

Operations

Details that help with the day-to-day operations of working with snaps.

  • Glossary: Terms and definitions specific to the world of snaps.
  • Snap system architecture: What snapd uses to manage confinement and security.
  • System options: Configurations options for the system and native snap devices.
  • Interfaces: Every interface, listed by category.

Administration

Deepen your understanding of how snaps can run on all kinds of devices, in all kinds of environments.

  • Network requirements: What network access snaps require to operate correctly.
  • Distribution support: The status of current builds for Linux distributions with snap support.

Development

Extend snap functionality with API access and customised environments for your applications and devices.

  • Environment variables: Internal values accessible to snapped applications.
  • Snapd REST API: Provides access to snapd’s state and many of its key functions.
  • REST API error codes: The types of errors returned by the API.

YAML schemas define exactly what a device, kernel and snap is capable of.

  • snap.yaml: The metadata for a snap.
  • Gadget snap: System and device properties.
  • Kernel snap: The Linux kernel snap, its metadata and setup files.

Last updated 1 year, 1 month ago.

Help improve this document in the forum.

Back to top

© 2026 Canonical Ltd.

Ubuntu and Canonical are registered trademarks of Canonical Ltd.
Powered by Charmed Kubernetes

Join the forum, contribute to or report problems with, snapd, Snapcraft, or this site.

  • Terms of Service
  • Data privacy
  • Manage your tracker settings
  • Service status
  • Other functions
  • Share on Twitter
  • Share on Facebook
  • Share on YouTube