Buckets: lockRetentionPolicy

Permanently locks the retention policy that is currently applied to the specified bucket.

Required permissions

The authenticated user must have the storage.buckets.update IAM permission to use this method.


HTTP request

POST https://storage.googleapis.com/storage/v1/b/bucket/lockRetentionPolicy

In addition to standard query parameters, the following query parameters apply to this method.

To see an example of how to include query parameters in a request, see the JSON API Overview page.


Parameter name Value Description
Path parameters
bucket string Name of a bucket.
Required query parameters
ifMetagenerationMatch long Makes the success of the request conditional on whether the bucket's current metageneration matches the given value.

Request body

Do not supply a request body with this method.


If successful, this method returns a bucket resource in the response body.

For information about status and error codes returned by this API, see the reference page.

Try it!

Use the APIs Explorer below to call this method on live data and see the response.