Google

GKE On-Prem API

GKE On-Prem API endpoints from Google

Developer tools#openapi

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

GKE On-Prem API endpoints from Google

Endpoints 31

projects.locations.vmwareClusters.vmwareNodePools.operations

  • GETGets the latest state of a long-running operation/v1/:nameGets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
  • 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.vmwareClusters.vmwareNodePools

  • DELETEDeletes a single VMware node pool./v1/:name?allowMissing=true&etag=string&ignoreErrors=true&validateOnly=trueDeletes a single VMware node pool.
  • PATCHUpdates the parameters of a single VMware node pool./v1/:name?updateMask=string&validateOnly=trueUpdates the parameters of a single VMware node pool.
  • 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…
  • DELETEUnenrolls a VMware node pool to Anthos On-Prem API/v1/:name:unenroll?allowMissing=true&etag=string&validateOnly=trueUnenrolls a VMware node pool to Anthos On-Prem API
  • GETLists VMware node pools in a given project, location and VMWare cluster./v1/:parent/vmwareNodePools?pageSize=0&pageToken=string&view=NODE_POOL_VIEW_UNSPECIFIEDLists VMware node pools in a given project, location and VMWare cluster.
  • POSTCreates a new VMware node pool in a given project, location and VMWare cluster./v1/:parent/vmwareNodePools?validateOnly=true&vmwareNodePoolId=stringCreates a new VMware node pool in a given project, location and VMWare cluster.
  • POSTEnrolls a VMware node pool to Anthos On-Prem API/v1/:parent/vmwareNodePools:enrollEnrolls a VMware node pool to Anthos On-Prem API

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.bareMetalAdminClusters

  • GETLists bare metal admin clusters in a given project and location./v1/:parent/bareMetalAdminClusters?allowMissing=true&pageSize=0&pageToken=string&view=CLUSTER_VIEW_UNSPECIFIEDLists bare metal admin clusters in a given project and location.
  • POSTCreates a new bare metal admin cluster in a given project and location/v1/:parent/bareMetalAdminClusters?allowPreflightFailure=true&bareMetalAdminClusterId=string&validateOnly=trueCreates a new bare metal admin cluster in a given project and location. The API needs to be combined with creating a bootstrap cluster to work. See:…
  • POSTEnrolls an existing bare metal admin cluster to the Anthos On-Prem API within a given project and location/v1/:parent/bareMetalAdminClusters:enrollEnrolls an existing bare metal admin cluster to the Anthos On-Prem API within a given project and location. Through enrollment, an existing admin cluster will…
  • POSTQueries the bare metal admin cluster version config./v1/:parent/bareMetalAdminClusters:queryVersionConfig?upgradeConfig.clusterName=stringQueries the bare metal admin cluster version config.

projects.locations.bareMetalClusters

  • GETLists bare metal clusters in a given project and location./v1/:parent/bareMetalClusters?allowMissing=true&filter=string&pageSize=0&pageToken=string&view=CLUSTER_VIEW_UNSPECIFIEDLists bare metal clusters in a given project and location.
  • POSTCreates a new bare metal cluster in a given project and location./v1/:parent/bareMetalClusters?allowPreflightFailure=true&bareMetalClusterId=string&validateOnly=trueCreates a new bare metal cluster in a given project and location.
  • POSTEnrolls an existing bare metal user cluster and its node pools to the Anthos On-Prem API within a given project and…/v1/:parent/bareMetalClusters:enrollEnrolls an existing bare metal user cluster and its node pools to the Anthos On-Prem API within a given project and location. Through enrollment, an existing…
  • POSTQueries the bare metal user cluster version config./v1/:parent/bareMetalClusters:queryVersionConfig?createConfig.adminClusterMembership=string&createConfig.adminClusterName=string&upgradeConfig.clusterName=stringQueries the bare metal user cluster version config.

