Method: folders.updateSettings

Updates the settings for the given resource. This method applies to all feature configurations for organization and folders.

v2.updateSettings fails when any of the following are true:

  • The value of storageLocation either isn't supported by Logging or violates the location OrgPolicy.
  • The defaultSinkConfig field is set, but it has an unspecified filter write mode.
  • The value of kmsKeyName is invalid.
  • The associated service account doesn't have the required roles/cloudkms.cryptoKeyEncrypterDecrypter role assigned for the key.
  • Access to the key is disabled.

See Configure default settings for organizations and folders for more information.

HTTP request


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

The URLs use gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. The resource name for the settings to update.

"organizations/[ORGANIZATION_ID]/settings"
"folders/[FOLDER_ID]/settings"

For example:

"organizations/12345/settings"

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

  • logging.settings.update

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.