> This page is for NVIDIA Kubernetes Engine. > For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.nvidia.com/nvke/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.nvidia.com/nvke/_mcp/server. # Create a cluster POST https://nvke.acme.example/api/clusters Content-Type: application/json Creates a cluster and starts provisioning. The cluster is returned before provisioning completes. Returns 400 for, among others: a duplicate cluster name; missing `nico.orgID`, `siteID` or `vpcID`; an unsupported `cniPlugin`; a missing `controlPlaneConfig.nico.release`; a control-plane `maxSurge` greater than 1; a pod CIDR too small for the requested nodes plus surge; a `controlPlaneVIP` inside the pod or service CIDR. Reference: https://docs.nvidia.com/nvke/rest-api-reference/clusters/create-cluster ## Authentication - `Authorization` header (bearer token, required) — A JWT from an issuer the Operator has configured, carried as `Authorization: Bearer `. ## Request ### Body (application/json) This endpoint expects a CreateClusterRequest. - `name` (string, required) — Cluster name. Lowercase DNS label, unique per management plane. Node names are derived from it. - `controlPlaneKubernetesVersion` (string, required) — Kubernetes version for the cluster, as X.Y.Z with no leading "v". - `etcdEncrypted` (boolean, required) — Encrypt etcd at rest. Can be turned on later with `enableEtcdEncryption`; cannot be turned off. - `controlPlaneVIP` (string, optional) — Virtual IP for the API server through kube-vip. Omit to skip kube-vip and use the first control-plane node's IP as the API server endpoint. Must not fall inside the pod or service CIDR. An explicit empty string is rejected. Without a VIP, a new cluster must have exactly one desired control-plane node. Control-plane scale-up above one node, upgrades, and configuration changes that replace control-plane nodes require a VIP. Recreate a no-VIP cluster with controlPlaneVIP to make those operations available. - `network` (ClusterNetworkCreateConfig, optional) — Pod and service network. Immutable after creation. Defaults apply when omitted. - `nodePools` (list of NodePoolCreateConfig, optional) — Initial worker node pools. - `controlPlaneConfig` (CreateClusterControlPlaneConfig, optional) — Writable cluster-level control plane configuration supplied at cluster creation. Required when you create a cluster. `nico` carries the NICo settings for the control-plane nodes; it is required for a NICo cluster. `launchLayer` is required for a LaunchLayer cluster. - `nico` (NicoClusterProvider, optional) — NICo identifiers for the cluster. Fixed at creation. - `launchLayer` (LaunchLayerClusterProvider, optional) — LaunchLayer identifiers for the cluster. Exactly one of vpcID or orgID must be set, and siteID is required. All fields are fixed at creation. ## Response ### 201 Cluster created; provisioning has started - `id` (string, required) — Cluster ID. - `name` (string, required) — Cluster name. - `controlPlaneKubernetesVersion` (string, required) — Desired control-plane Kubernetes version. The running version is in ControlPlaneStatus. - `cniPlugin` (string, required) — CNI plugin. - `cniVersion` (string, required) — CNI version. - `etcdEncrypted` (boolean, required) — Whether etcd is encrypted at rest. - `network` (ClusterNetwork, required) — Pod and service network. - `createdAt` (datetime, required) — Creation time. - `conditions` (ClusterConditions, required) — Lifecycle conditions. - `controlPlaneVIP` (string, optional) — API server VIP, if configured. - `enableCPNodeRecycling` (boolean, optional, default: false) — When true, control-plane upgrades and configuration changes replace nodes automatically. When false, nodes needing replacement are reported as pending and wait for an operator. - `controlPlaneConfig` (ControlPlaneConfig, optional) — Current control-plane configuration. - `nico` (NicoClusterProvider, optional) — NICo identifiers. - `launchLayer` (LaunchLayerClusterProvider, optional) — LaunchLayer identifiers. - `nodeAgentUpgrade` (NodeAgentUpgradeStatus, optional) — The active agent upgrade and latest retry error. ## Errors ### 400 Bad Request Error The request failed validation - `message` (string, required) — What went wrong. ### 401 Unauthorized Error No valid bearer token was presented. - `message` (string, required) — What went wrong. ### 403 Forbidden Error The token verified, but its subject matches no admission rule. - `message` (string, required) — What went wrong. ## Types ### ClusterNetworkCreateConfig Pod and service network. Immutable after creation. Defaults apply when omitted. - `podCIDR` (string, optional) — Comma-separated IPv4 pod CIDRs. Each must be private, with a prefix length from /12 to /23, and must not overlap the others or the service CIDR. Must have room for a /24 per desired node plus surge. Default 192.168.0.0/16. - `serviceCIDR` (string, optional) — IPv4 service CIDR, private, /12 to /24. Default 10.96.0.0/12. ### NodePoolCreateConfig A node pool and its provider settings. The provider follows the cluster's and is fixed at creation. - `name` (string, required) — Unique within the cluster. Immutable. - `nodeNamePrefix` (string, required) — Prefix for generated node names: `--`. The controller assigns suffix as a 4-digit decimal number (0000–9999). Generated names must fit within 63 characters (Kubernetes Node name limit). Maximum prefix length depends on cluster name length. - `desiredNodeCount` (integer, required) — The desired number of nodes in the pool. For control-plane pools, aggregate capacity above 1 requires controlPlaneVIP on the cluster. - `systemReservedMemory` (string, optional, default: 16Gi) — Memory reserved for system daemons. Nodes reserve 16Gi when omitted. - `kubeReservedMemory` (string, optional) — Memory reserved for Kubernetes components. Default 2Gi. - `machineAnnotations` (map from string to string, optional) — Annotations set on CAPI Machines only when they are created, including Machines created during scale-out or replacement. Fixed at node-pool creation. Not reconciled after provisioning. Keys under nke.nvidia.com, nke.io, nvke.nvidia.com, kubernetes.io, k8s.io, cluster.x-k8s.io and their subdomains require an explicit deployment allowlist entry for this metadata type. - `machineLabels` (map from string to string, optional) — Labels set on CAPI Machines only when they are created, including Machines created during scale-out or replacement. Fixed at node-pool creation. Not reconciled after provisioning. Keys under nke.nvidia.com, nke.io, nvke.nvidia.com, kubernetes.io, k8s.io, cluster.x-k8s.io and their subdomains require an explicit deployment allowlist entry for this metadata type. - `nodeLabels` (map from string to string, optional) — Labels applied to the pool's nodes at creation, as a map of keys to values. Keys under nvke.nvidia.com, nke.nvidia.com (legacy), nke.io (legacy), kubernetes.io, k8s.io and their subdomains are reserved, unless the deployment allows specific Kubernetes keys. - `nodeTaints` (list of NodeTaint, optional) — Taints applied to the pool's nodes at creation. Not allowed on control-plane pools. Keys under nvke.nvidia.com, nke.nvidia.com (legacy), nke.io (legacy), kubernetes.io, k8s.io and their subdomains are reserved. Each key and effect pair may appear only once. - `description` (string, optional) — Free-text description. - `autoProvisionDisabled` (boolean, optional, default: false) — Disables automatic provisioning for the pool. - `autoModeDisabled` (boolean, optional, default: false) — Disables auto-mode (automatic node recycling). - `provisioningMonitorDisabled` (boolean, optional, default: false) — When true, nodes stuck in provisioning past the timeout are not recycled automatically. - `recycleBudget` (integer, optional, default: 0) — Maximum number of nodes recycled at once. - `nico` (NicoNodePoolProvider, optional) — NICo settings for a node pool. instanceTypeID and release are required, and exactly one of subnetIDs and vpcPrefixIDs is required. - `launchLayer` (LaunchLayerNodePoolProvider, optional) — LaunchLayer settings for a node pool. instanceType is required, and at most one of hostOSProfile and vmProfile may be set. ### CreateClusterControlPlaneConfig Writable cluster-level control plane configuration supplied at cluster creation. Required when you create a cluster. `nico` carries the NICo settings for the control-plane nodes; it is required for a NICo cluster. `launchLayer` is required for a LaunchLayer cluster. - `desiredCount` (integer, required) — The desired number of cluster-level control plane nodes. Must be at least 1. Values above 1 require controlPlaneVIP on the cluster. - `maxSurge` (integer, optional) — Extra control-plane nodes allowed during a rollout (0 or 1). - `provisioningMonitorDisabled` (boolean, optional, default: false) — When true, nodes stuck in provisioning past the timeout are not replaced automatically. - `systemReservedMemory` (string, optional, default: 16Gi) — Memory reserved for system daemons. Nodes reserve 16Gi when omitted. - `machineAnnotations` (map from string to string, optional) — Annotations applied to control-plane CAPI Machines at creation, including scale-out and replacement Machines. Fixed at cluster creation and not reconciled after provisioning. Keys under nke.nvidia.com, nke.io, nvke.nvidia.com, kubernetes.io, k8s.io, cluster.x-k8s.io and their subdomains require an explicit deployment allowlist entry for this metadata type. - `machineLabels` (map from string to string, optional) — Labels applied to control-plane CAPI Machines at creation, including scale-out and replacement Machines. Fixed at cluster creation and not reconciled after provisioning. Keys under nke.nvidia.com, nke.io, nvke.nvidia.com, kubernetes.io, k8s.io, cluster.x-k8s.io and their subdomains require an explicit deployment allowlist entry for this metadata type. - `nodeLabels` (map from string to string, optional) — Labels applied to control-plane nodes at creation, as a map of keys to values. Keys under nvke.nvidia.com, nke.nvidia.com (legacy), nke.io (legacy), kubernetes.io, k8s.io and their subdomains are reserved, unless the deployment allows specific Kubernetes keys. - `nico` (NicoControlPlaneProviderCreate, optional) — NICo settings for control-plane nodes at creation. release is required, and exactly one of subnetIDs and vpcPrefixIDs is required. - `launchLayer` (LaunchLayerControlPlaneProvider, optional) — LaunchLayer settings for the control-plane nodes. Same shape as LaunchLayerNodePoolProvider — control-plane nodes are still LaunchLayer machines. Fixed at creation. - `nodeAgentConfig` (NodeAgentConfig, optional) — Desired control-plane node-agent configuration. ### NicoClusterProvider NICo identifiers for the cluster. Fixed at creation. - `orgID` (string, optional) — Organization that owns the cluster. - `siteID` (string, optional) — NICo site ID. - `vpcID` (string, optional) — NICo VPC ID. ### LaunchLayerClusterProvider LaunchLayer identifiers for the cluster. Exactly one of vpcID or orgID must be set, and siteID is required. All fields are fixed at creation. - `siteID` (string, required) — Names the LaunchLayer datahall this cluster's machines come from. - `vpcID` (string, optional) — An existing LaunchLayer VPC that CAPLL observes but never deletes. - `orgID` (string, optional) — Organization in which CAPLL creates a VPC when vpcID is omitted. - `vpcType` (enum, optional) — Network type for a managed or existing VPC. When omitted, CAPLL treats the VPC as VIRTUALIZED. A VIRTUALIZED security group needs a VIRTUALIZED VPC. - Allowed values: `BARE_METAL`, `VIRTUALIZED` - `cloudProviderEnabled` (boolean, optional) — Set true where a cloud controller manager runs, so CAPLL leaves the Node's provider ID to it. NVKE runs no CCM, so true is rejected. - `owner` (LaunchLayerClusterOwner, optional) — The LaunchLayer identity requests are attributed to. - `securityGroups` (list of LaunchLayerSecurityGroup, optional) — Security groups CAPLL creates with the cluster and deletes with it. ### ClusterNetwork Pod and service network in effect. Both fields are always present. - `podCIDR` (string, required) — Comma-separated IPv4 pod CIDRs in effect. - `serviceCIDR` (string, required) — IPv4 service CIDR in effect. ### ClusterConditions Lifecycle conditions of a cluster. Each is a Condition. - `provisioning` (Condition, required) — The cluster is provisioning. - `provisioned` (Condition, required) — The cluster is provisioned. - `deleting` (Condition, required) — The cluster is being deleted. - `cpNodesRecycling` (Condition, optional) — Control-plane nodes are being replaced. - `controlPlaneUpgrading` (Condition, optional) — The control plane is being upgraded. - `updateInProgress` (UpdateInProgress, optional) — The mutually exclusive cluster operation in progress, if any. Absent when none. - `updateFailed` (Condition, optional) — The most recent cluster update failed. ### ControlPlaneConfig The control-plane configuration in effect, including the desired node-agent version. - `configurationId` (string, optional) — ID of the current configuration snapshot. - `desiredCount` (integer, optional) — The desired number of cluster-level control plane nodes. Creating a cluster with or increasing this count above 1 requires controlPlaneVIP on the cluster. - `maxSurge` (integer, optional) — Extra control-plane nodes allowed during a rollout (0 or 1). - `provisioningMonitorDisabled` (boolean, optional) — When true, nodes stuck in provisioning past the timeout are not replaced automatically. - `systemReservedMemory` (string, optional) — Memory reserved for system daemons. Nodes reserve 16Gi when omitted. - `machineAnnotations` (map from string to string, optional) — Annotations applied to control-plane CAPI Machines at creation, including scale-out and replacement Machines. Fixed at cluster creation and not reconciled after provisioning. Keys under nke.nvidia.com, nke.io, nvke.nvidia.com, kubernetes.io, k8s.io, cluster.x-k8s.io and their subdomains require an explicit deployment allowlist entry for this metadata type. - `machineLabels` (map from string to string, optional) — Labels applied to control-plane CAPI Machines at creation, including scale-out and replacement Machines. Fixed at cluster creation and not reconciled after provisioning. Keys under nke.nvidia.com, nke.io, nvke.nvidia.com, kubernetes.io, k8s.io, cluster.x-k8s.io and their subdomains require an explicit deployment allowlist entry for this metadata type. - `nodeLabels` (map from string to string, optional) — Labels applied to control-plane nodes, as a map of keys to values. Set at creation. - `nico` (NicoControlPlaneProvider, optional) — NICo settings for control-plane nodes. - `launchLayer` (LaunchLayerControlPlaneProvider, optional) — LaunchLayer settings for control-plane nodes. - `nodeAgentConfig` (NodeAgentConfig, optional) — Desired control-plane node-agent configuration. ### NodeAgentUpgradeStatus The active agent upgrade and latest retry error. - `nodeId` (string, required) — ID of the selected control-plane node. - `targetVersion` (string, required) — Exact version accepted for this upgrade. - `method` (string, required) — Installation method from the controller configuration. - `phase` (enum, required) — Pending before installation starts. Running includes retries. - Allowed values: `Pending`, `Running` - `errorMessage` (string, required) — Latest failure message while retries continue. ### NodeTaint A Kubernetes taint applied to nodes in a pool. - `key` (string, required) — Taint key. - `effect` (enum, required) — Kubernetes taint effect. - Allowed values: `NoSchedule`, `PreferNoSchedule`, `NoExecute` - `value` (string, optional) — Taint value. Empty is valid. ### NicoNodePoolProvider NICo settings for a node pool. instanceTypeID and release are required, and exactly one of subnetIDs and vpcPrefixIDs is required. - `subnetIDs` (list of string, optional) — Subnets, for sites without native networking. - `vpcPrefixIDs` (list of string, optional) — VPC prefixes, for sites with native networking. - `instanceTypeID` (string, optional) — NICo instance type. Fixed at creation. - `infinibandPartitionID` (string, optional) — InfiniBand partition. Fixed at creation. - `nvLinkLogicalPartitionID` (string, optional) — NVLink logical partition. Fixed at creation. - `sshKeyGroupIDs` (list of string, optional) — SSH key groups for node access. Fixed at creation. - `release` (string, optional) — Name of a release the Operator has supplied to the management plane. - `diskSelectionStrategy` (enum, optional) — Which disk the OS is installed on. Default smallest. - Allowed values: `smallest`, `largest` ### LaunchLayerNodePoolProvider LaunchLayer settings for a node pool. instanceType is required, and at most one of hostOSProfile and vmProfile may be set. - `instanceType` (string, required) — Requests capacity of a given shape, for example "vm200". - `hostOSProfile` (string, optional) — Bare-metal profile, as "\" or "\:\". Mutually exclusive with vmProfile. - `vmProfile` (string, optional) — Virtual profile, as "\" or "\:\". Mutually exclusive with hostOSProfile. - `fulfillmentStrategy` (enum, optional) — Controls how the Compute Allocation Operator places the request. - Allowed values: `BEST_EFFORT`, `ALL_OR_NOTHING`, `WAIT_FOR_RESOURCE` - `securityGroupRefs` (LaunchLayerSecurityGroupRefs, optional) — Names of the owning cluster's managed security groups to attach, per network interface. Mutually exclusive with securityGroups (existing group IDs) per interface — CAPLL supports both but NVKE always creates groups through the cluster, so NVKE only exposes refs. ### NicoControlPlaneProviderCreate NICo settings for control-plane nodes at creation. release is required, and exactly one of subnetIDs and vpcPrefixIDs is required. - `instanceTypePreference` (list of string, optional) — Ordered list of acceptable NICo instance types; index 0 is the highest priority. - `subnetIDs` (list of string, optional) — Subnets, for sites without native networking. - `vpcPrefixIDs` (list of string, optional) — VPC prefixes, for sites with native networking. - `release` (string, optional) — Name of a release the Operator has supplied to the management plane. - `sshKeyGroupIDs` (list of string, optional) — SSH key groups for node access. Can be updated. ### LaunchLayerControlPlaneProvider LaunchLayer settings for the control-plane nodes. Same shape as LaunchLayerNodePoolProvider — control-plane nodes are still LaunchLayer machines. Fixed at creation. - `instanceType` (string, required) — Requests capacity of a given shape, for example "vm200". - `hostOSProfile` (string, optional) — Bare-metal profile, as "\" or "\:\". Mutually exclusive with vmProfile. - `vmProfile` (string, optional) — Virtual profile, as "\" or "\:\". Mutually exclusive with hostOSProfile. - `fulfillmentStrategy` (enum, optional) — Controls how the Compute Allocation Operator places the request. - Allowed values: `BEST_EFFORT`, `ALL_OR_NOTHING`, `WAIT_FOR_RESOURCE` - `securityGroupRefs` (LaunchLayerSecurityGroupRefs, optional) — Names of the owning cluster's managed security groups to attach, per network interface. Mutually exclusive with securityGroups (existing group IDs) per interface — CAPLL supports both but NVKE always creates groups through the cluster, so NVKE only exposes refs. ### NodeAgentConfig Desired control-plane node-agent configuration. - `version` (string, optional) — Exact agent release version. An empty value disables agent convergence. ### LaunchLayerClusterOwner The LaunchLayer identity requests are attributed to. - `userID` (string, optional) — LaunchLayer user ID. - `username` (string, optional) — LaunchLayer username. ### LaunchLayerSecurityGroup A security group LaunchLayer creates with the cluster and deletes with it. - `name` (string, required) — Security group name, referenced by node pools via securityGroupRefs. A DNS label of at most 24 characters, unique within the cluster. - `type` (enum, required) — Immutable. A virtual VPC can contain both kinds of groups. - Allowed values: `BARE_METAL`, `VIRTUALIZED` - `networkType` (enum, optional) — Required for a VIRTUALIZED group and rejected for a BARE_METAL group. - Allowed values: `primary`, `secondary` ### Condition A status, when it last changed, and a message. - `status` (enum, required) — Condition status. - Allowed values: `True`, `False`, `Unknown` - `lastTransitionTime` (datetime, required) — When the status last changed. - `message` (string, required) — Human-readable detail. May be empty. ### UpdateInProgress The mutually exclusive cluster operation in progress. Absent when none. - `type` (enum, required) — Operation in progress. - Allowed values: `etcd_encryption`, `k8s_upgrade`, `cp_nodes_recycling`, `oidc_enable` - `startedAt` (datetime, required) — Start time. - `message` (string, optional) — Detail. ### NicoControlPlaneProvider NICo settings for the control-plane nodes, as reported on read. Requests use NicoControlPlaneProviderCreate and NicoControlPlaneProviderUpdate, which omit the fields that direction cannot set. - `instanceTypePreference` (list of string, optional) — Ordered list of acceptable NICo instance types; index 0 is the highest priority. - `subnetIDs` (list of string, optional) — Subnets, for sites without native networking. - `vpcPrefixIDs` (list of string, optional) — VPC prefixes, for sites with native networking. - `release` (string, optional) — Name of a release the Operator has supplied to the management plane. - `diskSelectionStrategy` (enum, optional) — Always smallest for control-plane nodes. Not configurable through the API. - Allowed values: `smallest`, `largest` - `sshKeyGroupIDs` (list of string, optional) — SSH key groups for node access. Can be updated. ### LaunchLayerSecurityGroupRefs Names of the owning cluster's managed security groups to attach, per network interface. Mutually exclusive with securityGroups (existing group IDs) per interface — CAPLL supports both but NVKE always creates groups through the cluster, so NVKE only exposes refs. - `primaryNetworkInterface` (list of string, optional) — Managed security group names to attach to the primary network interface. - `gpuNetworkInterface` (list of string, optional) — Managed security group names to attach to the GPU network interface. ## Examples **Request** ```json { "name": "tenant-a-prod", "controlPlaneKubernetesVersion": "1.33.4", "etcdEncrypted": true, "network": { "podCIDR": "192.168.0.0/16", "serviceCIDR": "10.96.0.0/12" }, "nodePools": [ { "name": "gpu-workers", "nodeNamePrefix": "w", "desiredNodeCount": 2, "systemReservedMemory": "16Gi", "nodeLabels": { "nvidia.com/gpu.present": "true" }, "nodeTaints": [ { "key": "nvidia.com/dedicated", "effect": "NoSchedule", "value": "gpu" } ], "recycleBudget": 1, "nico": { "vpcPrefixIDs": [ "2d4f6b8a-0c2e-4a4f-b6d8-f0c2e4a6b8d0" ], "instanceTypeID": "0d2f4a6c-8e0b-4d2f-9a4c-6e8b0d2f4a6c", "sshKeyGroupIDs": [ "3e5a7c9b-1d3f-4b5a-c7e9-a1d3f5b7c9e1" ], "release": "example-ubuntu-24.04-amd64" } } ], "controlPlaneConfig": { "desiredCount": 3, "maxSurge": 1, "systemReservedMemory": "16Gi", "nico": { "instanceTypePreference": [ "1c3e5a7f-9b1d-4f3e-a5c7-e9b1d3f5a7c9" ], "vpcPrefixIDs": [ "2d4f6b8a-0c2e-4a4f-b6d8-f0c2e4a6b8d0" ], "release": "example-ubuntu-24.04-amd64", "sshKeyGroupIDs": [ "3e5a7c9b-1d3f-4b5a-c7e9-a1d3f5b7c9e1" ] } }, "nico": { "orgID": "dipfedrcvjiw", "siteID": "4f6a8c2e-1b3d-4e5f-a7b9-c1d3e5f7a9b1", "vpcID": "6a8c0e4f-3d5b-4f7a-b9c1-e3f5a7b9c1d3" } } ``` **Response** ```json { "id": "string", "name": "string", "controlPlaneKubernetesVersion": "string", "cniPlugin": "string", "cniVersion": "string", "etcdEncrypted": true, "network": { "podCIDR": "string", "serviceCIDR": "string" }, "createdAt": "2024-01-15T09:30:00Z", "conditions": { "provisioning": { "status": "True", "lastTransitionTime": "2024-01-15T09:30:00Z", "message": "string" }, "provisioned": { "status": "True", "lastTransitionTime": "2024-01-15T09:30:00Z", "message": "string" }, "deleting": { "status": "True", "lastTransitionTime": "2024-01-15T09:30:00Z", "message": "string" }, "cpNodesRecycling": { "status": "True", "lastTransitionTime": "2024-01-15T09:30:00Z", "message": "string" }, "controlPlaneUpgrading": { "status": "True", "lastTransitionTime": "2024-01-15T09:30:00Z", "message": "string" }, "updateInProgress": { "type": "etcd_encryption", "startedAt": "2024-01-15T09:30:00Z", "message": "string" }, "updateFailed": { "status": "True", "lastTransitionTime": "2024-01-15T09:30:00Z", "message": "string" } }, "controlPlaneVIP": "string", "enableCPNodeRecycling": false, "controlPlaneConfig": { "configurationId": "string", "desiredCount": 1, "maxSurge": 1, "provisioningMonitorDisabled": true, "systemReservedMemory": "string", "machineAnnotations": {}, "machineLabels": {}, "nodeLabels": {}, "nico": { "instanceTypePreference": [ "string" ], "subnetIDs": [ "string" ], "vpcPrefixIDs": [ "string" ], "release": "example-ubuntu-24.04-amd64", "diskSelectionStrategy": "smallest", "sshKeyGroupIDs": [ "string" ] }, "launchLayer": { "instanceType": "string", "hostOSProfile": "string", "vmProfile": "string", "fulfillmentStrategy": "BEST_EFFORT", "securityGroupRefs": { "primaryNetworkInterface": [ "string" ], "gpuNetworkInterface": [ "string" ] } }, "nodeAgentConfig": { "version": "string" } }, "nico": { "orgID": "dipfedrcvjiw", "siteID": "string", "vpcID": "string" }, "launchLayer": { "siteID": "string", "vpcID": "string", "orgID": "string", "vpcType": "BARE_METAL", "cloudProviderEnabled": true, "owner": { "userID": "string", "username": "string" }, "securityGroups": [ { "name": "string", "type": "BARE_METAL", "networkType": "primary" } ] }, "nodeAgentUpgrade": { "nodeId": "string", "targetVersion": "string", "method": "string", "phase": "Pending", "errorMessage": "string" } } ``` **SDK Code** ```python Clusters_createCluster_example import requests url = "https://nvke.acme.example/api/clusters" payload = { "name": "tenant-a-prod", "controlPlaneKubernetesVersion": "1.33.4", "etcdEncrypted": True, "network": { "podCIDR": "192.168.0.0/16", "serviceCIDR": "10.96.0.0/12" }, "nodePools": [ { "name": "gpu-workers", "nodeNamePrefix": "w", "desiredNodeCount": 2, "systemReservedMemory": "16Gi", "nodeLabels": { "nvidia.com/gpu.present": "true" }, "nodeTaints": [ { "key": "nvidia.com/dedicated", "effect": "NoSchedule", "value": "gpu" } ], "recycleBudget": 1, "nico": { "vpcPrefixIDs": ["2d4f6b8a-0c2e-4a4f-b6d8-f0c2e4a6b8d0"], "instanceTypeID": "0d2f4a6c-8e0b-4d2f-9a4c-6e8b0d2f4a6c", "sshKeyGroupIDs": ["3e5a7c9b-1d3f-4b5a-c7e9-a1d3f5b7c9e1"], "release": "example-ubuntu-24.04-amd64" } } ], "controlPlaneConfig": { "desiredCount": 3, "maxSurge": 1, "systemReservedMemory": "16Gi", "nico": { "instanceTypePreference": ["1c3e5a7f-9b1d-4f3e-a5c7-e9b1d3f5a7c9"], "vpcPrefixIDs": ["2d4f6b8a-0c2e-4a4f-b6d8-f0c2e4a6b8d0"], "release": "example-ubuntu-24.04-amd64", "sshKeyGroupIDs": ["3e5a7c9b-1d3f-4b5a-c7e9-a1d3f5b7c9e1"] } }, "nico": { "orgID": "dipfedrcvjiw", "siteID": "4f6a8c2e-1b3d-4e5f-a7b9-c1d3e5f7a9b1", "vpcID": "6a8c0e4f-3d5b-4f7a-b9c1-e3f5a7b9c1d3" } } headers = { "Authorization": "Bearer ", "Content-Type": "application/json" } response = requests.post(url, json=payload, headers=headers) print(response.json()) ``` ```javascript Clusters_createCluster_example const url = 'https://nvke.acme.example/api/clusters'; const options = { method: 'POST', headers: {Authorization: 'Bearer ', 'Content-Type': 'application/json'}, body: '{"name":"tenant-a-prod","controlPlaneKubernetesVersion":"1.33.4","etcdEncrypted":true,"network":{"podCIDR":"192.168.0.0/16","serviceCIDR":"10.96.0.0/12"},"nodePools":[{"name":"gpu-workers","nodeNamePrefix":"w","desiredNodeCount":2,"systemReservedMemory":"16Gi","nodeLabels":{"nvidia.com/gpu.present":"true"},"nodeTaints":[{"key":"nvidia.com/dedicated","effect":"NoSchedule","value":"gpu"}],"recycleBudget":1,"nico":{"vpcPrefixIDs":["2d4f6b8a-0c2e-4a4f-b6d8-f0c2e4a6b8d0"],"instanceTypeID":"0d2f4a6c-8e0b-4d2f-9a4c-6e8b0d2f4a6c","sshKeyGroupIDs":["3e5a7c9b-1d3f-4b5a-c7e9-a1d3f5b7c9e1"],"release":"example-ubuntu-24.04-amd64"}}],"controlPlaneConfig":{"desiredCount":3,"maxSurge":1,"systemReservedMemory":"16Gi","nico":{"instanceTypePreference":["1c3e5a7f-9b1d-4f3e-a5c7-e9b1d3f5a7c9"],"vpcPrefixIDs":["2d4f6b8a-0c2e-4a4f-b6d8-f0c2e4a6b8d0"],"release":"example-ubuntu-24.04-amd64","sshKeyGroupIDs":["3e5a7c9b-1d3f-4b5a-c7e9-a1d3f5b7c9e1"]}},"nico":{"orgID":"dipfedrcvjiw","siteID":"4f6a8c2e-1b3d-4e5f-a7b9-c1d3e5f7a9b1","vpcID":"6a8c0e4f-3d5b-4f7a-b9c1-e3f5a7b9c1d3"}}' }; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go Clusters_createCluster_example package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "https://nvke.acme.example/api/clusters" payload := strings.NewReader("{\n \"name\": \"tenant-a-prod\",\n \"controlPlaneKubernetesVersion\": \"1.33.4\",\n \"etcdEncrypted\": true,\n \"network\": {\n \"podCIDR\": \"192.168.0.0/16\",\n \"serviceCIDR\": \"10.96.0.0/12\"\n },\n \"nodePools\": [\n {\n \"name\": \"gpu-workers\",\n \"nodeNamePrefix\": \"w\",\n \"desiredNodeCount\": 2,\n \"systemReservedMemory\": \"16Gi\",\n \"nodeLabels\": {\n \"nvidia.com/gpu.present\": \"true\"\n },\n \"nodeTaints\": [\n {\n \"key\": \"nvidia.com/dedicated\",\n \"effect\": \"NoSchedule\",\n \"value\": \"gpu\"\n }\n ],\n \"recycleBudget\": 1,\n \"nico\": {\n \"vpcPrefixIDs\": [\n \"2d4f6b8a-0c2e-4a4f-b6d8-f0c2e4a6b8d0\"\n ],\n \"instanceTypeID\": \"0d2f4a6c-8e0b-4d2f-9a4c-6e8b0d2f4a6c\",\n \"sshKeyGroupIDs\": [\n \"3e5a7c9b-1d3f-4b5a-c7e9-a1d3f5b7c9e1\"\n ],\n \"release\": \"example-ubuntu-24.04-amd64\"\n }\n }\n ],\n \"controlPlaneConfig\": {\n \"desiredCount\": 3,\n \"maxSurge\": 1,\n \"systemReservedMemory\": \"16Gi\",\n \"nico\": {\n \"instanceTypePreference\": [\n \"1c3e5a7f-9b1d-4f3e-a5c7-e9b1d3f5a7c9\"\n ],\n \"vpcPrefixIDs\": [\n \"2d4f6b8a-0c2e-4a4f-b6d8-f0c2e4a6b8d0\"\n ],\n \"release\": \"example-ubuntu-24.04-amd64\",\n \"sshKeyGroupIDs\": [\n \"3e5a7c9b-1d3f-4b5a-c7e9-a1d3f5b7c9e1\"\n ]\n }\n },\n \"nico\": {\n \"orgID\": \"dipfedrcvjiw\",\n \"siteID\": \"4f6a8c2e-1b3d-4e5f-a7b9-c1d3e5f7a9b1\",\n \"vpcID\": \"6a8c0e4f-3d5b-4f7a-b9c1-e3f5a7b9c1d3\"\n }\n}") req, _ := http.NewRequest("POST", url, payload) req.Header.Add("Authorization", "Bearer ") req.Header.Add("Content-Type", "application/json") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby Clusters_createCluster_example require 'uri' require 'net/http' url = URI("https://nvke.acme.example/api/clusters") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Post.new(url) request["Authorization"] = 'Bearer ' request["Content-Type"] = 'application/json' request.body = "{\n \"name\": \"tenant-a-prod\",\n \"controlPlaneKubernetesVersion\": \"1.33.4\",\n \"etcdEncrypted\": true,\n \"network\": {\n \"podCIDR\": \"192.168.0.0/16\",\n \"serviceCIDR\": \"10.96.0.0/12\"\n },\n \"nodePools\": [\n {\n \"name\": \"gpu-workers\",\n \"nodeNamePrefix\": \"w\",\n \"desiredNodeCount\": 2,\n \"systemReservedMemory\": \"16Gi\",\n \"nodeLabels\": {\n \"nvidia.com/gpu.present\": \"true\"\n },\n \"nodeTaints\": [\n {\n \"key\": \"nvidia.com/dedicated\",\n \"effect\": \"NoSchedule\",\n \"value\": \"gpu\"\n }\n ],\n \"recycleBudget\": 1,\n \"nico\": {\n \"vpcPrefixIDs\": [\n \"2d4f6b8a-0c2e-4a4f-b6d8-f0c2e4a6b8d0\"\n ],\n \"instanceTypeID\": \"0d2f4a6c-8e0b-4d2f-9a4c-6e8b0d2f4a6c\",\n \"sshKeyGroupIDs\": [\n \"3e5a7c9b-1d3f-4b5a-c7e9-a1d3f5b7c9e1\"\n ],\n \"release\": \"example-ubuntu-24.04-amd64\"\n }\n }\n ],\n \"controlPlaneConfig\": {\n \"desiredCount\": 3,\n \"maxSurge\": 1,\n \"systemReservedMemory\": \"16Gi\",\n \"nico\": {\n \"instanceTypePreference\": [\n \"1c3e5a7f-9b1d-4f3e-a5c7-e9b1d3f5a7c9\"\n ],\n \"vpcPrefixIDs\": [\n \"2d4f6b8a-0c2e-4a4f-b6d8-f0c2e4a6b8d0\"\n ],\n \"release\": \"example-ubuntu-24.04-amd64\",\n \"sshKeyGroupIDs\": [\n \"3e5a7c9b-1d3f-4b5a-c7e9-a1d3f5b7c9e1\"\n ]\n }\n },\n \"nico\": {\n \"orgID\": \"dipfedrcvjiw\",\n \"siteID\": \"4f6a8c2e-1b3d-4e5f-a7b9-c1d3e5f7a9b1\",\n \"vpcID\": \"6a8c0e4f-3d5b-4f7a-b9c1-e3f5a7b9c1d3\"\n }\n}" response = http.request(request) puts response.read_body ``` ```java Clusters_createCluster_example import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.post("https://nvke.acme.example/api/clusters") .header("Authorization", "Bearer ") .header("Content-Type", "application/json") .body("{\n \"name\": \"tenant-a-prod\",\n \"controlPlaneKubernetesVersion\": \"1.33.4\",\n \"etcdEncrypted\": true,\n \"network\": {\n \"podCIDR\": \"192.168.0.0/16\",\n \"serviceCIDR\": \"10.96.0.0/12\"\n },\n \"nodePools\": [\n {\n \"name\": \"gpu-workers\",\n \"nodeNamePrefix\": \"w\",\n \"desiredNodeCount\": 2,\n \"systemReservedMemory\": \"16Gi\",\n \"nodeLabels\": {\n \"nvidia.com/gpu.present\": \"true\"\n },\n \"nodeTaints\": [\n {\n \"key\": \"nvidia.com/dedicated\",\n \"effect\": \"NoSchedule\",\n \"value\": \"gpu\"\n }\n ],\n \"recycleBudget\": 1,\n \"nico\": {\n \"vpcPrefixIDs\": [\n \"2d4f6b8a-0c2e-4a4f-b6d8-f0c2e4a6b8d0\"\n ],\n \"instanceTypeID\": \"0d2f4a6c-8e0b-4d2f-9a4c-6e8b0d2f4a6c\",\n \"sshKeyGroupIDs\": [\n \"3e5a7c9b-1d3f-4b5a-c7e9-a1d3f5b7c9e1\"\n ],\n \"release\": \"example-ubuntu-24.04-amd64\"\n }\n }\n ],\n \"controlPlaneConfig\": {\n \"desiredCount\": 3,\n \"maxSurge\": 1,\n \"systemReservedMemory\": \"16Gi\",\n \"nico\": {\n \"instanceTypePreference\": [\n \"1c3e5a7f-9b1d-4f3e-a5c7-e9b1d3f5a7c9\"\n ],\n \"vpcPrefixIDs\": [\n \"2d4f6b8a-0c2e-4a4f-b6d8-f0c2e4a6b8d0\"\n ],\n \"release\": \"example-ubuntu-24.04-amd64\",\n \"sshKeyGroupIDs\": [\n \"3e5a7c9b-1d3f-4b5a-c7e9-a1d3f5b7c9e1\"\n ]\n }\n },\n \"nico\": {\n \"orgID\": \"dipfedrcvjiw\",\n \"siteID\": \"4f6a8c2e-1b3d-4e5f-a7b9-c1d3e5f7a9b1\",\n \"vpcID\": \"6a8c0e4f-3d5b-4f7a-b9c1-e3f5a7b9c1d3\"\n }\n}") .asString(); ``` ```php Clusters_createCluster_example request('POST', 'https://nvke.acme.example/api/clusters', [ 'body' => '{ "name": "tenant-a-prod", "controlPlaneKubernetesVersion": "1.33.4", "etcdEncrypted": true, "network": { "podCIDR": "192.168.0.0/16", "serviceCIDR": "10.96.0.0/12" }, "nodePools": [ { "name": "gpu-workers", "nodeNamePrefix": "w", "desiredNodeCount": 2, "systemReservedMemory": "16Gi", "nodeLabels": { "nvidia.com/gpu.present": "true" }, "nodeTaints": [ { "key": "nvidia.com/dedicated", "effect": "NoSchedule", "value": "gpu" } ], "recycleBudget": 1, "nico": { "vpcPrefixIDs": [ "2d4f6b8a-0c2e-4a4f-b6d8-f0c2e4a6b8d0" ], "instanceTypeID": "0d2f4a6c-8e0b-4d2f-9a4c-6e8b0d2f4a6c", "sshKeyGroupIDs": [ "3e5a7c9b-1d3f-4b5a-c7e9-a1d3f5b7c9e1" ], "release": "example-ubuntu-24.04-amd64" } } ], "controlPlaneConfig": { "desiredCount": 3, "maxSurge": 1, "systemReservedMemory": "16Gi", "nico": { "instanceTypePreference": [ "1c3e5a7f-9b1d-4f3e-a5c7-e9b1d3f5a7c9" ], "vpcPrefixIDs": [ "2d4f6b8a-0c2e-4a4f-b6d8-f0c2e4a6b8d0" ], "release": "example-ubuntu-24.04-amd64", "sshKeyGroupIDs": [ "3e5a7c9b-1d3f-4b5a-c7e9-a1d3f5b7c9e1" ] } }, "nico": { "orgID": "dipfedrcvjiw", "siteID": "4f6a8c2e-1b3d-4e5f-a7b9-c1d3e5f7a9b1", "vpcID": "6a8c0e4f-3d5b-4f7a-b9c1-e3f5a7b9c1d3" } }', 'headers' => [ 'Authorization' => 'Bearer ', 'Content-Type' => 'application/json', ], ]); echo $response->getBody(); ``` ```csharp Clusters_createCluster_example using RestSharp; var client = new RestClient("https://nvke.acme.example/api/clusters"); var request = new RestRequest(Method.POST); request.AddHeader("Authorization", "Bearer "); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{\n \"name\": \"tenant-a-prod\",\n \"controlPlaneKubernetesVersion\": \"1.33.4\",\n \"etcdEncrypted\": true,\n \"network\": {\n \"podCIDR\": \"192.168.0.0/16\",\n \"serviceCIDR\": \"10.96.0.0/12\"\n },\n \"nodePools\": [\n {\n \"name\": \"gpu-workers\",\n \"nodeNamePrefix\": \"w\",\n \"desiredNodeCount\": 2,\n \"systemReservedMemory\": \"16Gi\",\n \"nodeLabels\": {\n \"nvidia.com/gpu.present\": \"true\"\n },\n \"nodeTaints\": [\n {\n \"key\": \"nvidia.com/dedicated\",\n \"effect\": \"NoSchedule\",\n \"value\": \"gpu\"\n }\n ],\n \"recycleBudget\": 1,\n \"nico\": {\n \"vpcPrefixIDs\": [\n \"2d4f6b8a-0c2e-4a4f-b6d8-f0c2e4a6b8d0\"\n ],\n \"instanceTypeID\": \"0d2f4a6c-8e0b-4d2f-9a4c-6e8b0d2f4a6c\",\n \"sshKeyGroupIDs\": [\n \"3e5a7c9b-1d3f-4b5a-c7e9-a1d3f5b7c9e1\"\n ],\n \"release\": \"example-ubuntu-24.04-amd64\"\n }\n }\n ],\n \"controlPlaneConfig\": {\n \"desiredCount\": 3,\n \"maxSurge\": 1,\n \"systemReservedMemory\": \"16Gi\",\n \"nico\": {\n \"instanceTypePreference\": [\n \"1c3e5a7f-9b1d-4f3e-a5c7-e9b1d3f5a7c9\"\n ],\n \"vpcPrefixIDs\": [\n \"2d4f6b8a-0c2e-4a4f-b6d8-f0c2e4a6b8d0\"\n ],\n \"release\": \"example-ubuntu-24.04-amd64\",\n \"sshKeyGroupIDs\": [\n \"3e5a7c9b-1d3f-4b5a-c7e9-a1d3f5b7c9e1\"\n ]\n }\n },\n \"nico\": {\n \"orgID\": \"dipfedrcvjiw\",\n \"siteID\": \"4f6a8c2e-1b3d-4e5f-a7b9-c1d3e5f7a9b1\",\n \"vpcID\": \"6a8c0e4f-3d5b-4f7a-b9c1-e3f5a7b9c1d3\"\n }\n}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift Clusters_createCluster_example import Foundation let headers = [ "Authorization": "Bearer ", "Content-Type": "application/json" ] let parameters = [ "name": "tenant-a-prod", "controlPlaneKubernetesVersion": "1.33.4", "etcdEncrypted": true, "network": [ "podCIDR": "192.168.0.0/16", "serviceCIDR": "10.96.0.0/12" ], "nodePools": [ [ "name": "gpu-workers", "nodeNamePrefix": "w", "desiredNodeCount": 2, "systemReservedMemory": "16Gi", "nodeLabels": ["nvidia.com/gpu.present": "true"], "nodeTaints": [ [ "key": "nvidia.com/dedicated", "effect": "NoSchedule", "value": "gpu" ] ], "recycleBudget": 1, "nico": [ "vpcPrefixIDs": ["2d4f6b8a-0c2e-4a4f-b6d8-f0c2e4a6b8d0"], "instanceTypeID": "0d2f4a6c-8e0b-4d2f-9a4c-6e8b0d2f4a6c", "sshKeyGroupIDs": ["3e5a7c9b-1d3f-4b5a-c7e9-a1d3f5b7c9e1"], "release": "example-ubuntu-24.04-amd64" ] ] ], "controlPlaneConfig": [ "desiredCount": 3, "maxSurge": 1, "systemReservedMemory": "16Gi", "nico": [ "instanceTypePreference": ["1c3e5a7f-9b1d-4f3e-a5c7-e9b1d3f5a7c9"], "vpcPrefixIDs": ["2d4f6b8a-0c2e-4a4f-b6d8-f0c2e4a6b8d0"], "release": "example-ubuntu-24.04-amd64", "sshKeyGroupIDs": ["3e5a7c9b-1d3f-4b5a-c7e9-a1d3f5b7c9e1"] ] ], "nico": [ "orgID": "dipfedrcvjiw", "siteID": "4f6a8c2e-1b3d-4e5f-a7b9-c1d3e5f7a9b1", "vpcID": "6a8c0e4f-3d5b-4f7a-b9c1-e3f5a7b9c1d3" ] ] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "https://nvke.acme.example/api/clusters")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "POST" request.allHTTPHeaderFields = headers request.httpBody = postData as Data let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```