Create Sandbox Cluster
client.sandboxClusters.create(SandboxClusterCreateParams { instance_type, name, node_count, 3 more } body, RequestOptionsoptions?): Operation { id, created_at, details, 6 more }
POST/v1/sandbox_clusters
Create a Sandbox Cluster to run sandboxes on. The infrastructure it runs on is provisioned in a project the platform manages.
Create Sandbox Cluster
import NirvanaLabs from '@nirvana-labs/nirvana';
const client = new NirvanaLabs({
apiKey: process.env['NIRVANA_LABS_API_KEY'], // This is the default and can be omitted
});
const operation = await client.sandboxClusters.create({
instance_type: 'n1-standard-8',
name: 'my-sandboxes',
node_count: 3,
project_id: '123e4567-e89b-12d3-a456-426614174000',
region: 'us-sva-2',
});
console.log(operation.id);{
"id": "123e4567-e89b-12d3-a456-426614174000",
"created_at": "2025-01-01T00:00:00Z",
"details": {
"changes": {
"foo": {
"from": "string",
"to": "string"
}
}
},
"kind": "vm",
"project_id": "123e4567-e89b-12d3-a456-426614174000",
"resource_id": "123e4567-e89b-12d3-a456-426614174000",
"status": "pending",
"type": "create",
"updated_at": "2025-01-01T00:00:00Z"
}Returns Examples
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"created_at": "2025-01-01T00:00:00Z",
"details": {
"changes": {
"foo": {
"from": "string",
"to": "string"
}
}
},
"kind": "vm",
"project_id": "123e4567-e89b-12d3-a456-426614174000",
"resource_id": "123e4567-e89b-12d3-a456-426614174000",
"status": "pending",
"type": "create",
"updated_at": "2025-01-01T00:00:00Z"
}