Googleapis Cloudshell
Google Cloud Shell API is an interface for managing browser-based command-line shell environments in Google Cloud.
- Base URL:
https://cloudshell.googleapis.com - Auth: OAuth 2.0 (user-delegated) — attach an InTouch
oauthcredential. Mint one withitcli.py /oauth <provider>(device-code) or/google-auth(Google); the server auto-refreshes the access token before each run, so the connector never handles or stores tokens.
Operations
cloudshell_users_environments_get— GET /v1/{name} — Gets an environment. Returns NOT_FOUND if the environment does not exist.cloudshell_users_environments_addpublickey— POST /v1/{environment}:addPublicKey — Adds a public SSH key to an environment, allowing clients with the correspondingcloudshell_users_environments_removepublickey— POST /v1/{environment}:removePublicKey — Removes a public SSH key from an environment. Clients will no longer be able tocloudshell_operations_delete— DELETE /v1/{name} — Deletes a long-running operation. This method indicates that the client is no locloudshell_users_environments_authorize— POST /v1/{name}:authorize — Sends OAuth credentials to a running environment on behalf of a user. When thiscloudshell_operations_cancel— POST /v1/{name}:cancel — Starts asynchronous cancellation on a long-running operation. The server makes a
Inputs
- a linked
oauthcredential (no key inputs) — the server injects a freshAuthorization: Bearerfrom it operation— one of the operations above- path parameters when an operation's path contains
{...} query— optional JSON object of query paramsbody— JSON object for create/update ops
Example
operation: cloudshell_users_environments_get
# (attach an 'oauth' credential to the task — no inline secrets)
Publishes
The keys a later task may reference as {{taskName.key}}. Referencing anything not listed here resolves to nothing at run time.
erroroperationresultstatus
Input Properties
Every property this tool accepts, from its own tool.iml.
| Property | Type | Required | Default | Description |
|---|---|---|---|---|
operation |
string | yes | — | One of: cloudshell_users_environments_get, cloudshell_users_environments_addpublickey, cloudshell_users_environments_removepublickey, cloudshell_operations_delete, cloudshell_users_environments_authorize, cloudshell_operations_cancel |
environment |
string | no | — | Path parameter environment (required by some operations). |
name |
string | no | — | Path parameter name (required by some operations). |
query |
string | no | — | Optional query params as a JSON object string, e.g. {"limit": 10}. |
body |
string | no | — | Request body as a JSON object string (for create/update operations). |