projects.locations.bareMetalClusters.bareMetalNodePools

  • GETLists bare metal node pools in a given project, location and bare metal cluster./v1/:parent/bareMetalNodePools?pageSize=0&pageToken=string&view=NODE_POOL_VIEW_UNSPECIFIEDLists bare metal node pools in a given project, location and bare metal cluster.
  • POSTCreates a new bare metal node pool in a given project, location and Bare Metal cluster./v1/:parent/bareMetalNodePools?bareMetalNodePoolId=string&validateOnly=trueCreates a new bare metal node pool in a given project, location and Bare Metal cluster.
  • POSTEnrolls an existing bare metal node pool to the Anthos On-Prem API within a given project and location/v1/:parent/bareMetalNodePools:enrollEnrolls an existing bare metal node pool to the Anthos On-Prem API within a given project and location. Through enrollment, an existing node pool will become…

projects.locations.operations

  • POSTStarts asynchronous cancellation on a long-running operation/v1/:name:cancelStarts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the…

projects.locations.vmwareAdminClusters

  • GETLists VMware admin clusters in a given project and location./v1/:parent/vmwareAdminClusters?allowMissing=true&pageSize=0&pageToken=string&view=CLUSTER_VIEW_UNSPECIFIEDLists VMware admin clusters in a given project and location.
  • POSTCreates a new VMware admin cluster in a given project and location/v1/:parent/vmwareAdminClusters?allowPreflightFailure=true&skipValidations=string&validateOnly=true&vmwareAdminClusterId=stringCreates a new VMware admin cluster in a given project and location. The API needs to be combined with creating a bootstrap cluster to work.
  • POSTEnrolls an existing VMware admin cluster to the Anthos On-Prem API within a given project and location/v1/:parent/vmwareAdminClusters:enrollEnrolls an existing VMware admin cluster to the Anthos On-Prem API within a given project and location. Through enrollment, an existing admin cluster will…

projects.locations.vmwareClusters

  • GETLists VMware Clusters in a given project and location./v1/:parent/vmwareClusters?allowMissing=true&filter=string&pageSize=0&pageToken=string&view=CLUSTER_VIEW_UNSPECIFIEDLists VMware Clusters in a given project and location.
  • POSTCreates a new VMware user cluster in a given project and location./v1/:parent/vmwareClusters?allowPreflightFailure=true&skipValidations=string&validateOnly=true&vmwareClusterId=stringCreates a new VMware user cluster in a given project and location.
  • POSTEnrolls an existing VMware user cluster and its node pools to the Anthos On-Prem API within a given project and location/v1/:parent/vmwareClusters:enrollEnrolls 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…
  • POSTQueries the VMware user cluster version config./v1/:parent/vmwareClusters:queryVersionConfig?createConfig.adminClusterMembership=string&createConfig.adminClusterName=string&upgradeConfig.clusterName=stringQueries the VMware user cluster version config.

API details

Base URL
https://gkeonprem.googleapis.com
Authentication
OAuth 2.0 (authorization code flow) with 1 scope
An API key in the key query parameter
Operations
31 operations on 23 pathsPOST 18GET 10DELETE 2PATCH 1
Main resources
projects.locations.vmwareClusters.vmwareNodePools 9projects.locations.bareMetalAdminClusters 4projects.locations.bareMetalClusters 4projects.locations.vmwareClusters 4projects.locations.bareMetalClusters.bareMetalNodePools 3projects.locations.vmwareAdminClusters 3projects.locations.vmwareClusters.vmwareNodePools.operations 2projects.locations 1projects.locations.operations 1
Response formats
application/json
Description format
Google API Discovery, API version v1

How to test the GKE On-Prem API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the GKE On-Prem API collection, without the publisher's secrets.
  3. 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.
  4. Send a requestPick an endpoint, for example “Gets the latest state of a long-running operation” (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 GKE On-Prem API?

GKE On-Prem API endpoints from Google It is listed under Developer tools and has 31 endpoints.

Who publishes the GKE On-Prem 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 GKE On-Prem API?

Requests go to https://gkeonprem.googleapis.com. Endpoint paths are added to this base URL.

How do I authenticate with the GKE On-Prem 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 GKE On-Prem API have?

31 operations on 23 paths (18 POST, 10 GET, 2 DELETE, 1 PATCH). The largest groups are projects.locations.vmwareClusters.vmwareNodePools, projects.locations.bareMetalAdminClusters, projects.locations.bareMetalClusters, projects.locations.vmwareClusters.

Is forking the GKE On-Prem API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.