S3 · Versioning & retention

GetObjectLockConfiguration

GET/{bucket}?object-lock

Returns the object lock settings of a bucket.

Shows whether object lock is on, and the default retention that new versions get.

View as Markdown

Role: Viewer or higher
Support: Supported
Auth: SigV4 with your API key

Returns the default retention for new versions.

Request

https://wspq7ws2np5l8z4.storage.beta.graphon.sh/support-tickets?object-lock

GET /support-tickets?object-lock 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

Object lock is on.

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

<?xml version="1.0" encoding="UTF-8"?>
<ObjectLockConfiguration xmlns="http://s3.amazonaws.com/doc/2006-03-01/">
  <ObjectLockEnabled>Enabled</ObjectLockEnabled>
  <Rule>
    <DefaultRetention>
      <Mode>COMPLIANCE</Mode>
      <Days>30</Days>
    </DefaultRetention>
  </Rule>
</ObjectLockConfiguration>

Path parameters

bucketstringrequired

The bucket name.

Query parameters

object-lockflagrequired

Selects this operation. Send it with no value.

Headers

x-amz-expected-bucket-ownerstringoptional

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

Responses

200OK

Object lock is on.

application/xml

ObjectLockConfigurationobjectrequired

The root element.

ObjectLockEnabledstring

Always Enabled.

Rule.DefaultRetentionobject

Present when the bucket has a default retention.

Errors

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

404ObjectLockConfigurationNotFoundError

Object lock is off for this bucket.

What to do: Turn it on with PutObjectLockConfiguration.

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?