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 Zones API

The network-zones API from Canonical — 6 operation(s) for network-zones.

Canonical Network Zones 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 Zones. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and release notes.

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

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

14 operations 6 paths 10 schemas 2 DELETE6 GET2 PATCH2 POST2 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 14

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

network-zones 14
GET
/1.0/network-zones
Get the network zones
network_zones_get 2 params → 200403500
POST
/1.0/network-zones
Add a network zone
network_zones_post 1 param body → 202400403500
DELETE
/1.0/network-zones/{zone}
Delete the network zone
network_zone_delete 1 param → 202400403404500
GET
/1.0/network-zones/{zone}
Get the network zone
network_zone_get 1 param → 200403500
PATCH
/1.0/network-zones/{zone}
Partially update the network zone
network_zone_patch 1 param body → 202400403404412500
PUT
/1.0/network-zones/{zone}
Update the network zone
network_zone_put 1 param body → 202400403404412500
GET
/1.0/network-zones/{zone}/records
Get the network zone records
network_zone_records_get 1 param → 200403500
POST
/1.0/network-zones/{zone}/records
Add a network zone record
network_zone_records_post 1 param body → 202400403500
DELETE
/1.0/network-zones/{zone}/records/{name}
Delete the network zone record
network_zone_record_delete 1 param → 202400403404500
GET
/1.0/network-zones/{zone}/records/{name}
Get the network zone record
network_zone_record_get 1 param → 200403500
PATCH
/1.0/network-zones/{zone}/records/{name}
Partially update the network zone record
network_zone_record_patch 1 param body → 202400403404412500
PUT
/1.0/network-zones/{zone}/records/{name}
Update the network zone record
network_zone_record_put 1 param body → 202400403404412500
GET
/1.0/network-zones/{zone}/records?recursion=1
Get the network zone records
network_zone_records_get_recursion1 1 param → 200403500
GET
/1.0/network-zones?recursion=1
Get the network zones
network_zones_get_recursion1 2 params → 200403500

Schemas 10

The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are Operation (15 properties), NetworkZone (6 properties), NetworkZoneRecordsPost (4 properties), NetworkZoneRecord (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
NetworkZonesPost
object
NetworkZonesPost represents the fields of a new LXD network zone
3 properties
NetworkZone
object
6 properties
OperationRequestor
object
API extension: operationrequestor.
3 properties
NetworkZoneRecordsPost
object
NetworkZoneRecordsPost represents the fields of a new LXD network zone record
4 properties
NetworkZonePut
object
NetworkZonePut represents the modifiable fields of a LXD network zone
2 properties
NetworkZoneRecordPut
object
NetworkZoneRecordPut represents the modifiable fields of a LXD network zone record
3 properties
NetworkZoneRecordEntry
object
NetworkZoneRecordEntry represents the fields in a record entry
3 properties
NetworkZoneRecord
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

canonical-network-zones-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 Zones 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.