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 Network Forwards API

The network-forwards API from Canonical — 3 operation(s) for network-forwards.

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

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

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

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

7 operations 3 paths 7 schemas 1 DELETE3 GET1 PATCH1 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 7

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

network-forwards 7
GET
/1.0/networks/{networkName}/forwards
Get the network address forwards
network_forwards_get 1 param → 200403500
POST
/1.0/networks/{networkName}/forwards
Add a network address forward
network_forwards_post 1 param body → 202400403500
DELETE
/1.0/networks/{networkName}/forwards/{listenAddress}
Delete the network address forward
network_forward_delete 1 param → 202400403500
GET
/1.0/networks/{networkName}/forwards/{listenAddress}
Get the network address forward
network_forward_get 1 param → 200403500
PATCH
/1.0/networks/{networkName}/forwards/{listenAddress}
Partially update the network address forward
network_forward_patch 1 param body → 202400403412500
PUT
/1.0/networks/{networkName}/forwards/{listenAddress}
Update the network address forward
network_forward_put 1 param body → 202400403412500
GET
/1.0/networks/{networkName}/forwards?recursion=1
Get the network address forwards
network_forward_get_recursion1 1 param → 200403500

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are Operation (15 properties), NetworkForward (5 properties), NetworkForwardPort (5 properties), NetworkForwardsPost (4 properties). Each schema is shown below with its type and property counts.

StatusCode
integer
Operation
object
Operation represents a LXD background operation
15 properties
OperationRequestor
object
API extension: operationrequestor.
3 properties
NetworkForwardPort
object
NetworkForwardPort represents a port specification in a network address forward
5 properties
NetworkForwardsPost
object
NetworkForwardsPost represents the fields of a new LXD network address forward
4 properties
NetworkForward
object
5 properties
NetworkForwardPut
object
NetworkForwardPut represents the modifiable fields of a LXD network address forward
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

canonical-network-forwards-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 Network Forwards 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.