Method: properties.patch

Full name: projects.locations.instances.moduleSettings.properties.patch

Updates a single property of a module setting. Use this method to modify a specific configuration value. Note that changing certain properties may have side effects, such as updating environment data retention or support access settings.

HTTP request


PATCH https://chronicle.africa-south1.rep.googleapis.com/v1beta/{moduleSettingsProperty.name}

Path parameters

Parameters
moduleSettingsProperty.name

string

Identifier. The unique name of the module settings property.

Query parameters

Parameters
updateMask

string (FieldMask format)

Optional. The list of fields to update.

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

Response body

If successful, the response body contains an instance of ModuleSettingsProperty.

Authorization scopes

Requires one of the following OAuth scopes:

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

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • chronicle.moduleSettingsProperties.update

For more information, see the IAM documentation.