Store the Contents of a URL

Save a Copy of the File Located at a Specific URL

The javascript storeUrl function can be called at anytime to store a URL once the client has been initialized

You can add Filestack to your project quickly and easily using our CDN

Or by installing Filestack-JS using NPM

You will need to instantiate the client with your API key and security or CNAME if they apply to you.

You may pass in an optional dictionary of key-value pairs to customize the options of client.storeUrl()

const client = filestack.init('Your_API_Key');
client.storeUrl('url', storeOptions);

Store URL Options

An optional dictionary of key-value pairs that specify how the picker behaves.

URL (Required) String

'url_to_be_stored'

The URL that points to the data to store. The format of the URL should be a string.

Filename String

filename: 'Myfilename.ext'

The name of the file as it will be stored.

Mimetype String

mimetype: 'text/html'

The type of the file as it will be stored. If this isn't provided, the API will attempt to recognize type. Defaults to 'text/plain' if upload is raw data.

Location String

location: 's3'

Where to store the file. Default is 's3'. Other options are 'azure', 'dropbox', 'rackspace' and 'gcs'. You must have configured your storage in the developer portal to enable this feature.

Path String

path: '/myfiles/Myfilename.ext'

The path to store the file within the specified file store. For S3, this is the key where the file will be stored at. By default, Filestack stores the file at the root at a unique id, followed by an underscore, followed by the filename, for example '3AB239102DB_Myfilename.ext'.

If the provided path ends in a '/', it will be treated as a folder, so if the provided path is 'myfiles/' and the uploaded file is named 'Myfilename.ext', the file will be stored at 'myfiles/Myfilename.ext'

Container String

container: 'user-photos'

The bucket or container in the specified file store where the file should end up. This is especially useful if you have different containers for testing and production and you want to use them both on the same Filestack app. If this parameter is omitted, the file is stored in the default container specified in your developer portal.

Region String

filename: region: 'us-east-1'

The region where your storage container is located. This setting currently applies only to S3 buckets. If you are using a different bucket and region than the one you set up in your developer portal you can pass the region as part of your store options. If this parameter is not set we will do our best to determine the region your S3 bucket is located so that we can properly authenticate our connection request. You can find a list of the S3 regions here in the region column.

Access String

access: 'public'

Indicates that the file should be stored in a way that allows public access going directly to the underlying file store. For instance, if the file is stored on S3, this will allow the S3 url to be used directly. This has no impact on the ability of users to read from the Filestack file URL. Defaults to 'private'.