Method: projects.locations.instances.patch

Updates the settings of a specific instance.

HTTP request

PATCH https://file.googleapis.com/v1beta1/{instance.name=projects/*/locations/*/instances/*}

The URL uses Google API HTTP annotation syntax.

Path parameters

Parameters
instance.name

string

Output only. The resource name of the instance, in the format projects/{project_id}/locations/{locationId}/instances/{instanceId}.

Query parameters

Parameters
updateMask

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"

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:

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

For more information, see the Authentication Overview.

Try it!

Was this page helpful? Let us know how we did: