Method: projects.locations.workstationClusters.workstationConfigs.workstations.start

Starts running a workstation so that users can connect to it.

HTTP request

POST https://workstations.googleapis.com/v1beta/{name=projects/*/locations/*/workstationClusters/*/workstationConfigs/*/workstations/*}:start

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. Name of the workstation to start.

Request body

The request body contains data with the following structure:

JSON representation 
{
  "validateOnly": boolean,
  "etag": string,
  "boostConfig": string
}
Fields
validateOnly

boolean

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

string

Optional. If set, the request will be rejected if the latest version of the workstation on the server does not have this ETag.
boostConfig

string

Optional. If set, the workstation starts using the boost configuration with the specified ID.

Response body

If successful, the response body contains an instance of Operation.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.