Creating a Cloud and Nodes

Create a Cloud via the API

Use the POST /v3/flexVM/clouds endpoint with a JSON body.

Example request:

POST /v3/flexVM/clouds
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Content-Type: application/json

{
  "name": "My private cloud",
  "description": "A cloud I would like to use to create VMs in.",
  "site": "frmtl1",
  "instance_type": "bm9.hmm.gpu.4rtx4000.64"
}

The instance_type property indicates the type of Bare Metal servers to use for your Private Cloud.

Currently, the available instance_type values are:

• bm7.hmm.8

• bm9.hmm.gpu.4rtx4000.64

More Bare Metal instance types will be available in the future, once they are validated for VM usage.

Detailed information on the Bare Metal instance types.

Response (201 Created) returns the created Cloud object.

A 409 Conflict is returned when a Cloud with the same name already exists.

Deleting a Cloud

Use the DELETE /v3/flexVM/clouds/{cloudUuid} endpoint.

Example request:

DELETE /v3/flexVM/clouds/{cloudUuid}
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY

Response (204 No Content) is returned on success.

A Cloud cannot be deleted while it still has active VMs.

Scaling Nodes

Nodes are the bare-metal servers that provide the capacity for your Cloud's VMs. You scale a Cloud by adding or removing Nodes. New Nodes use the Cloud's instance type and location, so no request body is required.

Add a Node

Use the POST /v3/flexVM/clouds/{cloudUuid}/nodes endpoint.

Example request:

POST /v3/flexVM/clouds/{cloudUuid}/nodes
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY

Response (201 Created) returns the new Node object. The Node is provisioned asynchronously and becomes available to host VMs once provisioning completes; retrieve it with GET /v3/flexVM/clouds/{cloudUuid}/nodes/{nodeUuid}.

Remove a Node

Use the DELETE /v3/flexVM/clouds/{cloudUuid}/nodes/{nodeUuid} endpoint.

Example request:

DELETE /v3/flexVM/clouds/{cloudUuid}/nodes/{nodeUuid}
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY

Response (202 Accepted) is returned — the Node is released asynchronously.

A 409 Conflict is returned when the Node still hosts active VMs (node_has_vms) — move or delete those VMs first — or when the Node is not in a deletable state (node_not_running), e.g. it is still provisioning or already being removed.