Canonical

Canonical Images API

The images API from Canonical — 19 operation(s) for images.

GitHub OpenAPI

Operations 31

GET /1.0/images Get a list of images #
POST /1.0/images Import an image #
POST /1.0/images/ Upload a package to create an image #
GET /1.0/images/{id_or_name} Get information about an image #
DELETE /1.0/images/{id} Delete an image #
PATCH /1.0/images/{id} Update an image with a new package to upload #
PATCH /1.0/images/{id}/ Update an image's metadata #
DELETE /1.0/images/{id}/{version} Delete an image version #
GET /1.0/images?recursion=1 Get the list of images expanded #
DELETE /1.0/images/{fingerprint} Delete the image #
GET /1.0/images/{fingerprint} Get the image #
PATCH /1.0/images/{fingerprint} Partially update the image #
PUT /1.0/images/{fingerprint} Update the image #
GET /1.0/images/{fingerprint}/export Get the raw image file(s) #
POST /1.0/images/{fingerprint}/export Make LXD push the image to a remote server #
GET /1.0/images/{fingerprint}/export?public Get the raw image file(s) #
POST /1.0/images/{fingerprint}/refresh Refresh an image #
POST /1.0/images/{fingerprint}/secret Generate secret for retrieval of the image by an untrusted client #
GET /1.0/images/{fingerprint}?public Get the public image #
GET /1.0/images/aliases Get the image aliases #
POST /1.0/images/aliases Add an image alias #
DELETE /1.0/images/aliases/{name} Delete the image alias #
GET /1.0/images/aliases/{name} Get the image alias #
PATCH /1.0/images/aliases/{name} Partially update the image alias #
POST /1.0/images/aliases/{name} Rename the image alias #
PUT /1.0/images/aliases/{name} Update the image alias #
GET /1.0/images/aliases/{name}?public Get the public image alias #
GET /1.0/images/aliases?recursion=1 Get the image aliases #
GET /1.0/images?public Get the public images #
POST /1.0/images?public Add an image #
GET /1.0/images?public&recursion=1 Get the public images #

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-images-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-images-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-images-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Canonical Images API
  version: '1.0'
  description: 'Operations tagged images across 2 of this provider''s published API definitions: canonical-anbox-cloud-ams-api-openapi.json, canonical-lxd-rest-api-openapi.yml. Each path carries the servers of the definition it was published in.'
tags:


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