Skip to content

Import S3 credentials

It is possible to programmatically import S3 credentials into S3Drive using JSON format.

Desktop example: Import

Unencrypted bucket

[
    {
        "bucketName": "bucket-movies",
        "keyId": "keyId",
        "applicationKey": "applicationKey",
        "endpoint": "https://s3.us-west-004.backblazeb2.com",
    },
]

Encrypted bucket

encryptionKey must be base64 encoded plaintext password.

For example if you wish to specify confidential as a password, this would translate into: Y29uZmlkZW50aWFs string.

Control filepath encryption using filepathEncryptionEnabled parameter. 

[
    {
        "bucketName": "another-bucket",
        "keyId": "keyId",
        "applicationKey": "applicationKey",
        "endpoint": "https://s3.eu-west-1.amazonaws.com",
        "encryptionKey": "Y29uZmlkZW50aWFs",
    }
]

Multiple buckets

[
    {
        "bucketName": "bucket-movies",
        "keyId": "keyId",
        "applicationKey": "applicationKey",
        "endpoint": "https://s3.us-west-004.backblazeb2.com",
    },
    {
        "bucketName": "another-bucket",
        "keyId": "keyId",
        "applicationKey": "applicationKey",
        "endpoint": "https://s3.eu-west-1.amazonaws.com",
        "encryptionKey": "cG90YXRv",
    }
]

Optional parameters

filepathEncryptionEnabled

Controls whether to enable filename and directory encryption.

type: boolean
example: true | false

autouploadPath

Controls the directory of media backup on Android and iOS.

type: string
example: Folder/PixelPhotos

storageClass

Controls the S3 provider specific: x-amz-storage-class header.

type: string
example: ONEZONE_IA

Refer to documentation of your S3 provider.

AWS

https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage-class-intro.html#sc-compare
Options: STANDARD | REDUCED_REDUNDANCY | STANDARD_IA | ONEZONE_IA | INTELLIGENT_TIERING | GLACIER | DEEP_ARCHIVE | OUTPOSTS | GLACIER_IR | SNOW

Scaleway

https://www.scaleway.com/en/docs/storage/object/concepts/#storage-class
Options: Standard | One Zone - Infrequent Access | Glacier