Filebase Platform APIs

Learn about how to use the Filebase Platform APIs.

Filebase Platform APIs
The Filebase Platform APIs can be used to monitor and understand a user's data storage, recent bandwidth usage, and recent IPFS gateway bandwidth usage. 
Total Storage and Recent Bandwidth (Past 24 Hours) Usage API
The following API can be used to generate reports on a user's current storage in bytes across all buckets, regardless of the bucket's network. This API also returns information regarding the user's bandwidth usage over the last 24 hours. 
Authorization
Authorization: Bearer <access-token>
To generate the access-token, start by retrieving your Filebase Access Key and Secret Access Key pair.
Then, navigate to Base64Encode and input the following information: 
ACCESS-KEY:SECRET-KEY
Then select 'Encode' and copy the result:
Payload
Request Body Schema: application/json
get
https://api.filebase.io/v1
/usage
List current storage across all buckets and all bandwidth usage in the last 24 hours.
Total Storage for a Specific Bucket API
The following API can be used to generate reports on a user's current storage in a specific bucket. This API can be used to return data for buckets on any network. 
Authorization
Authorization: Bearer <access-token>
To generate the access-token, start by retrieving your Filebase Access Key and Secret Access Key pair.
Then, navigate to Base64Encode and input the following information: 
ACCESS-KEY:SECRET-KEY
Then select 'Encode' and copy the result:
Payload
Request Body Schema: application/json
get
https://api.filebase.io/v1
/usage/storage/<bucket-name>
List current storage usage in bytes for a specific bucket.
Bandwidth Usage For an IPFS Dedicated Gateway API
The following API can be used to generate reports on a user's current bandwidth usage over the last 24 hours for a specific IPFS dedicated gateway. 
Authorization
Authorization: Bearer <access-token>
To generate the access-token, start by retrieving your Filebase Access Key and Secret Access Key pair.
Then, navigate to Base64Encode and input the following information: 
ACCESS-KEY:SECRET-KEY
Then select 'Encode' and copy the result:
Payload
Request Body Schema: application/json
get
https://api.filebase.io/v1
/usage/gateway/<gateway-name>
List bandwidth usage over the last 24 hours for a specific IPFS dedicated gateway.
If you have any questions, please join our Discord server, or send us an email at [email protected]​

API Documentation - Previous

Filebase IPFS Gateway Management API

Next - API Documentation

IPFS Pinning Service API

Last modified 9mo ago