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

Incus cluster-groups API

The cluster-groups API from Incus — 3 operation(s) for cluster-groups.

Incus cluster-groups 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-groups. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, and a GitHub repository.

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

7 operations 3 paths 3 schemas 1 DELETE3 GET1 PATCH1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
API Version
1.0
License
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.

cluster-groups 7
GET
/1.0/cluster/groups
Get the cluster groups
cluster_groups_get → 200403500
DELETE
/1.0/cluster/groups/{name}
Delete the cluster group.
cluster_group_delete 1 param → 200400403500
GET
/1.0/cluster/groups/{name}
Get the cluster group
cluster_group_get 1 param → 200403500
PATCH
/1.0/cluster/groups/{name}
Update the cluster group
cluster_group_patch 2 params → 200400403412500
POST
/1.0/cluster/groups/{name}
Rename the cluster group
cluster_group_post 2 params → 200400403500
PUT
/1.0/cluster/groups/{name}
Update the cluster group
cluster_group_put 2 params → 200400403412500
GET
/1.0/cluster/groups?recursion=1
Get the cluster groups
cluster_groups_get_recursion1 → 200403500

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are ClusterGroup (5 properties), ClusterGroupPut (3 properties), ClusterGroupPost (1 property). Each schema is shown below with its type and property counts.

ClusterGroupPost
object
1 property
ClusterGroupPut
object
3 properties
ClusterGroup
object
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

incus-cluster-groups-api-openapi.yml Raw ↑

Other APIs Incus publishes across the network.

Incus certificates API
Incus cluster API
Incus images API
Incus instances API
Incus Metadata API
Incus metrics API
Incus network-acls API
Incus network-address-sets API
Incus network-allocations API
Incus network-forwards API
Incus network-integrations API
Incus network-load-balancers API