S3 APIs integrations

S3 is a cloud-based object storage service designed to store and retrieve any amount of data.

Instance and workspace object storage are different from using S3 resources within scripts, flows, and apps, which is free and unlimited. This is what is described in this page.

At the workspace level, what is exclusive to the Enterprise version is using the integration of Windmill with S3 that is a major convenience layer to enable users to read and write from S3 without having to have access to the credentials.

Additionally, for instance integration, the Enterprise version offers advanced features such as large-scale log management and distributed dependency caching.

Windmill provides a unique resource type for any API following the typical S3 schema.

Add an S3 Resource

Here are the required details:

Property	Type	Description	Default	Required
bucket	string	S3 bucket name		true
region	string	S3 region for the bucket		true
useSSL	boolean	Use SSL for connections	true	true
endPoint	string	S3 endpoint		true
accessKey	string	AWS access key		false
pathStyle	boolean	Use path-style addressing	false	true
secretKey	string	AWS secret key		false

For guidelines on where to find such details on a given platform, please go to the AWS S3 or Cloudflare R2 pages.

Your resource can be used passed as parameters or directly fetched within scripts, flows and apps.

Example of a Supabase resource being used in two different manners from a script in Windmill.

tip

Find some pre-set interactions with S3 on the Hub.

Feel free to create your own S3 scripts on Windmill.

Workspace object storage

Once you've created an S3 or Azure Blob resource in Windmill, you can use Windmill's native integration with S3 and Azure Blob, making it the recommended storage for large objects like files and binary data.

The workspace object storage is exclusive to the Enterprise edition. It is meant to be a major convenience layer to enable users to read and write from S3 without having to have access to the credentials.

Workspace object storage

Connect your Windmill workspace to your S3 bucket or your Azure Blob storage to enable users to read and write from S3 without having to have access to the credentials.

Instance object storage

Under Enterprise Edition, Instance object storage offers advanced features to enhance performance and scalability at the instance level. This integration is separate from the Workspace object storage and provides solutions for large-scale log management and distributed dependency caching.

S3/Azure Blob Instance Integration

Connect your Windmill instance to your S3 bucket or your Azure Blob storage to enable users to read and write from S3 without having to have access to the credentials.