GKE On-Prem API

Service: gkeonprem.googleapis.com

To call this service, we recommend that you use the Google-provided client libraries. If your application needs to use your own libraries to call this service, use the following information when you make the API requests.

Discovery document

A Discovery Document is a machine-readable specification for describing and consuming REST APIs. It is used to build client libraries, IDE plugins, and other tools that interact with Google APIs. One service may provide multiple discovery documents. This service provides the following discovery document:

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://gkeonprem.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.bareMetalAdminClusters

Methods
create POST /v1/{parent=projects/*/locations/*}/bareMetalAdminClusters
Creates a new bare metal admin cluster in a given project and location.
enroll POST /v1/{parent=projects/*/locations/*}/bareMetalAdminClusters:enroll
Enrolls an existing bare metal admin cluster to the Anthos On-Prem API within a given project and location.
get GET /v1/{name=projects/*/locations/*/bareMetalAdminClusters/*}
Gets details of a single bare metal admin cluster.
list GET /v1/{parent=projects/*/locations/*}/bareMetalAdminClusters
Lists bare metal admin clusters in a given project and location.
patch PATCH /v1/{bareMetalAdminCluster.name=projects/*/locations/*/bareMetalAdminClusters/*}
Updates the parameters of a single bare metal admin cluster.
queryVersionConfig POST /v1/{parent=projects/*/locations/*}/bareMetalAdminClusters:queryVersionConfig
Queries the bare metal admin cluster version config.

REST Resource: v1.projects.locations.bareMetalClusters

Methods
create POST /v1/{parent=projects/*/locations/*}/bareMetalClusters
Creates a new bare metal cluster in a given project and location.
delete DELETE /v1/{name=projects/*/locations/*/bareMetalClusters/*}
Deletes a single bare metal Cluster.
enroll POST /v1/{parent=projects/*/locations/*}/bareMetalClusters:enroll
Enrolls an existing bare metal user cluster and its node pools to the Anthos On-Prem API within a given project and location.
get GET /v1/{name=projects/*/locations/*/bareMetalClusters/*}
Gets details of a single bare metal Cluster.
list GET /v1/{parent=projects/*/locations/*}/bareMetalClusters
Lists bare metal clusters in a given project and location.
patch PATCH /v1/{bareMetalCluster.name=projects/*/locations/*/bareMetalClusters/*}
Updates the parameters of a single bare metal Cluster.
queryVersionConfig POST /v1/{parent=projects/*/locations/*}/bareMetalClusters:queryVersionConfig
Queries the bare metal user cluster version config.

REST Resource: v1.projects.locations.bareMetalClusters.bareMetalNodePools

Methods
create POST /v1/{parent=projects/*/locations/*/bareMetalClusters/*}/bareMetalNodePools
Creates a new bare metal node pool in a given project, location and Bare Metal cluster.
delete DELETE /v1/{name=projects/*/locations/*/bareMetalClusters/*/bareMetalNodePools/*}
Deletes a single bare metal node pool.
enroll POST /v1/{parent=projects/*/locations/*/bareMetalClusters/*}/bareMetalNodePools:enroll
Enrolls an existing bare metal node pool to the Anthos On-Prem API within a given project and location.
get GET /v1/{name=projects/*/locations/*/bareMetalClusters/*/bareMetalNodePools/*}
Gets details of a single bare metal node pool.
list GET /v1/{parent=projects/*/locations/*/bareMetalClusters/*}/bareMetalNodePools
Lists bare metal node pools in a given project, location and bare metal cluster.
patch PATCH /v1/{bareMetalNodePool.name=projects/*/locations/*/bareMetalClusters/*/bareMetalNodePools/*}
Updates the parameters of a single bare metal node pool.

REST Resource: v1.projects.locations.operations

Methods
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.vmwareAdminClusters

Methods
create POST /v1/{parent=projects/*/locations/*}/vmwareAdminClusters
Creates a new VMware admin cluster in a given project and location.
enroll POST /v1/{parent=projects/*/locations/*}/vmwareAdminClusters:enroll
Enrolls an existing VMware admin cluster to the Anthos On-Prem API within a given project and location.
get GET /v1/{name=projects/*/locations/*/vmwareAdminClusters/*}
Gets details of a single VMware admin cluster.
list GET /v1/{parent=projects/*/locations/*}/vmwareAdminClusters
Lists VMware admin clusters in a given project and location.
patch PATCH /v1/{vmwareAdminCluster.name=projects/*/locations/*/vmwareAdminClusters/*}
Updates the parameters of a single VMware admin cluster.

REST Resource: v1.projects.locations.vmwareClusters

Methods
create POST /v1/{parent=projects/*/locations/*}/vmwareClusters
Creates a new VMware user cluster in a given project and location.
delete DELETE /v1/{name=projects/*/locations/*/vmwareClusters/*}
Deletes a single VMware Cluster.
enroll POST /v1/{parent=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.
get GET /v1/{name=projects/*/locations/*/vmwareClusters/*}
Gets details of a single VMware Cluster.
list GET /v1/{parent=projects/*/locations/*}/vmwareClusters
Lists VMware Clusters in a given project and location.
patch PATCH /v1/{vmwareCluster.name=projects/*/locations/*/vmwareClusters/*}
Updates the parameters of a single VMware cluster.
queryVersionConfig POST /v1/{parent=projects/*/locations/*}/vmwareClusters:queryVersionConfig
Queries the VMware user cluster version config.

REST Resource: v1.projects.locations.vmwareClusters.vmwareNodePools

Methods
create POST /v1/{parent=projects/*/locations/*/vmwareClusters/*}/vmwareNodePools
Creates a new VMware node pool in a given project, location and VMWare cluster.
delete DELETE /v1/{name=projects/*/locations/*/vmwareClusters/*/vmwareNodePools/*}
Deletes a single VMware node pool.
enroll POST /v1/{parent=projects/*/locations/*/vmwareClusters/*}/vmwareNodePools:enroll
Enrolls a VMware node pool to Anthos On-Prem API
get GET /v1/{name=projects/*/locations/*/vmwareClusters/*/vmwareNodePools/*}
Gets details of a single VMware node pool.
list GET /v1/{parent=projects/*/locations/*/vmwareClusters/*}/vmwareNodePools
Lists VMware node pools in a given project, location and VMWare cluster.
patch PATCH /v1/{vmwareNodePool.name=projects/*/locations/*/vmwareClusters/*/vmwareNodePools/*}
Updates the parameters of a single VMware node pool.