VMware Engine API

Name: VMware Engine API API
Brand: VMware Engine API
Availability: InStock

✓ Official Vendor SpecCloud InfrastructureComputeoauth245 EndpointsREST

For Agents

Provision and manage VMware private clouds, clusters, and networks in Google Cloud so an agent can scale capacity, peer networks, and rotate credentials without console clicks.

Quickstart

Get started with VMware Engine API in minutes using your preferred integration method.

# Add to your MCP client config (Claude Desktop, Cursor, Windsurf)
{
  "jentic": {
    "url": "https://api.jentic.com/mcp",
    "auth": "oauth"
  }
}

# Then ask your agent:
"create a vmware private cloud"

# → Jentic returns the GET /events tool with parameter schema, agent executes.

Capabilities

What an agent can do with VMware Engine API API.

Provision and delete VMware private clouds with chosen node types and cluster sizes

Add or remove ESXi clusters within a private cloud to scale capacity

List supported node types and locations for capacity planning

Create network peerings between VMware Engine and VPCs or on-prem environments

GET STARTED

Start building with VMware Engine API API

Explore with Jentic

View OpenAPI Document

Use for: I need to create a new VMware private cloud in us-central1, List all clusters in our production private cloud, Add a cluster to expand capacity in an existing private cloud, Generate an HCX activation key for a new workload migration

Not supported: Does not handle in-guest VM management, vSphere-level operations, or workload migration off VMware — use for managing VMware Engine private clouds, clusters, and networking in Google Cloud only.

The Google VMware Engine API programmatically manages dedicated VMware private clouds running natively on Google Cloud. It exposes private clouds, clusters, ESXi node types, networks, network peerings, HCX activation keys, DNS bindings, management DNS zones, NSX and vCenter credentials, and subnets so platform teams can script cluster provisioning, capacity changes, and network integration. It targets organizations running VMware workloads who need cloud control without changing the underlying hypervisor.

Use Cases

Patterns agents use VMware Engine API API for, with concrete tasks.

★ Automated VMware Private Cloud Provisioning

Platform teams provision VMware Engine private clouds from infrastructure-as-code by scripting the create-private-cloud, create-cluster, and create-network-peering calls in a defined order. The API exposes per-cluster node-type selection so capacity decisions are explicit, and long-running operations expose enough state for the IaC layer to wait safely before the next step. This replaces the manual console workflow that typically takes a platform engineer most of a day per environment.

Create a private cloud named prod-vmw with one cluster of three standard-72 nodes in us-central1-a

Capacity Scaling for VMware Workloads

Operations teams scale VMware Engine capacity in response to demand by adding or removing clusters and resizing node counts within a cluster. The VMware Engine API exposes cluster-level operations and node-type listings so the scaling job can choose hardware that matches the workload profile. Long-running operations are observable so the orchestration code can wait for ACTIVE state before declaring success.

Add a fourth cluster of six nodes to the prod-vmw private cloud and wait for ACTIVE state

Network Integration and Peering

Networking teams integrate VMware Engine private clouds with VPCs, on-prem datacenters, and other private clouds by managing network peerings and DNS bindings via the API. The peering endpoints expose state so the orchestration code can validate connectivity before workloads attempt to communicate. DNS binding endpoints let the team script private DNS resolution into the management network.

Create a network peering between the prod-vmw private cloud and a Shared VPC, then verify the peering is ACTIVE

AI Agent VMware Operator

An AI agent integrated through Jentic responds to platform prompts like 'add capacity to the prod-vmw private cloud' by listing clusters, computing the deficit, and calling create or resize cluster operations. Because the API uses OAuth 2.0 with the cloud-platform scope, Jentic isolates the token in the MAXsystem vault and exposes only a scoped reference to the agent.

Search Jentic for add a vmware cluster, load the schema, and call it on the named private cloud

Key Endpoints

45 endpoints — the google vmware engine api programmatically manages dedicated vmware private clouds running natively on google cloud.

METHOD

PATH

DESCRIPTION

GET

