Canonical

Canonical Instances API

The instances API from Canonical — 29 operation(s) for instances.

GitHub OpenAPI

Operations 58

GET /1.0/instances Get a list of instances #
POST /1.0/instances Create a new instance #
DELETE /1.0/instances Delete multiple instances #
PUT /1.0/instances Bulk instance state update #
GET /1.0/instances/{id_or_name} Get information about a specific instance instance #
DELETE /1.0/instances/{id_or_name} Delete a specific instance #
PATCH /1.0/instances/{id_or_name} Update the state of a specific instance instance #
POST /1.0/instances/{id_or_name}/exec Execute a command in a instance #
GET /1.0/instances/{id_or_name}/logs Get a list of collected log files for the instance #
GET /1.0/instances/{id_or_name}/logs/{name} Retrieve a specific log file stored for the instance #
GET /1.0/instances?recursion=1 Get a list of instances #
DELETE /1.0/instances/{name} Delete an instance #
GET /1.0/instances/{name} Get the instance #
PATCH /1.0/instances/{name} Partially update the instance #
POST /1.0/instances/{name} Rename or move/migrate an instance #
PUT /1.0/instances/{name} Update the instance #
GET /1.0/instances/{name}/backups Get the backups #
POST /1.0/instances/{name}/backups Create a backup #
DELETE /1.0/instances/{name}/backups/{backup} Delete a backup #
GET /1.0/instances/{name}/backups/{backup} Get the backup #
POST /1.0/instances/{name}/backups/{backup} Rename a backup #
GET /1.0/instances/{name}/backups/{backup}/export Get the raw backup file(s) #
GET /1.0/instances/{name}/backups?recursion=1 Get the backups #
DELETE /1.0/instances/{name}/console Clear the console log #
GET /1.0/instances/{name}/console Get console log #
POST /1.0/instances/{name}/console Connect to console #
POST /1.0/instances/{name}/exec Run a command #
DELETE /1.0/instances/{name}/files Delete a file #
GET /1.0/instances/{name}/files Get a file #
HEAD /1.0/instances/{name}/files Get metadata for a file #
POST /1.0/instances/{name}/files Create or replace a file #
GET /1.0/instances/{name}/logs Get the log files #
GET /1.0/instances/{name}/logs/{filename} Get the log file #
GET /1.0/instances/{name}/logs/exec-output Get the exec record-output files #
DELETE /1.0/instances/{name}/logs/exec-output/{filename} Delete the exec record-output file #
GET /1.0/instances/{name}/logs/exec-output/{filename} Get the exec-output log file #
GET /1.0/instances/{name}/metadata Get the instance image metadata #
PATCH /1.0/instances/{name}/metadata Partially update the image metadata #
PUT /1.0/instances/{name}/metadata Update the image metadata #
DELETE /1.0/instances/{name}/metadata/templates Delete a template file #
GET /1.0/instances/{name}/metadata/templates Get the template file names or a specific #
POST /1.0/instances/{name}/metadata/templates Create or replace a template file #
POST /1.0/instances/{name}/rebuild Rebuild an instance #
GET /1.0/instances/{name}/sftp Get the instance SFTP connection #
GET /1.0/instances/{name}/snapshots Get the snapshots #
POST /1.0/instances/{name}/snapshots Create a snapshot #
DELETE /1.0/instances/{name}/snapshots/{snapshot} Delete a snapshot #
GET /1.0/instances/{name}/snapshots/{snapshot} Get the snapshot #
PATCH /1.0/instances/{name}/snapshots/{snapshot} Partially update snapshot #
POST /1.0/instances/{name}/snapshots/{snapshot} Rename or move/migrate a snapshot #
PUT /1.0/instances/{name}/snapshots/{snapshot} Update snapshot #
GET /1.0/instances/{name}/snapshots?recursion=1 Get the snapshots #
GET /1.0/instances/{name}/state Get the runtime state #
PUT /1.0/instances/{name}/state Change the state #
GET /1.0/instances/{name}/uefi-vars Get the instance's UEFI variables #
PUT /1.0/instances/{name}/uefi-vars Set the instance's UEFI variables #
GET /1.0/instances/{name}?recursion=1 Get the instance #
GET /1.0/instances?recursion=2 Get the instances #

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-instances-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-instances-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-instances-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Canonical Instances API
  version: '1.0'
  description: 'Operations tagged instances 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 (140 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/canonical/refs/heads/main/openapi/canonical-instances-api-openapi.yml