Object Lock (Beta)
Beta Service Release
S3-Compatible Object Lock is currently available as pre-production beta and may not be suitable for all production environments.
Please refer to our Terms of Service for more information on release definitions.
Summary
Overview
Storj is currently developing Object Versioning (Beta). As part of that development, we have released an early Beta Service Release, which includes S3-Compatible Object Lock, that can be used to evaluate the functionality.
Beta Opt-In Instructions
To gain access to S3-compatible Object Lock, you'll need to opt into the Object Versioning Beta following the steps below:
You need to opt in to the object versioning beta separately for each project.
- Login to the Storj web console
- Navigate to the desired project
- If you haven't already dismissed the prompt, you will be prompted to enable the object versioning beta.
- If you do not see the prompt you can navigate to the project settings, where you can opt into the beta:
- Click the project name, then Project Settings
- Scroll down to the Features section and click "Learn more" under Object Versioning (Beta)
- Enable versioning
- Click the project name, then Project Settings
Enabling Object Lock on a Bucket
Object Lock is not backwards compatible with existing buckets—a new bucket must be created to enable Object Lock.
Navigate to Browse on the left side menu.
Click on the New Bucket button.
Assign the bucket an easily identifiable name, such as "my-bucket".
Optional: Enable Object Lock (required for immutability in many applications).
Optional: Enable Object Versioning (note that this will be enabled by default if Object Lock is enabled)
Click Create bucket
FAQ
- When will Object Lock be fully released?
- Object lock will be released soon - the target is December 2024 or January 2025
- Why would I test this Beta?
- If you plan to conduct a proof of concept or want to test a a pre-production instance of an integration that utilizes object lock.
- How do I test the Beta?
- See instructions above
- How do I give feedback or request features related to Object Lock?
- Our roadmap is public. Here are the relevant roadmap items:
- You may also submit a support request here: https://support.storj.io/hc/en-us/requests/new
Technical Details
New S3 Actions Supported:
| Action | API Description | Description of Change(s) |
|---|---|---|
GetObjectLockConfiguration | Gets the object lock configuration for a bucket. | Will return the ObjectLockConfiguration with
|
PutObjectLockConfiguration | Enables Object Lock configuration on a bucket. | ObjectLockEnabled: Indicates if Object Lock is enabled on the bucket. Rule (Optional): Specifies the Object Lock rule (mode and period) for the bucket. The period can be either |
| PutObjectRetention | Places an object retention configuration on an object. | |
| GetObjectRetention | Retrieves an object's retention settings. | |
| GetObjectLegalHold | Retrieves the Legal Hold status of an object. | |
| PutObjectLegalHold | Applies a Legal Hold to the specified object. |
Existing S3 Actions Updated
| Action | API Description | Description of Change(s) |
|---|---|---|
| CreateBucket | Creates a new bucket. | CreateBucket will now accept the following request parameter:
|
| HeadObject | Retrieves metadata from an object without returning the object itself. | HeadObject will now return:
|
| GetObject | Retrieves an object from a bucket. | GetObject will now return:
|
PutObject | Adds an object to a bucket. | PutObject will now:
PutObject will now accept the following request parameters:
|
| CopyObject | Creates a copy of an object that is already stored on Storj. | CopyObject will now accept the following request parameters:
|
CreateMultipartUpload | This action initiates a multipart upload and returns an upload ID. | CreateMultipartUpload will now accept the following request parameters:
Storj has a unique object level TTL. Any request that has both a TTL and a retention period will be rejected to prevent TTL's from conflicting with object lock retention periods. |
| DeleteBucket | Deletes the specified bucket. | Forced deletion of a bucket with locked objects will be prevented. |
| DeleteObject | Removes an object from a bucket. | Deletion of an object with a retention set will be prevented. |