S3 Compatible storage S3 Compatible storage
  1. iconik
  2. Admin
  3. Storage
  4. adding

S3 Compatible storage

adding

We support the S3 protocol for storage, and storages that correctly implement the S3 API can be used with iconik. For example:

  • Backblaze B2 (though we prefer to use the in-built support from iconik for B2)
  • Cloudian
  • IBM Cloud Object Storage
  • Object Matrix
  • Wasabi
  • Seagate Lyve
  • Others that implement the full S3 API

Roles

These are the iconik roles that are needed:

  • Owner
  • read storage
  • write storage
  • reindex storage

Before you begin

Please ensure you have the following details ready to configure your S3 storage (Your administrator of the S3 compatible storage should be able to provide these if you don’t have them):

  • Access Key
  • Secret Key
  • Bucket Name
  • Region
  • End Point
    *Note: You can use iconik managed credentials instead of the Access and Secret keys. This is automatically generated based on your iconik domain ID

If you are setting up a third party bucket we strongly recommend you read our knowledgebase article Controlling Costs as using iconik with third party buckets may cause costs for you.

Where to connect the storage

  1. Click on ADMIN in the top navigation.
  2. Choose Storages from the left navigation bar.
  3. In the + Connect Storage section, select the S3 Compatible option from the list of available storages:

Screenshot 2025-03-25 at 2.17.36 PM.png

Connecting your S3 Compatible Storage

To successfully connect your S3 Compatible storage to iconik, fill out the required fields presented in the guided step-by-step wizard. You can expand the Help pop out to provide more context as you complete each step.

 Step 1 - Setup

Screenshot 2025-04-28 at 3.39.14 PM.png

  1. Enter the purpose of the storage you’re connecting:
  • Files: stores all file types except keyframes and proxies.
  • Keyframes: stores only keyframes generated by iconik.*
  • Proxies: stores only proxies generated by iconik.*
  • Exports: will be used as a destination for export jobs.
  • Archive: will be used as an archive destination.
    *Note: Adding your own keyframe and proxy storages will incur an additional monthly cost.
  1. Enter a unique name for your storage that will be easily recognizable for yourself and your team.
  1. Optional - enter a brief description of what this storage is used for.
  1. Enable or disable the available options:
  • Read: this will allow iconik to read files on the storage.
  • Write: this will allow iconik to write files to the storage.
  • Delete: this will allow iconik to delete files on this storage. If this is enabled, files deleted from iconik will also be deleted from this storage.
  • Add unique ID to filename: this will allow iconik to add a unique ID to each file within the storage, to avoid filename duplication.
  1. Select “Next” to continue.

Step 2 - Credentials

  1. Optional - instead of adding the Access and Secret Key, you can toggle on the option to use iconik managed credentials that will be automatically generated for you.
  1. Enter the Access Key for the S3 compatible storage you want to connect.
  1. Enter the Secret key for the S3 Compatible storage you want to connect. 
  1. Enter the name of the S3 Compatible storage bucket you want to connect.
  1. Enter the Region where the bucket is located.*
     
  2. Enter the Endpoint for your bucket.**Note. If your storage address is https://s3.us-east-1.wasabisys.com/bucketname then your Region will be us-east-1 and your endpoint will be https://s3.us-east-1.wasabisys.com/.
  1. Optional - update the following fields based on the storage bucket you are connecting:
  • If bucket acceleration is enabled on your S3 Compatible storage, toggle this on. If you are not sure, leave off and the setting can be changed later.
  • If the storage bucket has object lock enabled and therefore a default retention period set, toggle this on. If you are not sure, leave off and the setting can be changed later.
  1. For file or archive storages, choose whether you will enable the ability for iconik to scan for new files on the storage. 
  • Optional - if Scan is enabled, you can enter specific scan directories to limit the scanning of these directories only.
  • Recommended - If Scan is enabled, you can enable the Collection Directory Mapping toggle. This will automatically mirror the folder structure within your directory to a collection structure within iconik. 
    *Note: You can customize the scan settings after the storage is connected.
  1. Optional - Select any of the transcoders that Iconik provides or have been set up previously by your team.
  2. Select "Verify" to continue.

Step 3 - Verification

Iconik will verify the credentials that you have provided. 

If verification is successful, please complete the process by selecting “Connect” and reviewing the storage settings. There may be some additional customization that you want to complete.

If verification is not successful, you can use the “Back” button to visit the previous steps and update the highlighted fields. If you’re making changes outside of iconik and want to run the verification process again, please choose “Retry”.

Next steps

Once you have successfully connected your AWS S3 storage, review the storage and scan settings available to ensure that is is configuration is optimized for your workflows.

Read next >> Editing S3 Compatible Storages