Create Training Cluster — API

Query parameters

project_idQueryintegerrequired
Project ID
active_iamQueryintegeroptional
Active IAM ID (To access contact person account) Find your Active IAM ID here
locationQuerystringrequired
Location

Request body

application/json

object

namestringrequired

Name of the training cluster.

image_version_idintegerrequired

ID of the image version to use for cluster nodes (Ubuntu Slurm or NeMo).

ssh_key_idsarrayrequired

List of SSH key IDs to attach to the cluster login node.

security_group_idintegerrequired

Security group ID controlling inbound and outbound traffic to cluster nodes.

script_addedboolean

Whether a lifecycle script has been provided.

lifecycle_scriptstring

Script executed on each node after the cluster starts.

sfs_mount_listarray

Shared File System volumes to mount on cluster nodes.

pfs_mount_listarray

Parallel File System volumes to mount on cluster nodes.

dataset_mount_listarray

Read-only dataset volumes to mount on cluster nodes.

sku_idintegerrequired

SKU ID for the cluster node type.

no_of_nodesintegerrequired

Number of nodes in the cluster.

sku_item_price_idintegerrequired

SKU item price ID for the cluster plan. This value is region-specific.

Responses

201Cluster created successfully.

object

codeinteger

example201

dataobject

errorsobject

messagestring

exampleCluster created successfully

400Bad request due to invalid parameters.

object

codeinteger

example400

errorsobject

messagestring

exampleBad Request

401Unauthorized — missing or invalid API key.

object

codeinteger

example401

messagestring

exampleUnauthorized access.

Request

curl -X POST 'https://api.e2enetworks.com/myaccount/api/v1/gpu/distributed_jobs_v2/cluster/?project_id=%3Cproject_id%3E&active_iam=%3Cactive_iam%3E&location=%3Clocation%3E&apikey=%3Capikey%3E' \
  -H 'Authorization: Bearer <JWT>' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "string",
  "image_version_id": 0,
  "ssh_key_ids": [
    0
  ],
  "security_group_id": 0,
  "script_added": false,
  "lifecycle_script": "string",
  "sfs_mount_list": [
    {
      "id": 0,
      "name": "string",
      "mount_path": "string"
    }
  ],
  "pfs_mount_list": [
    {}
  ],
  "dataset_mount_list": [
    {}
  ],
  "sku_id": 0,
  "no_of_nodes": 0,
  "sku_item_price_id": 0
}'

Response · 201

{
  "code": 201,
  "data": {
    "id": 101,
    "name": "training-cluster-010125103045",
    "created_by": {
      "id": 1001,
      "name": "John Doe",
      "email": "user@example.com",
      "username": "user@example.com",
      "is_primary_contact": true,
      "currency": "INR",
      "is_suspended": false
    },
    "no_of_nodes": 1,
    "created_at": "2025-01-15T10:30:00Z",
    "private_cloud_id": null,
    "private_cloud_name": null,
    "sku_details": {
      "specs": {
        "sku_id": 139,
        "name": "C3.32GB",
        "series": "CPU",
        "cpu": 8,
        "gpu": 0,
        "memory": 32,
        "ephemeral_storage": 0,
        "gpu_memory": 0,
        "is_free": false,
        "is_active": true,
        "local_storage_in_gb": 0,
        "sku_type": "C3-250GB",
        "gpu_card_type": null,
        "category": "distributed_job",
        "variant": "e2e",
        "no_of_nodes": 1
      },
      "plan": {
        "sku_item_price_id": 645,
        "sku_type": "hourly",
        "committed_days": 0,
        "unit_price": 12.3,
        "currency": "INR",
        "is_active": true,
        "description": null,
        "location": "Delhi"
      }
    },
    "total_gpu": 0,
    "total_cpu": 0,
    "total_memory": "0 GB",
    "available_gpu": 0,
    "available_cpu": 0,
    "available_memory": "0 GB",
    "worker_nodes": [],
    "has_local_storage": false,
    "local_storage_per_node": null,
    "status": "Creating",
    "image_pull_policy": "IfNotPresent",
    "image_version": {
      "id": 2,
      "version": "v2-slurm25.11-ubuntu24.04",
      "description": "",
      "tags": [],
      "name": "Ubuntu Slurm",
      "slug_name": "ubuntu-slurm",
      "framework": "Slurm",
      "is_internal": false
    },
    "ssh_keys": [
      {
        "pk": 1001,
        "label": "my-ssh-key",
        "ssh_key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAB... user@example.com"
      }
    ],
    "ssh_public_ip": "",
    "has_floating_ip": true,
    "reserve_ip": [],
    "clone_data": {
      "name": "training-cluster-010125103045",
      "image_version_id": 2,
      "ssh_key_ids": [
        1001
      ],
      "security_group_id": 1001,
      "script_added": false,
      "lifecycle_script": "",
      "sfs_mount_list": [],
      "pfs_mount_list": [],
      "dataset_mount_list": [],
      "sku_id": 139,
      "no_of_nodes": 1,
      "sku_item_price_id": 645,
      "project_id": 10001
    }
  },
  "errors": {},
  "message": "Cluster created successfully"
}