## Update Sandbox Cluster

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

Update a Sandbox Cluster's name and tags

### Path Parameters

- `sandbox_cluster_id: string`

### Body Parameters

- `name: optional string`

  Name of the Sandbox Cluster. Unique within its project.

- `tags: optional array of string`

  Tags to attach to the Sandbox Cluster.

### Returns

- `SandboxCluster object { id, created_at, gateway_hostname, 8 more }`

  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`

    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 of string`

    Tags attached to the Sandbox Cluster.

  - `updated_at: string`

    When the Sandbox Cluster was last updated.

### Example

```http
curl https://api.nirvanalabs.io/v1/sandbox_clusters/$SANDBOX_CLUSTER_ID \
    -X PATCH \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $NIRVANA_LABS_API_KEY" \
    -d '{
          "name": "my-sandboxes",
          "tags": [
            "production",
            "agents"
          ]
        }'
```

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