Kubernetes Engine API API

by googleapis.com

Overview

Builds and manages container-based applications, powered by the open source Kubernetes technology.

Kubernetes Engine API is an analytics API from googleapis.com. Requests are authenticated with OAuth. It is served over HTTPS. Its OpenAPI description documents 61 endpoints.

At a glance

Authentication: OAuth
HTTPS: Yes
CORS: Unknown
Category: Analytics
Base URL: https://container.googleapis.com/
Version: v1beta1
Endpoints: 61
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://container.googleapis.com/v1beta1/projects/PROJECTID/zones/ZONE/clusters" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer YOUR_TOKEN"

JavaScript

const response = await fetch("https://container.googleapis.com/v1beta1/projects/PROJECTID/zones/ZONE/clusters", {
  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://container.googleapis.com/v1beta1/projects/PROJECTID/zones/ZONE/clusters",
    headers={
    "Accept": "application/json",
    "Authorization": "Bearer YOUR_TOKEN",
    },
    timeout=30,
)
print(response.json())

Endpoints

Method	Path	What it does
GET	`/v1beta1/projects/{projectId}/zones/{zone}/clusters`	Lists all clusters owned by a project in either the specified zone or all zones.
POST	`/v1beta1/projects/{projectId}/zones/{zone}/clusters`	Creates a cluster, consisting of the specified number and type of Google Compute Engine instances. By default, the cluster is created in the project's [default
GET	`/v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}`	Gets the details for a specific cluster.
PUT	`/v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}`	Updates the settings for a specific cluster.
DELETE	`/v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}`	Deletes the cluster, including the Kubernetes endpoint and all worker nodes. Firewalls and routes that were configured during cluster creation are also deleted.
POST	`/v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/addons`	Sets the addons for a specific cluster.
POST	`/v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/legacyAbac`	Enables or disables the ABAC authorization mechanism on a cluster.
POST	`/v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/locations`	Sets the locations for a specific cluster. Deprecated. Use [projects.locations.clusters.update](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v
POST	`/v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/logging`	Sets the logging service for a specific cluster.
POST	`/v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/master`	Updates the master for a specific cluster.
POST	`/v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/monitoring`	Sets the monitoring service for a specific cluster.
GET	`/v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools`	Lists the node pools for a cluster.
POST	`/v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools`	Creates a node pool for a cluster.
GET	`/v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}`	Retrieves the requested node pool.
DELETE	`/v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}`	Deletes a node pool from a cluster.
POST	`/v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}/autoscaling`	Sets the autoscaling settings of a specific node pool.
POST	`/v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}/setManagement`	Sets the NodeManagement options for a node pool.
POST	`/v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}/setSize`	SetNodePoolSizeRequest sets the size of a node pool. The new size will be used for all replicas, including future replicas created by modifying NodePool.locatio
POST	`/v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}/update`	Updates the version and/or image type of a specific node pool.
POST	`/v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}:rollback`	Rolls back a previously Aborted or Failed NodePool upgrade. This makes no changes if the last upgrade successfully completed.
POST	`/v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/resourceLabels`	Sets labels on a cluster.
POST	`/v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:completeIpRotation`	Completes master IP rotation.
POST	`/v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:setMaintenancePolicy`	Sets the maintenance policy for a cluster.
POST	`/v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:setMasterAuth`	Sets master auth materials. Currently supports changing the admin password or a specific cluster, either via password generation or explicitly setting the passw
POST	`/v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:setNetworkPolicy`	Enables or disables Network Policy for a cluster.
POST	`/v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:startIpRotation`	Starts master IP rotation.
GET	`/v1beta1/projects/{projectId}/zones/{zone}/operations`	Lists all operations in a project in the specified zone or all zones.
GET	`/v1beta1/projects/{projectId}/zones/{zone}/operations/{operationId}`	Gets the specified operation.
POST	`/v1beta1/projects/{projectId}/zones/{zone}/operations/{operationId}:cancel`	Cancels the specified operation.
GET	`/v1beta1/projects/{projectId}/zones/{zone}/serverconfig`	Returns configuration info about the Google Kubernetes Engine service.
GET	`/v1beta1/{name}`	Gets the specified operation.
PUT	`/v1beta1/{name}`	Updates the version and/or image type of a specific node pool.
DELETE	`/v1beta1/{name}`	Deletes a node pool from a cluster.
GET	`/v1beta1/{name}/serverConfig`	Returns configuration info about the Google Kubernetes Engine service.
POST	`/v1beta1/{name}:cancel`	Cancels the specified operation.
POST	`/v1beta1/{name}:completeIpRotation`	Completes master IP rotation.
POST	`/v1beta1/{name}:completeUpgrade`	CompleteNodePoolUpgrade will signal an on-going node pool upgrade to complete.
POST	`/v1beta1/{name}:rollback`	Rolls back a previously Aborted or Failed NodePool upgrade. This makes no changes if the last upgrade successfully completed.
POST	`/v1beta1/{name}:setAddons`	Sets the addons for a specific cluster.
POST	`/v1beta1/{name}:setAutoscaling`	Sets the autoscaling settings of a specific node pool.
POST	`/v1beta1/{name}:setLegacyAbac`	Enables or disables the ABAC authorization mechanism on a cluster.
POST	`/v1beta1/{name}:setLocations`	Sets the locations for a specific cluster. Deprecated. Use [projects.locations.clusters.update](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v
POST	`/v1beta1/{name}:setLogging`	Sets the logging service for a specific cluster.
POST	`/v1beta1/{name}:setMaintenancePolicy`	Sets the maintenance policy for a cluster.
POST	`/v1beta1/{name}:setManagement`	Sets the NodeManagement options for a node pool.
POST	`/v1beta1/{name}:setMasterAuth`	Sets master auth materials. Currently supports changing the admin password or a specific cluster, either via password generation or explicitly setting the passw
POST	`/v1beta1/{name}:setMonitoring`	Sets the monitoring service for a specific cluster.
POST	`/v1beta1/{name}:setNetworkPolicy`	Enables or disables Network Policy for a cluster.
POST	`/v1beta1/{name}:setResourceLabels`	Sets labels on a cluster.
POST	`/v1beta1/{name}:setSize`	SetNodePoolSizeRequest sets the size of a node pool. The new size will be used for all replicas, including future replicas created by modifying NodePool.locatio
POST	`/v1beta1/{name}:startIpRotation`	Starts master IP rotation.
POST	`/v1beta1/{name}:updateMaster`	Updates the master for a specific cluster.
GET	`/v1beta1/{parent}/.well-known/openid-configuration`	Gets the OIDC discovery document for the cluster. See the [OpenID Connect Discovery 1.0 specification](https://openid.net/specs/openid-connect-discovery-1_0.htm
GET	`/v1beta1/{parent}/aggregated/usableSubnetworks`	Lists subnetworks that can be used for creating clusters in a project.
GET	`/v1beta1/{parent}/clusters`	Lists all clusters owned by a project in either the specified zone or all zones.
POST	`/v1beta1/{parent}/clusters`	Creates a cluster, consisting of the specified number and type of Google Compute Engine instances. By default, the cluster is created in the project's [default
GET	`/v1beta1/{parent}/jwks`	Gets the public component of the cluster signing keys in JSON Web Key format. This API is not yet intended for general use, and is not available for all cluster
GET	`/v1beta1/{parent}/locations`	Fetches locations that offer Google Kubernetes Engine.
GET	`/v1beta1/{parent}/nodePools`	Lists the node pools for a cluster.
POST	`/v1beta1/{parent}/nodePools`	Creates a node pool for a cluster.
GET	`/v1beta1/{parent}/operations`	Lists all operations in a project in the specified zone or all zones.

Questions

Does the Kubernetes Engine API API need an API key?

Yes. The Kubernetes Engine API API uses OAuth authentication; the documentation explains how to get credentials.

Does the Kubernetes Engine API API support HTTPS?

Yes, the Kubernetes Engine API API is served over HTTPS.

How many endpoints does the Kubernetes Engine API API have?

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

What are alternatives to the Kubernetes Engine 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).

Overview

At a glance

Make a first request

Endpoints

Questions

Similar analytics APIs

Google Play Integrity API

versionhistory.googleapis.com API

Doc Converter

Perspective Comment Analyzer API

Safe Browsing API

Web Fonts Developer API