Skip to main content

Platform API overview

The Filebase Platform API gives you programmatic access to account-level information that doesn't fit the S3 protocol — storage usage, bandwidth usage, and other account telemetry.

The Platform API is complementary to the S3 API. Bucket and object operations live on the S3 API at s3.filebase.io; usage metrics and account management live here.

Base URL

https://api.filebase.io

Authentication

Authenticate with HTTP Basic using your access key pair. The header value is the base64 encoding of <access-key>:<secret-key>:

KEY="your-access-key"
SECRET="your-secret-key"

curl -H "Authorization: Bearer $(echo -n "$KEY:$SECRET" | base64)" \
https://api.filebase.io/v1/usage

Or use the Authorization: Bearer <base64> form your tooling produces — both work.

Versioning

The current version is v1. All endpoints live under /v1/. Breaking changes will ship under /v2/ with v1 maintained for a deprecation window.

Rate limit

500 requests per second per account, same as the S3 API. See rate limits.

Available endpoints

EndpointDescription
GET /v1/usageTotal storage and trailing-24-hour bandwidth across all buckets
GET /v1/usage/storage/<bucket>Storage usage for one bucket

See usage endpoints for the full reference.

What's next