Post v1+name:start — cloudshell

v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-1382123.9 KB

users

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 GetOperation. Once the environment has finished starting and is ready to accept connections, the operation will contain a StartEnvironmentResponse in its response field.

post/v1/{+name}:start

Path parameters

namestring required

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

Request body

accessTokenstring

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

publicKeysstring[]

Public keys that should be added to the environment before it is started.

Response

Successful response