VMware Engine API
The Google VMware Engine API lets you programmatically manage VMware environments.
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
The Google VMware Engine API lets you programmatically manage VMware environments.
Endpoints 52
projects.locations.vmwareEngineNetworks
- GETRetrieves a `VmwareEngineNetwork` resource by its resource name
/v1/:nameRetrieves a VmwareEngineNetwork resource by its resource name. The resource contains details of the VMware Engine network, such as its VMware Engine network… - DELETEDeletes a `VmwareEngineNetwork` resource
/v1/:name?etag=string&requestId=stringDeletes a VmwareEngineNetwork resource. You can only delete a VMware Engine network after all resources that refer to it are deleted. For example, a private… - PATCHModifies a VMware Engine network resource
/v1/:name?requestId=string&updateMask=string&validateOnly=trueModifies a VMware Engine network resource. Only the following fields can be updated: description. Only fields specified in updateMask are applied. - GETLists `VmwareEngineNetwork` resources in a given project and location.
/v1/:parent/vmwareEngineNetworks?filter=string&orderBy=string&pageSize=0&pageToken=stringLists VmwareEngineNetwork resources in a given project and location. - POSTCreates a new VMware Engine network that can be used by a private cloud.
/v1/:parent/vmwareEngineNetworks?requestId=string&validateOnly=true&vmwareEngineNetworkId=stringCreates a new VMware Engine network that can be used by a private cloud.
projects.locations
- GETLists information about the supported locations for this service
/v1/:name/locations?extraLocationTypes=string&filter=string&pageSize=0&pageToken=stringLists information about the supported locations for this service. This method lists locations based on the resource scope provided in the…
projects.locations.announcements
- GETLists `Announcements` for a given region and project
/v1/:parent/announcements?filter=string&orderBy=string&pageSize=0&pageToken=stringLists Announcements for a given region and project
projects.locations.capacityAllocations
- GETLists `CapacityAllocation` resources in a given project and location.
/v1/:parent/capacityAllocations?filter=string&orderBy=string&pageSize=0&pageToken=stringLists CapacityAllocation resources in a given project and location.
projects.locations.datastores
- GETLists `Datastore` resources in a given project and location.
/v1/:parent/datastores?filter=string&orderBy=string&pageSize=0&pageToken=string&requestId=stringLists Datastore resources in a given project and location. - POSTCreates a new `Datastore` resource in a given project and location.
/v1/:parent/datastores?datastoreId=string&requestId=stringCreates a new Datastore resource in a given project and location.
projects.locations.dnsBindPermission
- POSTGrants the bind permission to the customer provided principal(user / service account) to bind their DNS zone with the…
/v1/:name:grantGrants the bind permission to the customer provided principal(user / service account) to bind their DNS zone with the intranet VPC associated with the… - POSTRevokes the bind permission from the customer provided principal(user / service account) on the intranet VPC…
/v1/:name:revokeRevokes the bind permission from the customer provided principal(user / service account) on the intranet VPC associated with the consumer project.…
projects.locations.networkPeerings
- GETLists `NetworkPeering` resources in a given project
/v1/:parent/networkPeerings?filter=string&orderBy=string&pageSize=0&pageToken=stringLists NetworkPeering resources in a given project. NetworkPeering is a global resource and location can only be global. - POSTCreates a new network peering between the peer network and VMware Engine network provided in a `NetworkPeering` resource
/v1/:parent/networkPeerings?networkPeeringId=string&requestId=string&validateOnly=trueCreates a new network peering between the peer network and VMware Engine network provided in a NetworkPeering resource. NetworkPeering is a global resource…
projects.locations.privateConnections.peeringRoutes
- GETLists the private connection routes exchanged over a peering connection.
/v1/:parent/peeringRoutes?pageSize=0&pageToken=stringLists the private connection routes exchanged over a peering connection.
projects.locations.networkPolicies
- GETLists `NetworkPolicy` resources in a specified project and location.
/v1/:parent/networkPolicies?filter=string&orderBy=string&pageSize=0&pageToken=stringLists NetworkPolicy resources in a specified project and location. - POSTCreates a new network policy in a given VMware Engine network of a project and location (region)
/v1/:parent/networkPolicies?networkPolicyId=string&requestId=string&validateOnly=trueCreates a new network policy in a given VMware Engine network of a project and location (region). A new network policy cannot be created if another network… - GETLists external IP addresses assigned to VMware workload VMs within the scope of the given network policy.
/v1/:networkPolicy:fetchExternalAddresses?pageSize=0&pageToken=stringLists external IP addresses assigned to VMware workload VMs within the scope of the given network policy.
projects.locations.networkPolicies.externalAccessRules
- GETLists `ExternalAccessRule` resources in the specified network policy.
/v1/:parent/externalAccessRules?filter=string&orderBy=string&pageSize=0&pageToken=stringLists ExternalAccessRule resources in the specified network policy. - POSTCreates a new external access rule in a given network policy.
/v1/:parent/externalAccessRules?externalAccessRuleId=string&requestId=string&validateOnly=trueCreates a new external access rule in a given network policy.
projects.locations.nodeTypes
- GETLists node types
/v1/:parent/nodeTypes?filter=string&pageSize=0&pageToken=stringLists node types
projects.locations.operations
- GETLists operations that match the specified filter in the request
/v1/:name/operations?filter=string&pageSize=0&pageToken=string&returnPartialSuccess=trueLists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.
projects.locations.privateClouds
- GETLists `PrivateCloud` resources in a given project and location.
/v1/:parent/privateClouds?filter=string&orderBy=string&pageSize=0&pageToken=stringLists PrivateCloud resources in a given project and location. - POSTCreates a new `PrivateCloud` resource in a given project and location
/v1/:parent/privateClouds?privateCloudId=string&requestId=string&validateOnly=trueCreates a new PrivateCloud resource in a given project and location. Private clouds of type STANDARD and TIME_LIMITED are zonal resources, STRETCHED private… - POSTMigrates the management VMs of the PC from the current management cluster to a workload cluster
/v1/:name:migrateManagementVmsMigrates the management VMs of the PC from the current management cluster to a workload cluster. Post this migration, the provided workload cluster becomes… - POSTAccelerates the deletion of a private cloud that is currently in soft deletion A `PrivateCloud` resource in soft…
/v1/:name:privateCloudDeletionNowAccelerates the deletion of a private cloud that is currently in soft deletion A PrivateCloud resource in soft deletion has PrivateCloud.state set to… - POSTResets credentials of the NSX appliance.
/v1/:privateCloud:resetNsxCredentialsResets credentials of the NSX appliance. - POSTResets credentials of the Vcenter appliance.
/v1/:privateCloud:resetVcenterCredentialsResets credentials of the Vcenter appliance. - GETGets details of credentials for NSX appliance.
/v1/:privateCloud:showNsxCredentialsGets details of credentials for NSX appliance. - GETGets details of credentials for Vcenter appliance.
/v1/:privateCloud:showVcenterCredentials?username=stringGets details of credentials for Vcenter appliance. - POSTRestores a private cloud that was previously scheduled for deletion by `DeletePrivateCloud`
/v1/:name:undeleteRestores a private cloud that was previously scheduled for deletion by DeletePrivateCloud. A PrivateCloud resource scheduled for deletion has…
projects.locations.privateClouds.hcxActivationKeys
- GETGets the access control policy for a resource
/v1/:resource:getIamPolicy?options.requestedPolicyVersion=0Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. - POSTSets the access control policy on the specified resource
/v1/:resource:setIamPolicySets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors. - POSTReturns permissions that a caller has on the specified resource
/v1/:resource:testIamPermissionsReturns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND… - GETLists `HcxActivationKey` resources in a given private cloud.
/v1/:parent/hcxActivationKeys?pageSize=0&pageToken=stringLists HcxActivationKey resources in a given private cloud. - POSTCreates a new HCX activation key in a given private cloud.
/v1/:parent/hcxActivationKeys?hcxActivationKeyId=string&requestId=stringCreates a new HCX activation key in a given private cloud.
projects.locations.privateClouds.clusters
- GETLists `Cluster` resources in a given private cloud.
/v1/:parent/clusters?filter=string&orderBy=string&pageSize=0&pageToken=stringLists Cluster resources in a given private cloud. - POSTCreates a new cluster in a given private cloud
/v1/:parent/clusters?clusterId=string&requestId=string&validateOnly=trueCreates a new cluster in a given private cloud. Creating a new cluster provides additional nodes for use in the parent private cloud and requires sufficient… - POSTMounts a `Datastore` on a cluster resource
/v1/:name:mountDatastoreMounts a Datastore on a cluster resource - POSTUnmounts a `Datastore` on a cluster resource
/v1/:name:unmountDatastoreUnmounts a Datastore on a cluster resource
projects.locations.privateClouds.clusters.nodes
- GETLists nodes in a given cluster.
/v1/:parent/nodes?pageSize=0&pageToken=stringLists nodes in a given cluster.
projects.locations.privateClouds.externalAddresses
- GETLists external IP addresses assigned to VMware workload VMs in a given private cloud.
/v1/:parent/externalAddresses?filter=string&orderBy=string&pageSize=0&pageToken=stringLists external IP addresses assigned to VMware workload VMs in a given private cloud. - POSTCreates a new `ExternalAddress` resource in a given private cloud
/v1/:parent/externalAddresses?externalAddressId=string&requestId=string&validateOnly=trueCreates a new ExternalAddress resource in a given private cloud. The network policy that corresponds to the private cloud must have the external IP address…
projects.locations.privateClouds.loggingServers
- GETLists logging servers configured for a given private cloud.
/v1/:parent/loggingServers?filter=string&orderBy=string&pageSize=0&pageToken=stringLists logging servers configured for a given private cloud. - POSTCreate a new logging server for a given private cloud.
/v1/:parent/loggingServers?loggingServerId=string&requestId=stringCreate a new logging server for a given private cloud.
projects.locations.privateClouds.managementDnsZoneBindings
- GETLists Consumer VPCs bound to Management DNS Zone of a given private cloud.
/v1/:parent/managementDnsZoneBindings?filter=string&orderBy=string&pageSize=0&pageToken=stringLists Consumer VPCs bound to Management DNS Zone of a given private cloud. - POSTCreates a new `ManagementDnsZoneBinding` resource in a private cloud
/v1/:parent/managementDnsZoneBindings?managementDnsZoneBindingId=string&requestId=stringCreates a new ManagementDnsZoneBinding resource in a private cloud. This RPC creates the DNS binding and the resource that represents the DNS binding of the… - POSTRetries to create a `ManagementDnsZoneBinding` resource that is in failed state.
/v1/:name:repairRetries to create a ManagementDnsZoneBinding resource that is in failed state.
projects.locations.privateClouds.subnets
- GETLists subnets in a given private cloud.
/v1/:parent/subnets?pageSize=0&pageToken=stringLists subnets in a given private cloud.
projects.locations.privateClouds.upgrades
- GETLists past, ongoing and upcoming `Upgrades` for the given private cloud.
/v1/:parent/upgrades?filter=string&orderBy=string&pageSize=0&pageToken=stringLists past, ongoing and upcoming Upgrades for the given private cloud.
projects.locations.privateConnections
- GETLists `PrivateConnection` resources in a given project and location.
/v1/:parent/privateConnections?filter=string&orderBy=string&pageSize=0&pageToken=stringLists PrivateConnection resources in a given project and location. - POSTCreates a new private connection that can be used for accessing private Clouds.
/v1/:parent/privateConnections?privateConnectionId=string&requestId=string&validateOnly=trueCreates a new private connection that can be used for accessing private Clouds.
API details
- Base URL
https://vmwareengine.googleapis.com- Authentication
- OAuth 2.0 (authorization code flow) with 1 scope
An API key in the key query parameter - Operations
- 52 operations on 38 pathsGET 26POST 24PATCH 1DELETE 1
- Main resources
- projects.locations.privateClouds 9projects.locations.privateClouds.hcxActivationKeys 5projects.locations.vmwareEngineNetworks 5projects.locations.privateClouds.clusters 4projects.locations.networkPolicies 3projects.locations.privateClouds.managementDnsZoneBindings 3projects.locations.datastores 2projects.locations.dnsBindPermission 2projects.locations.networkPeerings 2projects.locations.networkPolicies.externalAccessRules 2
- Response formats
application/json- Description format
- Google API Discovery, API version
v1 - Links
- Documentation · OpenAPI document
- Listed from
- Google API Discovery document (googleapis/discovery-artifact-manager) (Apache-2.0)
How to test the VMware Engine API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the VMware Engine API collection, without the publisher's secrets.
- Add your credentialsThis API uses OAuth 2.0 (authorization code flow) with 1 scope. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Retrieves a `VmwareEngineNetwork` resource by its resource name” (GET /v1/:name), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the VMware Engine API?
The Google VMware Engine API lets you programmatically manage VMware environments. It is listed under Developer tools and has 52 endpoints.
Who publishes the VMware Engine API?
It is listed from Google's public API description (an OpenAPI document), not published by Google on Swastik Codes. Anyone who controls googleapis.com can claim the profile by adding a DNS TXT record.
What is the base URL of the VMware Engine API?
Requests go to https://vmwareengine.googleapis.com. Endpoint paths are added to this base URL.
How do I authenticate with the VMware Engine API?
It accepts 2 methods: OAuth 2.0 (authorization code flow) with 1 scope; an API key in the key query parameter.
How many endpoints does the VMware Engine API have?
52 operations on 38 paths (26 GET, 24 POST, 1 PATCH, 1 DELETE). The largest groups are projects.locations.privateClouds, projects.locations.privateClouds.hcxActivationKeys, projects.locations.vmwareEngineNetworks, projects.locations.privateClouds.clusters.
Is forking the VMware Engine API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.