Kubernetes Engine API

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

Service: container.googleapis.com

To call this service, we recommend that you use the Google-provided client libraries. If your application needs to use your own libraries to call this service, use the following information when you make the API requests.

Discovery document

A Discovery Document is a machine-readable specification for describing and consuming REST APIs. It is used to build client libraries, IDE plugins, and other tools that interact with Google APIs. One service may provide multiple discovery documents. This service provides the following discovery documents:

Service endpoint

A service endpoint is a base URL that specifies the network address of an API service. One service might have multiple service endpoints. This service has the following service endpoint and all URIs below are relative to this service endpoint:

  • https://container.googleapis.com

REST Resource: v1beta1.projects.aggregated.usableSubnetworks

Methods
listGET /v1beta1/{parent=projects/*}/aggregated/usableSubnetworks
Lists subnetworks that can be used for creating clusters in a project.

REST Resource: v1beta1.projects.locations

Methods
getServerConfigGET /v1beta1/{name=projects/*/locations/*}/serverConfig
Returns configuration info about the Google Kubernetes Engine service.
listGET /v1beta1/{parent=projects/*}/locations
Fetches locations that offer Google Kubernetes Engine.

REST Resource: v1beta1.projects.locations.clusters

Methods
checkAutopilotCompatibilityGET /v1beta1/{name=projects/*/locations/*/clusters/*}:checkAutopilotCompatibility
Checks the cluster compatibility with Autopilot mode, and returns a list of compatibility issues.
completeIpRotationPOST /v1beta1/{name=projects/*/locations/*/clusters/*}:completeIpRotation
Completes master IP rotation.
createPOST /v1beta1/{parent=projects/*/locations/*}/clusters
Creates a cluster, consisting of the specified number and type of Google Compute Engine instances.
deleteDELETE /v1beta1/{name=projects/*/locations/*/clusters/*}
Deletes the cluster, including the Kubernetes endpoint and all worker nodes.
fetchClusterUpgradeInfoGET /v1beta1/{name=projects/*/locations/*/clusters/*}:fetchClusterUpgradeInfo
Fetch upgrade information of a specific cluster.
getGET /v1beta1/{name=projects/*/locations/*/clusters/*}
Gets the details for a specific cluster.
getJwksGET /v1beta1/{parent=projects/*/locations/*/clusters/*}/jwks
Gets the public component of the cluster signing keys in JSON Web Key format.
listGET /v1beta1/{parent=projects/*/locations/*}/clusters
Lists all clusters owned by a project in either the specified zone or all zones.
setAddonsPOST /v1beta1/{name=projects/*/locations/*/clusters/*}:setAddons
Sets the addons for a specific cluster.
setLegacyAbacPOST /v1beta1/{name=projects/*/locations/*/clusters/*}:setLegacyAbac
Enables or disables the ABAC authorization mechanism on a cluster.
setLocations
(deprecated)
POST /v1beta1/{name=projects/*/locations/*/clusters/*}:setLocations
Sets the locations for a specific cluster.
setLoggingPOST /v1beta1/{name=projects/*/locations/*/clusters/*}:setLogging
Sets the logging service for a specific cluster.
setMaintenancePolicyPOST /v1beta1/{name=projects/*/locations/*/clusters/*}:setMaintenancePolicy
Sets the maintenance policy for a cluster.
setMasterAuthPOST /v1beta1/{name=projects/*/locations/*/clusters/*}:setMasterAuth
Sets master auth materials.
setMonitoringPOST /v1beta1/{name=projects/*/locations/*/clusters/*}:setMonitoring
Sets the monitoring service for a specific cluster.
setNetworkPolicyPOST /v1beta1/{name=projects/*/locations/*/clusters/*}:setNetworkPolicy
Enables or disables Network Policy for a cluster.
setResourceLabelsPOST /v1beta1/{name=projects/*/locations/*/clusters/*}:setResourceLabels
Sets labels on a cluster.
startIpRotationPOST /v1beta1/{name=projects/*/locations/*/clusters/*}:startIpRotation
Starts master IP rotation.
updatePUT /v1beta1/{name=projects/*/locations/*/clusters/*}
Updates the settings for a specific cluster.
updateMasterPOST /v1beta1/{name=projects/*/locations/*/clusters/*}:updateMaster
Updates the master for a specific cluster.

REST Resource: v1beta1.projects.locations.clusters.nodePools

Methods
completeUpgradePOST /v1beta1/{name=projects/*/locations/*/clusters/*/nodePools/*}:completeUpgrade
CompleteNodePoolUpgrade will signal an on-going node pool upgrade to complete.
createPOST /v1beta1/{parent=projects/*/locations/*/clusters/*}/nodePools
Creates a node pool for a cluster.
deleteDELETE /v1beta1/{name=projects/*/locations/*/clusters/*/nodePools/*}
Deletes a node pool from a cluster.
fetchNodePoolUpgradeInfoGET /v1beta1/{name=projects/*/locations/*/clusters/*/nodePools/*}:fetchNodePoolUpgradeInfo
Fetch upgrade information of a specific nodepool.
getGET /v1beta1/{name=projects/*/locations/*/clusters/*/nodePools/*}
Retrieves the requested node pool.
listGET /v1beta1/{parent=projects/*/locations/*/clusters/*}/nodePools
Lists the node pools for a cluster.
rollbackPOST /v1beta1/{name=projects/*/locations/*/clusters/*/nodePools/*}:rollback
Rolls back a previously Aborted or Failed NodePool upgrade.
setAutoscalingPOST /v1beta1/{name=projects/*/locations/*/clusters/*/nodePools/*}:setAutoscaling
Sets the autoscaling settings of a specific node pool.
setManagementPOST /v1beta1/{name=projects/*/locations/*/clusters/*/nodePools/*}:setManagement
Sets the NodeManagement options for a node pool.
setSizePOST /v1beta1/{name=projects/*/locations/*/clusters/*/nodePools/*}:setSize
SetNodePoolSizeRequest sets the size of a node pool.
updatePUT /v1beta1/{name=projects/*/locations/*/clusters/*/nodePools/*}
Updates the version and/or image type of a specific node pool.

REST Resource: v1beta1.projects.locations.clusters.well-known

Methods
getOpenid-configurationGET /v1beta1/{parent=projects/*/locations/*/clusters/*}/.well-known/openid-configuration
Gets the OIDC discovery document for the cluster.

REST Resource: v1beta1.projects.locations.operations

Methods
cancelPOST /v1beta1/{name=projects/*/locations/*/operations/*}:cancel
Cancels the specified operation.
getGET /v1beta1/{name=projects/*/locations/*/operations/*}
Gets the specified operation.
listGET /v1beta1/{parent=projects/*/locations/*}/operations
Lists all operations in a project in the specified zone or all zones.

REST Resource: v1beta1.projects.zones

Methods
getServerconfigGET /v1beta1/projects/{projectId}/zones/{zone}/serverconfig
Returns configuration info about the Google Kubernetes Engine service.

REST Resource: v1beta1.projects.zones.clusters

Methods
addonsPOST /v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/addons
Sets the addons for a specific cluster.
completeIpRotationPOST /v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:completeIpRotation
Completes master IP rotation.
createPOST /v1beta1/projects/{projectId}/zones/{zone}/clusters
Creates a cluster, consisting of the specified number and type of Google Compute Engine instances.
deleteDELETE /v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}
Deletes the cluster, including the Kubernetes endpoint and all worker nodes.
fetchClusterUpgradeInfoGET /v1beta1/{name=projects/*/zones/*/clusters/*}:fetchClusterUpgradeInfo
Fetch upgrade information of a specific cluster.
getGET /v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}
Gets the details for a specific cluster.
legacyAbacPOST /v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/legacyAbac
Enables or disables the ABAC authorization mechanism on a cluster.
listGET /v1beta1/projects/{projectId}/zones/{zone}/clusters
Lists all clusters owned by a project in either the specified zone or all zones.
locations
(deprecated)
POST /v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/locations
Sets the locations for a specific cluster.
loggingPOST /v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/logging
Sets the logging service for a specific cluster.
masterPOST /v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/master
Updates the master for a specific cluster.
monitoringPOST /v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/monitoring
Sets the monitoring service for a specific cluster.
resourceLabelsPOST /v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/resourceLabels
Sets labels on a cluster.
setMaintenancePolicyPOST /v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:setMaintenancePolicy
Sets the maintenance policy for a cluster.
setMasterAuthPOST /v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:setMasterAuth
Sets master auth materials.
setNetworkPolicyPOST /v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:setNetworkPolicy
Enables or disables Network Policy for a cluster.
startIpRotationPOST /v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:startIpRotation
Starts master IP rotation.
updatePUT /v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}
Updates the settings for a specific cluster.

REST Resource: v1beta1.projects.zones.clusters.nodePools

Methods
autoscalingPOST /v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}/autoscaling
Sets the autoscaling settings of a specific node pool.
createPOST /v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools
Creates a node pool for a cluster.
deleteDELETE /v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}
Deletes a node pool from a cluster.
fetchNodePoolUpgradeInfoGET /v1beta1/{name=projects/*/zones/*/clusters/*/nodePools/*}:fetchNodePoolUpgradeInfo
Fetch upgrade information of a specific nodepool.
getGET /v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}
Retrieves the requested node pool.
listGET /v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools
Lists the node pools for a cluster.
rollbackPOST /v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}:rollback
Rolls back a previously Aborted or Failed NodePool upgrade.
setManagementPOST /v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}/setManagement
Sets the NodeManagement options for a node pool.
setSizePOST /v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}/setSize
SetNodePoolSizeRequest sets the size of a node pool.
updatePOST /v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}/update
Updates the version and/or image type of a specific node pool.

REST Resource: v1beta1.projects.zones.operations

Methods
cancelPOST /v1beta1/projects/{projectId}/zones/{zone}/operations/{operationId}:cancel
Cancels the specified operation.
getGET /v1beta1/projects/{projectId}/zones/{zone}/operations/{operationId}
Gets the specified operation.
listGET /v1beta1/projects/{projectId}/zones/{zone}/operations
Lists all operations in a project in the specified zone or all zones.

REST Resource: v1.projects.aggregated.usableSubnetworks

Methods
listGET /v1/{parent=projects/*}/aggregated/usableSubnetworks
Lists subnetworks that are usable for creating clusters in a project.

REST Resource: v1.projects.locations

Methods
getServerConfigGET /v1/{name=projects/*/locations/*}/serverConfig
Returns configuration info about the Google Kubernetes Engine service.

REST Resource: v1.projects.locations.clusters

Methods
checkAutopilotCompatibilityGET /v1/{name=projects/*/locations/*/clusters/*}:checkAutopilotCompatibility
Checks the cluster compatibility with Autopilot mode, and returns a list of compatibility issues.
completeIpRotationPOST /v1/{name=projects/*/locations/*/clusters/*}:completeIpRotation
Completes master IP rotation.
createPOST /v1/{parent=projects/*/locations/*}/clusters
Creates a cluster, consisting of the specified number and type of Google Compute Engine instances.
deleteDELETE /v1/{name=projects/*/locations/*/clusters/*}
Deletes the cluster, including the Kubernetes endpoint and all worker nodes.
fetchClusterUpgradeInfoGET /v1/{name=projects/*/locations/*/clusters/*}:fetchClusterUpgradeInfo
Fetch upgrade information of a specific cluster.
getGET /v1/{name=projects/*/locations/*/clusters/*}
Gets the details of a specific cluster.
getJwksGET /v1/{parent=projects/*/locations/*/clusters/*}/jwks
Gets the public component of the cluster signing keys in JSON Web Key format.
listGET /v1/{parent=projects/*/locations/*}/clusters
Lists all clusters owned by a project in either the specified zone or all zones.
setAddonsPOST /v1/{name=projects/*/locations/*/clusters/*}:setAddons
Sets the addons for a specific cluster.
setLegacyAbacPOST /v1/{name=projects/*/locations/*/clusters/*}:setLegacyAbac
Enables or disables the ABAC authorization mechanism on a cluster.
setLocations
(deprecated)
POST /v1/{name=projects/*/locations/*/clusters/*}:setLocations
Sets the locations for a specific cluster.
setLoggingPOST /v1/{name=projects/*/locations/*/clusters/*}:setLogging
Sets the logging service for a specific cluster.
setMaintenancePolicyPOST /v1/{name=projects/*/locations/*/clusters/*}:setMaintenancePolicy
Sets the maintenance policy for a cluster.
setMasterAuthPOST /v1/{name=projects/*/locations/*/clusters/*}:setMasterAuth
Sets master auth materials.
setMonitoringPOST /v1/{name=projects/*/locations/*/clusters/*}:setMonitoring
Sets the monitoring service for a specific cluster.
setNetworkPolicyPOST /v1/{name=projects/*/locations/*/clusters/*}:setNetworkPolicy
Enables or disables Network Policy for a cluster.
setResourceLabelsPOST /v1/{name=projects/*/locations/*/clusters/*}:setResourceLabels
Sets labels on a cluster.
startIpRotationPOST /v1/{name=projects/*/locations/*/clusters/*}:startIpRotation
Starts master IP rotation.
updatePUT /v1/{name=projects/*/locations/*/clusters/*}
Updates the settings of a specific cluster.
updateMasterPOST /v1/{name=projects/*/locations/*/clusters/*}:updateMaster
Updates the master for a specific cluster.

REST Resource: v1.projects.locations.clusters.nodePools

Methods
completeUpgradePOST /v1/{name=projects/*/locations/*/clusters/*/nodePools/*}:completeUpgrade
CompleteNodePoolUpgrade will signal an on-going node pool upgrade to complete.
createPOST /v1/{parent=projects/*/locations/*/clusters/*}/nodePools
Creates a node pool for a cluster.
deleteDELETE /v1/{name=projects/*/locations/*/clusters/*/nodePools/*}
Deletes a node pool from a cluster.
fetchNodePoolUpgradeInfoGET /v1/{name=projects/*/locations/*/clusters/*/nodePools/*}:fetchNodePoolUpgradeInfo
Fetch upgrade information of a specific nodepool.
getGET /v1/{name=projects/*/locations/*/clusters/*/nodePools/*}
Retrieves the requested node pool.
listGET /v1/{parent=projects/*/locations/*/clusters/*}/nodePools
Lists the node pools for a cluster.
rollbackPOST /v1/{name=projects/*/locations/*/clusters/*/nodePools/*}:rollback
Rolls back a previously Aborted or Failed NodePool upgrade.
setAutoscalingPOST /v1/{name=projects/*/locations/*/clusters/*/nodePools/*}:setAutoscaling
Sets the autoscaling settings for the specified node pool.
setManagementPOST /v1/{name=projects/*/locations/*/clusters/*/nodePools/*}:setManagement
Sets the NodeManagement options for a node pool.
setSizePOST /v1/{name=projects/*/locations/*/clusters/*/nodePools/*}:setSize
Sets the size for a specific node pool.
updatePUT /v1/{name=projects/*/locations/*/clusters/*/nodePools/*}
Updates the version and/or image type for the specified node pool.

REST Resource: v1.projects.locations.clusters.well-known

Methods
getOpenid-configurationGET /v1/{parent=projects/*/locations/*/clusters/*}/.well-known/openid-configuration
Gets the OIDC discovery document for the cluster.

REST Resource: v1.projects.locations.operations

Methods
cancelPOST /v1/{name=projects/*/locations/*/operations/*}:cancel
Cancels the specified operation.
getGET /v1/{name=projects/*/locations/*/operations/*}
Gets the specified operation.
listGET /v1/{parent=projects/*/locations/*}/operations
Lists all operations in a project in a specific zone or all zones.

REST Resource: v1.projects.zones

Methods
getServerconfigGET /v1/projects/{projectId}/zones/{zone}/serverconfig
Returns configuration info about the Google Kubernetes Engine service.

REST Resource: v1.projects.zones.clusters

Methods
addonsPOST /v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/addons
Sets the addons for a specific cluster.
completeIpRotationPOST /v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:completeIpRotation
Completes master IP rotation.
createPOST /v1/projects/{projectId}/zones/{zone}/clusters
Creates a cluster, consisting of the specified number and type of Google Compute Engine instances.
deleteDELETE /v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}
Deletes the cluster, including the Kubernetes endpoint and all worker nodes.
fetchClusterUpgradeInfoGET /v1/{name=projects/*/zones/*/clusters/*}:fetchClusterUpgradeInfo
Fetch upgrade information of a specific cluster.
getGET /v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}
Gets the details of a specific cluster.
legacyAbacPOST /v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/legacyAbac
Enables or disables the ABAC authorization mechanism on a cluster.
listGET /v1/projects/{projectId}/zones/{zone}/clusters
Lists all clusters owned by a project in either the specified zone or all zones.
locations
(deprecated)
POST /v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/locations
Sets the locations for a specific cluster.
loggingPOST /v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/logging
Sets the logging service for a specific cluster.
masterPOST /v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/master
Updates the master for a specific cluster.
monitoringPOST /v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/monitoring
Sets the monitoring service for a specific cluster.
resourceLabelsPOST /v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/resourceLabels
Sets labels on a cluster.
setMaintenancePolicyPOST /v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:setMaintenancePolicy
Sets the maintenance policy for a cluster.
setMasterAuthPOST /v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:setMasterAuth
Sets master auth materials.
setNetworkPolicyPOST /v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:setNetworkPolicy
Enables or disables Network Policy for a cluster.
startIpRotationPOST /v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:startIpRotation
Starts master IP rotation.
updatePUT /v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}
Updates the settings of a specific cluster.

REST Resource: v1.projects.zones.clusters.nodePools

Methods
autoscalingPOST /v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}/autoscaling
Sets the autoscaling settings for the specified node pool.
createPOST /v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools
Creates a node pool for a cluster.
deleteDELETE /v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}
Deletes a node pool from a cluster.
fetchNodePoolUpgradeInfoGET /v1/{name=projects/*/zones/*/clusters/*/nodePools/*}:fetchNodePoolUpgradeInfo
Fetch upgrade information of a specific nodepool.
getGET /v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}
Retrieves the requested node pool.
listGET /v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools
Lists the node pools for a cluster.
rollbackPOST /v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}:rollback
Rolls back a previously Aborted or Failed NodePool upgrade.
setManagementPOST /v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}/setManagement
Sets the NodeManagement options for a node pool.
setSizePOST /v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}/setSize
Sets the size for a specific node pool.
updatePOST /v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}/update
Updates the version and/or image type for the specified node pool.

REST Resource: v1.projects.zones.operations

Methods
cancelPOST /v1/projects/{projectId}/zones/{zone}/operations/{operationId}:cancel
Cancels the specified operation.
getGET /v1/projects/{projectId}/zones/{zone}/operations/{operationId}
Gets the specified operation.
listGET /v1/projects/{projectId}/zones/{zone}/operations
Lists all operations in a project in a specific zone or all zones.