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

The nodes API from Canonical — 3 operation(s) for nodes.

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

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

This API exposes 6 operations across 3 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.

6 operations 3 paths 15 schemas 1 DELETE3 GET1 PATCH1 POST

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 6

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

Nodes 6
GET
/1.0/nodes
Get a list of nodes
nodes_get 1 param → 200default
POST
/1.0/nodes
Create a node
node_post body → 202400409default
GET
/1.0/nodes/{name}
Get information about a node
node_get 1 param → 200400404409default
DELETE
/1.0/nodes/{name}
Delete a node
node_delete 1 param body → 202400404409default
PATCH
/1.0/nodes/{name}
Update a node
node_patch 2 params body → 202400404409default
GET
/1.0/nodes?recursion=1
Get a list of nodes
nodes_get_recursion1 1 param → 200default

Schemas 15

The contract defines 15 schemas that model the data the API accepts and returns. The most detailed are Node (22 properties), NodesPost (18 properties), Operation (12 properties), NodePatch (12 properties). Each schema is shown below with its type and property counts.

NodeGPUAllocation
object
NodeGPUAllocation describes a single allocation on a GPU
3 properties
Node
object
Node describes a single node of the underlying LXD cluster AMS manages
22 properties
NodePatch
object
NodePatch describes a request to update an existing node
12 properties
NodeDelete
object
NodeDelete describes a request used to delete a node
2 properties
CollectionResponse
Collection Response
NodeGPUPatch
object
NodeGPUPatch allows changing configuration for individual GPUs
3 properties
NodeStatus
integer
NodeStatus describes the current status of a node
OperationResponse
object
Operation
5 properties
StatusCode
integer
StatusCode represents a valid REST operation
Operation
object
Operation represents a background operation
12 properties
NodeGPU
object
NodeGPU describes a single GPU available on a node
7 properties
NodesPost
object
NodesPost describes a request to create a new node on AMS
18 properties
NodeVPU
object
NodeVPU describes a single independent VPU available on a node
6 properties
NoMetaSyncResponse
object
Swagger Synchronous response without metadata field
4 properties
NodeVPUAllocation
object
NodeVPUAllocation describes a single allocation for a VPU
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

canonical-nodes-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 Nodes 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.