Skip to content

File Upload

The file upload operation delivers a file in the Backendless file storage of your application. The return value of the upload operation is the public file URL. Backendless uses the following rules when assigning a URL to the uploaded file:

  1. If no custom domains are mapped to the application, the URL has the following structure:
    North American cluster:

    https://backendlessappcontent.com/<application id>/<REST-API-key>/files/<path>/<file name>
    

    European Union cluster:
    https://eu.backendlessappcontent.com/<application id>/<REST-API-key>/files/<path>/<file name>
    

    where: | Argument                | Description | | --- | --- | | <application id> | ID of the application which can be obtained from the Manage > App Settings screen of the Backendless Console | | <REST-API-key> | REST API key of your application. You can get the value from the Manage > App Settings section of the Backendless Console. Note that if the file is created from Cloud Code (JS, Java or Codeless), the API key in the file path will be the CodeRunner API Key. | | <path> | directory path where the file is saved | | <file name> | name of the file |

  2. If a custom domain is assigned to the application and the domain is selected for File Repo access, Backendless will use the custom domain to create a URL for the uploaded file. The File Repo access configuration is available in Backendless Console (Manage > App Settings > Custom Domains):
    file-repo-access
    When a custom domain is assigned to handle files in your Backendless backend, the structure of the URL is as follows:

    https://your-custom-domain.com/api/files/<path>/<file name>
    

    Note that your xxxx.backendless.app subdomain cannot be assigned to handle File Repo access. This means that Backendless server will never assign that subdomain to the files in your Backendless file repo.

The URL assigned to a file and returned as a result of the upload operation accounts for any security permissions assigned to the file (or the folder it is located in).

// single file upload
Backendless.Files.upload( file, path, overwrite )
 .then( function( fileURL ) {
  })
 .catch( function( error ) {
  });

where:

Argument                Description
file an instance of JavaScript File class.
overwrite a boolean value indicating whether the upload must overwrite an existing file.
path directory path (without the name of the file) in the Backendless file storage where the file should be stored. If the path does not exist, Backendless File Service creates the directory structure.

Return Value

URL of the uploaded file.

Example

HTML:

<input type="file" id="files" name="files[]" multiple />
<input type="button" onclick="uploadFileFunc(); return false;" value="Upload File"/>
Javascript:
// this line goes into the app initialization block
document.getElementById('files').addEventListener('change', handleFileSelect, false);

function handleFileSelect(evt) 
{
   file = evt.target.files[0]; // FileList object
}

function uploadFileFunc()
{
  var callback = {};

   callback.success = function(result)
   {

   }

   callback.fault = function(result)
   {
       alert( "error - " + result.message );
   }

   Backendless.Files.upload( file, "my-folder" )
    .then( function( fileURLs ) {
       console.log( "File successfully uploaded. Path to download: " + result.fileURL );
     })
    .catch( function( error ) {
       console.log( "error - " + error.message );
     });