v1

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

Creates a new workstation cluster.

post/v1/{+parent}/workstationClusters

Path parameters

parentstring required

Required. Parent resource name.

Query parameters

validateOnlyboolean

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

workstationClusterIdstring

Required. ID to use for the workstation cluster.

Request body

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 cluster was soft-deleted.

tagsobject

Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: "123/environment": "production", "123/costCenter": "marketing"

workstationAuthorizationUrlstring

Optional. Specifies the redirect URL for unauthorized requests received by workstation VMs in this cluster. Redirects to this endpoint will send a base64 encoded state query param containing the target workstation name and original request hostname. The endpoint is responsible for retrieving a token using GenerateAccessToken and redirecting back to the original hostname with the token.

workstationLaunchUrlstring

Optional. Specifies the launch URL for workstations in this cluster. Requests sent to unstarted workstations will be redirected to this URL. Requests redirected to the launch endpoint will be sent with a workstation and project query parameter containing the full workstation resource name and project ID, respectively. The launch endpoint is responsible for starting the workstation, polling it until it reaches STATE_RUNNING, and then issuing a redirect to the workstation's host URL.

reconcilingboolean

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

updateTimestring google-datetime

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

labelsobject

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

subnetworkstring

Immutable. Name of the Compute Engine subnetwork in which instances associated with this workstation cluster will be created. Must be part of the subnetwork specified for this workstation cluster.

displayNamestring

Optional. Human-readable name for this workstation cluster.

annotationsobject

Optional. Client-specified annotations.

degradedboolean

Output only. Whether this workstation cluster is in degraded mode, in which case it may require user action to restore full functionality. The conditions field contains detailed information about the status of the cluster.

networkstring

Immutable. Name of the Compute Engine network in which instances associated with this workstation cluster will be created.

namestring

Identifier. Full name of this workstation cluster.

controlPlaneIpstring

Output only. The private IP address of the control plane for this workstation cluster. Workstation VMs need access to this IP address to work with the service, so make sure that your firewall rules allow egress from the workstation VMs to this address.

uidstring

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

createTimestring google-datetime

Output only. Time when this workstation cluster was created.

Response

Successful response