Method: projects.locations.instances.patch

Updates the metadata and configuration of a specific Redis instance.

Completed longrunning.Operation will contain the new instance object in the response field. The returned operation is automatically deleted after a few hours, so there is no need to call operations.delete.

HTTP request


The URL uses gRPC Transcoding syntax.

Path parameters



Required. Unique name of the resource in this scope including project and location using the form: projects/{projectId}/locations/{locationId}/instances/{instanceId}

Note: Redis instances are managed and addressed at regional level so locationId here refers to a GCP region; however, users may choose which specific zone (or collection of zones for cross-zone instances) an instance should be provisioned in. Refer to locationId and alternativeLocationId fields for more details.

Query parameters


string (FieldMask format)

Required. Mask of fields to update. At least one path must be supplied in this field. The elements of the repeated paths field may only include these fields from Instance:

  • displayName
  • labels
  • memorySizeGb
  • redisConfig
  • replicaCount

This is a comma-separated list of fully qualified names of fields. Example: "user.displayName,photo".

Request body

The request body contains an instance of Instance.

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.