Method: folders.locations.buckets.patch

Updates a log bucket.

If the bucket has alifecycleState ofDELETE_REQUESTED, thenFAILED_PRECONDITION will be returned.

After a bucket has been created, the bucket's location cannot be changed.

HTTP request

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

The URL usesgRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. The full resource name of the bucket to update.

"projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]""organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]""billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]""folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]"

For example:

"projects/my-project/locations/global/buckets/my-bucket"

Authorization requires the followingIAM permission on the specified resourcename:

  • logging.buckets.update

Query parameters

Parameters
updateMask

string (FieldMask format)

Required. Field mask that specifies the fields inbucket that need an update. A bucket field will be overwritten if, and only if, it is in the update mask.name and output only fields cannot be updated.

For a detailedFieldMask definition, see:https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.FieldMask

For example:updateMask=retentionDays

This is a comma-separated list of fully qualified names of fields. Example:"user.displayName,photo".

Request body

The request body contains an instance ofLogBucket.

Response body

If successful, the response body contains an instance ofLogBucket.

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 theAuthentication Overview.

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-07-21 UTC.