10. StorageSets

The StorageSets that volumes are created within, their space usage, and StorageSet-level actions.

Endpoint Summary

GET /api/v1/storagesets

List storagesets

Returns a list of storagesets accessible to the authenticated user.

Authentication: required (PasswordLogin or BearerJWT).

Responses

Response Body (200, StorageSetListResponse)

Example

{
   "storagesets" : [
      {
         "capacity_balancing" : true,
         "encrypted" : false,
         "fips_mode" : false,
         "id" : 1,
         "mlec" : false,
         "name" : "Set 1",
         "nodes_not_responding" : 0,
         "nodes_offline" : 0,
         "nodes_online" : 6,
         "nodes_reconstructing" : 0,
         "nodes_total" : 6,
         "spares_available" : 2,
         "spares_requested" : 2,
         "state" : {
            "conditions" : [],
            "status" : "ok"
         },
         "topology_aware_placement" : false,
         "ure_default" : false,
         "vhosts_total" : 6
      }
   ],
   "total" : 1
}

POST /api/v1/storagesets

Create StorageSet

Creates a new StorageSet with the specified configuration.

Authentication: required (PasswordLogin or BearerJWT).

Request Body (application/json, required)

Schema: StorageSetCreateRequest

Request payload for creating a StorageSet.

Requires a unique StorageSet name. Optional parameters use system defaults when omitted.

Example

{
   "flags" : [
      "mlec"
   ],
   "name" : "Set 1",
   "spares_requested" : 4
}

Responses

Response Body (201, StorageSetCreateResponse)

Example

{
   "id" : 3
}

GET /api/v1/storagesets/{storageset_id}

Get StorageSet details

Returns details for a specific StorageSet by its ID.

Authentication: required (PasswordLogin or BearerJWT).

Parameters

Responses

Response Body (200, StorageSetGetResponse)

Example

{
   "storageset" : {
      "capacity_balancing" : true,
      "encrypted" : false,
      "fips_mode" : false,
      "id" : 1,
      "mlec" : false,
      "name" : "Set 1",
      "nodes_not_responding" : 0,
      "nodes_offline" : 0,
      "nodes_online" : 6,
      "nodes_reconstructing" : 0,
      "nodes_total" : 6,
      "spares_available" : 2,
      "spares_requested" : 2,
      "state" : {
         "conditions" : [],
         "status" : "ok"
      },
      "topology_aware_placement" : false,
      "ure_default" : false,
      "vhosts_total" : 6
   }
}

PATCH /api/v1/storagesets/{storageset_id}

Update StorageSet

Updates an existing StorageSet using PATCH semantics. Only the fields provided in the request are modified.

Authentication: required (PasswordLogin or BearerJWT).

Parameters

Request Body (application/json, required)

Schema: StorageSetPatchRequest

Request payload for updating an existing StorageSet via PATCH.

Example

{
   "capacity_balancing_disabled" : false,
   "name" : "Set 3",
   "spares_requested" : 3
}

Responses

DELETE /api/v1/storagesets/{storageset_id}

Delete StorageSet

Deletes a StorageSet by its ID.

Authentication: required (PasswordLogin or BearerJWT).

Parameters

Responses

POST /api/v1/storagesets/{storageset_id}/actions

Perform StorageSet Action

Performs an action on a StorageSet. Currently supports “add_storage” action to add unassigned storage nodes (dataserials). The add_storage action supports “add_spare” mode to expand capacity with optional spare adjustment, or “migration” mode to add storage for draining another enclosure. A vhost adds its capacity later, not at once. Each of its VPODs joins the StorageSet after it installs and boots, which takes tens of minutes. Until the first VPOD joins, the StorageSet reports the “activating” condition.

Authentication: required (PasswordLogin or BearerJWT).

Parameters

Request Body (application/json, required)

Schema: StorageSetAddStorageActionRequest

Request to perform an add_storage action on a StorageSet.

Responses

GET /api/v1/storagesets/{storageset_id}/space

Get StorageSet space

Returns detailed space usage for a specific StorageSet: raw, usable, and reserved capacity buckets (each with total/free/used), plus volume/node counts, capacity-balancing state, and volume hard quota.

Authentication: required (PasswordLogin or BearerJWT).

Parameters

Responses

Response Body (200, StorageSetSpaceResponse)

Example

{
   "capacity_balancing_active" : true,
   "node_count" : 6,
   "raw" : {
      "free" : 333884440576,
      "total" : 333900152832,
      "used" : 15712256
   },
   "reserved" : {
      "free" : 55650041856,
      "total" : 55650041856,
      "used" : 0
   },
   "usable" : {
      "free" : 278234398720,
      "total" : 278250110976,
      "used" : 15712256
   },
   "volume_hard_quota" : 524288000
}