Method: users.environments.start

Starts an existing environment, allowing clients to connect to it. The returned operation will contain an instance of StartEnvironmentMetadata in its metadata field. Users can wait for the environment to start by polling this operation via operations.get. Once the environment has finished starting and is ready to accept connections, the operation will contain a StartEnvironmentResponse in its response field.

HTTP request

POST https://cloudshell.googleapis.com/v1alpha1/{name=users/*/environments/*}:start

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Name of the resource that should be started, for example users/me/environments/default or users/someone@example.com/environments/default.

Request body

The request body contains data with the following structure:

JSON representation
{
  "accessToken": string
}
Fields
accessToken

string

The initial access token passed to the environment. If this is present and valid, the environment will be pre-authenticated with gcloud so that the user can run gcloud commands in Cloud Shell without having to log in. This code can be updated later by calling environments.authorize.

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.

Try it!

Was this page helpful? Let us know how we did:

Send feedback about...

Cloud Shell