Canonical

Canonical Networks API

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

Documentation 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 /1.0/networks List network URLs · Get the networks #

Ask an LLM

“Which networks are defined on my LXD server?”

“Can I get network links across all projects?”

Tell an agent

List the network URLs in project {project}.

Give me links to all LXD networks.

POST /1.0/networks Create a network · Add a network #

Ask an LLM

“How do I create a new bridge network in LXD?”

“When clustered, do I need to create the network on each member first?”

Tell an agent

Create a {type} network named {name}.

Define network {name} on cluster member {target} with config {config}.

DELETE /1.0/networks/{name} Delete a network · Delete the network #

Ask an LLM

“How do I remove a network I no longer use?”

“Can I delete a network from a specific project?”

Tell an agent destructive · confirm first

Delete the network.

Remove the network from project {project}.

GET /1.0/networks/{name} Get one network's configuration · Get the network #

Ask an LLM

“How do I see the configuration of a specific network?”

“Can I view a network's settings as seen on one cluster member?”

Tell an agent

Show the network's configuration in project {project}.

Get the network as defined on member {target}.

PATCH /1.0/networks/{name} Change some settings of a network · Partially update the network #

Ask an LLM

“Can I change one key like ipv4.address without resending the full config?”

“How do I tweak a network's settings on a single cluster member?”

Tell an agent

Merge {config} into the network's existing config.

Patch the network on member {target} with {config}.

POST /1.0/networks/{name} Rename a network · Rename the network #

Ask an LLM

“How do I rename an existing network?”

“Can a network be given a new name without recreating it?”

Tell an agent

Rename the network to {name}.

Give the network in project {project} the new name {name}.

PUT /1.0/networks/{name} Replace a network's configuration · Update the network #

Ask an LLM

“Can I replace every setting of a network in one go?”

“How do I overwrite a network's whole config and description?”

Tell an agent

Replace the network configuration with {config}.

Overwrite the network description with {description} and config {config}.

GET /1.0/networks/{name}/leases List a network's DHCP leases · Get the DHCP leases #

Ask an LLM

“Which IP addresses has a network's DHCP server handed out?”

“How do I find what address an instance got from DHCP?”

Tell an agent

List the DHCP leases on the network.

Show DHCP leases on member {target}.

GET /1.0/networks/{name}/state Get a network's live state · Get the network state #

Ask an LLM

“Is my network interface up, and what are its counters?”

“How do I see the current addresses and traffic on a network?”

Tell an agent

Show the current state of the network.

Get the network's live state on member {target}.

GET /1.0/networks?recursion=1 List networks with full details · Get the networks #

Ask an LLM

“Can I list every network with its config, not just its URL?”

“How do I get full network records across all projects?”

Tell an agent

List all networks as full records in project {project}.

Give me detailed network entries across every project.

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://raw.githubusercontent.com/api-evangelist/canonical/refs/heads/main/openapi/canonical-networks-api-openapi.yml

Schemas & Data

https://raw.githubusercontent.com/api-evangelist/canonical/refs/heads/main/json-schema/canonical-network-schema.json

https://raw.githubusercontent.com/api-evangelist/canonical/refs/heads/main/json-schema/canonical-network-state-schema.json

https://raw.githubusercontent.com/api-evangelist/canonical/refs/heads/main/json-schema/canonical-network-lease-schema.json

https://raw.githubusercontent.com/api-evangelist/canonical/refs/heads/main/json-schema/canonical-networks-post-schema.json

https://raw.githubusercontent.com/api-evangelist/canonical/refs/heads/main/json-schema/canonical-network-put-schema.json

https://raw.githubusercontent.com/api-evangelist/canonical/refs/heads/main/json-schema/canonical-network-post-schema.json

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-networks-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

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 Networks API
  version: '1.0'
tags:


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