Sign in

v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-13204997.1 KB
projects

Updates an existing workstation.

patch/v1/{+name}

Path parameters

namestring required

Identifier. Full name of this workstation.

Query parameters

allowMissingboolean

Optional. If set and the workstation is not found, a new workstation is created. In this situation, update_mask is ignored.

updateMaskstring

Required. Mask specifying which fields in the workstation should be updated.

validateOnlyboolean

Optional. If set, validate the request and preview the result, but do not actually apply it.

Request body

envobject

Optional. Environment variables passed to the workstation container's entrypoint.

startTimestring google-datetime

Output only. Time when this workstation was most recently successfully started, regardless of the workstation's initial state.

etagstring

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.

deleteTimestring 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.

sourceWorkstationstring

Optional. The source workstation from which this workstation's persistent directories were cloned on creation.

kmsKeystring

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/*.

reconcilingboolean

Output only. Indicates whether this workstation is currently being updated to match its intended state.

updateTimestring google-datetime

Output only. Time when this workstation was most recently updated.

hoststring

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

annotationsobject

Optional. Client-specified annotations.

labelsobject

Optional. Labels that are applied to the workstation and that are also propagated to the underlying Compute Engine resources.

displayNamestring

Optional. Human-readable name for this workstation.

namestring

Identifier. Full name of this workstation.

uidstring

Output only. A system-assigned unique identifier for this workstation.

createTimestring google-datetime

Output only. Time when this workstation was created.

Response

Successful response