File and Folder

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

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

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

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

Response:

{
  "shareLink": "https://api.everabyte.io/shared/abc123#xyz789key"
}

Access the shared file (no auth):

Download the file (no auth):

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

Everabyte File & Folder Sharing API Documentation#

Table of Contents#

Overview#

Key Features#

Key Concepts#

Authentication#

File API Endpoints#

1. Create Shared Link for File#

2. Access Shared File (Public)#

3. Download Shared File (Public)#

4. Update Shared Link#

5. Revoke Shared Link#

6. Share File with Specific Users#

7. Get Users with File Access#

8. Remove User Access from File#

Folder API Endpoints#

1. Create Folder#

2. Update Folder#

3. Delete Folder#

4. Create Shared Link for Folder#

5. Access Shared Folder (Public)#

6. Update Shared Folder Link#

7. Revoke Shared Folder Link#

8. Share Folder with Specific Users#

9. Get Users with Folder Access#

10. Remove User Access from Folder#

Request/Response Examples#

Example 1: Create and Use Public Share Link#

Example 2: Share with Specific Users#

Example 3: Access Shared Folder#

Example 4: Revoke Link#

Support#

Everabyte File & Folder Sharing API Documentation

Table of Contents

Overview

Key Features

Key Concepts

Authentication

File API Endpoints

1. Create Shared Link for File

2. Access Shared File (Public)

3. Download Shared File (Public)

4. Update Shared Link

5. Revoke Shared Link

6. Share File with Specific Users

7. Get Users with File Access

8. Remove User Access from File

Folder API Endpoints

1. Create Folder

2. Update Folder

3. Delete Folder

4. Create Shared Link for Folder

5. Access Shared Folder (Public)

6. Update Shared Folder Link

7. Revoke Shared Folder Link

8. Share Folder with Specific Users

9. Get Users with Folder Access

10. Remove User Access from Folder

Request/Response Examples

Example 1: Create and Use Public Share Link

Example 2: Share with Specific Users

Example 3: Access Shared Folder

Example 4: Revoke Link

Support