Method: projects.locations.buckets.patch

Updates a log bucket.

If the bucket has a lifecycleState of DELETE_REQUESTED, then FAILED_PRECONDITION will be returned.

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

HTTP request


The URL uses gRPC Transcoding syntax.

Path parameters



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


For example:


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

  • logging.buckets.update

Query parameters


string (FieldMask format)

Required. Field mask that specifies the fields in bucket 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 detailed FieldMask definition, see:

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 of LogBucket.

Response body

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

Authorization scopes

Requires one of the following OAuth scopes:


For more information, see the Authentication Overview.