S3 · Versioning & retention

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: SigV4 with your API key

Needs versionId. Returns the retention of that version.

Request

https://wspq7ws2np5l8z4.storage.beta.graphon.sh/support-tickets/a.json?retention&versionId=ver_5f0c8a8e3d2b4c1e9a7f6b5d4c3b2a19

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>

Replace wspq7ws2np5l8z4 with your workspace ID. HTTP shows the signed request on the wire. The aws CLI and the SDKs sign for you. The CLI uses the graphon profile, and the SDK samples read GRAPHON_API_KEY.

Response

200

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

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>

Path parameters

bucketstringrequired

The bucket name.

keystringrequired

The object key. Keep each / as it is. Percent-encode the other reserved characters.

Query parameters

retentionflagrequired

Selects this operation. Send it with no value.

versionIdstringrequired

The version to read.

Headers

x-amz-expected-bucket-ownerstringoptional

The workspace ID that must own the bucket. Another owner returns 403 AccessDenied.

Responses

200OK

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

application/xml

Retentionobjectrequired

The root element.

Modestring

Always COMPLIANCE.

RetainUntilDatestring

The date until which storage keeps the version.

Errors

Select an error in the response example to see its XML body. Any request can also get the common errors, such as SignatureDoesNotMatch.

400InvalidRequest

The request has no versionId.

What to do: Send the versionId of the version.

404NoSuchKey

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

What to do: Check the key and the versionId.

405MethodNotAllowed

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

What to do: Use the versionId of a version that holds data. ListObjectVersions shows each one.

404NoSuchBucket

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

What to do: Check the bucket name. ListBuckets shows the buckets of the workspace.

403AccessDenied

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

What to do: Use a key of the workspace that owns the bucket, with the role above.

Was this page helpful?