Method: projects.locations.vmwareClusters.enroll

Enrolls an existing VMware user cluster and its node pools to the Anthos On-Prem API within a given project and location. Through enrollment, an existing cluster will become Anthos On-Prem API managed. The corresponding GCP resources will be created and all future modifications to the cluster and/or its node pools will be expected to be performed through the API.

HTTP request


The URL uses gRPC Transcoding syntax.

Path parameters



Required. The parent of the project and location where the cluster is Enrolled in. Format: "projects/{project}/locations/{location}"

Request body

The request body contains data with the following structure:

JSON representation
  "vmwareClusterId": string,
  "localName": string,
  "adminClusterMembership": string,
  "validateOnly": boolean


User provided OnePlatform identifier that is used as part of the resource name. This must be unique among all GKE on-prem clusters within a project and location and will return a 409 if the cluster already exists.

( format.



Optional. The object name of the VMware OnPremUserCluster custom resource on the associated admin cluster. This field is used to support conflicting resource names when enrolling existing clusters to the API. When not provided, this field will resolve to the vmwareClusterId. Otherwise, it must match the object name of the VMware OnPremUserCluster custom resource. It is not modifiable outside / beyond the enrollment operation.



Required. The admin cluster this VMware user cluster belongs to. This is the full resource name of the admin cluster's fleet membership. In the future, references to other resource types might be allowed if admin clusters are modeled as their own resources.



Validate the request without actually doing any updates.

Response body

If successful, the response body contains an instance of Operation.

Authorization scopes

Requires the following OAuth scope:


For more information, see the Authentication Overview.