Method: projects.locations.instances.rename

instances.rename sets a new name for an instance.

HTTP request

POST https://baremetalsolution.googleapis.com/v2/{name=projects/*/locations/*/instances/*}:rename

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. The name field is used to identify the instance. Format: projects/{project}/locations/{location}/instances/{instance}

Request body

The request body contains data with the following structure:

JSON representation 
{
  "newName": string
}
Fields
newName

string

Required. The new name of the instance. Format: {instancename}

Response body

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

Authorization Scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.