/v1/{+name}/locations

List supported VMware Engine locations

POST

/v1/{+name}:grant

Grant access to a VMware Engine resource

POST

/v1/{+name}:repair

Repair a VMware Engine resource

GET

/v1/{+name}/operations

List long-running operations for a private cloud

GET

/v1/{+name}/locations

List supported VMware Engine locations

POST

/v1/{+name}:grant

Grant access to a VMware Engine resource

POST

/v1/{+name}:repair

Repair a VMware Engine resource

GET

/v1/{+name}/operations

List long-running operations for a private cloud

Why though Jentic?

Three things that make agents converge on Jentic-routed access.

Credential isolation

VMware Engine OAuth tokens with the cloud-platform scope are stored encrypted in the Jentic vault (MAXsystem). Agents receive scoped access tokens — raw OAuth tokens never enter the agent's context, which matters because cloud-platform grants broad project-level access including the ability to delete entire private clouds.

Intent-based discovery

Agents search Jentic with intents like 'create a vmware private cloud' or 'add a cluster' and Jentic returns the matching operation with its full input schema, including node-type and location selectors, so the agent can construct a valid request without reading Google's discovery doc.

Time to first call

Direct VMware Engine integration: 4-6 days for OAuth setup, region and node-type catalog wiring, and long-running operation handling. Through Jentic: under 1 day — search, load schema, execute and poll.

Related APIs

Alternatives and complements available in the Jentic catalogue.

Alternative

VM Migration API

Migrate VMware workloads off VMware to native Compute Engine; VMware Engine keeps them on VMware

Choose VM Migration when the goal is to convert VMware workloads to native Compute Engine; choose VMware Engine when the goal is to keep them on VMware in Google Cloud.

Complementary

Compute Engine API

Manage native Compute Engine VMs alongside the VMware Engine private cloud

Choose Compute Engine when an agent needs to manage native VMs; pair with VMware Engine when a deployment spans both.

Complementary

Cloud IAM API

Grant the roles required to manage VMware Engine resources

Choose IAM when an agent needs to provision the roles that the VMware Engine service account or operator user requires.

Complementary

Cloud DNS API

Manage public and private DNS zones that VMware Engine private clouds depend on

Choose Cloud DNS when an agent needs to configure name resolution that integrates with VMware Engine management DNS bindings.

FAQs

Specific to using VMware Engine API API through Jentic.

What authentication does the VMware Engine API use?

The VMware Engine API uses OAuth 2.0 with the https://www.googleapis.com/auth/cloud-platform scope. Through Jentic, the OAuth token is stored encrypted in the MAXsystem vault and only a scoped reference is exposed to the agent at execution time.

Can I scale a VMware Engine private cloud with the VMware Engine API?

Yes. Use the cluster create, update, and delete operations to add capacity, resize node counts, or remove clusters. Each call returns a long-running operation; poll GET /v1/{+name}/operations on the parent until done is true and the cluster reaches ACTIVE state.

What are the rate limits for the VMware Engine API?

Default project quotas allow 600 requests per minute on control-plane operations and a smaller concurrent limit on long-running mutations like create-private-cloud and create-cluster. Higher quotas can be requested in the Google Cloud Console for production fleets.

How do I create a network peering through Jentic with the VMware Engine API?

Install Jentic with pip install jentic, search for create vmware network peering, load the schema for the network peerings create operation, then call it with the parent private cloud, vmware-engine network, and the peer network. Verify the peering reaches ACTIVE state before sending traffic.

Does the VMware Engine API expose HCX for workload mobility?

Yes. Generate an HCX activation key with the hcxActivationKeys create operation under a private cloud, then use it on-prem to register VMware workloads with HCX. Activation keys are scoped to a single private cloud and have a one-time use lifecycle.

Why does my private cloud creation fail with quota errors?

VMware Engine enforces per-region node-type quotas in addition to standard request quotas. Confirm node-type availability in the target region with the node-types list endpoint, and request a quota increase in the Google Cloud Console if the requested cluster size exceeds your current allocation.