Lap-Platform Kubernetes Engine API
API version: v1
Auth
OAuth2 | OAuth2
Base URL
https://container.googleapis.com/
Setup
- Configure auth: OAuth2 | OAuth2
- GET /v1/projects/{projectId}/zones/{zone}/clusters -- verify access
- POST /v1/projects/{projectId}/zones/{zone}/clusters -- create first clusters
Endpoints
60 endpoints across 21 groups. See references/api-spec.lap for full details.
projects
| Method | Path | Description |
|---|---|---|
| GET | /v1/projects/{projectId}/zones/{zone}/clusters | Lists all clusters owned by a project in either the specified zone or all zones. |
| POST | /v1/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 network. One firewall is added for the cluster. After cluster creation, the Kubelet creates routes for each node to allow the containers on that node to communicate with all other instances in the cluster. Finally, an entry is added to the project's global metadata indicating which CIDR range the cluster is using. |
| DELETE | /v1/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. Other Google Compute Engine resources that might be in use by the cluster, such as load balancer resources, are not deleted if they weren't present when the cluster was initially created. |
| GET | /v1/projects/{projectId}/zones/{zone}/clusters/{clusterId} | Gets the details of a specific cluster. |
| PUT | /v1/projects/{projectId}/zones/{zone}/clusters/{clusterId} | Updates the settings of a specific cluster. |
| POST | /v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/addons | Sets the addons for a specific cluster. |
| POST | /v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/legacyAbac | Enables or disables the ABAC authorization mechanism on a cluster. |
| POST | /v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/locations | Sets the locations for a specific cluster. Deprecated. Use projects.locations.clusters.update instead. |
| POST | /v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/logging | Sets the logging service for a specific cluster. |
| POST | /v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/master | Updates the master for a specific cluster. |
| POST | /v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/monitoring | Sets the monitoring service for a specific cluster. |
| GET | /v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools | Lists the node pools for a cluster. |
| POST | /v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools | Creates a node pool for a cluster. |
| DELETE | /v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId} | Deletes a node pool from a cluster. |
| GET | /v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId} | Retrieves the requested node pool. |
| POST | /v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}/autoscaling | Sets the autoscaling settings for the specified node pool. |
| POST | /v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}/setManagement | Sets the NodeManagement options for a node pool. |
| POST | /v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}/setSize | Sets the size for a specific node pool. The new size will be used for all replicas, including future replicas created by modifying NodePool.locations. |
| POST | /v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}/update | Updates the version and/or image type for the specified node pool. |
| POST | /v1/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 | /v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/resourceLabels | Sets labels on a cluster. |
| POST | /v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:completeIpRotation | Completes master IP rotation. |
| POST | /v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:setMaintenancePolicy | Sets the maintenance policy for a cluster. |
| POST | /v1/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 password. |
| POST | /v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:setNetworkPolicy | Enables or disables Network Policy for a cluster. |
| POST | /v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:startIpRotation | Starts master IP rotation. |
| GET | /v1/projects/{projectId}/zones/{zone}/operations | Lists all operations in a project in a specific zone or all zones. |
| GET | /v1/projects/{projectId}/zones/{zone}/operations/{operationId} | Gets the specified operation. |
| POST | /v1/projects/{projectId}/zones/{zone}/operations/{operationId}:cancel | Cancels the specified operation. |
| GET | /v1/projects/{projectId}/zones/{zone}/serverconfig | Returns configuration info about the Google Kubernetes Engine service. |
{name}
| Method | Path | Description |
|---|---|---|
| DELETE | /v1/{name} | Deletes a node pool from a cluster. |
| GET | /v1/{name} | Gets the specified operation. |
| PUT | /v1/{name} | Updates the version and/or image type for the specified node pool. |
| GET | /v1/{name}/serverConfig | Returns configuration info about the Google Kubernetes Engine service. |
{name}:cancel
| Method | Path | Description |
|---|---|---|
| POST | /v1/{name}:cancel | Cancels the specified operation. |
{name}:completeIpRotation
| Method | Path | Description |
|---|---|---|
| POST | /v1/{name}:completeIpRotation | Completes master IP rotation. |
{name}:completeUpgrade
| Method | Path | Description |
|---|---|---|
| POST | /v1/{name}:completeUpgrade | CompleteNodePoolUpgrade will signal an on-going node pool upgrade to complete. |
{name}:rollback
| Method | Path | Description |
|---|---|---|
| POST | /v1/{name}:rollback | Rolls back a previously Aborted or Failed NodePool upgrade. This makes no changes if the last upgrade successfully completed. |
{name}:setAddons
| Method | Path | Description |
|---|---|---|
| POST | /v1/{name}:setAddons | Sets the addons for a specific cluster. |
{name}:setAutoscaling
| Method | Path | Description |
|---|---|---|
| POST | /v1/{name}:setAutoscaling | Sets the autoscaling settings for the specified node pool. |
{name}:setLegacyAbac
| Method | Path | Description |
|---|---|---|
| POST | /v1/{name}:setLegacyAbac | Enables or disables the ABAC authorization mechanism on a cluster. |
{name}:setLocations
| Method | Path | Description |
|---|---|---|
| POST | /v1/{name}:setLocations | Sets the locations for a specific cluster. Deprecated. Use projects.locations.clusters.update instead. |
{name}:setLogging
| Method | Path | Description |
|---|---|---|
| POST | /v1/{name}:setLogging | Sets the logging service for a specific cluster. |
{name}:setMaintenancePolicy
| Method | Path | Description |
|---|---|---|
| POST | /v1/{name}:setMaintenancePolicy | Sets the maintenance policy for a cluster. |
{name}:setManagement
| Method | Path | Description |
|---|---|---|
| POST | /v1/{name}:setManagement | Sets the NodeManagement options for a node pool. |
{name}:setMasterAuth
| Method | Path | Description |
|---|---|---|
| POST | /v1/{name}:setMasterAuth | Sets master auth materials. Currently supports changing the admin password or a specific cluster, either via password generation or explicitly setting the password. |
{name}:setMonitoring
| Method | Path | Description |
|---|---|---|
| POST | /v1/{name}:setMonitoring | Sets the monitoring service for a specific cluster. |
{name}:setNetworkPolicy
| Method | Path | Description |
|---|---|---|
| POST | /v1/{name}:setNetworkPolicy | Enables or disables Network Policy for a cluster. |
{name}:setResourceLabels
| Method | Path | Description |
|---|---|---|
| POST | /v1/{name}:setResourceLabels | Sets labels on a cluster. |
{name}:setSize
| Method | Path | Description |
|---|---|---|
| POST | /v1/{name}:setSize | Sets the size for a specific node pool. The new size will be used for all replicas, including future replicas created by modifying NodePool.locations. |
{name}:startIpRotation
| Method | Path | Description |
|---|---|---|
| POST | /v1/{name}:startIpRotation | Starts master IP rotation. |
{name}:updateMaster
| Method | Path | Description |
|---|---|---|
| POST | /v1/{name}:updateMaster | Updates the master for a specific cluster. |
{parent}
| Method | Path | Description |
|---|---|---|
| GET | /v1/{parent}/.well-known/openid-configuration | Gets the OIDC discovery document for the cluster. See the OpenID Connect Discovery 1.0 specification for details. This API is not yet intended for general use, and is not available for all clusters. |
| GET | /v1/{parent}/aggregated/usableSubnetworks | Lists subnetworks that are usable for creating clusters in a project. |
| GET | /v1/{parent}/clusters | Lists all clusters owned by a project in either the specified zone or all zones. |
| POST | /v1/{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 network. One firewall is added for the cluster. After cluster creation, the Kubelet creates routes for each node to allow the containers on that node to communicate with all other instances in the cluster. Finally, an entry is added to the project's global metadata indicating which CIDR range the cluster is using. |
| GET | /v1/{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 clusters. |
| GET | /v1/{parent}/nodePools | Lists the node pools for a cluster. |
| POST | /v1/{parent}/nodePools | Creates a node pool for a cluster. |
| GET | /v1/{parent}/operations | Lists all operations in a project in a specific zone or all zones. |
Common Questions
Match user requests to endpoints in references/api-spec.lap. Key patterns:
- "List all clusters?" -> GET /v1/projects/{projectId}/zones/{zone}/clusters
- "Create a cluster?" -> POST /v1/projects/{projectId}/zones/{zone}/clusters
- "Delete a cluster?" -> DELETE /v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}
- "Get cluster details?" -> GET /v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}
- "Update a cluster?" -> PUT /v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}
- "Create a addon?" -> POST /v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/addons
- "Create a legacyAbac?" -> POST /v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/legacyAbac
- "Create a location?" -> POST /v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/locations
- "Create a logging?" -> POST /v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/logging
- "Create a master?" -> POST /v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/master
- "Create a monitoring?" -> POST /v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/monitoring
- "List all nodePools?" -> GET /v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools
- "Create a nodePool?" -> POST /v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools
- "Delete a nodePool?" -> DELETE /v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}
- "Get nodePool details?" -> GET /v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}
- "Create a autoscaling?" -> POST /v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}/autoscaling
- "Create a setManagement?" -> POST /v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}/setManagement
- "Create a setSize?" -> POST /v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}/setSize
- "Create a update?" -> POST /v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}/update
- "Create a resourceLabel?" -> POST /v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/resourceLabels
- "List all operations?" -> GET /v1/projects/{projectId}/zones/{zone}/operations
- "Get operation details?" -> GET /v1/projects/{projectId}/zones/{zone}/operations/{operationId}
- "List all serverconfig?" -> GET /v1/projects/{projectId}/zones/{zone}/serverconfig
- "List all serverConfig?" -> GET /v1/{name}/serverConfig
- "List all openid-configuration?" -> GET /v1/{parent}/.well-known/openid-configuration
- "List all usableSubnetworks?" -> GET /v1/{parent}/aggregated/usableSubnetworks
- "List all clusters?" -> GET /v1/{parent}/clusters
- "Create a cluster?" -> POST /v1/{parent}/clusters
- "List all jwks?" -> GET /v1/{parent}/jwks
- "List all nodePools?" -> GET /v1/{parent}/nodePools
- "Create a nodePool?" -> POST /v1/{parent}/nodePools
- "List all operations?" -> GET /v1/{parent}/operations
- "How to authenticate?" -> See Auth section
Response Tips
- Check response schemas in references/api-spec.lap for field details
- Create/update endpoints typically return the created/updated object
References
- Full spec: See references/api-spec.lap for complete endpoint details, parameter tables, and response schemas
Generated from the official API spec by LAP