GET

/{Bucket}/{Key}#legal-hold

http://s3{dash-or-dot}{region}.amazonaws.com/{Bucket}/{Key}#legal-hold

Gets an object's current legal hold status. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html">Locking Objects</a>. This action is not supported by Amazon S3 on Outposts. The following action is related to <code>GetObjectLegalHold</code>: <ul> <li> <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAttributes.html">GetObjectAttributes</a> </li> </ul>

Access Token Required: API Key

Path Parameters

Bucketstringrequired

The bucket name containing the object whose legal hold status you want to retrieve. When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html">Using access points</a> in the Amazon S3 User Guide.

Keystringrequired

The key name for the object whose legal hold status you want to retrieve.

Query Params

versionIdstring

The version ID of the object whose legal hold status you want to retrieve.

legal-holdbooleanrequired

Allowed:

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request GET \
2     --url 'http://s3{dash-or-dot}{region}.amazonaws.com/{Bucket}/{Key}#legal-hold' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}