VMware Engine API

Stay organized with collections Save and categorize content based on your preferences.

The Google VMware Engine API lets you programmatically manage VMware environments.

Service: vmwareengine.googleapis.com

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://vmwareengine.googleapis.com

REST Resource: v1.projects.locations

Methods
get GET /v1/{name=projects/*/locations/*}
Gets information about a location.
list GET /v1/{name=projects/*}/locations
Lists information about the supported locations for this service.

REST Resource: v1.projects.locations.networkPolicies

Methods
create POST /v1/{parent=projects/*/locations/*}/networkPolicies
Creates a new network policy in a given VMware Engine network of a project and location (region).
delete DELETE /v1/{name=projects/*/locations/*/networkPolicies/*}
Deletes a NetworkPolicy resource.
get GET /v1/{name=projects/*/locations/*/networkPolicies/*}
Retrieves a NetworkPolicy resource by its resource name.
list GET /v1/{parent=projects/*/locations/*}/networkPolicies
Lists NetworkPolicy resources in a specified project and location.
patch PATCH /v1/{networkPolicy.name=projects/*/locations/*/networkPolicies/*}
Modifies a NetworkPolicy resource.

REST Resource: v1.projects.locations.nodeTypes

Methods
get GET /v1/{name=projects/*/locations/*/nodeTypes/*}
Gets details of a single NodeType.
list GET /v1/{parent=projects/*/locations/*}/nodeTypes
Lists node types

REST Resource: v1.projects.locations.operations

Methods
delete DELETE /v1/{name=projects/*/locations/*/operations/*}
Deletes a long-running operation.
get GET /v1/{name=projects/*/locations/*/operations/*}
Gets the latest state of a long-running operation.
list GET /v1/{name=projects/*/locations/*}/operations
Lists operations that match the specified filter in the request.

REST Resource: v1.projects.locations.privateClouds

Methods
create POST /v1/{parent=projects/*/locations/*}/privateClouds
Creates a new PrivateCloud resource in a given project and location.
delete DELETE /v1/{name=projects/*/locations/*/privateClouds/*}
Schedules a PrivateCloud resource for deletion.
get GET /v1/{name=projects/*/locations/*/privateClouds/*}
Retrieves a PrivateCloud resource by its resource name.
getIamPolicy GET /v1/{resource=projects/*/locations/*/privateClouds/*}:getIamPolicy
Gets the access control policy for a resource.
list GET /v1/{parent=projects/*/locations/*}/privateClouds
Lists PrivateCloud resources in a given project and location.
patch PATCH /v1/{privateCloud.name=projects/*/locations/*/privateClouds/*}
Modifies a PrivateCloud resource.
resetNsxCredentials POST /v1/{privateCloud=projects/*/locations/*/privateClouds/*}:resetNsxCredentials
Resets credentials of the NSX appliance.
resetVcenterCredentials POST /v1/{privateCloud=projects/*/locations/*/privateClouds/*}:resetVcenterCredentials
Resets credentials of the Vcenter appliance.
setIamPolicy POST /v1/{resource=projects/*/locations/*/privateClouds/*}:setIamPolicy
Sets the access control policy on the specified resource.
showNsxCredentials GET /v1/{privateCloud=projects/*/locations/*/privateClouds/*}:showNsxCredentials
Gets details of credentials for NSX appliance.
showVcenterCredentials GET /v1/{privateCloud=projects/*/locations/*/privateClouds/*}:showVcenterCredentials
Gets details of credentials for Vcenter appliance.
testIamPermissions POST /v1/{resource=projects/*/locations/*/privateClouds/*}:testIamPermissions
Returns permissions that a caller has on the specified resource.
undelete POST /v1/{name=projects/*/locations/*/privateClouds/*}:undelete
Restores a private cloud that was previously scheduled for deletion by DeletePrivateCloud.

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

Methods
create POST /v1/{parent=projects/*/locations/*/privateClouds/*}/clusters
Creates a new cluster in a given private cloud.
delete DELETE /v1/{name=projects/*/locations/*/privateClouds/*/clusters/*}
Deletes a Cluster resource.
get GET /v1/{name=projects/*/locations/*/privateClouds/*/clusters/*}
Retrieves a Cluster resource by its resource name.
getIamPolicy GET /v1/{resource=projects/*/locations/*/privateClouds/*/clusters/*}:getIamPolicy
Gets the access control policy for a resource.
list GET /v1/{parent=projects/*/locations/*/privateClouds/*}/clusters
Lists Cluster resources in a given private cloud.
patch PATCH /v1/{cluster.name=projects/*/locations/*/privateClouds/*/clusters/*}
Modifies a Cluster resource.
setIamPolicy POST /v1/{resource=projects/*/locations/*/privateClouds/*/clusters/*}:setIamPolicy
Sets the access control policy on the specified resource.
testIamPermissions POST /v1/{resource=projects/*/locations/*/privateClouds/*/clusters/*}:testIamPermissions
Returns permissions that a caller has on the specified resource.

REST Resource: v1.projects.locations.privateClouds.hcxActivationKeys

Methods
create POST /v1/{parent=projects/*/locations/*/privateClouds/*}/hcxActivationKeys
Creates a new HCX activation key in a given private cloud.
get GET /v1/{name=projects/*/locations/*/privateClouds/*/hcxActivationKeys/*}
Retrieves a HcxActivationKey resource by its resource name.
getIamPolicy GET /v1/{resource=projects/*/locations/*/privateClouds/*/hcxActivationKeys/*}:getIamPolicy
Gets the access control policy for a resource.
list GET /v1/{parent=projects/*/locations/*/privateClouds/*}/hcxActivationKeys
Lists HcxActivationKey resources in a given private cloud.
setIamPolicy POST /v1/{resource=projects/*/locations/*/privateClouds/*/hcxActivationKeys/*}:setIamPolicy
Sets the access control policy on the specified resource.
testIamPermissions POST /v1/{resource=projects/*/locations/*/privateClouds/*/hcxActivationKeys/*}:testIamPermissions
Returns permissions that a caller has on the specified resource.

REST Resource: v1.projects.locations.privateClouds.subnets

Methods
list GET /v1/{parent=projects/*/locations/*/privateClouds/*}/subnets
Lists subnets in a given private cloud.

REST Resource: v1.projects.locations.vmwareEngineNetworks

Methods
create POST /v1/{parent=projects/*/locations/*}/vmwareEngineNetworks
Creates a new VMware Engine network that can be used by a private cloud.
delete DELETE /v1/{name=projects/*/locations/*/vmwareEngineNetworks/*}
Deletes a VmwareEngineNetwork resource.
get GET /v1/{name=projects/*/locations/*/vmwareEngineNetworks/*}
Retrieves a VmwareEngineNetwork resource by its resource name.
list GET /v1/{parent=projects/*/locations/*}/vmwareEngineNetworks
Lists VmwareEngineNetwork resources in a given project and location.
patch PATCH /v1/{vmwareEngineNetwork.name=projects/*/locations/*/vmwareEngineNetworks/*}
Modifies a VMware Engine network resource.