Buckets: lockRetentionPolicy

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


HTTP request

POST https://www.googleapis.com/storage/v1/b/bucket/lockRetentionPolicy?ifMetagenerationMatch=metageneration


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.
Optional query parameters
userProject string The project to be billed for this request. Required for Requester Pays buckets.

Request body

Do not supply a request body with this method.


If successful, this method returns an empty response body.

Try it!

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

Was this page helpful? Let us know how we did:

Send feedback about...

Cloud Storage
Need help? Visit our support page.