Cloud Shell API
Allows users to start, configure, and connect to interactive shell sessions running in the cloud.
Developer tools#openapi#analytics#media
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
Allows users to start, configure, and connect to interactive shell sessions running in the cloud.
Endpoints 8
operations
- POSTStarts asynchronous cancellation on a long-running operation
/v1/:name:cancelStarts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the… - DELETEDeletes a long-running operation
/v1/:nameDeletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If…
users.environments
- GETGets an environment
/v1/:nameGets an environment. Returns NOT_FOUND if the environment does not exist. - POSTAdds a public SSH key to an environment, allowing clients with the corresponding private key to connect to that…
/v1/:environment:addPublicKeyAdds a public SSH key to an environment, allowing clients with the corresponding private key to connect to that environment via SSH. If a key with the same… - POSTSends OAuth credentials to a running environment on behalf of a user
/v1/:name:authorizeSends OAuth credentials to a running environment on behalf of a user. When this completes, the environment will be authorized to run various Google Cloud… - GETGenerates an access token for the user's environment.
/v1/:environment:generateAccessToken?expireTime=string&ttl=stringGenerates an access token for the user's environment. - POSTRemoves a public SSH key from an environment
/v1/:environment:removePublicKeyRemoves a public SSH key from an environment. Clients will no longer be able to connect to the environment using the corresponding private key. If a key with… - POSTStarts an existing environment, allowing clients to connect to it
/v1/:name:startStarts an existing environment, allowing clients to connect to it. The returned operation will contain an instance of StartEnvironmentMetadata in its metadata…
API details
- Base URL
https://cloudshell.googleapis.com- Authentication
- OAuth 2.0 (authorization code flow) with 1 scope
An API key in the key query parameter - Operations
- 8 operations on 7 pathsPOST 5GET 2DELETE 1
- Main resources
- users.environments 6operations 2
- Response formats
application/json- Description format
- Google API Discovery, API version
v1 - Links
- Documentation · OpenAPI document
- Listed from
- Google API Discovery document (googleapis/discovery-artifact-manager) (Apache-2.0)
How to test the Cloud Shell API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Cloud Shell API collection, without the publisher's secrets.
- Add your credentialsThis API uses OAuth 2.0 (authorization code flow) with 1 scope. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Starts asynchronous cancellation on a long-running operation” (POST /v1/:name:cancel), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Cloud Shell API?
Allows users to start, configure, and connect to interactive shell sessions running in the cloud. It is listed under Developer tools and has 8 endpoints.
Who publishes the Cloud Shell API?
It is listed from Google's public API description (an OpenAPI document), not published by Google on Swastik Codes. Anyone who controls googleapis.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Cloud Shell API?
Requests go to https://cloudshell.googleapis.com. Endpoint paths are added to this base URL.
How do I authenticate with the Cloud Shell API?
It accepts 2 methods: OAuth 2.0 (authorization code flow) with 1 scope; an API key in the key query parameter.
How many endpoints does the Cloud Shell API have?
8 operations on 7 paths (5 POST, 2 GET, 1 DELETE). The largest groups are users.environments, operations.
Is forking the Cloud Shell API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.