Method: projects.locations.instances.patch

Updates the settings of a specific instance.

HTTP request


The URL uses gRPC Transcoding syntax.

Path parameters



Output only. The resource name of the instance, in the format projects/{project}/locations/{location}/instances/{instance}.

Query parameters


string (FieldMask format)

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:

  • "description"
  • "fileShares"
  • "labels"

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.