Skip to main content

Storage API

Storage API is an API for securely storing and serving binary data such as files, images, videos, PDFs, and CSVs.

Your dedicated Object Storage is automatically configured when you start using the service.
Upload, download, URL generation, and delete endpoints are automatically provided,
so there is no need to build or operate a storage infrastructure yourself.


Three Access Modes

The Storage API provides three modes depending on how files are accessed.

Public (No Authentication)

A mode that allows file access without authentication.
Suitable for serving files that anyone should be able to view, such as product images, public documents, or static resources.

  • Upload and download without an authentication token
  • Retrieve a public URL for uploaded files

User Scope (Per Authenticated User)

Integrates with the IAM API to provide isolated storage areas per logged-in user.
Users can only access the files they uploaded; they cannot view other users' files.

  • Suitable for user-specific file management such as profile images, attachments, and personal documents
  • Requires authentication with an IAM API user token

Organization Scope (Per Organization)

Integrates with IAM API Organizations to provide isolated storage areas per organization.
Members of the same organization can share files; other organizations cannot access them.

  • Suitable for managing shared files within an organization, such as department documents or team working files
  • Requires authentication with an IAM API organization token

Key Features

FeatureDescription
File UploadUpload any binary file (Public / User / Org modes)
File DownloadRetrieve uploaded files
Public URLGenerate a publicly accessible URL for uploaded files
File ListRetrieve a list of files at the organization level
File DeleteDelete a specified file
Dedicated Storage AreaIsolated storage areas per user or per organization

Storage Engine

Two types of storage engines can be used depending on the environment.

EngineUse CaseFeatures
Local StorageTestEnv / DevelopEnvSaves to local disk. For testing and development. Not used in production
Object StorageStagingEnv / ProductionEnvCloud object storage. Persistent storage suitable for production

See Storage Engine for details.


Integration with IAM API

The Storage API can enable authentication by selecting the IAM API to connect to at build time.
When authentication is enabled, the Storage API validates IAM API tokens,
preventing unauthorized access and data mixing between users.

If you only use Public mode, integration with the IAM API is not required.


Interface

The Storage API is provided as a standard HTTP/1.x REST API.
It supports multipart form file uploads and can be connected from anywhere —
web frontends, mobile apps, and backend systems alike.