Canonical

Canonical Authentication Required API

Access is restricted to the root user.

GitHub OpenAPI

Operations 20

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/changes List snapd changes in progress or completed · Get all changes #
Ask an LLM
“What installs, refreshes and other changes is snapd running right now?”
“Can I filter the snapd change list to only in-progress or only finished work?”
Tell an agent
List snapd changes filtered to {select}.
Show all changes that involve snap {for}.
GET /v2/changes/{id} Check the status of one snapd change · Get the status of a change #
Ask an LLM
“Has a specific snapd background change finished yet?”
“How do I check whether a snap install I kicked off succeeded?”
Tell an agent
Get the current status of snapd change {id}.
Tell me whether change {id} is done, still running or errored.
POST /v2/changes/{id} Abort a snapd change in progress · Abort a change #
Ask an LLM
“Can I stop a snap operation that's still running?”
“How do I cancel a stuck snapd change?”
Tell an agent destructive · confirm first
Abort snapd change {id} with action {action}.
Cancel the in-progress change {id}.
POST /v2/cohorts Create cohort keys for snaps · Create cohort keys #
Ask an LLM
“How do I generate cohort keys so several devices get the same snap revision?”
“Can I create cohort keys for a set of snaps at once?”
Tell an agent
Create cohort keys for snaps {snaps} using action {action}.
Generate cohort keys for the snaps {snaps}.
GET /v2/find Search the store for snaps · Find snaps in the store #
Ask an LLM
“Which snaps in the store match a search term and work on this machine?”
“Can I browse store snaps by section, like games or development?”
Tell an agent
Search the snap store for {q}.
Find the snap named exactly {name} in the store.
POST /v2/login Log in to snapd and the store · Authenticate user with snapd and store #
Ask an LLM
“How do I sign in to snapd with my store account?”
“Does snapd login support a one-time password for two-factor accounts?”
Tell an agent
Log in to snapd as {email} with password {password}.
Sign in {email} using password {password} and one-time code {otp}.
POST /v2/logout Log out of snapd and the store · Log user out of snapd and the store #
Ask an LLM
“How do I sign the current user out of snapd?”
“Can I clear my store session from snapd?”
Tell an agent
Log me out of snapd and the store.
End the current snapd store session.
GET /v2/logs Read snap service logs · Get log contents #
Ask an LLM
“Where can I read the logs for my snap services?”
“Can I follow snapd logs live as new lines arrive?”
Tell an agent
Show the last {n} log lines for {names}.
Stream logs for {names} and keep following them.
POST /v2/snapctl Run a snapctl command from inside a snap · Run snapctl command #
Ask an LLM
“How does a snap run snapctl commands through the snapd socket?”
“Can I pass stdin to a snapctl command over the API?”
Tell an agent
Run snapctl with arguments {args} in context {context-id}.
Execute snapctl {args} for context {context-id}, feeding {stdin} as input.
GET /v2/snaps/{name}/conf Get an installed snap's configuration · Get snap configuration #
Ask an LLM
“What configuration options are set for an installed snap?”
“Can I read system-wide snap options too?”
Tell an agent
Show the configuration of snap {name}.
Get config keys {keys} for snap {name}.
GET /v2/snapshots/{set-id}/export Download a snapshot set as an archive · Export a snapshot set #
Ask an LLM
“How do I download a snap snapshot so I can move it to another machine?”
“In what format does a snapshot export come back?”
Tell an agent
Export snapshot set {set-id} as a tar archive.
Download snapshot {set-id}.
GET /v2/system/system-recovery-keys Retrieve the disk encryption recovery key · Get system recovery key #
Ask an LLM
“Where do I find the LUKS recovery key on an encrypted Ubuntu Core device?”
“Can I fetch the full disk encryption keys through snapd?”
Tell an agent
Get the system recovery key for this Ubuntu Core device.
Show me the LUKS encryption recovery keys.
POST /v2/system/system-recovery-keys Remove or reset disk encryption recovery keys · Manage system recovery keys #
Ask an LLM
“How do I reset the LUKS recovery keys on Ubuntu Core?”
“Can I remove the recovery keys from an encrypted device?”
Tell an agent destructive · confirm first
Apply recovery key action {action} on this device.
Reset the full disk encryption recovery keys using action {action}.
POST /v2/systems Act on the current recovery system or create one · Perform an action on the current recovery system or create a new one #
Ask an LLM
“Can I reboot into or install from the currently active recovery system?”
“How do I create a brand-new recovery system on the device?”
Tell an agent
Create a new recovery system on this device.
Reboot using the current active recovery system.
GET /v2/systems/{label} Get details of one recovery system · Get details for a specific recovery system #
Ask an LLM
“Is storage encryption enabled on a given recovery system?”
“What actions can I take on a specific recovery system?”
Tell an agent
Show details and available actions for recovery system {label}.
Check the encryption status of recovery system {label}.
POST /v2/systems/{label} Perform an action on a labeled recovery system · Perform an action on a specific recovery system #
Ask an LLM
“Can I trigger an action on a specific recovery system by its label?”
“Which body fields are needed depends on the action, so what can a labeled system do?”
Tell an agent
Run an action against recovery system {label}.
Reboot into the recovery system labeled {label}.
GET /v2/validation-sets List enabled validation sets · Get all enabled validation sets #
Ask an LLM
“Which validation sets are enabled on this system?”
“Can I see every validation set that's constraining my snaps?”
Tell an agent
List all enabled validation sets.
Show every validation set active on this device.
GET /v2/validation-sets/{account-id}/{name} Get one validation set · Get a specific validation set #
Ask an LLM
“What does a particular validation set require?”
“How do I look up a validation set by account and name?”
Tell an agent
Show validation set {name} from account {account-id}.
Get the details of {account-id}/{name}.
POST /v2/validation-sets/{account-id}/{name} Apply or forget a validation set · Manage a specific validation set #
Ask an LLM
“Can I enforce a validation set or only monitor it?”
“How do I forget a validation set I no longer want?”
Tell an agent
Apply validation set {account-id}/{name} in {mode} mode.
Run action {action} on validation set {account-id}/{name} at sequence {sequence}.
POST /v2/warnings Acknowledge snapd warnings · Respond to warnings #
Ask an LLM
“How do I clear snapd warnings I've already seen?”
“Does acknowledging a warning fix whatever caused it?”
Tell an agent
Acknowledge all snapd warnings up to {timestamp}.
Apply action {action} to warnings as of {timestamp}.

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-authenticationrequired-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/canonical/refs/heads/main/json-schema/canonical-system-details-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/canonical/refs/heads/main/json-schema/canonical-snap-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/canonical/refs/heads/main/json-schema/canonical-system-action-install-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/canonical/refs/heads/main/json-schema/canonical-change-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/canonical/refs/heads/main/json-schema/canonical-system-action-create-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/canonical/refs/heads/main/json-schema/canonical-validation-set-schema.json

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-authenticationrequired-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-authenticationrequired-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Snapd REST Authentication Required 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 (56 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/canonical/refs/heads/main/openapi/canonical-authenticationrequired-api-openapi.yml