Google

Kubernetes Engine API

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

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

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

Endpoints 64

projects.aggregated.usableSubnetworks

  • GETLists subnetworks that are usable for creating clusters in a project./v1/:parent/aggregated/usableSubnetworks?filter=string&pageSize=0&pageToken=stringLists subnetworks that are usable for creating clusters in a project.

projects.locations

  • GETReturns configuration info about the Google Kubernetes Engine service./v1/:name/serverConfig?projectId=string&zone=stringReturns configuration info about the Google Kubernetes Engine service.

projects.locations.clusters

  • GETChecks the cluster compatibility with Autopilot mode, and returns a list of compatibility issues./v1/:name:checkAutopilotCompatibilityChecks the cluster compatibility with Autopilot mode, and returns a list of compatibility issues.
  • POSTCompletes master IP rotation./v1/:name:completeIpRotationCompletes master IP rotation.
  • GETLists all clusters owned by a project in either the specified zone or all zones./v1/:parent/clusters?projectId=string&zone=stringLists all clusters owned by a project in either the specified zone or all zones.
  • POSTCreates a cluster, consisting of the specified number and type of Google Compute Engine instances/v1/:parent/clustersCreates 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…
  • GETGets the public component of the cluster signing keys in JSON Web Key format./v1/:parent/jwksGets the public component of the cluster signing keys in JSON Web Key format.
  • POSTSets the addons for a specific cluster./v1/:name:setAddonsSets the addons for a specific cluster.
  • POSTEnables or disables the ABAC authorization mechanism on a cluster./v1/:name:setLegacyAbacEnables or disables the ABAC authorization mechanism on a cluster.
  • POSTSets the locations for a specific cluster/v1/:name:setLocationsSets the locations for a specific cluster. Deprecated. Use projects.locations.clusters.update instead.
  • POSTSets the logging service for a specific cluster./v1/:name:setLoggingSets the logging service for a specific cluster.
  • POSTSets the maintenance policy for a cluster./v1/:name:setMaintenancePolicySets the maintenance policy for a cluster.
  • POSTSets master auth materials/v1/:name:setMasterAuthSets master auth materials. Currently supports changing the admin password or a specific cluster, either via password generation or explicitly setting the…
  • POSTSets the monitoring service for a specific cluster./v1/:name:setMonitoringSets the monitoring service for a specific cluster.
  • POSTEnables or disables Network Policy for a cluster./v1/:name:setNetworkPolicyEnables or disables Network Policy for a cluster.
  • POSTSets labels on a cluster./v1/:name:setResourceLabelsSets labels on a cluster.
  • POSTStarts master IP rotation./v1/:name:startIpRotationStarts master IP rotation.
  • POSTUpdates the master for a specific cluster./v1/:name:updateMasterUpdates the master for a specific cluster.

