API documentation
    • Introduction
    • Error guide
    • Quickstart guide
    • Datacenter
    • File and Folder
      • File
      • Folder
    • Region
    • Storage
      • Status
        GET
    • Welcome
      GET
    • Schemas
      • StandardResponse
      • ErrorResponse

    File and Folder

    Everabyte File & Folder Sharing API Documentation#

    Last Updated: October 13, 2025
    Organization: Everabyte
    Base URL: https://api.everabyte.io
    Audience: Public Developers & Internal Team

    Table of Contents#

    1.
    Overview
    2.
    Authentication
    3.
    File API Endpoints
    4.
    Folder API Endpoints
    5.
    Request/Response Examples

    Overview#

    Everabyte provides a secure, enterprise-grade file storage and sharing platform with end-to-end encryption (AES-256-GCM). This API enables file and folder management with advanced sharing capabilities.

    Key Features#

    End-to-end encryption with client-side keys
    Public sharing links (Mega.co.nz-style security)
    User-specific sharing with granular permissions
    Password protection and expiration dates

    Key Concepts#

    sharedHash: Public identifier for shared links
    encryptionKey: Client-side encryption key (in URL fragment #)
    fileHash/hashName: Unique identifier for files

    Authentication#

    Header:
    šŸ”“ Public endpoints (no authentication required):
    POST /files/shared/:sharedHash
    POST /files/download/public/:sharedHash
    POST /folders/shared/:sharedHash

    File API Endpoints#

    1. Create Shared Link for File#

    POST /files/share/:fileId
šŸ”’ Authentication Required
    Parameters:
    password (optional) - Password protection
    expirationDays (optional) - Expiration (0 = never)
    maxAccess (optional) - Max downloads (0 = unlimited)
    canView, canDownload, canEdit (boolean) - Permissions
    isPublic (boolean) - Public visibility

    2. Access Shared File (Public)#

    POST /files/shared/:sharedHash
šŸ”“ No Authentication Required
    Parameters:
    password (optional) - If link is password-protected

    3. Download Shared File (Public)#

    POST /files/download/public/:sharedHash
šŸ”“ No Authentication Required
    Parameters:
    encryptionKey (required) - From URL fragment
    password (optional) - If link is password-protected

    4. Update Shared Link#

    PATCH /files/share/:sharedHash
šŸ”’ Authentication Required
    Parameters:
    password, expirationDays, maxAccess, canDownload (optional)

    5. Revoke Shared Link#

    DELETE /files/revoke/:sharedHash
šŸ”’ Authentication Required

    6. Share File with Specific Users#

    POST /files/share-users/:fileId
šŸ”’ Authentication Required
    Parameters:
    users (array) - List of { userId, canView, canDownload, canEdit }

    7. Get Users with File Access#

    GET /files/share-users/:fileId
šŸ”’ Authentication Required

    8. Remove User Access from File#

    DELETE /files/share-users/:fileId/:userId
šŸ”’ Authentication Required

    Folder API Endpoints#

    1. Create Folder#

    POST /folders/create/:bucketId
šŸ”’ Authentication Required
    Parameters:
    name (required) - Folder name
    parentId (optional) - Parent folder ID
    visibility (optional) - "private" or "public"

    2. Update Folder#

    PUT /folders/update/:folderId
šŸ”’ Authentication Required
    Parameters:
    name, visibility (optional)

    3. Delete Folder#

    DELETE /folders/delete/:folderId
šŸ”’ Authentication Required

    4. Create Shared Link for Folder#

    POST /folders/share/:folderId
šŸ”’ Authentication Required
    Parameters:
    password (optional) - Password protection
    expirationDays (optional) - Expiration (0 = never)
    maxAccess (optional) - Max accesses (0 = unlimited)
    canView, canDownload, canEdit (boolean) - Permissions
    isPublic (boolean) - Public visibility

    5. Access Shared Folder (Public)#

    POST /folders/shared/:sharedHash
šŸ”“ No Authentication Required
    Parameters:
    password (optional) - If link is password-protected
    Returns: Folder info + list of files + stats

    6. Update Shared Folder Link#

    PATCH /folders/share/:sharedHash
šŸ”’ Authentication Required
    Parameters:
    password, expirationDays, maxAccess, canDownload (optional)

    7. Revoke Shared Folder Link#

    DELETE /folders/revoke/:sharedHash
šŸ”’ Authentication Required

    8. Share Folder with Specific Users#

    POST /folders/share-users/:folderId
šŸ”’ Authentication Required
    Parameters:
    users (array) - List of { userId, canView, canDownload, canEdit }

    9. Get Users with Folder Access#

    GET /folders/share-users/:folderId
šŸ”’ Authentication Required

    10. Remove User Access from Folder#

    DELETE /folders/share-users/:folderId/:userId
šŸ”’ Authentication Required

    Request/Response Examples#

    Example 1: Create and Use Public Share Link#

    Response:
    {
  "shareLink": "https://api.everabyte.io/shared/abc123#xyz789key"
}
    Access the shared file (no auth):
    Download the file (no auth):

    Example 2: Share with Specific Users#

    Example 3: Access Shared Folder#

    Response includes:
    Folder information
    List of files with hashName
    Total files and size stats

    Example 4: Revoke Link#

    Support#

    Email: support@everabyte.com
    Modified atĀ 2025-10-13 15:54:37
    Previous
    Datacenter
    Next
    File
    Built with