Method: projects.instances.partialUpdateInstance

Partially updates an instance within a project. This method can modify all fields of an Instance and is the preferred way to update an Instance.

HTTP request


The URL uses gRPC Transcoding syntax.

Path parameters



The unique name of the instance. Values are of the form projects/{project}/instances/[a-z][a-z0-9\\-]+[a-z0-9].

Query parameters


string (FieldMask format)

Required. The subset of Instance fields which should be replaced. Must be explicitly set.

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 one of the following OAuth scopes:


For more information, see the Authentication Overview.