projects.zones.clusters

  • POSTCompleteControlPlaneUpgrade completes the rollback-safe upgrade by performing the step two upgrade for a specific…/v1/:name:completeControlPlaneUpgradeCompleteControlPlaneUpgrade completes the rollback-safe upgrade by performing the step two upgrade for a specific cluster.
  • GETFetch upgrade information of a specific cluster./v1/:name:fetchClusterUpgradeInfo?version=stringFetch upgrade information of a specific cluster.
  • POSTSets the addons for a specific cluster./v1/projects/:projectId/zones/:zone/clusters/:clusterId/addonsSets the addons for a specific cluster.
  • POSTCompletes master IP rotation./v1/projects/:projectId/zones/:zone/clusters/:clusterId:completeIpRotationCompletes master IP rotation.
  • GETLists all clusters owned by a project in either the specified zone or all zones./v1/projects/:projectId/zones/:zone/clusters?parent=stringLists all clusters owned by a project in either the specified zone or all zones.
  • POSTCreates a cluster, consisting of the specified number and type of Google Compute Engine instances/v1/projects/:projectId/zones/:zone/clustersCreates 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…
  • GETGets the details of a specific cluster./v1/projects/:projectId/zones/:zone/clusters/:clusterId?name=stringGets the details of a specific cluster.
  • PUTUpdates the settings of a specific cluster./v1/projects/:projectId/zones/:zone/clusters/:clusterIdUpdates the settings of a specific cluster.
  • DELETEDeletes the cluster, including the Kubernetes endpoint and all worker nodes/v1/projects/:projectId/zones/:zone/clusters/:clusterId?name=stringDeletes the cluster, including the Kubernetes endpoint and all worker nodes. Firewalls and routes that were configured during cluster creation are also…
  • POSTEnables or disables the ABAC authorization mechanism on a cluster./v1/projects/:projectId/zones/:zone/clusters/:clusterId/legacyAbacEnables or disables the ABAC authorization mechanism on a cluster.
  • POSTSets the locations for a specific cluster/v1/projects/:projectId/zones/:zone/clusters/:clusterId/locationsSets the locations for a specific cluster. Deprecated. Use projects.locations.clusters.update instead.
  • POSTSets the logging service for a specific cluster./v1/projects/:projectId/zones/:zone/clusters/:clusterId/loggingSets the logging service for a specific cluster.
  • POSTUpdates the master for a specific cluster./v1/projects/:projectId/zones/:zone/clusters/:clusterId/masterUpdates the master for a specific cluster.
  • POSTSets the monitoring service for a specific cluster./v1/projects/:projectId/zones/:zone/clusters/:clusterId/monitoringSets the monitoring service for a specific cluster.
  • POSTSets labels on a cluster./v1/projects/:projectId/zones/:zone/clusters/:clusterId/resourceLabelsSets labels on a cluster.
  • POSTSets the maintenance policy for a cluster./v1/projects/:projectId/zones/:zone/clusters/:clusterId:setMaintenancePolicySets the maintenance policy for a cluster.
  • POSTSets master auth materials/v1/projects/:projectId/zones/:zone/clusters/:clusterId:setMasterAuthSets master auth materials. Currently supports changing the admin password or a specific cluster, either via password generation or explicitly setting the…
  • POSTEnables or disables Network Policy for a cluster./v1/projects/:projectId/zones/:zone/clusters/:clusterId:setNetworkPolicyEnables or disables Network Policy for a cluster.
  • POSTStarts master IP rotation./v1/projects/:projectId/zones/:zone/clusters/:clusterId:startIpRotationStarts master IP rotation.

projects.locations.operations

  • GETGets the specified operation./v1/:name?operationId=string&projectId=string&zone=stringGets the specified operation.
  • POSTCancels the specified operation./v1/:name:cancelCancels the specified operation.
  • GETLists all operations in a project in a specific zone or all zones./v1/:parent/operations?projectId=string&zone=stringLists all operations in a project in a specific zone or all zones.

projects.locations.clusters.nodePools

  • PUTUpdates the version and/or image type for the specified node pool./v1/:nameUpdates the version and/or image type for the specified node pool.
  • DELETEDeletes a node pool from a cluster./v1/:name?clusterId=string&nodePoolId=string&projectId=string&zone=stringDeletes a node pool from a cluster.
  • POSTCompleteNodePoolUpgrade will signal an on-going node pool upgrade to complete./v1/:name:completeUpgradeCompleteNodePoolUpgrade will signal an on-going node pool upgrade to complete.
  • GETLists the node pools for a cluster./v1/:parent/nodePools?clusterId=string&projectId=string&zone=stringLists the node pools for a cluster.
  • POSTCreates a node pool for a cluster./v1/:parent/nodePoolsCreates a node pool for a cluster.
  • POSTRolls back a previously Aborted or Failed NodePool upgrade/v1/:name:rollbackRolls back a previously Aborted or Failed NodePool upgrade. This makes no changes if the last upgrade successfully completed.
  • POSTSets the autoscaling settings for the specified node pool./v1/:name:setAutoscalingSets the autoscaling settings for the specified node pool.
  • POSTSets the NodeManagement options for a node pool./v1/:name:setManagementSets the NodeManagement options for a node pool.
  • POSTSets the size for a specific node pool/v1/:name:setSizeSets the size for a specific node pool. The new size will be used for all replicas, including future replicas created by modifying NodePool.locations.

