---
title: GetObjectRetention · S3 API
description: Returns the retention of one object version.
doc_version: 0.1.0-preview
last_updated: 2026-09-14
---

# GetObjectRetention

`GET /{bucket}/{key}?retention`

Returns the retention of one object version.

Shows the retention mode and the date until which storage keeps the version.

- Role: Viewer or higher.
- Support: supported.
- Auth: AWS Signature Version 4 with your API key. See [S3 API](/api/s3.md).
- Needs versionId. Returns the retention of that version.

## Example request

```http
GET /support-tickets/a.json?retention&versionId=ver_5f0c8a8e3d2b4c1e9a7f6b5d4c3b2a19 HTTP/1.1
Host: wspq7ws2np5l8z4.storage.beta.graphon.sh
x-amz-date: 20261007T093000Z
x-amz-content-sha256: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855
Authorization: AWS4-HMAC-SHA256 Credential=<ACCESS_KEY_ID>/20261007/us-east-1/s3/aws4_request, SignedHeaders=host;x-amz-content-sha256;x-amz-date, Signature=<SIGNATURE>
```

## Path parameters

- `bucket` (string, required): The bucket name.
- `key` (string, required): The object key. Keep each `/` as it is. Percent-encode the other reserved characters.

## Query parameters

- `retention` (flag, required): Selects this operation. Send it with no value.
- `versionId` (string, required): The version to read.

## Headers

- `x-amz-expected-bucket-owner` (string, optional): The workspace ID that must own the bucket. Another owner returns `403 AccessDenied`.

## Responses

### 200 · OK

The retention. The element is empty when the version has no retention.

Response body:

- `Retention` (object, required): The root element.
  - `Mode` (string, optional): Always `COMPLIANCE`.
  - `RetainUntilDate` (string, optional): The date until which storage keeps the version.

```http
HTTP/1.1 200 OK
Content-Type: application/xml
x-amz-request-id: 4F8A2C7D1E6B4093A5C2D8E1F7B3A960

<?xml version="1.0" encoding="UTF-8"?>
<Retention xmlns="http://s3.amazonaws.com/doc/2006-03-01/">
  <Mode>COMPLIANCE</Mode>
  <RetainUntilDate>2027-01-01T00:00:00.000Z</RetainUntilDate>
</Retention>
```

## Errors

Any request can also get the common errors on [S3 API](/api/s3.md).

### 400 · `InvalidRequest`

The request has no versionId.

Send the versionId of the version.

### 404 · `NoSuchKey`

The bucket has no object at this key, or no version with this versionId.

Check the key and the versionId.

### 405 · `MethodNotAllowed`

The versionId names a delete marker, which has no bytes.

Use the versionId of a version that holds data. ListObjectVersions shows each one.

### 404 · `NoSuchBucket`

No bucket has this name, or the bucket was deleted.

Check the bucket name. ListBuckets shows the buckets of the workspace.

### 403 · `AccessDenied`

The key does not have the role for this operation, or the bucket is in another workspace.

Use a key of the workspace that owns the bucket, with the role above.

## Other request languages

### aws CLI

```bash
# The graphon profile from the S3 API overview.
export AWS_PROFILE=graphon

VERSION_ID="ver_5f0c8a8e3d2b4c1e9a7f6b5d4c3b2a19"  # A VersionId from list-object-versions
aws s3api get-object-retention \
  --bucket support-tickets \
  --key a.json \
  --version-id "$VERSION_ID"
```

### Python (boto3)

```python
# Replace wspq7ws2np5l8z4 with your workspace ID.
import os

import boto3
from botocore.config import Config

api_key = os.environ["GRAPHON_API_KEY"]
access_key_id = api_key.split("_", 1)[1].split(".")[0]

s3 = boto3.client(
    "s3",
    endpoint_url="https://wspq7ws2np5l8z4.storage.beta.graphon.sh",
    region_name="us-east-1",
    aws_access_key_id=access_key_id,
    aws_secret_access_key=api_key,
    config=Config(signature_version="s3v4", s3={"addressing_style": "path"}),
)

response = s3.get_object_retention(
    Bucket="support-tickets",
    Key="a.json",
    VersionId="ver_5f0c8a8e3d2b4c1e9a7f6b5d4c3b2a19",
)
print(response["Retention"])
```

### JavaScript (AWS SDK)

```javascript
// Replace wspq7ws2np5l8z4 with your workspace ID.
import { S3Client, GetObjectRetentionCommand } from '@aws-sdk/client-s3';

const apiKey = process.env.GRAPHON_API_KEY;
if (!apiKey) throw new Error('Set GRAPHON_API_KEY.');
const accessKeyId = apiKey.split('_')[1].split('.')[0];

const s3 = new S3Client({
  endpoint: 'https://wspq7ws2np5l8z4.storage.beta.graphon.sh',
  region: 'us-east-1',
  forcePathStyle: true,
  credentials: { accessKeyId, secretAccessKey: apiKey },
});

const response = await s3.send(new GetObjectRetentionCommand({
  Bucket: 'support-tickets',
  Key: 'a.json',
  VersionId: 'ver_5f0c8a8e3d2b4c1e9a7f6b5d4c3b2a19',
}));
console.log(response.Retention);
```

## Sitemap

See the full [sitemap](/sitemap.md) for all pages.