Method: instances.patch

Full name: projects.locations.instances.patch

Updates an Instance.

HTTP request


Path parameters

Parameters
instance.name

string

Identifier. The resource name of this instance. Format: projects/{project}/locations/{location}/instances/{instance}

Query parameters

Parameters
updateMask

string (FieldMask format)

Optional. The list of fields to update. 1. If updateMask is not included in the request, error will be returned. 2. If updateMask is present and paths includes only "*" then all the fields which are supported by instances.patch will be updated irrespective of whether they are present in the request or not. Fields which are not present in the request will be set to nil/false value. 3. To update partial flags in instanceConfig, the relevant flags should be provided like instanceConfig. for each flag. For eg to update secopsUiEnabled flag, instanceConfig.secops_ui_enabled should be provided in the paths of the updateMask. If the flag is present in the paths but not present in the request, it will be set to false. 4. If only instanceConfig is provided in the paths, all the flags in instanceConfig will be updated and those flags which are not present in the request will be set to false.

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 Instance.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • chronicle.instances.update

For more information, see the IAM documentation.