Platform API Reference

Flashback API v0.0.49

Find categories, code samples, example requests and responses. Select a language for code samples of API calls in the tabs or the mobile navigation menu.

Flashback provides a unified API to seamlessly manage cloud storage across diverse platforms, including:

  • Major providers: AWS S3, Google Cloud Storage (GCS), Azure Blob Storage (more soon)

  • Decentralized and compatible services: StorJ, Akave, and other S3/GCS-compatible systems

Through the API, developers and system administrators can:

  • Provision and manage storage buckets

  • Configure repositories with automated backup and mirroring

  • Monitor performance and usage metrics in real time

  • Control access securely with API keys

  • Gain visibility into storage health and availability

API Reference Index

Check the additional information for a full understanding of your management options in this section.

This documentation is structured into functional categories for ease of navigation:

Category
Description

User Account

Cover your user account.

  • Secure API access using JWT tokens for user sessions or OAuth2 for delegated identity management.

  • Access Flashback environments via dedicated endpoints for development and production use.

  • Enforce and monitor per-user and per-IP request quotas to avoid throttling.

  • Provides structured error responses to simplify debugging and clarify failures like auth errors or quota issues.

Bucket

Create and manage storage buckets across different providers.

  • Supports unified creation/configuration for AWS S3, GCP Google Cloud Storage, Mircrosoft Azure Blob, and S3/GCS-compatible services

  • Enables provider-specific configuration such as regions, replication settings, and lifecycle rules

  • Manage permissions, encryption, and storage classes

Repository

Set up and control repositories used for backup, mirroring, and synchronization workflows.

  • Link multiple buckets under a logical repository

  • Define sync schedules, mirror configurations, and data redundancy policies

  • Monitor repository health and ensure consistency across providers

API Keys

Manage access credentials for secure interaction with the Flashback API.

  • Generate API keys with scoped permissions with repositories (read, write, admin)

  • Enable or disable keys without deleting them

  • Use keys for fine-grained control over repository-level access

Bridge Node

Access details about Flashback’s node infrastructure and availability.

  • View metadata and health of nodes deployed across AWS, GCP, Azure, and other locations

  • Assess latency, uptime, and load-balancing readiness

  • Helps optimize client routing and storage decisions

Performance Statistics

Fetch detailed usage and performance metrics.

  • Retrieve daily summaries or minute-level usage data

  • Metrics include: storage volume, read/write operations, latency, and error rates

  • Useful for auditing, billing, and performance optimization

Additional Services

Utility endpoints and auxiliary services.

  • Includes feedback submission (email integration)

  • Experimental or non-core service features may appear here

Check the real-time and historical status of Flashback services.

  • Includes uptime records, incident history, and component-level status

  • Authenticated endpoints to verify service identity and readiness

HTTP Bearer Authentication

Flashback uses HTTP Bearer Authentication with JWT (JSON Web Tokens). To authenticate your requests, first obtain a JWT from the appropriate login or OAuth endpoint. Then include it in the Authorization header of every API call like this:

Authorization: Bearer <your-jwt-token>

This token confirms your identity and grants access to protected resources. Be sure to keep it secure.

Additional Information

Authentication

This API supports three authentication mechanisms:

  1. Internal Authentication - Email/password based authentication with JWT tokens

  2. Google OAuth - Google OAuth 2.0 authentication

  3. GitHub OAuth - GitHub OAuth 2.0 authentication

Account Validation

  • New user registrations require email verification

  • Verification tokens expire after 24 hours

  • Write operations (create/update/delete) are blocked until email verification is complete

  • Read operations remain available for unverified accounts

Base URL

Rate Limits

  • 100 requests per minute per IP

  • 1000 requests per hour per user

File Upload Limits

  • Feedback emails: Maximum 10MB per file, 25MB total

  • Storage operations: 100MB per file (handled by external nodes)

Quota Management

The platform uses a subscription-based quota system. When quotas are exceeded:

  • Repository operations are automatically disabled

  • Read operations remain available

  • Quotas reset based on your subscription period

Error Handling

All endpoints return consistent error responses with:

  • success: boolean indicating operation status

  • message: human-readable error description

  • error_code: machine-readable error code (when applicable)

Common error codes

  • QUOTA_EXCEEDED: Organization has reached its limits

  • NAME_ALREADY_USED: Resource name already exists

  • NOT_FOUND: Requested resource doesn't exist

  • VALIDATION_ERROR: Request data is invalid

Support

For questions or issues, use the feedback system APIs, in your Flashback platform interface or contact Flashback Support.

PreviousUpload/Download a FileNextUser Account

Last updated

Was this helpful?