Canonical

Canonical Open Access API

Do not require the user to authenticate.

GitHub OpenAPI

Operations 10

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /v2/icons/{name}/icon Get an installed snap's icon · Get a snap's icon #
Ask an LLM
“Can I fetch the icon file of a snap installed on this machine?”
“Where does snapd serve the raw icon for an installed snap?”
Tell an agent
Get the icon of the installed snap {name}.
Download the icon file for snap {name}.
GET /v2/quotas List snap quota groups · Get all quota groups #
Ask an LLM
“Which quota groups exist on this system and what limits do they set?”
“What resource constraints are applied to snaps via quota groups?”
Tell an agent
List all snap quota groups and their constraints.
Show every quota group on this device.
GET /v2/quotas/{group-name} Get one snap quota group · Get a specific quota group #
Ask an LLM
“What limits does a particular quota group enforce?”
“Can I look up a single quota group by its name?”
Tell an agent
Show the quota group {group}.
Get the constraints of quota group {group}.
GET /v2/sections List Snap Store sections · Get store sections #
Ask an LLM
“Which sections or categories are available in the Snap Store?”
“What store sections can I browse snaps by?”
Tell an agent
List the Snap Store sections.
Show the available store categories.
GET /v2/snaps List installed snaps · List installed snaps #
Ask an LLM
“Which snaps are installed on this system, with their components?”
“Can I list only some installed snaps by name?”
Tell an agent
List all installed snaps.
Show installed snaps {snaps}.
GET /v2/snaps/{name} Get details of an installed snap · Get details for an installed snap #
Ask an LLM
“What version and channel is a specific installed snap on?”
“Can I see the details of one snap installed on this machine?”
Tell an agent
Show details for the installed snap {name}.
Get the version and revision of snap {name}.
GET /v2/snapshots List snap snapshots · Get a list of snapshots #
Ask an LLM
“Which snapshot sets of snap data are stored on this system?”
“Can I see the metadata of all saved snapshots?”
Tell an agent
List all stored snapshot sets.
Show metadata for every snap snapshot on this machine.
GET /v2/systems List recovery systems · Get the list of recovery systems #
Ask an LLM
“Which recovery systems are available on this device?”
“Can I see the Ubuntu Core recovery systems I could boot into?”
Tell an agent
List the available recovery systems.
Show every recovery system on this device.
GET /v2/system-info Get snapd system information · Get system information #
Ask an LLM
“What version of snapd is running and how is the server configured?”
“Where can I see snapd's environment and configuration info?”
Tell an agent
Show snapd system information.
Get the server configuration and environment details from snapd.
GET /v2/warnings Get snapd warnings · Get system warnings #
Ask an LLM
“Are there any current warnings from snapd?”
“Can I list all warnings, including ones already shown?”
Tell an agent
Show the current snapd warnings.
List snapd warnings using selection {select}.

Documentation

📖
Documentation
https://snapcraft.io/docs/reference/development/snapd-rest-api/
📖
Documentation
https://ubuntu.com/landscape/docs
📖
APIReference
https://documentation.ubuntu.com/landscape/reference/api/
📖
Documentation
https://documentation.ubuntu.com/lxd/latest/rest-api/
📖
APIReference
https://documentation.ubuntu.com/lxd/latest/api-extensions/
📖
Documentation
https://ubuntu.com/security/api/docs
📖
APIReference
https://ubuntu.com/security/api/spec.json
📖
Documentation
https://documentation.ubuntu.com/pebble/
📖
Documentation
https://canonical-testflinger.readthedocs-hosted.com/en/latest/
📖
Documentation
https://documentation.ubuntu.com/anbox-cloud/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/canonical/refs/heads/main/openapi/canonical-open-access-api-openapi.yml

Other Resources

🔗
HowTo
https://snapcraft.io/docs/how-to-guides/snap-development/use-the-rest-api/
🔗
ReleaseNotes
https://documentation.ubuntu.com/landscape/reference/release-notes/
🔗
Portal
https://ubuntu.com/landscape
🔗
SourceCode
https://github.com/canonical/lxd
🔗
Portal
https://canonical.com/lxd
🔗
Portal
https://ubuntu.com/security
🔗
SourceCode
https://github.com/canonical/pebble
🔗
SourceCode
https://github.com/canonical/testflinger
🔗
SourceCode
https://github.com/canonical/hardware-api
🔗
Portal
https://ubuntu.com/certified
🔗
SourceCode
https://github.com/canonical/identity-platform-api
🔗
SourceCode
https://github.com/canonical/test_observer
🔗
Portal
https://canonical.com/anbox-cloud
🔗
SourceCode
https://github.com/canonical/cos-registration-server

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/canonical:canonical-open-access-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

canonical-open-access-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Snapd REST Open Access API
  license:
    name: GPL-3.0
    url: https://www.gnu.org/licenses/gpl-3.0.txt
  version: '1.0'
  description: 'The REST API provides access to snapd''s state and many of its key functions,

    as listed below.


    For general information on how to use the API, including how to access it,

    its requests and responses, results fields and error types, see Using the

    REST API.'
servers:
- url: unix:///run/snapd.socket
  description: 'Local snapd socket access. Unless otherwise specified, routes appear on

    this socket.'
- url: unix:///run/snapd-snap.socket
  description: Snapd socket access for snaps
tags:


# --- truncated at 32 KB (38 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/canonical/refs/heads/main/openapi/canonical-open-access-api-openapi.yml