Our /backblaze/import Robot

Import files from Backblaze

🤖/backblaze/import imports whole directories of files from your Backblaze bucket.

Keep your credentials safe. Since you need to provide credentials to this Robot, please always use this together with Templates and/or Template Credentials, so that you can never leak any secrets while transmitting your Assembly Instructions.

Note: Transloadit supports file sizes up to 200 GB. If you require a higher limit for your application, please get in touch.

Usage example

Import files from the path/to/files directory and its subdirectories:

{
  "steps": {
    "imported": {
      "robot": "/backblaze/import",
      "credentials": "YOUR_BACKBLAZE_CREDENTIALS",
      "path": "path/to/files/",
      "recursive": true
    }
  }
}

Parameters

  • ignore_errors

    Array of Strings / Boolean ⋅ default: []

    Possible array members are "meta" and "import".

    You might see an error when trying to extract metadata from your imported files. This happens, for example, for files with a size of zero bytes. Including "meta" in the array will cause the Robot to not stop the import (and the entire Assembly) when that happens.

    Including "import" in the array will ensure the Robot does not cease to function on any import errors either.

    To keep backwards compatibility, setting this parameter to true will set it to ["meta", "import"] internally.

  • credentials

    Stringrequired

    Please create your associated Template Credentials in your Transloadit account and use the name of your Template Credentials as this parameter's value. They will contain the values for your Backblaze Bucket Name, App Key ID, and App Key.

    To create your credential information, head over to Backblaze, sign in to your account, and select "Create a Bucket". Save the name of your bucket, and click on the "App Keys" tab, scroll to the bottom of the page then select “Add a New Application Key”. Allow access to your recently created bucket, select “Read and Write” as your type of access, and tick the “Allow List All Bucket Names” option.

    Now that everything is in place, create your key, and take note of the information you are given so you can input the information into your Template Credentials.

    ⚠️ Your App Key will only be viewable once, so make sure you note this down.

    While we recommend to use Template Credentials at all times, some use cases demand dynamic credentials for which using Template Credentials is too unwieldy because of their static nature. If you have this requirement, feel free to use the following parameters instead: "bucket", "app_key_id", "app_key".

  • path

    String / Array of Stringsrequired

    The path in your bucket to the specific file or directory. If the path points to a file, only this file will be imported. For example: images/avatar.jpg.

    If it points to a directory, indicated by a trailing slash (/), then all files that are direct descendants of this directory will be imported. For example: images/.

    Directories are not imported recursively. If you want to import files from subdirectories and sub-subdirectories, enable the recursive parameter.

    If you want to import all files from the root directory, please use / as the value here. In this case, make sure all your objects belong to a path. If you have objects in the root of your bucket that aren't prefixed with /, you'll receive a 404 BACKBLAZE_IMPORT_NOT_FOUND error.

    You can also use an array of path strings here to import multiple paths in the same Robot's Step.

  • recursive

    Boolean ⋅ default: false

    Setting this to true will enable importing files from subdirectories and sub-subdirectories (etc.) of the given path.

    Please use the pagination parameters start_file_name and files_per_page wisely here.

  • start_file_name

    String ⋅ default: ""

    The name of the last file from the previous paging call. This tells the Robot to ignore all files up to and including this file.

  • files_per_page

    Integer ⋅ default: 1000

    The pagination page size. This only works when recursive is true for now, in order to not break backwards compatibility in non-recursive imports.

Related blog posts