Our /digitalocean/store Robot

Export files to DigitalOcean Spaces

🤖/digitalocean/store exports encoding results to DigitalOcean Spaces.

The URL to the result file in your DigitalOcean Space will be returned in the Assembly Status JSON.

Warning: Our result URLs use the form https://{space}.{region}.digitaloceanspaces.com/path/to/file, which means that your Space name must be DNS-compliant. This includes that you do not use uppercase letters in your Space name. Please note that any non alphanumeric characters in the file names will be replaced with an underscore, and spaces are replaced with dashes. If your existing DigitalOcean Space contains uppercase letters or is otherwise not DNS-compliant, please make sure to rewrite the result URLs using the Robot's url_prefix parameter.

Usage example

Export uploaded files to my_target_folder on DigitalOcean Spaces:

{
  "steps": {
    "exported": {
      "robot": "/digitalocean/store",
      "use": ":original",
      "credentials": "YOUR_DIGITALOCEAN_CREDENTIALS",
      "path": "my_target_folder/${unique_prefix}/${file.url_name}"
    }
  }
}

Parameters

  • use

    String / Array of Strings / Object required

    Specifies which Step(s) to use as input.

    • You can pick any names for Steps except ":original" (reserved for user uploads handled by Transloadit)

    • You can provide several Steps as input with arrays:

      "use": [
  ":original",
  "encoded",
  "resized"
]

    💡 That’s likely all you need to know about use, but you can view Advanced use cases.

  • 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 DigitalOcean Space, Key, Secret and Region.

    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: "space", "region" (for example: "fra1" or "nyc3"), "key", "secret".

  • path

    String ⋅ default: "${unique_prefix}/${file.url_name}"

    The path at which the file is to be stored. This may include any available Assembly variables. The path must not be a directory.

  • url_prefix

    String ⋅ default: "https://{space}.{region}.digitaloceanspaces.com/"

    The URL prefix used for the returned URL, such as "https://my.cdn.com/some/path".

  • acl

    String ⋅ default: "public-read"

    The permissions used for this file. This can be "public-read" or "private".

  • headers

    Object ⋅ default: { "Content-Type": "${file.mime}" }

    An object containing a list of headers to be set for this file on DigitalOcean Spaces, such as { FileURL: "${file.url_name}" }. This can also include any available Assembly Variables.

    Here you can find a list of available headers.

    Object Metadata can be specified using x-amz-meta-* headers. Note that these headers do not support non-ASCII metadata values.

  • sign_urls_for

    Integer

    This parameter provides signed URLs in the result JSON (in the signed_ssl_url property). The number that you set this parameter to is the URL expiry time in seconds. If this parameter is not used, no URL signing is done.

Note: The URLs in the result JSON already point to the file on your target storage platform, so you can just save that URL in your database.

Demos

Related blog posts