S3-Compatible API
Learn about Filebase’s S3-compatible API for seamless integration with existing data management tools and frameworks.
Last updated
Learn about Filebase’s S3-compatible API for seamless integration with existing data management tools and frameworks.
Last updated
The Filebase S3-compatible API can be used by thousands of standardized S3-compatible frameworks, tools, clients, and SDKs to manage data pinned to IPFS by Filebase.
Filebase has certified several of these tools for use with the platform. Filebase certification consists of putting software tools through testing procedures to validate conformity with the Filebase S3-compatible API.
The Filebase S3-compatible API endpoint URL is:
https://s3.filebase.com
To use the Filebase S3-compatible API, you will need to have your Filebase Access and Secret key pair to submit API requests.
To view the access key for your Filebase account, start by clicking on the ‘Access Keys’ option from the menu to open the access keys dashboard.
Here you can view the access keys for your account. Each access key has two parts, the key and the secret associated with the key. The access key dashboard will also provide information such as the time and date the access key was created and its current status.
To use access keys, you will need to have both the key and the secret associated with that key.
The Filebase S3-compatible API only supports AWS v4 signatures (AWS4-HMAC-SHA256) for authentication and does not support AWS v2 signatures at this time. To learn more about S3 authentication, see this article.
Filebase maintains a strict HTTPS-only standard. This means objects and API calls are served only via HTTPS. The port for this connection is the HTTPS standard port 443.
It is not possible to disable this at this time. Requests sent via the HTTP protocol will be redirected to HTTPS.
The Filebase S3 API has an effective rate limit of 100 RPS (requests per second).
The list below documents Filebase's currently supported S3 API methods.
When a response payload is present, all responses are returned using UTF-8 encoded XML.
The Filebase S3-compatible API supports pre-signed URLs for downloading and uploading objects. Pre-signed URLs can be generated in a number of ways including the AWS CLI and the AWS SDKs.
For more information on Pre-signed URLS, see our guide here.
The Filebase S3-compatible API features limited support for Access Control Lists (ACLs). Object-level ACLs are currently not supported.
The GetObjectAcl and GetBucketAcl methods will work as expected, but the GetObjectAcl response will return the ACL of the bucket that the object is contained in.
This design eliminates the possibility of a user accidentally making an object public within a private bucket. If a mix of private and public objects is required for your workflow, you can simply create two different buckets.
For information on how to create a Filebase bucket, see here.