projects.zones.clusters.nodePools

  • GETFetch upgrade information of a specific node pool./v1/:name:fetchNodePoolUpgradeInfo?version=stringFetch upgrade information of a specific node pool.
  • POSTSets the autoscaling settings for the specified node pool./v1/projects/:projectId/zones/:zone/clusters/:clusterId/nodePools/:nodePoolId/autoscalingSets the autoscaling settings for the specified node pool.
  • GETLists the node pools for a cluster./v1/projects/:projectId/zones/:zone/clusters/:clusterId/nodePools?parent=stringLists the node pools for a cluster.
  • POSTCreates a node pool for a cluster./v1/projects/:projectId/zones/:zone/clusters/:clusterId/nodePoolsCreates a node pool for a cluster.
  • GETRetrieves the requested node pool./v1/projects/:projectId/zones/:zone/clusters/:clusterId/nodePools/:nodePoolId?name=stringRetrieves the requested node pool.
  • DELETEDeletes a node pool from a cluster./v1/projects/:projectId/zones/:zone/clusters/:clusterId/nodePools/:nodePoolId?name=stringDeletes a node pool from a cluster.
  • POSTRolls back a previously Aborted or Failed NodePool upgrade/v1/projects/:projectId/zones/:zone/clusters/:clusterId/nodePools/:nodePoolId:rollbackRolls back a previously Aborted or Failed NodePool upgrade. This makes no changes if the last upgrade successfully completed.
  • POSTSets the NodeManagement options for a node pool./v1/projects/:projectId/zones/:zone/clusters/:clusterId/nodePools/:nodePoolId/setManagementSets the NodeManagement options for a node pool.
  • POSTSets the size for a specific node pool/v1/projects/:projectId/zones/:zone/clusters/:clusterId/nodePools/:nodePoolId/setSizeSets the size for a specific node pool. The new size will be used for all replicas, including future replicas created by modifying NodePool.locations.
  • POSTUpdates the version and/or image type for the specified node pool./v1/projects/:projectId/zones/:zone/clusters/:clusterId/nodePools/:nodePoolId/updateUpdates the version and/or image type for the specified node pool.

projects.locations.clusters.well-known

  • GETGets the OIDC discovery document for the cluster/v1/:parent/.well-known/openid-configurationGets the OIDC discovery document for the cluster. See the OpenID Connect Discovery 1.0 specification for details.

projects.zones

  • GETReturns configuration info about the Google Kubernetes Engine service./v1/projects/:projectId/zones/:zone/serverconfig?name=stringReturns configuration info about the Google Kubernetes Engine service.

projects.zones.operations

  • POSTCancels the specified operation./v1/projects/:projectId/zones/:zone/operations/:operationId:cancelCancels the specified operation.
  • GETGets the specified operation./v1/projects/:projectId/zones/:zone/operations/:operationId?name=stringGets the specified operation.
  • GETLists all operations in a project in a specific zone or all zones./v1/projects/:projectId/zones/:zone/operations?parent=stringLists all operations in a project in a specific zone or all zones.

API details

Base URL
https://container.googleapis.com
Authentication
OAuth 2.0 (authorization code flow) with 3 scopes
An API key in the key query parameter
Operations
64 operations on 55 pathsPOST 41GET 18DELETE 3PUT 2
Main resources
projects.zones.clusters 19projects.locations.clusters 16projects.zones.clusters.nodePools 10projects.locations.clusters.nodePools 9projects.locations.operations 3projects.zones.operations 3projects.aggregated.usableSubnetworks 1projects.locations 1projects.locations.clusters.well-known 1projects.zones 1
Response formats
application/json
Description format
Google API Discovery, API version v1

How to test the Kubernetes Engine API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Kubernetes Engine API collection, without the publisher's secrets.
  3. Add your credentialsThis API uses OAuth 2.0 (authorization code flow) with 3 scopes. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Lists subnetworks that are usable for creating clusters in a project.” (GET /v1/:parent/aggregated/usableSubnetworks?filter=string&pageSize=0&pageToken=string), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Kubernetes Engine API?

Builds and manages container-based applications, powered by the open source Kubernetes technology. It is listed under Developer tools and has 64 endpoints.

Who publishes the Kubernetes Engine 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 Kubernetes Engine API?

Requests go to https://container.googleapis.com. Endpoint paths are added to this base URL.

How do I authenticate with the Kubernetes Engine API?

It accepts 2 methods: OAuth 2.0 (authorization code flow) with 3 scopes; an API key in the key query parameter.

How many endpoints does the Kubernetes Engine API have?

64 operations on 55 paths (41 POST, 18 GET, 3 DELETE, 2 PUT). The largest groups are projects.zones.clusters, projects.locations.clusters, projects.zones.clusters.nodePools, projects.locations.clusters.nodePools.

Is forking the Kubernetes Engine API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.