How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Canonical Networks API

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

Canonical Networks API is one of 122 APIs that Canonical publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Networks. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and release notes.

This API exposes 10 operations across 5 paths, and defines 15 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against the base URL https://api.snapcraft.io.

10 operations 5 paths 15 schemas 1 DELETE5 GET1 PATCH2 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://api.snapcraft.io
Resource Areas
1

Paths & Operations 10

Across 5 paths, the API surfaces 10 operations — 1 DELETE, 5 GET, 1 PATCH, 2 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Networks 10
GET
/1.0/networks
Get the networks
networks_get 2 params → 200403500
POST
/1.0/networks
Add a network
networks_post 2 params body → 202400403500
DELETE
/1.0/networks/{name}
Delete the network
network_delete 1 param → 202400403404500
GET
/1.0/networks/{name}
Get the network
network_get 2 params → 200403500
PATCH
/1.0/networks/{name}
Partially update the network
network_patch 2 params body → 202400403412500
POST
/1.0/networks/{name}
Rename the network
network_post 1 param body → 202400403500
PUT
/1.0/networks/{name}
Update the network
network_put 2 params body → 202400403404412500
GET
/1.0/networks/{name}/leases
Get the DHCP leases
networks_leases_get 2 params → 200403500
GET
/1.0/networks/{name}/state
Get the network state
networks_state_get 2 params → 200403500
GET
/1.0/networks?recursion=1
Get the networks
networks_get_recursion1 3 params → 200403500

Schemas 15

The contract defines 15 schemas that model the data the API accepts and returns. The most detailed are Operation (15 properties), Network (10 properties), NetworkState (10 properties), NetworkStateBond (7 properties). Each schema is shown below with its type and property counts.

NetworkStateBridge
object
NetworkStateBridge represents bridge specific state
6 properties
NetworkPost
object
NetworkPost represents the fields required to rename a LXD network
1 property
NetworkLease
object
NetworkLease represents a DHCP lease
6 properties
Network
object
Network represents a LXD network
10 properties
StatusCode
integer
Operation
object
Operation represents a LXD background operation
15 properties
NetworkState
object
NetworkState represents the network state
10 properties
NetworkStateCounters
object
NetworkStateCounters represents packet counters
4 properties
NetworkStateAddress
object
NetworkStateAddress represents a network address
4 properties
OperationRequestor
object
API extension: operationrequestor.
3 properties
NetworkStateVLAN
object
NetworkStateVLAN represents VLAN specific state
2 properties
NetworkStateBond
object
NetworkStateBond represents bond specific state
7 properties
NetworksPost
object
NetworksPost represents the fields of a new LXD network
4 properties
NetworkStateOVN
object
NetworkStateOVN represents OVN specific state
1 property
NetworkPut
object
NetworkPut represents the modifiable fields of a LXD network
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

canonical-networks-api-openapi.yml Raw ↑

Other APIs Canonical publishes across the network.

Snap Store API
Charmhub API
MAAS API
Juju Client / Controller API
Launchpad Web Services API
Ubuntu Pro Client API
Canonical Assertions API
Canonical Search API
Canonical Snaps API
MicroCeph REST API
Canonical App Authorization Service API
Canonical Application API
Where this information came from

This is an independent, third-party profile of Canonical Networks API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.