Skip to content
DocsOpenAPI spec

    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.

    ParametersExpand Collapse
    body: SandboxClusterCreateParams { instance_type, name, node_count, 3 more }
    instance_type: string

    Instance type of the nodes the sandboxes run on.

    name: string

    Name of the Sandbox Cluster. Unique within its project.

    node_count: number

    Number of nodes the sandboxes run on.

    maximum100
    minimum1
    project_id: string

    ID of the project to create the Sandbox Cluster in.

    region: RegionName

    Region the resource is in.

    One of the following:
    "us-sva-2"
    "us-wdc-1"
    tags?: Array<string>

    Tags to attach to the Sandbox Cluster.

    ReturnsExpand Collapse
    Operation { id, created_at, details, 6 more }

    Operation details.

    id: string

    Unique identifier for the Operation.

    created_at: string

    When the Operation was created.

    formatdate-time
    details: OperationDetails { changes } | null

    Structured details about what an operation is changing.

    changes: OperationChanges { from, to }

    Map of changed field names to their from/to diffs. Keys depend on the parent operation’s kind+type.

    from: string | number | boolean | Array<string>

    Previous value.

    One of the following:
    string
    number
    boolean
    Array<string>
    to: string | number | boolean | Array<string>

    New value.

    One of the following:
    string
    number
    boolean
    Array<string>

    Kind of Operation.

    One of the following:
    "vm"
    "volume"
    "vpc"
    "firewall_rule"
    "nks_cluster"
    "nks_node_pool"
    "sandbox_cluster"
    "bucket"
    project_id: string

    Project ID the Operation belongs to.

    resource_id: string

    ID of the resource that the Operation is acting on.

    Status of the Operation.

    One of the following:
    "pending"
    "running"
    "done"
    "failed"
    "unknown"

    Type of Operation.

    One of the following:
    "create"
    "update"
    "delete"
    "restart"
    updated_at: string

    When the Operation was updated.

    formatdate-time

    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"
    }