Cloud Shell API

Allows users to start, configure, and connect to interactive shell sessions running in the cloud.


To call this service, we recommend that you use the Google-provided client libraries. If your application needs to use your own libraries to call this service, use the following information when you make the API requests.

Discovery document

A Discovery Document is a machine-readable specification for describing and consuming REST APIs. It is used to build client libraries, IDE plugins, and other tools that interact with Google APIs. One service may provide multiple discovery documents. This service provides the following discovery document:

Service endpoint

A service endpoint is a base URL that specifies the network address of an API service. One service might have multiple service endpoints. This service has the following service endpoint and all URIs below are relative to this service endpoint:


REST Resource: v1.operations

cancel POST /v1/{name=operations/**}:cancel
Starts asynchronous cancellation on a long-running operation.
delete DELETE /v1/{name=operations/**}
Deletes a long-running operation.
get GET /v1/{name=operations/**}
Gets the latest state of a long-running operation.
list GET /v1/{name}
Lists operations that match the specified filter in the request.

REST Resource: v1.users.environments

addPublicKey POST /v1/{environment=users/*/environments/*}:addPublicKey
Adds a public SSH key to an environment, allowing clients with the corresponding private key to connect to that environment via SSH.
authorize POST /v1/{name=users/*/environments/*}:authorize
Sends OAuth credentials to a running environment on behalf of a user.
get GET /v1/{name=users/*/environments/*}
Gets an environment.
removePublicKey POST /v1/{environment=users/*/environments/*}:removePublicKey
Removes a public SSH key from an environment.
start POST /v1/{name=users/*/environments/*}:start
Starts an existing environment, allowing clients to connect to it.