Skip to content
OpenParablePublic APIs

Cloud Shell API API

by googleapis.com

OAuthHTTPSAnalytics
Open documentation ↗

Overview

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

Cloud Shell API is an analytics API from googleapis.com. Requests are authenticated with OAuth. It is served over HTTPS. Its OpenAPI description documents 7 endpoints.

At a glance

Authentication
OAuth
HTTPS
Yes
CORS
Unknown
Category
Analytics
Base URL
https://cloudshell.googleapis.com/
Version
v1
Endpoints
7
OpenAPI
Specification ↗
Spec updated
2023-04-21

Make a first request

Replace the placeholders; the documentation says exactly where credentials go.

cURL
curl -X GET "https://cloudshell.googleapis.com/v1/NAME" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer YOUR_TOKEN"
JavaScript
const response = await fetch("https://cloudshell.googleapis.com/v1/NAME", {
  method: "GET",
  headers: {
    "Accept": "application/json",
    "Authorization": "Bearer YOUR_TOKEN",
  },
});
const data = await response.json();
console.log(data);
Python
import requests

response = requests.request(
    "GET",
    "https://cloudshell.googleapis.com/v1/NAME",
    headers={
    "Accept": "application/json",
    "Authorization": "Bearer YOUR_TOKEN",
    },
    timeout=30,
)
print(response.json())

Endpoints

MethodPathWhat it does
POST/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 cont
POST/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 th
GET/v1/{name}Gets an environment. Returns NOT_FOUND if the environment does not exist.
DELETE/v1/{name}Deletes 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 th
POST/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 comman
POST/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 serv
POST/v1/{name}:startStarts an existing environment, allowing clients to connect to it. The returned operation will contain an instance of StartEnvironmentMetadata in its metadata f

Questions

Does the Cloud Shell API API need an API key?

Yes. The Cloud Shell API API uses OAuth authentication; the documentation explains how to get credentials.

Does the Cloud Shell API API support HTTPS?

Yes, the Cloud Shell API API is served over HTTPS.

How many endpoints does the Cloud Shell API API have?

Its OpenAPI description lists 7 endpoints in version v1. All of them are shown on this page.

What are alternatives to the Cloud Shell API API?

Other Analytics APIs include Google Play Integrity API, versionhistory.googleapis.com API, Doc Converter, Perspective Comment Analyzer API, Safe Browsing API.

Compare alternatives →

Google Play Integrity API

Analytics

The Play Integrity API helps you check that you're interacting with your genuine app on a genuine Android device powered by Google Play services. The Play Integrity API has replaced SafetyNet Attestation and Android Device Verification.

OAuth1 endpoints

versionhistory.googleapis.com API

Analytics

Version History API - Prod

No auth4 endpoints

Doc Converter

Analytics

This api converts file formats of OpenXml and OpenOffice documents formats to vector files (e.g., svg)

No auth1 endpoints

Perspective Comment Analyzer API

Analytics

The Perspective Comment Analyzer API provides information about the potential impact of a comment on a conversation (e.g. it can provide a score for the "toxicity" of a comment). Users can leverage the "SuggestCommentScore" method to submit corrections to improve Perspective over time. Users can set the "doNotStore" flag to ensure that all submitted comments are automatically deleted after scores are returned.

OAuth2 endpoints

Safe Browsing API

Analytics

Enables client applications to check web resources (most commonly URLs) against Google-generated lists of unsafe web resources. The Safe Browsing APIs are for non-commercial use only. If you need to use APIs to detect malicious URLs for commercial purposes – meaning “for sale or revenue-generating purposes” – please refer to the Web Risk API.

No auth7 endpoints

Web Fonts Developer API

Analytics

The Google Web Fonts Developer API lets you retrieve information about web fonts served by Google.

No auth1 endpoints

Listed from APIs.guru (CC0).