Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Kin Lane

Chat with Kin

AI assistant · trained on my blog

Incus

Incus cluster API

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

Documentation Provider Profile APIs.io OpenAPI GitHub

Incus cluster API is one of 22 APIs that Incus 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, authentication docs, and a GitHub repository.

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

14 operations 7 paths 17 schemas 1 DELETE5 GET1 PATCH4 POST3 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
API Version
1.0
Contact
Incus upstream
License
Apache-2.0
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 1 param → 200400403412500
PUT
/1.0/cluster/certificate
Update the certificate for the cluster
clustering_update_cert 1 param → 200400403500
POST
/1.0/cluster/groups
Create a cluster group.
cluster_groups_post 1 param → 200400403500
GET
/1.0/cluster/members
Get the cluster members
cluster_members_get 1 param → 200403500
POST
/1.0/cluster/members
Request a join token
cluster_members_post 1 param → 202400403500
DELETE
/1.0/cluster/members/{name}
Delete the cluster member
cluster_member_delete 1 param → 200400403500
GET
/1.0/cluster/members/{name}
Get the cluster member
cluster_member_get 1 param → 200403500
PATCH
/1.0/cluster/members/{name}
Partially update the cluster member
cluster_member_patch 2 params → 200400403412500
POST
/1.0/cluster/members/{name}
Rename the cluster member
cluster_member_post 2 params → 200400403500
PUT
/1.0/cluster/members/{name}
Update the cluster member
cluster_member_put 2 params → 200400403412500
GET
/1.0/cluster/members/{name}/state
Get state of the cluster member
cluster_member_state_get 1 param → 200403500
POST
/1.0/cluster/members/{name}/state
Evacuate or restore a cluster member
cluster_member_state_post 2 params → 202400403500
GET
/1.0/cluster/members?recursion=1
Get the cluster members
cluster_members_get_recursion1 1 param → 200403500

Schemas 17

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

StatusCode
integer
ClusterMemberPost
object
1 property
StoragePoolState
object
2 properties
ResourcesStoragePoolSpace
object
ResourcesStoragePoolSpace represents the space available to a given storage pool
2 properties
ClusterMemberState
object
2 properties
ClusterMemberStatePost
object
2 properties
ClusterGroupsPost
object
4 properties
ResourcesStoragePoolInodes
object
ResourcesStoragePoolInodes represents the inodes available to a given storage pool
2 properties
ClusterMemberPut
object
ClusterMemberPut represents the modifiable fields of a cluster member
5 properties
ClusterMembersPost
object
1 property
Cluster
object
3 properties
ClusterMember
object
11 properties
Operation
object
Operation represents a background operation
12 properties
ClusterPut
object
7 properties
ClusterMemberSysInfo
object
9 properties
ClusterCertificatePut
object
ClusterCertificatePut represents the certificate and key pair for all cluster members
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 server when performing a PUT 1.0/cluster…
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

incus-cluster-api-openapi.yml Raw ↑

Other APIs Incus publishes across the network.

Incus certificates API
AE Profile APIs.io
Incus cluster-groups API
AE Profile APIs.io
Incus images API
AE Profile APIs.io
Incus instances API
AE Profile APIs.io
Incus Metadata API
AE Profile APIs.io
Incus metrics API
AE Profile APIs.io
Incus network-acls API
AE Profile APIs.io
Incus network-address-sets API
AE Profile APIs.io
Incus network-allocations API
AE Profile APIs.io
Incus network-forwards API
AE Profile APIs.io
Incus network-integrations API
AE Profile APIs.io
Incus network-load-balancers API
AE Profile APIs.io
#cluster
← Back to I APIs
API Details
ID
incus:incus-cluster-api
Docs
https://linuxcontainers.org/incus/docs/main/rest-api/
Provider
Incus
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network