putObjectLegalHold method
Written by
Updated at September 2, 2025
Puts or removes legal hold for an object version.
To be able to put locks on object versions, enable object lock in the bucket using the putObjectLockConfiguration method.
Users with the storage.uploader role can place or release a lock. To check a legal hold, use the getObjectLegalHold method.
For more information on getting started with the API and the general request format, see How to use the S3 API.
Request
PUT /{bucket}/{key}?legal-hold&versionId={versionId} HTTP/2
Path parameters
| Parameter | Description |
|---|---|
bucket |
Bucket name. |
key |
Object key. |
Request parameters
| Parameter | Description |
|---|---|
legal-hold |
Required parameter that indicates the type of operation. |
versionId |
Object version ID. This is a required parameter. |
Headers
Use the appropriate common headers in your request.
Data schema
<ListBucketResult
xmlns="http://s3.amazonaws.com/doc/2006-03-01/">
<KeyCount>1</KeyCount>
<Name>my-sample-bucket</Name>
<Prefix></Prefix>
<MaxKeys>1000</MaxKeys>
<IsTruncated>false</IsTruncated>
<Contents>
<Key>text.txt</Key>
<LastModified>2025-05-15T07:23:08.030Z</LastModified>
<Owner>
<ID>ajegtlf2q28a********</ID>
<DisplayName>ajegtlf2q28a********</DisplayName>
</Owner>
<ETag>"f75a361db63aa4722fb8e083********"</ETag>
<Size>103</Size>
<StorageClass>STANDARD</StorageClass>
<TagSet></TagSet>
</Contents>
</ListBucketResult>
| Element | Description |
|---|---|
Status |
Legal hold status:
Path: |
Response
Headers
Responses can only contain common headers.
Response codes
For a list of possible responses, see Responses.