Google Kubernetes Engine · Schema
Cluster
A Google Kubernetes Engine cluster.
Cloud-NativeContainersGoogle CloudKubernetesManaged ServiceContainer Orchestration
Properties
| Name | Type | Description |
|---|---|---|
| locations | array | The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the cluster's nodes should be located. This field provides a default value if [NodePool.Locati |
| loggingService | string | The logging service the cluster should use to write logs. Currently available options: * `logging.googleapis.com/kubernetes` - The Cloud Logging service with a Kubernetes-native resource model * `logg |
| binaryAuthorization | object | Configuration for Binary Authorization. |
| rollbackSafeUpgrade | object | Optional. The rollback safe upgrade information of the cluster. This field is used when user manually triggers a rollback safe upgrade. |
| currentNodeVersion | string | Output only. Deprecated, use [NodePools.version](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools) instead. The current version of the node softw |
| servicesIpv4Cidr | string | Output only. The IP address range of the Kubernetes services in this cluster, in [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). Service addresses ar |
| nodeConfig | object | Parameters used in creating the cluster's nodes. For requests, this field should only be used in lieu of a "node_pool" object, since this configuration (along with the "initial_node_count") will be us |
| parentProductConfig | object | The configuration of the parent product of the cluster. This field is used by Google internal products that are built on top of the GKE cluster and take the ownership of the cluster. |
| rbacBindingConfig | object | RBACBindingConfig allows user to restrict ClusterRoleBindings an RoleBindings that can be created. |
| autopilot | object | Autopilot configuration for the cluster. |
| podAutoscaling | object | The config for pod autoscaling. |
| controlPlaneEndpointsConfig | object | Configuration for all cluster's control plane endpoints. |
| userManagedKeysConfig | object | The Custom keys configuration for the cluster. |
| id | string | Output only. Unique id for the cluster. |
| managedOpentelemetryConfig | object | Configuration for Managed OpenTelemetry pipeline. |
| description | string | An optional description of this cluster. |
| compliancePostureConfig | object | Optional. Deprecated: Compliance Posture is no longer supported. For more details, see https://cloud.google.com/kubernetes-engine/docs/deprecations/posture-management-deprecation. Enable/Disable Compl |
| createTime | string | Output only. The time the cluster was created, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| controlPlaneEgress | object | Configuration for control plane egress control. |
| satisfiesPzi | boolean | Output only. Reserved for future use. |
| scheduleUpgradeConfig | object | Optional. Configuration for scheduled upgrades. |
| initialNodeCount | integer | The number of nodes to create in this cluster. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must a |
| subnetwork | string | The name of the Google Compute Engine [subnetwork](https://cloud.google.com/compute/docs/subnetworks) to which the cluster is connected. |
| monitoringConfig | object | Monitoring configuration for the cluster. |
| fleet | object | Fleet information for the cluster. |
| initialClusterVersion | string | The initial Kubernetes version for this cluster. Valid versions are those found in validMasterVersions returned by getServerConfig. The version can be upgraded over time; such upgrades are reflected i |
| conditions | array | Which conditions caused the current cluster state. |
| releaseChannel | object | Release channel configuration. If left unspecified on cluster creation and a version is specified, the cluster is enrolled in the most mature release channel where the version is available (first chec |
| currentMasterVersion | string | Output only. The current software version of the master endpoint. |
| gkeAutoUpgradeConfig | object | Configuration for GKE auto upgrades. |
| tpuIpv4CidrBlock | string | Output only. The IP address range of the Cloud TPUs in this cluster, in [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). This field is deprecated due |
| selfLink | string | Output only. Server-defined URL for the resource. |
| shieldedNodes | object | Shielded Nodes configuration. |
| privateClusterConfig | object | Configuration for private cluster. |
| nodePoolDefaults | object | Default NodePool settings for the entire cluster. These settings are overridden if specified on the specific NodePool object. |
| enterpriseConfig | object | GKE Enterprise Configuration. Deprecated: GKE Enterprise features are now available without an Enterprise tier. |
| endpoint | string | Output only. The IP address of this cluster's master endpoint. The endpoint can be accessed from the internet at `https://username:password@endpoint/`. See the `masterAuth` property of this resource f |
| securityPostureConfig | object | Optional. Enable/Disable Security Posture API features for the cluster. |
| satisfiesPzs | boolean | Output only. Reserved for future use. |
| enableK8sBetaApis | object | Beta APIs Config |
| defaultMaxPodsConstraint | object | The default constraint on the maximum number of pods that can be run simultaneously on a node in the node pool of this cluster. Only honored if cluster created with IP Alias support. |
| ipAllocationPolicy | object | Configuration for cluster IP allocation. |
| verticalPodAutoscaling | object | Cluster-level Vertical Pod Autoscaling configuration. |
| nodeIpv4CidrSize | integer | Output only. The size of the address space on each node for hosting containers. This is provisioned from within the `container_ipv4_cidr` range. This field will only be set when cluster is in route-ba |
| databaseEncryption | object | Configuration of etcd encryption. |
| network | string | The name of the Google Compute Engine [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. If left unspecified, the `default` network wil |
| enableKubernetesAlpha | boolean | Kubernetes alpha features are enabled on this cluster. This includes alpha API groups (e.g. v1alpha1) and features that may not be production ready in the kubernetes version of the master and nodes. T |
| labelFingerprint | string | The fingerprint of the set of labels for this cluster. |
| clusterIpv4Cidr | string | The IP address range of the container pods in this cluster, in [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`). Leave blank to have one automaticall |
| instanceGroupUrls | array | Output only. Deprecated. Use node_pools.instance_group_urls. |
| zone | string | Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use location instead. |
| secretSyncConfig | object | Configuration for sync Secret Manager secrets as k8s secrets. |
| nodePools | array | The node pools associated with this cluster. This field should not be set if "node_config" or "initial_node_count" are specified. |
| status | string | Output only. The current status of this cluster. |
| masterAuth | object | The authentication information for accessing the master endpoint. If unspecified, the defaults are used: For clusters before v1.12, if master_auth is unspecified, `username` will be set to "admin", a |
| location | string | Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/r |
| nodeCreationConfig | object | Optional. Configuration for Node Creation Mode. |
| etag | string | This checksum is computed by the server based on the value of cluster fields, and may be sent on update requests to ensure the client has an up-to-date value before proceeding. |
| networkConfig | object | Configuration for cluster networking. |
| authenticatorGroupsConfig | object | Configuration controlling RBAC group membership information. |
| maintenancePolicy | object | Configure the maintenance policy for this cluster. |
| networkPolicy | object | Configuration options for the NetworkPolicy feature. |
| statusMessage | string | Output only. Deprecated. Use conditions instead. Additional information about the current status of this cluster, if available. |
| masterAuthorizedNetworksConfig | object | The configuration options for master authorized networks feature. Deprecated: Use ControlPlaneEndpointsConfig.IPEndpointsConfig.authorized_networks_config instead. |
| currentEmulatedVersion | string | Output only. The current emulated version of the master endpoint. The version is in minor version format, e.g. 1.30. No value or empty string means the cluster has no emulated version. |
| resourceUsageExportConfig | object | Configuration for exporting resource usages. Resource usage export is disabled when this config is unspecified. |
| autoscaling | object | Cluster-level autoscaling configuration. |
| managedMachineLearningDiagnosticsConfig | object | Configuration for Managed Machine Learning Diagnostics. |
| expireTime | string | Output only. The time the cluster will be automatically deleted in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. |
| monitoringService | string | The monitoring service the cluster should use to write metrics. Currently available options: * `monitoring.googleapis.com/kubernetes` - The Cloud Monitoring service with a Kubernetes-native resource m |
| name | string | The name of this cluster. The name must be unique within this project and location (e.g. zone or region), and can be up to 40 characters with the following restrictions: * Lowercase letters, numbers, |
| notificationConfig | object | Notification configuration of the cluster. |
| anonymousAuthenticationConfig | object | Configuration for limiting anonymous access to all endpoints except the health checks. |
| alphaClusterFeatureGates | array | The list of user specified Kubernetes feature gates. Each string represents the activation status of a feature gate (e.g. "featureX=true" or "featureX=false") |
| costManagementConfig | object | Configuration for the fine-grained cost allocation feature. |
| nodePoolAutoConfig | object | Node pool configs that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters. |
| addonsConfig | object | Configurations for the various addons available to run in the cluster. |
| workloadIdentityConfig | object | Configuration for the use of Kubernetes Service Accounts in IAM policies. |
| identityServiceConfig | object | Configuration for Identity Service component. |
| confidentialNodes | object | Configuration of Confidential Nodes. All the nodes in the cluster will be Confidential VM once enabled. |
| secretManagerConfig | object | Secret CSI driver configuration. |
| resourceLabels | object | The resource labels for the cluster to use to annotate any related Google Compute Engine resources. |
| enableTpu | boolean | Enable the ability to use Cloud TPUs in this cluster. This field is deprecated due to the deprecation of 2VM TPU. The end of life date for 2VM TPU is 2025-04-25. |
| meshCertificates | object | Configuration for issuance of mTLS keys and certificates to Kubernetes pods. |
| legacyAbac | object | Configuration for the legacy ABAC authorization mode. |
| loggingConfig | object | Logging configuration for the cluster. |
| currentNodeCount | integer | Output only. The number of nodes currently in the cluster. Deprecated. Call Kubernetes API directly to retrieve node information. |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://artifacts.apis.io/google-kubernetes-engine/json-schema/google-kubernetes-engine-cluster-schema.json",
"title": "Cluster",
"description": "A Google Kubernetes Engine cluster.",
"x-generated": "2026-11-11",
"x-method": "derived",
"x-generator": "derive-json-schema.py",
"x-source": "openapi/google-kubernetes-engine-container-projects-api-openapi.yml#/components/schemas/Cluster",
"properties": {
"locations": {
"type": "array",
"description": "The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the cluster's nodes should be located. This field provides a default value if [NodePool.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) are not specified during node pool creation. Warning: changing cluster locations will update the [NodePool.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) of all node pools and will result in nodes being added and/or removed.",
"items": {
"type": "string"
}
},
"loggingService": {
"type": "string",
"description": "The logging service the cluster should use to write logs. Currently available options: * `logging.googleapis.com/kubernetes` - The Cloud Logging service with a Kubernetes-native resource model * `logging.googleapis.com` - The legacy Cloud Logging service (no longer available as of GKE 1.15). * `none` - no logs will be exported from the cluster. If left as an empty string,`logging.googleapis.com/kubernetes` will be used for GKE 1.14+ or `logging.googleapis.com` for earlier versions."
},
"binaryAuthorization": {
"$ref": "#/$defs/BinaryAuthorization",
"description": "Configuration for Binary Authorization."
},
"rollbackSafeUpgrade": {
"$ref": "#/$defs/RollbackSafeUpgrade",
"description": "Optional. The rollback safe upgrade information of the cluster. This field is used when user manually triggers a rollback safe upgrade."
},
"currentNodeVersion": {
"readOnly": true,
"type": "string",
"description": "Output only. Deprecated, use [NodePools.version](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools) instead. The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes.",
"deprecated": true
},
"servicesIpv4Cidr": {
"readOnly": true,
"description": "Output only. The IP address range of the Kubernetes services in this cluster, in [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). Service addresses are typically put in the last `/16` from the container CIDR.",
"type": "string"
},
"nodeConfig": {
"$ref": "#/$defs/NodeConfig",
"description": "Parameters used in creating the cluster's nodes. For requests, this field should only be used in lieu of a \"node_pool\" object, since this configuration (along with the \"initial_node_count\") will be used to create a \"NodePool\" object with an auto-generated name. Do not use this and a node_pool at the same time. For responses, this field will be populated with the node configuration of the first node pool. (For configuration of each node pool, see `node_pool.config`) If unspecified, the defaults are used. This field is deprecated, use node_pool.config instead."
},
"parentProductConfig": {
"$ref": "#/$defs/ParentProductConfig",
"description": "The configuration of the parent product of the cluster. This field is used by Google internal products that are built on top of the GKE cluster and take the ownership of the cluster."
},
"rbacBindingConfig": {
"$ref": "#/$defs/RBACBindingConfig",
"description": "RBACBindingConfig allows user to restrict ClusterRoleBindings an RoleBindings that can be created."
},
"autopilot": {
"$ref": "#/$defs/Autopilot",
"description": "Autopilot configuration for the cluster."
},
"podAutoscaling": {
"$ref": "#/$defs/PodAutoscaling",
"description": "The config for pod autoscaling."
},
"controlPlaneEndpointsConfig": {
"$ref": "#/$defs/ControlPlaneEndpointsConfig",
"description": "Configuration for all cluster's control plane endpoints."
},
"userManagedKeysConfig": {
"$ref": "#/$defs/UserManagedKeysConfig",
"description": "The Custom keys configuration for the cluster."
},
"id": {
"description": "Output only. Unique id for the cluster.",
"readOnly": true,
"type": "string"
},
"managedOpentelemetryConfig": {
"$ref": "#/$defs/ManagedOpenTelemetryConfig",
"description": "Configuration for Managed OpenTelemetry pipeline."
},
"description": {
"type": "string",
"description": "An optional description of this cluster."
},
"compliancePostureConfig": {
"$ref": "#/$defs/CompliancePostureConfig",
"description": "Optional. Deprecated: Compliance Posture is no longer supported. For more details, see https://cloud.google.com/kubernetes-engine/docs/deprecations/posture-management-deprecation. Enable/Disable Compliance Posture features for the cluster."
},
"createTime": {
"type": "string",
"readOnly": true,
"description": "Output only. The time the cluster was created, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format."
},
"controlPlaneEgress": {
"$ref": "#/$defs/ControlPlaneEgress",
"description": "Configuration for control plane egress control."
},
"satisfiesPzi": {
"readOnly": true,
"type": "boolean",
"description": "Output only. Reserved for future use."
},
"scheduleUpgradeConfig": {
"$ref": "#/$defs/ScheduleUpgradeConfig",
"description": "Optional. Configuration for scheduled upgrades."
},
"initialNodeCount": {
"format": "int32",
"description": "The number of nodes to create in this cluster. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. For requests, this field should only be used in lieu of a \"node_pool\" object, since this configuration (along with the \"node_config\") will be used to create a \"NodePool\" object with an auto-generated name. Do not use this and a node_pool at the same time. This field is deprecated, use node_pool.initial_node_count instead.",
"type": "integer",
"deprecated": true
},
"subnetwork": {
"description": "The name of the Google Compute Engine [subnetwork](https://cloud.google.com/compute/docs/subnetworks) to which the cluster is connected.",
"type": "string"
},
"monitoringConfig": {
"$ref": "#/$defs/MonitoringConfig",
"description": "Monitoring configuration for the cluster."
},
"fleet": {
"$ref": "#/$defs/Fleet",
"description": "Fleet information for the cluster."
},
"initialClusterVersion": {
"type": "string",
"description": "The initial Kubernetes version for this cluster. Valid versions are those found in validMasterVersions returned by getServerConfig. The version can be upgraded over time; such upgrades are reflected in currentMasterVersion and currentNodeVersion. Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior: - \"latest\": picks the highest valid Kubernetes version - \"1.X\": picks the highest valid patch+gke.N patch in the 1.X version - \"1.X.Y\": picks the highest valid gke.N patch in the 1.X.Y version - \"1.X.Y-gke.N\": picks an explicit Kubernetes version - \"\",\"-\": picks the default Kubernetes version"
},
"conditions": {
"description": "Which conditions caused the current cluster state.",
"items": {
"$ref": "#/$defs/StatusCondition"
},
"type": "array"
},
"releaseChannel": {
"$ref": "#/$defs/ReleaseChannel",
"description": "Release channel configuration. If left unspecified on cluster creation and a version is specified, the cluster is enrolled in the most mature release channel where the version is available (first checking STABLE, then REGULAR, and finally RAPID). Otherwise, if no release channel configuration and no version is specified, the cluster is enrolled in the REGULAR channel with its default version."
},
"currentMasterVersion": {
"description": "Output only. The current software version of the master endpoint.",
"readOnly": true,
"type": "string"
},
"gkeAutoUpgradeConfig": {
"$ref": "#/$defs/GkeAutoUpgradeConfig",
"description": "Configuration for GKE auto upgrades."
},
"tpuIpv4CidrBlock": {
"type": "string",
"description": "Output only. The IP address range of the Cloud TPUs in this cluster, in [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). This field is deprecated due to the deprecation of 2VM TPU. The end of life date for 2VM TPU is 2025-04-25.",
"readOnly": true,
"deprecated": true
},
"selfLink": {
"type": "string",
"readOnly": true,
"description": "Output only. Server-defined URL for the resource."
},
"shieldedNodes": {
"$ref": "#/$defs/ShieldedNodes",
"description": "Shielded Nodes configuration."
},
"privateClusterConfig": {
"$ref": "#/$defs/PrivateClusterConfig",
"description": "Configuration for private cluster."
},
"nodePoolDefaults": {
"$ref": "#/$defs/NodePoolDefaults",
"description": "Default NodePool settings for the entire cluster. These settings are overridden if specified on the specific NodePool object."
},
"enterpriseConfig": {
"$ref": "#/$defs/EnterpriseConfig",
"description": "GKE Enterprise Configuration. Deprecated: GKE Enterprise features are now available without an Enterprise tier."
},
"endpoint": {
"readOnly": true,
"description": "Output only. The IP address of this cluster's master endpoint. The endpoint can be accessed from the internet at `https://username:password@endpoint/`. See the `masterAuth` property of this resource for username and password information.",
"type": "string"
},
"securityPostureConfig": {
"$ref": "#/$defs/SecurityPostureConfig",
"description": "Optional. Enable/Disable Security Posture API features for the cluster."
},
"satisfiesPzs": {
"type": "boolean",
"readOnly": true,
"description": "Output only. Reserved for future use."
},
"enableK8sBetaApis": {
"$ref": "#/$defs/K8sBetaAPIConfig",
"description": "Beta APIs Config"
},
"defaultMaxPodsConstraint": {
"$ref": "#/$defs/MaxPodsConstraint",
"description": "The default constraint on the maximum number of pods that can be run simultaneously on a node in the node pool of this cluster. Only honored if cluster created with IP Alias support."
},
"ipAllocationPolicy": {
"$ref": "#/$defs/IPAllocationPolicy",
"description": "Configuration for cluster IP allocation."
},
"verticalPodAutoscaling": {
"$ref": "#/$defs/VerticalPodAutoscaling",
"description": "Cluster-level Vertical Pod Autoscaling configuration."
},
"nodeIpv4CidrSize": {
"format": "int32",
"description": "Output only. The size of the address space on each node for hosting containers. This is provisioned from within the `container_ipv4_cidr` range. This field will only be set when cluster is in route-based network mode.",
"type": "integer",
"readOnly": true
},
"databaseEncryption": {
"$ref": "#/$defs/DatabaseEncryption",
"description": "Configuration of etcd encryption."
},
"network": {
"type": "string",
"description": "The name of the Google Compute Engine [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. If left unspecified, the `default` network will be used."
},
"enableKubernetesAlpha": {
"description": "Kubernetes alpha features are enabled on this cluster. This includes alpha API groups (e.g. v1alpha1) and features that may not be production ready in the kubernetes version of the master and nodes. The cluster has no SLA for uptime and master/node upgrades are disabled. Alpha enabled clusters are automatically deleted thirty days after creation.",
"type": "boolean"
},
"labelFingerprint": {
"type": "string",
"description": "The fingerprint of the set of labels for this cluster."
},
"clusterIpv4Cidr": {
"type": "string",
"description": "The IP address range of the container pods in this cluster, in [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`). Leave blank to have one automatically chosen or specify a `/14` block in `10.0.0.0/8`."
},
"instanceGroupUrls": {
"readOnly": true,
"description": "Output only. Deprecated. Use node_pools.instance_group_urls.",
"type": "array",
"items": {
"type": "string"
},
"deprecated": true
},
"zone": {
"type": "string",
"readOnly": true,
"description": "Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use location instead.",
"deprecated": true
},
"secretSyncConfig": {
"$ref": "#/$defs/SecretSyncConfig",
"description": "Configuration for sync Secret Manager secrets as k8s secrets."
},
"nodePools": {
"description": "The node pools associated with this cluster. This field should not be set if \"node_config\" or \"initial_node_count\" are specified.",
"type": "array",
"items": {
"$ref": "#/$defs/NodePool"
}
},
"status": {
"type": "string",
"readOnly": true,
"description": "Output only. The current status of this cluster.",
"enum": [
"STATUS_UNSPECIFIED",
"PROVISIONING",
"RUNNING",
"RECONCILING",
"STOPPING",
"ERROR",
"DEGRADED"
]
},
"masterAuth": {
"$ref": "#/$defs/MasterAuth",
"description": "The authentication information for accessing the master endpoint. If unspecified, the defaults are used: For clusters before v1.12, if master_auth is unspecified, `username` will be set to \"admin\", a random password will be generated, and a client certificate will be issued."
},
"location": {
"type": "string",
"readOnly": true,
"description": "Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides."
},
"nodeCreationConfig": {
"$ref": "#/$defs/NodeCreationConfig",
"description": "Optional. Configuration for Node Creation Mode."
},
"etag": {
"description": "This checksum is computed by the server based on the value of cluster fields, and may be sent on update requests to ensure the client has an up-to-date value before proceeding.",
"type": "string"
},
"networkConfig": {
"$ref": "#/$defs/NetworkConfig",
"description": "Configuration for cluster networking."
},
"authenticatorGroupsConfig": {
"$ref": "#/$defs/AuthenticatorGroupsConfig",
"description": "Configuration controlling RBAC group membership information."
},
"maintenancePolicy": {
"$ref": "#/$defs/MaintenancePolicy",
"description": "Configure the maintenance policy for this cluster."
},
"networkPolicy": {
"$ref": "#/$defs/NetworkPolicy",
"description": "Configuration options for the NetworkPolicy feature."
},
"statusMessage": {
"readOnly": true,
"type": "string",
"description": "Output only. Deprecated. Use conditions instead. Additional information about the current status of this cluster, if available.",
"deprecated": true
},
"masterAuthorizedNetworksConfig": {
"$ref": "#/$defs/MasterAuthorizedNetworksConfig",
"description": "The configuration options for master authorized networks feature. Deprecated: Use ControlPlaneEndpointsConfig.IPEndpointsConfig.authorized_networks_config instead."
},
"currentEmulatedVersion": {
"readOnly": true,
"type": "string",
"description": "Output only. The current emulated version of the master endpoint. The version is in minor version format, e.g. 1.30. No value or empty string means the cluster has no emulated version."
},
"resourceUsageExportConfig": {
"$ref": "#/$defs/ResourceUsageExportConfig",
"description": "Configuration for exporting resource usages. Resource usage export is disabled when this config is unspecified."
},
"autoscaling": {
"$ref": "#/$defs/ClusterAutoscaling",
"description": "Cluster-level autoscaling configuration."
},
"managedMachineLearningDiagnosticsConfig": {
"$ref": "#/$defs/ManagedMachineLearningDiagnosticsConfig",
"description": "Configuration for Managed Machine Learning Diagnostics."
},
"expireTime": {
"readOnly": true,
"description": "Output only. The time the cluster will be automatically deleted in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.",
"type": "string"
},
"monitoringService": {
"type": "string",
"description": "The monitoring service the cluster should use to write metrics. Currently available options: * `monitoring.googleapis.com/kubernetes` - The Cloud Monitoring service with a Kubernetes-native resource model * `monitoring.googleapis.com` - The legacy Cloud Monitoring service (no longer available as of GKE 1.15). * `none` - No metrics will be exported from the cluster. If left as an empty string,`monitoring.googleapis.com/kubernetes` will be used for GKE 1.14+ or `monitoring.googleapis.com` for earlier versions."
},
"name": {
"type": "string",
"description": "The name of this cluster. The name must be unique within this project and location (e.g. zone or region), and can be up to 40 characters with the following restrictions: * Lowercase letters, numbers, and hyphens only. * Must start with a letter. * Must end with a number or a letter."
},
"notificationConfig": {
"$ref": "#/$defs/NotificationConfig",
"description": "Notification configuration of the cluster."
},
"anonymousAuthenticationConfig": {
"$ref": "#/$defs/AnonymousAuthenticationConfig",
"description": "Configuration for limiting anonymous access to all endpoints except the health checks."
},
"alphaClusterFeatureGates": {
"items": {
"type": "string"
},
"description": "The list of user specified Kubernetes feature gates. Each string represents the activation status of a feature gate (e.g. \"featureX=true\" or \"featureX=false\")",
"type": "array"
},
"costManagementConfig": {
"$ref": "#/$defs/CostManagementConfig",
"description": "Configuration for the fine-grained cost allocation feature."
},
"nodePoolAutoConfig": {
"$ref": "#/$defs/NodePoolAutoConfig",
"description": "Node pool configs that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters."
},
"addonsConfig": {
"$ref": "#/$defs/AddonsConfig",
"description": "Configurations for the various addons available to run in the cluster."
},
"workloadIdentityConfig": {
"$ref": "#/$defs/WorkloadIdentityConfig",
"description": "Configuration for the use of Kubernetes Service Accounts in IAM policies."
},
"identityServiceConfig": {
"$ref": "#/$defs/IdentityServiceConfig",
"description": "Configuration for Identity Service component."
},
"confidentialNodes": {
"$ref": "#/$defs/ConfidentialNodes",
"description": "Configuration of Confidential Nodes. All the nodes in the cluster will be Confidential VM once enabled."
},
"secretManagerConfig": {
"$ref": "#/$defs/SecretManagerConfig",
"description": "Secret CSI driver configuration."
},
"resourceLabels": {
"type": "object",
"description": "The resource labels for the cluster to use to annotate any related Google Compute Engine resources.",
"additionalProperties": {
"type": "string"
}
},
"enableTpu": {
"description": "Enable the ability to use Cloud TPUs in this cluster. This field is deprecated due to the deprecation of 2VM TPU. The end of life date for 2VM TPU is 2025-04-25.",
"type": "boolean",
"deprecated": true
},
"meshCertificates": {
"$ref": "#/$defs/MeshCertificates",
"description": "Configuration for issuance of mTLS keys and certificates to Kubernetes pods."
},
"legacyAbac": {
"$ref": "#/$defs/LegacyAbac",
"description": "Configuration for the legacy ABAC authorization mode."
},
"loggingConfig": {
"$ref": "#/$defs/LoggingConfig",
"description": "Logging configuration for the cluster."
},
"currentNodeCount": {
"format": "int32",
"type": "integer",
"description": "Output only. The number of nodes currently in the cluster. Deprecated. Call Kubernetes API directly to retrieve node information.",
"readOnly": true,
"deprecated": true
}
},
"type": "object",
"$defs": {
"AcceleratorConfig": {
"properties": {
"acceleratorType": {
"type": "string",
"description": "The accelerator type resource name. List of supported accelerators [here](https://cloud.google.com/compute/docs/gpus)"
},
"gpuSharingConfig": {
"$ref": "#/$defs/GPUSharingConfig",
"description": "The configuration for GPU sharing options."
},
"gpuDriverInstallationConfig": {
"$ref": "#/$defs/GPUDriverInstallationConfig",
"description": "The configuration for auto installation of GPU driver."
},
"acceleratorCount": {
"description": "The number of the accelerator cards exposed to an instance.",
"format": "int64",
"type": "string"
},
"gpuPartitionSize": {
"description": "Size of partitions to create on the GPU. Valid values are described in the NVIDIA [mig user guide](https://docs.nvidia.com/datacenter/tesla/mig-user-guide/#partitioning).",
"type": "string"
}
},
"type": "object",
"description": "AcceleratorConfig represents a Hardware Accelerator request."
},
"AccurateTimeConfig": {
"type": "object",
"properties": {
"enablePtpKvmTimeSync": {
"description": "Enables enhanced time synchronization using PTP-KVM.",
"type": "boolean"
}
},
"description": "AccurateTimeConfig contains configuration for the accurate time synchronization feature."
},
"AdditionalIPRangesConfig": {
"type": "object",
"description": "AdditionalIPRangesConfig is the configuration for individual additional subnetwork attached to the cluster",
"properties": {
"status": {
"description": "Draining status of the additional subnet.",
"enum": [
"STATUS_UNSPECIFIED",
"ACTIVE",
"DRAINING"
],
"type": "string"
},
"subnetwork": {
"description": "Name of the subnetwork. This can be the full path of the subnetwork or just the name. Example1: my-subnet Example2: projects/gke-project/regions/us-central1/subnetworks/my-subnet",
"type": "string"
},
"podIpv4RangeNames": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of secondary ranges names within this subnetwork that can be used for pod IPs. Example1: gke-pod-range1 Example2: gke-pod-range1,gke-pod-range2"
}
}
},
"AdditionalNodeNetworkConfig": {
"properties": {
"network": {
"description": "Name of the VPC where the additional interface belongs",
"type": "string"
},
"subnetwork": {
"description": "Name of the subnetwork where the additional interface belongs",
"type": "string"
}
},
"type": "object",
"description": "AdditionalNodeNetworkConfig is the configuration for additional node networks within the NodeNetworkConfig message"
},
"AdditionalPodNetworkConfig": {
"properties": {
"secondaryPodRange": {
"type": "string",
"description": "The name of the secondary range on the subnet which provides IP address for this pod range."
},
"subnetwork": {
"type": "string",
"description": "Name of the subnetwork where the additional pod network belongs."
},
"networkAttachment": {
"description": "The name of the network attachment for pods to communicate to; cannot be specified along with subnetwork or secondary_pod_range.",
"type": "string"
},
"maxPodsPerNode": {
"$ref": "#/$defs/MaxPodsConstraint",
"description": "The maximum number of pods per node which use this pod network."
}
},
"description": "AdditionalPodNetworkConfig is the configuration for additional pod networks within the NodeNetworkConfig message",
"type": "object"
},
"AdditionalPodRangesConfig": {
"properties": {
"podRangeInfo": {
"readOnly": true,
"type": "array",
"description": "Output only. Information for additional pod range.",
"items": {
"$ref": "#/$defs/RangeInfo"
}
},
"podRangeNames": {
"description": "Name for pod secondary ipv4 range which has the actual range defined ahead.",
"type": "array",
"items": {
"type": "string"
}
}
},
"description": "AdditionalPodRangesConfig is the configuration for additional pod secondary ranges supporting the ClusterUpdate message.",
"type": "object"
},
"AddonsConfig": {
"type": "object",
"description": "Configuration for the addons that can be automatically spun up in the cluster, enabling additional functionality.",
"properties": {
"gcePersistentDiskCsiDriverConfig": {
"$ref": "#/$defs/GcePersistentDiskCsiDriverConfig",
"description": "Configuration for the Compute Engine Persistent Disk CSI driver."
},
"configConnectorConfig": {
"$ref": "#/$defs/ConfigConnectorConfig",
"description": "Configuration for the ConfigConnector add-on, a Kubernetes extension to manage hosted Google Cloud services through the Kubernetes API."
},
"parallelstoreCsiDriverConfig": {
"$ref": "#/$defs/ParallelstoreCsiDriverConfig",
"description": "Deprecated: The Parallelstore CSI driver is no longer supported. Configuration for the Cloud Storage Parallelstore CSI driver."
},
"agentSandboxConfig": {
"$ref": "#/$defs/AgentSandboxConfig",
"description": "Optional. Configuration for the AgentSandbox addon."
},
"nodeReadinessConfig": {
"$ref": "#/$defs/NodeReadinessConfig",
"description": "Optional. Configuration for NodeReadinessController add-on."
},
"dnsCacheConfig": {
"$ref": "#/$defs/DnsCacheConfig",
"description": "Configuration for NodeLocalDNS, a dns cache running on cluster nodes"
},
"cloudRunConfig": {
"$ref": "#/$defs/CloudRunConfig",
"description": "Configuration for the Cloud Run addon, which allows the user to use a managed Knative service."
},
"sliceControllerConfig": {
"$ref": "#/$defs/SliceControllerConfig",
"description": "Optional. Configuration for the slice controller add-on."
},
"httpLoadBalancing": {
"$ref": "#/$defs/HttpLoadBalancing",
"description": "Configuration for the HTTP (L7) load balancing controller addon, which makes it easy to set up HTTP load balancers for services in a cluster."
},
"highScaleCheckpointingConfig": {
"$ref": "#/$defs/HighScaleCheckpointingConfig",
"description": "Configuration for the High Scale Checkpointing add-on."
},
"gcsFuseCsiDriverConfig": {
"$ref": "#/$defs/GcsFuseCsiDriverConfig",
"description": "Configuration for the Cloud Storage Fuse CSI driver."
},
"gkeBackupAgentConfig": {
"$ref": "#/$defs/GkeBackupAgentConfig",
"description": "Configuration for the Backup for GKE agent addon."
},
"rayOperatorConfig": {
"$ref": "#/$defs/RayOperatorConfig",
"description": "Optional. Configuration for Ray Operator addon."
},
"slurmOperatorConfig": {
"$ref": "#/$defs/SlurmOperatorConfig",
"description": "Configuration for the Slurm Operator."
},
"statefulHaConfig": {
"$ref": "#/$defs/StatefulHAConfig",
"description": "Optional. Configuration for the StatefulHA add-on."
},
"horizontalPodAutoscaling": {
"$ref": "#/$defs/HorizontalPodAutoscaling",
"description": "Configuration for the horizontal pod autoscaling feature, which increases or decreases the number of replica pods a replication controller has based on the resource usage of the existing pods."
},
"gcpFilestoreCsiDriverConfig": {
"$ref": "#/$defs/GcpFilestoreCsiDriverConfig",
"description": "Configuration for the Filestore CSI driver."
},
"podSnapshotConfig": {
"$ref": "#/$defs/PodSnapshotConfig",
"description": "Optional. Configuration for the Pod Snapshot feature."
},
"wizSensorConfig": {
"$ref": "#/$defs/WizSensorConfig",
"description": "Optional. Configuration for the Wiz Sensor add-on."
},
"kubernetesDashboard": {
"$ref": "#/$defs/KubernetesDashboard",
"description": "Configuration for the Kubernetes Dashboard. This addon is deprecated, and will be disabled in 1.15. It is recommended to use the Cloud Console to manage and monitor your Kubernetes clusters, workloads and applications. For more information, see: https://cloud.google.com/kubernetes-engine/docs/concepts/dashboards"
},
"networkPolicyConfig": {
"$ref": "#/$defs/NetworkPolicyConfig",
"description": "Configuration for NetworkPolicy. This only tracks whether the addon is enabled or not on the Master, it does not track whether network policy is enabled for the nodes."
},
"lustreCsiDriverConfig": {
"$ref": "#/$defs/LustreCsiDriverConfig",
"description": "Configuration for the Lustre CSI driver."
}
}
},
"AdvancedDatapathObservabilityConfig": {
"properties": {
"enableRelay": {
"type": "boolean",
"description": "Enable Relay component"
},
"enableMetrics": {
"description": "Expose flow metrics on nodes",
"type": "boolean"
},
"relayMode": {
"description": "Method used to make Relay available",
"type": "string",
"enum": [
"RELAY_MODE_UNSPECIFIED",
"DISABLED",
"INTERNAL_VPC_LB",
"EXTERNAL_LB"
]
}
},
"description": "AdvancedDatapathObservabilityConfig specifies configuration of observability features of advanced datapath.",
"type": "object"
},
"AdvancedMachineFeatures": {
"properties": {
"threadsPerCore": {
"type": "string",
"format": "in
# --- truncated at 32 KB (232 KB total) ---
# Full source: https://artifacts.apis.io/google-kubernetes-engine/json-schema/google-kubernetes-engine-cluster-schema.json
Work with this as data
Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for schemas
4 MCP tools reach this
find_json_schemasBrowse and filter every JSON Schema in the catalog.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/google-kubernetes-engine-cluster"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.