---
title: "PATCH /v1/{+name}"
method: PATCH
path: "/v1/{+name}"
tags: ["projects"]
---

# PATCH /v1/{+name}

`PATCH /v1/{+name}`

Updates an existing workstation.

## Path parameters

- `name` string, required

## Query parameters

- `allowMissing` boolean
- `updateMask` string
- `validateOnly` boolean

## Request body

- Workstation — A single instance of a developer workstation with its own persistent storage.
  - `env` object — Optional. Environment variables passed to the workstation container's entrypoint.
  - `runtimeHost` RuntimeHost — Runtime host for the workstation.
    - `gceInstanceHost` GceInstanceHost — The Compute Engine instance host.
      - `name` string — Optional. Output only. The name of the Compute Engine instance.
      - `id` string — Optional. Output only. The ID of the Compute Engine instance.
      - `zone` string — Optional. Output only. The zone of the Compute Engine instance.
  - `startTime` string, google-datetime — Output only. Time when this workstation was most recently successfully started, regardless of the workstation's initial state.
  - `etag` string — Optional. Checksum computed by the server. May be sent on update and delete requests to make sure that the client has an up-to-date value before proceeding.
  - `deleteTime` string, google-datetime — Output only. Time when this workstation was soft-deleted.
  - `state` 'STATE_UNSPECIFIED' | 'STATE_STARTING' | 'STATE_RUNNING' | 'STATE_STOPPING' | 'STATE_STOPPED' — Output only. Current state of the workstation.
  - `sourceWorkstation` string — Optional. The source workstation from which this workstation's persistent directories were cloned on creation.
  - `kmsKey` string — Output only. The name of the Google Cloud KMS encryption key used to encrypt this workstation. The KMS key can only be configured in the WorkstationConfig. The expected format is `projects/*/locations/*/keyRings/*/cryptoKeys/*`.
  - `reconciling` boolean — Output only. Indicates whether this workstation is currently being updated to match its intended state.
  - `updateTime` string, google-datetime — Output only. Time when this workstation was most recently updated.
  - `host` string — Output only. Host to which clients can send HTTPS traffic that will be received by the workstation. Authorized traffic will be received to the workstation as HTTP on port 80. To send traffic to a different port, clients may prefix the host with the destination port in the format `{port}-{host}`.
  - `persistentDirectories` WorkstationPersistentDirectory[] — Optional. Directories to persist across workstation sessions.
    - `mountPath` string — Optional. The mount path of the persistent directory.
    - `sizeGb` integer — Optional. Size of the persistent directory in GB. If specified in an update request, this is the desired size of the directory.
  - `annotations` object — Optional. Client-specified annotations.
  - `labels` object — Optional. [Labels](https://cloud.google.com/workstations/docs/label-resources) that are applied to the workstation and that are also propagated to the underlying Compute Engine resources.
  - `displayName` string — Optional. Human-readable name for this workstation.
  - `name` string — Identifier. Full name of this workstation.
  - `uid` string — Output only. A system-assigned unique identifier for this workstation.
  - `createTime` string, google-datetime — Output only. Time when this workstation was created.

## Response `200`

Successful response

---

[API](https://skmtc.dev/google/apis/workstations.md) · [All operations](https://skmtc.dev/google/apis/workstations/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/google/workstations/revisions/fb7c28fdc534/schema)