Method: projects.locations.clusters.startIpRotation

Starts master IP rotation.

HTTP request

POST https://container.googleapis.com/v1/{name=projects/*/locations/*/clusters/*}:startIpRotation

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

The name (project, location, cluster name) of the cluster to start IP rotation. Specified in the format projects/*/locations/*/clusters/*.

Authorization requires the following IAM permission on the specified resource name:

  • container.clusters.update

Request body

The request body contains data with the following structure:

JSON representation
{
  "projectId": string,
  "zone": string,
  "clusterId": string,
  "rotateCredentials": boolean
}
Fields
projectId
(deprecated)

string

Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.

zone
(deprecated)

string

Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the name field.

clusterId
(deprecated)

string

Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field.

rotateCredentials

boolean

Whether to rotate credentials during IP rotation.

Response body

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

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.