Object Versioning (Beta)

Beta Service Release

S3-Compatible Object Versioning 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.

How do I opt in to the object versioning beta?

To opt in to the object versioning beta, you can follow these steps:

You need to opt in to the object versioning beta separately for each project.

  1. Login to the Storj web console
  2. Navigate to the desired project
  3. If you haven't already dismissed the prompt, you will be prompted to enable the object versioning beta.
  4. 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

How does object versioning work?

Object versioning enables you to preserve, retrieve, and restore every version of every object stored in a bucket. This feature adds an extra layer of data protection and recovery options, allowing you to safeguard against accidental deletions and overwrites.

Key Features of Object Versioning

  • S3 Compatibility: Storj's object versioning is designed to be compatible with the S3 API. This means you can use existing S3 SDKs and tools to manage versioned objects, making it easy to integrate into your current workflows.

  • Version Preservation: Every time an object is overwritten or deleted, a new version is created. This means that previous versions of the object are preserved, not replaced, ensuring that you can access historical data at any time.

  • Recovery and Rollback: In case of accidental deletion or if an object is overwritten with an undesired version, you can easily recover the previous version of the object.

  • Object Lock: For more details on Object Lock support see Object Lock (Beta).

Note that enabling object versioning can increase storage costs since each version of an object is stored separately.

Supported S3 API Methods for Object Versioning

Storj's S3-Compatible Object Versioning supports a range of S3 API methods, allowing you to manage and interact with versioned objects. Below are the key S3 API methods supported by Storj's object versioning, along with a brief description of their use:

Bucket Operations

  • PUT Bucket versioning: Enables or suspends versioning for a bucket.
  • GET Bucket versioning: Retrieves the versioning state of a bucket.

Object Operations

  • PUT Object: Adds an object to a bucket. If versioning is enabled, a unique version ID is assigned to the object.
  • GET Object: Retrieves the current version of an object or a specific version if the version ID is specified.
  • DELETE Object: Permanently deletes a version of an object if the version ID is provided, or marks the current version as deleted by adding a delete marker.
  • LIST Versions: Lists all the versions of all objects in a bucket, including delete markers.

Bucket Versioning Status

The following are the possible versioning statuses a bucket can be in:

StatusDescription
Not SupportedThe bucket was created prior to the release of object versioning, and versioning cannot be enabled. Create a new bucket to enable versioning.
UnversionedVersioning has not been set on the bucket.
EnabledVersioning is enabled for the bucket.
SuspendedVersioning was previously enabled, but is currently suspended. You may re-enable versioning at any time.
Previous
Object Lock (Beta)
Next
S3 Credentials