Method: updateSettings

Updates the Log Router settings for the given resource.

Note: Settings for the Log Router can currently only be configured for Google Cloud organizations. Once configured, it applies to all projects and folders in the Google Cloud organization.

v2.updateSettings will fail if 1) kmsKeyName is invalid, or 2) the associated service account does not have the required roles/cloudkms.cryptoKeyEncrypterDecrypter role assigned for the key, or 3) access to the key is disabled. 4) locationId is not supported by Logging. 5) locationId violate OrgPolicy.

See Enabling CMEK for Log Router for more information.

HTTP request

PATCH https://logging.googleapis.com/v2/{name=*/*}/settings

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. The resource name for the settings to update.

"organizations/[ORGANIZATION_ID]/settings"

For example:

"organizations/12345/settings"

Note: Settings for the Log Router can currently only be configured for Google Cloud organizations. Once configured, it applies to all projects and folders in the Google Cloud organization.

Authorization requires the following IAM permission on the specified resource name:

  • logging.cmekSettings.get

Query parameters

Parameters
updateMask

string (FieldMask format)

Optional. Field mask identifying which fields from settings should be updated. A field will be overwritten if and only if it is in the update mask. Output only fields cannot be updated.

See FieldMask for more information.

For example: "updateMask=kmsKeyName"

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

Response body

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

Authorization Scopes

Requires one of the following OAuth scopes:

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

For more information, see the Authentication Overview.