Clusters

Create a node group in a cluster

Creates a node group and adds it to an existing Kubernetes cluster with a specified number of worker nodes of the selected flavor.

post/core/clusters/{cluster_id}/node-groups

Request

  • Base URL: https://infrahub-api.nexgencloud.com/v1
  • URL: https://infrahub-api.nexgencloud.com/v1/core/clusters/{cluster_id}/node-groups
  • Auth: API key in header api_key

Path parameters

cluster_idinteger required

ID of the cluster.

Request body

flavor_namestring required

Name of the flavor (machine type), see List flavors.

namestring required

Name of the cluster node group.

role'worker' required

Role assigned to the user.

countinteger

Number of items returned in the current page.

min_countinteger

Minimum number of nodes the group will scale down to.

max_countinteger

Maximum number of nodes the group will scale up to.

firewall_idsinteger[]

IDs of the firewalls to apply to all nodes in this node group.

Example request

{
  "role": "worker"
}

Response

Success

statusboolean

Whether the request succeeded.

messagestring

Human-readable description of the result.

Example response

{
  "message": "Cluster 1617 is reconciling",
  "node_group": {
    "id": 4501,
    "name": "default",
    "role": "worker",
    "flavor": {
      "id": 4501,
      "name": "n1-cpu-small",
      "cpu": 4,
      "ram": 4,
      "disk": 100
    },
    "count": 1,
    "min_count": 1,
    "max_count": 1,
    "created_at": "2026-05-07T09:21:55Z",
    "updated_at": "2026-05-07T09:21:55Z"
  },
  "nodes": [
    {
      "id": 3287,
      "role": "bastion",
      "instance": {
        "id": 7613,
        "name": "example-c1-bastion-0",
        "status": "CREATING",
        "fixed_ip": "192.0.2.42",
        "floating_ip": "192.0.2.91",
        "floating_ip_status": "ATTACHING",
        "image_id": 7613
      },
      "status": "CREATING",
      "status_reason": "VM is creating",
      "is_bastion": true,
      "requires_public_ip": true,
      "created_at": "2026-05-06T16:04:09Z",
      "updated_at": "2026-05-06T16:04:09Z"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.