Canonical

Canonical Server API

The server API from Canonical — 5 operation(s) for server.

Documentation GitHub OpenAPI

Operations 7

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 / List supported API versions · Get the supported API endpoints #

Ask an LLM

“Which API versions does this LXD server support?”

“How do I discover the versioned endpoints an LXD server exposes?”

Tell an agent

List the API versions the server supports.

Show me the root API endpoints available.

GET /1.0 Get the server environment and config · Get the server environment and configuration #

Ask an LLM

“How do I see the full LXD server configuration and environment?”

“What version and storage drivers is my server running?”

Tell an agent

Show the full server environment and configuration.

Get the server config as seen by cluster member {target}.

PATCH /1.0 Change some server settings · Partially update the server configuration #

Ask an LLM

“How do I set one server option like core.https_address?”

“Can I change a single server setting without resending the rest?”

Tell an agent

Merge {config} into the server's existing settings.

Patch server settings on member {target} with {config}.

PUT /1.0 Replace the server configuration · Update the server configuration #

Ask an LLM

“Can I replace the entire LXD server configuration at once?”

“What happens to server keys I leave out of a full config update?”

Tell an agent

Replace the server configuration with {config}.

Overwrite the config on member {target} with {config}.

GET /1.0/events Stream server events · Get the event stream #

Ask an LLM

“How do I subscribe to live LXD events over a websocket?”

“Can I only receive lifecycle or logging events?”

Tell an agent

Stream events of type {type}.

Connect to the event stream for project {project}.

GET /1.0/resources Get the server's hardware inventory · Get system resources information #

Ask an LLM

“What CPUs, memory and GPUs does my LXD host have?”

“How do I see the hardware profile of one cluster member?”

Tell an agent

Show the hardware resources of the server.

Get the hardware profile of member {target}.

GET /1.0?public Get public server info for untrusted clients · Get the server environment #

Ask an LLM

“What server details can an unauthenticated client see?”

“How does a new client check a server's auth methods before trusting it?”

Tell an agent

Show the public subset of the server environment.

Get the server info available without a trusted certificate.

Documentation

https://snapcraft.io/docs/reference/development/snapd-rest-api/

https://ubuntu.com/landscape/docs

https://documentation.ubuntu.com/landscape/reference/api/

https://documentation.ubuntu.com/lxd/latest/rest-api/

https://documentation.ubuntu.com/lxd/latest/api-extensions/

https://ubuntu.com/security/api/docs

https://ubuntu.com/security/api/spec.json

https://documentation.ubuntu.com/pebble/

https://canonical-testflinger.readthedocs-hosted.com/en/latest/

https://documentation.ubuntu.com/anbox-cloud/

Specifications

https://artifacts.apis.io/canonical/openapi/canonical-server-api-openapi.yml

Other Resources

https://snapcraft.io/docs/how-to-guides/snap-development/use-the-rest-api/

https://documentation.ubuntu.com/landscape/reference/release-notes/

https://ubuntu.com/landscape

https://github.com/canonical/lxd

https://canonical.com/lxd

https://ubuntu.com/security

https://github.com/canonical/pebble

https://github.com/canonical/testflinger

https://github.com/canonical/hardware-api

https://ubuntu.com/certified

https://github.com/canonical/identity-platform-api

https://github.com/canonical/test_observer

https://canonical.com/anbox-cloud

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-server-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

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

openapi: 3.2.0
info:
  contact:
    email: lxd@lists.canonical.com
    name: LXD upstream
    url: https://github.com/canonical/lxd
  description: 'This is the REST API used by all LXD clients.

    Internal endpoints aren''t included in this documentation.


    The LXD API is available over both a local unix+http and remote https API.

    Authentication for local users relies on group membership and access to the unix socket.

    For remote users, the default authentication method is TLS client.'
  license:
    name: AGPL-3.0-only
    url: https://www.gnu.org/licenses/agpl-3.0.en.html
  title: LXD external REST Server API
  version: '1.0'
tags:


# --- truncated at 32 KB (62 KB total) ---
# Full source: https://artifacts.apis.io/canonical/openapi/canonical-server-api-openapi.yml