## Get Sandbox Cluster

`client.sandboxClusters.get(stringsandboxClusterID, RequestOptionsoptions?): SandboxCluster`

**get** `/v1/sandbox_clusters/{sandbox_cluster_id}`

Get a Sandbox Cluster

### Parameters

- `sandboxClusterID: string`

### Returns

- `SandboxCluster`

  A cluster sandboxes run on, in one region.

  - `id: string`

    Unique identifier for the Sandbox Cluster.

  - `created_at: string`

    When the Sandbox Cluster was created.

  - `gateway_hostname: string | null`

    Hostname sandboxes' endpoints are served on over HTTPS, to allow in outbound firewalls. Null until assigned; a recreated Sandbox Cluster gets a new one.

  - `instance_type: string`

    Instance type of the nodes the sandboxes run on.

  - `name: string`

    Name of the Sandbox Cluster.

  - `node_count: number`

    Number of nodes the sandboxes run on.

  - `project_id: string`

    ID of the project the Sandbox Cluster is in.

  - `region: RegionName`

    Region the resource is in.

    - `"us-sva-2"`

    - `"us-wdc-1"`

  - `status: ResourceStatus`

    Status of the resource.

    - `"pending"`

    - `"creating"`

    - `"updating"`

    - `"ready"`

    - `"deleting"`

    - `"deleted"`

    - `"error"`

    - `"suspended"`

  - `tags: Array<string>`

    Tags attached to the Sandbox Cluster.

  - `updated_at: string`

    When the Sandbox Cluster was last updated.

### Example

```typescript
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 sandboxCluster = await client.sandboxClusters.get('sandbox_cluster_id');

console.log(sandboxCluster.id);
```

#### Response

```json
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "created_at": "2025-01-01T00:00:00Z",
  "gateway_hostname": "gw.0123456789ab.example.com",
  "instance_type": "n1-standard-8",
  "name": "my-sandboxes",
  "node_count": 3,
  "project_id": "123e4567-e89b-12d3-a456-426614174000",
  "region": "us-sva-2",
  "status": "ready",
  "tags": [
    "production",
    "agents"
  ],
  "updated_at": "2025-01-01T00:00:00Z"
}
```
