Google GKE On-Prem API
Browse all Google APIs40
AI ReadinessNon-Ready (F)40/100
Official vendor OpenAPI document · agent-readyCloud InfrastructureContainer Orchestrationoauth231 EndpointsREST
For Agents
Provision, upgrade, and enroll on-prem Anthos clusters on bare metal or VMware, including admin and user clusters. Built for platform teams running Kubernetes outside Google Cloud.
Use for: Create a bare metal admin cluster in my data centre, Create a user cluster under an existing bare metal admin cluster, List all bare metal clusters in my project, Query the supported versions for a bare metal user cluster
Not supported: Does not provision cloud-hosted GKE, run workloads inside clusters, or manage IAM directly - use the Container API for cloud GKE, the cluster's Kubernetes API for workloads, and Cloud IAM for role bindings.
The GKE On-Prem API manages Anthos clusters that run on customer hardware, including bare metal admin and user clusters and VMware-based clusters. It supports cluster creation, upgrades, enrollment of existing clusters, and version queries, integrating on-prem clusters with the rest of Google Cloud's control plane. The API works alongside GKE Hub so on-prem clusters appear in fleets and can receive fleet-level features.
Install Jentic One Beta
Connect the GKE On-Prem API to your agent
Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the GKE On-Prem API, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.
Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.
1
Step 1: Jentic One Host machine
# On the machine that will host your Jentic One instance:
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Fgoogleapis.com%2Fgkeonprem" | sh2
Step 2: Agent machine
# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Fgoogleapis.com%2Fgkeonprem" | sh
jentic register # connects your agent to your Jentic One instanceJentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.
Capabilities
What an agent can do with GKE On-Prem API.
Create bare metal admin and user clusters in a given Cloud location
Enroll an existing on-prem cluster into the GKE On-Prem control plane
Query supported version configurations for a cluster type
List, get, update, and delete clusters managed by the API
Unenroll a cluster from Google Cloud without destroying it
List long-running operations and cancel them when needed
Use Cases
Patterns agents use GKE On-Prem API for, with concrete tasks.
★ Provision an On-Prem Anthos Bare Metal Cluster
Enterprises that need Kubernetes on their own hardware use Anthos on bare metal to run a managed control plane locally. The GKE On-Prem API creates the bare metal admin cluster and subsequent user clusters in a Google Cloud location, providing a single API surface for cluster lifecycle. Once created, clusters are managed alongside cloud GKE clusters in the same project.
Call POST /v1/projects/{project}/locations/{location}/bareMetalAdminClusters with the network and node specs, then create user clusters under it.
Enroll Existing On-Prem Clusters
Operators sometimes have legacy bare metal clusters they want to bring under Google Cloud control without recreating them. The enroll endpoints register an existing cluster with the GKE On-Prem API so it appears alongside other clusters and can receive lifecycle operations. Unenroll reverses the action, leaving the cluster intact.
Call POST /v1/{parent}/bareMetalAdminClusters:enroll with the local cluster details to register it, and verify with GET on the resulting resource name.
Plan Cluster Upgrades
Before upgrading an on-prem cluster, operators need to know the exact target version supported for that cluster shape and the current version. The queryVersionConfig endpoints return supported versions and upgrade paths for bare metal admin and user clusters, supporting safe upgrade planning across many on-prem sites.
Call POST /v1/{parent}/bareMetalUserClusters:queryVersionConfig and use the returned version list to drive the upgrade plan for each cluster.
Agent-Assisted On-Prem Cluster Lifecycle
An AI agent in a platform engineering toolchain can guide an operator through enrolling, upgrading, and decommissioning on-prem clusters. Through Jentic, the agent searches for the right cluster operation by intent, loads its schema, and executes it under the operator's IAM scope without holding raw service account keys.
Use Jentic to search 'enroll a bare metal cluster', load the enroll schema, and execute it for the target cluster identifier.
Key Endpoints
31 endpoints — the gke on-prem api manages anthos clusters that run on customer hardware, including bare metal admin and user clusters and vmware-based clusters.
METHOD
PATH
DESCRIPTION
GET
/v1/{+parent}/bareMetalAdminClusters
List bare metal admin clusters
POST
/v1/{+parent}/bareMetalAdminClusters
Create a bare metal admin cluster
POST
/v1/{+parent}/bareMetalAdminClusters:enroll
Enroll an existing bare metal admin cluster
POST
/v1/{+parent}/bareMetalAdminClusters:queryVersionConfig
Query supported versions for admin clusters
GET
/v1/{+parent}/bareMetalClusters
List bare metal user clusters
POST
/v1/{+parent}/bareMetalClusters
Create a bare metal user cluster
POST
/v1/{+parent}/bareMetalClusters:enroll
Enroll an existing bare metal user cluster
DELETE
/v1/{+name}:unenroll
Unenroll a cluster without destroying it
GET
/v1/{+parent}/bareMetalAdminClusters
List bare metal admin clusters
POST
/v1/{+parent}/bareMetalAdminClusters
Create a bare metal admin cluster
POST
/v1/{+parent}/bareMetalAdminClusters:enroll
Enroll an existing bare metal admin cluster
POST
/v1/{+parent}/bareMetalAdminClusters:queryVersionConfig
Query supported versions for admin clusters
GET
/v1/{+parent}/bareMetalClusters
List bare metal user clusters
POST
/v1/{+parent}/bareMetalClusters
Create a bare metal user cluster
POST
/v1/{+parent}/bareMetalClusters:enroll
Enroll an existing bare metal user cluster
DELETE
/v1/{+name}:unenroll
Unenroll a cluster without destroying it
Jentic AI Readiness Score
This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use.
G
GKE On-Prem API
- Non-Ready (F)40/100
38
Foundational Compliance56
Developer Experience & Jentic Compatibility20
AI-Readiness & Agent Experience94
Agent Usability63
Security68
AI DiscoverabilityPowered by JenticScoring Framework 1.0.0 | Scoring Engine 0.4.0
Show dimension breakdown
38
Foundational Compliance
Base layer of spec validity and structural soundness.
Grade: FSignals: 4
51%
Lint Results
Aggregated quality score from linter diagnostics, weighted by severity.
100%
Resolution Completeness
Percentage of `$ref` references that resolve successfully.
0%
Specification Validity
Checks whether the API description parses successfully and conforms to its declared specification (e.g., OpenAPI).
0%
Structural Integrity
Structural correctness score based on schema issues using logarithmic dampening.
56
Developer Experience & Jentic Compatibility
Clarity, completeness, and ingestion readiness for developers and tooling.
Grade: CSignals: 4
0%
Example Density
How richly the API is illustrated with examples.
100%
Example Validity
Percentage of examples that conform to their schemas.
25%
Response Coverage
Percentage of operations with complete response definitions (success, client error, server error).
100%
Tooling Readiness
Health of API ingestion, bundling, and resolution within Jentic pipelines.
20
AI-Readiness & Agent Experience
Semantic breadth, depth, and agent comprehension for AI systems.
Grade: FSignals: 4
78%
Description Coverage
Coverage of descriptions across API elements.
0%
Error Standardization
Coverage of RFC 9457 Problem Details for error responses.
0%
OperationId Quality
Coverage, uniqueness, and casing consistency of operationIds for AI inference.
0%
Summary Coverage
Coverage of summaries across operations/tags/info.
94
Agent Usability
Functional utility, complexity comfort, and AI orchestration readiness.
Grade: A+Signals: 1
94%
Complexity Comfort
Agent comfort level based on API operational and structural complexity.
63
Security
Trust, risk posture, and security compliance.
Grade: B-Signals: 1
62%
Authentication Strength
Average quality of security schemes based on authentication method strength (weakest link for OAuth2).
68
AI Discoverability
Findability, semantic richness, and reasoning readiness.
Grade: B+Signals: 1
68%
Descriptive Richness
Clarity and depth of descriptions across API elements.
Score it yourself
Every API in the directory is allowlisted, so you can re-score it with no key required.
npx @jentic/api-scorecard-cli score <openapi-url>Why Jentic?
What agents get from Jentic-routed access to this vendor.
Setup
Wiring the GKE On-Prem API by hand means standing up Google OAuth 2.0 with a service account, requesting the cloud-platform scope, and polling the long-running cluster enroll and create operations yourself. Through Jentic you install once, import the GKE On-Prem API from the API Directory, store the service-account credential once, and your agent calls it.
Permission scoping
GKE On-Prem puts the parent project and location in the URL path (/v1/{parent}/bareMetalClusters, /v1/{parent}/bareMetalAdminClusters), so a rule can pin your agent to one project and location: it can list and enroll clusters there and nothing else. You choose the operations it may call, so unenroll is not included unless you add it.
Credential isolation
Your Google service-account credential is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
Intent-based discovery
Agents search Jentic by intent such as 'enroll a bare metal cluster' or 'query version config', and Jentic returns the matching operation with its input schema so the agent calls the right endpoint without browsing the reference docs.
Related APIs
Alternatives and complements available in the Jentic catalogue.
FAQs
Specific to using GKE On-Prem API through Jentic.
What authentication does the GKE On-Prem API use?
It uses Google OAuth 2.0 with the cloud-platform scope, typically through a service account with anthos and gkeonprem-related IAM roles. Through Jentic, credentials live encrypted in the vault and agents receive scoped bearer tokens.
Can I create a bare metal user cluster with this API?
Yes. Once a bare metal admin cluster exists, call POST /v1/{parent}/bareMetalClusters with the desired control-plane and node-pool spec to provision a user cluster under it.
What are the rate limits for the GKE On-Prem API?
Google enforces standard per-project quotas on management calls. Cluster create and upgrade operations are long-running operations whose runtime depends on the underlying hardware, not the API rate.
How do I enroll an existing on-prem cluster through Jentic?
Search Jentic for 'enroll a bare metal cluster', load the schema for POST /v1/{parent}/bareMetalAdminClusters:enroll or the user-cluster equivalent, and execute it with the existing cluster's local identifier.
Is the GKE On-Prem API free?
The API itself has no separate charge, but Anthos on bare metal and Anthos on VMware have per-vCPU subscription pricing. See Anthos pricing for current rates.
Does this API run workloads on the cluster?
No. The API only manages cluster lifecycle. Workload deployment happens via the cluster's Kubernetes API once the cluster is created or enrolled.
Can I limit what my agent is allowed to do with the GKE On-Prem API?
Yes. Because you self-host Jentic One, your own rules decide which GKE On-Prem operations and which Google service-account credential the agent may use. Since this API puts the parent project and location in the URL path (/v1/{parent}/bareMetalClusters and /v1/{parent}/bareMetalAdminClusters), you can pin the agent to a single project and location and allow only the operations you choose, such as listing and enrolling clusters. Destructive calls like unenroll stay off unless you explicitly add them.
GET STARTED