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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Canonical

Canonical Cluster API

The cluster API from Canonical — 7 operation(s) for cluster.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

Tagged areas include Cluster. 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 7 paths, and defines 18 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 7 paths 18 schemas 1 DELETE5 GET1 PATCH4 POST3 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
Contact
LXD upstream
License
AGPL-3.0-only
Resource Areas
1

Paths & Operations 14

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

Cluster 14
GET
/1.0/cluster
Get the cluster configuration
cluster_get → 200403500
PUT
/1.0/cluster
Update the cluster configuration
cluster_put body → 200400403412500
PUT
/1.0/cluster/certificate
Update the certificate for the cluster
clustering_update_cert body → 200400403500
POST
/1.0/cluster/groups
Create a cluster group
cluster_groups_post body → 200400403500
GET
/1.0/cluster/members
Get the cluster members
cluster_members_get → 200403500
POST
/1.0/cluster/members
Request a join token
cluster_members_post body → 202400403500
DELETE
/1.0/cluster/members/{name}
Delete the cluster member
cluster_member_delete → 200400403500
GET
/1.0/cluster/members/{name}
Get the cluster member
cluster_member_get → 200403500
PATCH
/1.0/cluster/members/{name}
Partially update the cluster member
cluster_member_patch body → 200400403412500
POST
/1.0/cluster/members/{name}
Rename the cluster member
cluster_member_post body → 200400403500
PUT
/1.0/cluster/members/{name}
Update the cluster member
cluster_member_put body → 200400403412500
GET
/1.0/cluster/members/{name}/state
Get state of the cluster member
cluster_member_state_get → 200403500
POST
/1.0/cluster/members/{name}/state
Evacuate or restore a cluster member
cluster_member_state_post body → 202400403500
GET
/1.0/cluster/members?recursion=1
Get the cluster members
cluster_members_get_recursion1 → 200403500

Schemas 18

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

ResourcesStoragePoolInodes
object
ResourcesStoragePoolInodes represents the inodes available to a given storage pool
2 properties
StoragePoolState
object
2 properties
ClusterMemberPost
object
1 property
ClusterCertificatePut
object
ClusterCertificatePut represents the certificate and key pair for all members in a LXD Cluster
2 properties
ClusterPut
object
ClusterPut represents the fields required to bootstrap or join a LXD cluster.
7 properties
ClusterMemberSysInfo
object
10 properties
ClusterMemberState
object
2 properties
ClusterMemberConfigKey
object
The Value field is empty when getting clustering information with GET 1.0/cluster, and should be filled by the joining node when performing a PUT 1.0/cluster j…
5 properties
ClusterMemberStatePost
object
3 properties
StatusCode
integer
Operation
object
Operation represents a LXD background operation
15 properties
ClusterGroupsPost
object
3 properties
ResourcesStoragePoolSpace
object
ResourcesStoragePoolSpace represents the space available to a given storage pool
2 properties
OperationRequestor
object
API extension: operationrequestor.
3 properties
ClusterMembersPost
object
1 property
ClusterMember
object
11 properties
Cluster
object
3 properties
ClusterMemberPut
object
ClusterMemberPut represents the modifiable fields of a LXD cluster member
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

canonical-cluster-api-openapi.yml Raw ↑

Other APIs Canonical publishes across the network.

Snap Store API
AE Profile APIs.io
Charmhub API
AE Profile APIs.io
MAAS API
AE Profile APIs.io
Juju Client / Controller API
AE Profile APIs.io
Launchpad Web Services API
AE Profile APIs.io
Ubuntu Pro Client API
AE Profile APIs.io
Canonical Assertions API
AE Profile APIs.io
Canonical Search API
AE Profile APIs.io
Canonical Snaps API
AE Profile APIs.io
MicroCeph REST API
AE Profile APIs.io
Canonical App Authorization Service API
AE Profile APIs.io
Canonical Application API
AE Profile APIs.io
#Cluster
← Back to C APIs
API Details
ID
canonical:canonical-cluster-api
Base URL
https://api.snapcraft.io
Docs
https://api.snapcraft.io/docs/
Provider
Canonical
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=canonical-cluster-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/canonical-cluster-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Canonical Cluster 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.