API

The file upload API is an interface which can be used in your own applications to securely upload, manage and download files externally from this website.

API compatibility

This API will evolve over time when access to other data within the system is made available. However, none of the current endpoints or response values will change. You can write your integration code knowing that it will now be affected by future updates.

SSL/HTTPS recommended

We recommend SSL is used for all requests. You can require SSL by forcing it via your web server.

UTF-8 encoding

Every string passed to and from the API needs to be UTF-8 encoded.

HTTP Method

All methods are done using POST unless otherwise stated.

Y-m-d H:i:s

2026-09-21 00:32:17

https://bigbyteshare.com/api/v2/

Provides an access_token and account_id to make further requests into the API.

URL Structure

https://bigbyteshare.com/api/v2/authorize

Parameters

• key1 The API key 1. Expected 64 characters in length.
• key2 The API key 2. Expected 64 characters in length.

Returns

A JSON-encoded string including an access token (access_token) and account id (account_id).

Sample Successful JSON Response

{
  "data": {
    "access_token": "X3Xp6cUcue22Q3AlpCiZz3mJQWPT2v10zZqGblSGzVIqZiMoV4ou8LeYH4SKAUL9TcP5xIL7DtxDMj2HoqcwbrvTvoD5ioebA4h7M2fqwM3i650vwc1IExB9VffeDtqe",
    "account_id": "158642"
  },
  "_status": "success",
  "_datetime": "2026-09-21 00:32:17"
}

Possible Errors

200	Could not authenticate user. The username and password may be invalid or your account may be locked from too many failed logins..
200	Failed issuing access token.

Disables an active access_token.

URL Structure

https://bigbyteshare.com/api/v2/disable_access_token

Parameters

• access_token The access token created previously by /authorize.
• account_id The account id returned by /authorize.

Returns

A JSON-encoded string with the response message.

Sample Successful JSON Response

{
  "response": "Token removed or no longer available.",
  "_status": "success",
  "_datetime": "2026-09-21 00:32:17"
}

Possible Errors

200	Please provide the access_token param.
200	Please provide the account_id param.
200	Could not validate access_token and account_id, please reauthenticate or try again.

Provides details of an account based on the account_id.

URL Structure

https://bigbyteshare.com/api/v2/account/info

Parameters

• access_token The access token created previously by /authorize.
• account_id The account id returned by /authorize.

Returns

A JSON-encoded string including a username (username), account level id (level_id), email address (email) and more.

Sample Successful JSON Response

{
  "data": {
    "id": "158642",
    "username": "admin",
    "level_id": "20",
    "email": "[email protected]",
    "lastlogindate": "2017-02-18 11:43:39",
    "lastloginip": "192.168.33.1",
    "status": "active",
    "title": "Mr",
    "firstname": "Admin",
    "lastname": "User",
    "languageId": "1",
    "datecreated": null,
    "lastPayment": "2011-12-27 13:45:22",
    "paidExpiryDate": null,
    "storageLimitOverride": null
  },
  "_status": "success",
  "_datetime": "2026-09-21 00:32:17"
}

Possible Errors

200	Please provide the access_token param.
200	Please provide the account_id param.
200	Could not validate access_token and account_id, please reauthenticate or try again.

Provides the account restrictions inherited from the package associated to the account.

URL Structure

https://bigbyteshare.com/api/v2/account/package

Parameters

• access_token The access token created previously by /authorize.
• account_id The account id returned by /authorize.

Returns

A JSON-encoded string including a label (label), max upload size (max_upload_size) and more.

Sample Successful JSON Response

{
  "data": {
    "id": "20",
    "label": "Premium Account",
    "max_upload_size": "1073741824",
    "can_upload": "1",
    "wait_between_downloads": "0",
    "download_speed": "0",
    "max_storage_bytes": "0",
    "show_site_adverts": "0",
    "show_upgrade_screen": "1",
    "days_to_keep_inactive_files": "0",
    "concurrent_uploads": "100",
    "concurrent_downloads": "0",
    "downloads_per_24_hours": "0",
    "download_size_per_24_hours": "0",
    "max_download_filesize_allowed": "0",
    "max_remote_download_urls": "50",
    "level_type": "paid user",
    "on_upgrade_page": "0"
  },
  "_status": "success",
  "_datetime": "2026-09-21 00:32:17"
}

Possible Errors

200	Please provide the access_token param.
200	Please provide the account_id param.
200	Could not validate access_token and account_id, please reauthenticate or try again.

Permanently deletes all files and folders in an account's trash, as per the file manager Empty Trash action. Only the authenticated account's own trash can be purged.

URL Structure

https://bigbyteshare.com/api/v2/account/purge_trash

Parameters

• access_token The access token created previously by /authorize.
• account_id The account id returned by /authorize.

Returns

Sample Successful JSON Response

{
  "response": "Trash emptied.",
  "data": {
    "total_files": 12,
    "total_folders": 3
  },
  "_status": "success",
  "_datetime": "2026-09-21 00:32:17"
}

Possible Errors

200	Please provide the account_id param.
200	You do not have access to this feature.
200	Option to empty trash not available
200	This API feature is not available in demo mode.

Provides an interface to upload files (whole-file or chunked). Chunked uploads reuse the same server-side handling as the site uploader (append via Content-Range, assemble on the final chunk).

URL Structure

https://bigbyteshare.com/api/v2/file/upload

Parameters

• access_token The access token created previously by /authorize.
• account_id The account id returned by /authorize.
• upload_file The uploaded file (or chunk). Multipart field. The core uploader field name files is also accepted.
• folder_id A folder id within the users account. If left blank the file will be added to the root folder.
• c_tracker Required for chunked uploads. Stable unique id for the whole upload (e.g. a UUID). Must be identical on every chunk for that file. Alias: cTracker.
• max_chunk_size Recommended for chunked uploads. Chunk size in bytes. When omitted on a chunked request, the site default chunk size is used. Alias: maxChunkSize.
• upload_server Optional. Sticky upload-server base URL returned by a previous chunk response. Use when upload pooling is enabled so every chunk hits the same host.

Chunked Upload Guidelines

Use the same byte-range contract as the website uploader:

• Choose a unique c_tracker for the file and send it with every chunk.
• Split the file into sequential chunks. Recommended size is the site's configured chunk size (typically up to ~100MB), and never larger than the server PHP upload limit.
• POST each chunk to /file/upload as multipart upload_file, in order.
• Send chunks sequentially (do not upload in parallel). The server appends each part to a temporary file keyed by filename + c_tracker.
• Read upload_complete (and optionally reuse upload_server / c_tracker) from each response. Intermediate chunks return upload_complete: false and no file_id. The final chunk returns upload_complete: true with the normal file payload.
• Whole-file uploads simply omit the Content-Range header (existing behaviour).

Required header on each chunk

Content-Range: bytes {start}-{end}/{total}

Example for a 2,000,000 byte file in 524,288 byte chunks:

Content-Range: bytes 0-524287/2000000
Content-Range: bytes 524288-1048575/2000000
Content-Range: bytes 1048576-1572863/2000000
Content-Range: bytes 1572864-1999999/2000000

Returns

A JSON-encoded string with the response message.

Sample Intermediate Chunk JSON Response

{
  "response": "Chunk received",
  "data": [
    {
      "name": "large-archive.zip",
      "size": "524288",
      "type": "application/octet-stream",
      "error": null
    }
  ],
  "upload_complete": false,
  "upload_server": "https://yoursite.com",
  "c_tracker": "9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d",
  "_status": "success",
  "_datetime": "2026-09-21 00:32:17"
}

Sample Successful (Final / Whole-File) JSON Response

{
  "response": "File uploaded",
  "data": [
    {
      "name": "sample4_l.jpg",
      "size": "149084",
      "type": "application/octet-stream",
      "error": null,
      "url": "https://yoursite.com/2Vv",
      "delete_url": "https://yoursite.com/2Vv~d?41efa710444abad11a8f4b5a90e4d746",
      "info_url": "https://yoursite.com/2Vv~i",
      "delete_type": "DELETE",
      "delete_hash": "41efa710444abad11a8f4b5a90e4d746",
      "hash": "2f4105bc2c626232544275c2d890168b",
      "stats_url": "https://yoursite.com/2Vv~s",
      "short_url": "2Vv",
      "file_id": "1253",
      "unique_hash": "60b0be7e3b18de9a3f00d940a8e5a9834c6cdc0f49d40af64973be5ca504c4fd",
      "url_html": "<a href="https://yoursite.com/2Vv" target="_blank" title="View image on File Upload Script">view sample4_l (1).jpg on File Upload Script</a>",
      "url_bbcode": "[url]https://yoursite.com/2Vv[/url]"
    }
  ],
  "upload_complete": true,
  "upload_server": "https://yoursite.com",
  "c_tracker": null,
  "_status": "success",
  "_datetime": "2026-09-21 00:32:17"
}

Possible Errors

200	Please provide the access_token param.
200	Please provide the account_id param.
200	Could not validate access_token and account_id, please reauthenticate or try again.
200	Did not receive uploaded file.
200	Filesize received was zero.
200	Chunked uploads require the c_tracker param (stable unique id for the whole file).
200	Invalid upload_server value for this account.
200	PHP Curl module does not exist on your server/web hosting. It will need to be enabled to use this upload feature.
200	Error uploading file. No response received from:

Note: Account upload restrictions are still in place, so you may also receive the same errors as shown on the site uploader.

Generates a unique download url for a file in the currently authorised account.

URL Structure

https://bigbyteshare.com/api/v2/file/download

Parameters

• access_token The access token created previously by /authorize.
• account_id The account id returned by /authorize.
• One of:
• file_id The numeric file id.
• short_url The short url of the file.

Returns

A JSON-encoded string with the response message.

Sample Successful JSON Response

{
  "data": {
    "file_id": "1253",
    "filename": "sample4_l.jpg",
    "download_url": "https://yoursite.com/2Vv?download_token=c3e6289a23e9819d8663569da96087d0760ccc46d0f3ddbe3f6930b261777067"
  },
  "_status": "success",
  "_datetime": "2026-09-21 00:32:17"
}

Possible Errors

200	Please provide the file_id param.
200	Please provide the account_id param.
200	Could not validate access_token and account_id, please reauthenticate or try again.
200	Could not find file based on file_id.
200	Could not generate download url.

Provides an interface to import files from external URLs. Note: URLs should be publicly available, i.e. not password protected. This is only available when background URL downloading is enabled.

URL Structure

https://bigbyteshare.com/api/v2/file/url_upload_add

Parameters

• access_token The access token created previously by /authorize.
• account_id The account id returned by /authorize.
• file_url_base64 The external URL of the file, base64 encoded.
• folder_id A folder id within the users account. If left blank the file will be added to the root folder.

Returns

A JSON-encoded string with the response message.

Sample Successful JSON Response

{
  "response": "File download from URL scheduled",
  "data": {
    "scheduled_item_id": 52,
    "url": "https://yetishare.com/_include/images/yetishare_logo.png"
  },
  "_status": "success",
  "_datetime": "2026-09-21 00:32:17"
}

Possible Errors

200	Please provide the access_token param.
200	Please provide the account_id param.
200	Could not validate access_token and account_id, please reauthenticate or try again.
200	Please provide the file_url_base64 param.
200	Could not parse the file_url_base64 parameter. Ensure it's base64 encoded.
200	PHP Curl module does not exist on your server/web hosting. It will need to be enabled to use this feature.

Displays the status of a previously scheduled remote URL file download. This is only available when background URL downloading is enabled.

URL Structure

https://bigbyteshare.com/api/v2/file/url_upload_status

Parameters

• access_token The access token created previously by /authorize.
• account_id The account id returned by /authorize.
• scheduled_item_id The scheduled item id returned by /file/url_upload_add.

Returns

A JSON-encoded string with the response message.

Sample Successful JSON Response

{
  "response": "Scheduled URL file download found",
  "data": {
    "scheduled_item_id": 51,
    "status": "complete",
    "created": "2024-01-25 19:34:52",
    "started": "2024-01-25 20:24:53",
    "finished": "2024-01-25 20:24:54",
    "total_size": 17262,
    "downloaded_file": {
      "file_id": 11456,
      "name": "file_upload_script_logo.png",
      "size": 17262,
      "url": "https://yoursite.com/sZG/file_upload_script_logo.png"
    }
  },
  "_status": "success",
  "_datetime": "2026-09-21 00:32:17"
}

Possible Errors

200	Please provide the access_token param.
200	Please provide the account_id param.
200	Please provide the scheduled_item_id param.

Provides meta data and urls of a file within a users account.

URL Structure

https://bigbyteshare.com/api/v2/file/info

Parameters

• access_token The access token created previously by /authorize.
• account_id The account id returned by /authorize.
• file_id The file id to get information on.

Returns

A JSON-encoded string with the response message.

Sample Successful JSON Response

{
  "data": {
    "id": "1253",
    "filename": "sample4_l.jpg",
    "shortUrl": "2Vv",
    "thumbnail_url": "https://yoursite.com/cache/plugins/filepreviewer/1253/.../160x134_middle.jpg",
    ...
  },
  "_status": "success",
  "_datetime": "2026-09-21 00:32:17"
}

The thumbnail_url field resolves to a generated image/video/PDF thumbnail when available, otherwise the themed file-type icon URL (same logic as the file manager).

Possible Errors

200	Please provide the file_id param.
200	Please provide the account_id param.
200	Could not validate access_token and account_id, please reauthenticate or try again.
200	Could not find file based on file_id.

Provides meta data and urls of a file within a users account.

URL Structure

https://bigbyteshare.com/api/v2/file/edit

Parameters

• access_token The access token created previously by /authorize.
• account_id The account id returned by /authorize.
• file_id The file id to update.
• filename The new filename. Leave blank to keep existing.
• fileType The new file type/mime type. Example: application/octet-stream. Leave blank to keep existing.
• folder_id The new folder id in the users account. Leave blank to keep existing.

Returns

A JSON-encoded string with the response message.

Sample Successful JSON Response

{
  "response": "File successfully updated.",
  "data": {
    "id": "1253",
    "filename": "sample4.jpg",
    "shortUrl": "2Vv",
    ...
  },
  "_status": "success",
  "_datetime": "2026-09-21 00:32:17"
}

Possible Errors

200	Please provide the file_id param.
200	Please provide the account_id param.
200	Could not validate access_token and account_id, please reauthenticate or try again.
200	Could not find file based on file_id.

Delete an active file.

URL Structure

https://bigbyteshare.com/api/v2/file/delete

Parameters

• access_token The access token created previously by /authorize.
• account_id The account id returned by /authorize.
• file_id The file id to delete.

Returns

A JSON-encoded string with the response message.

Sample Successful JSON Response

{
  "response": "File successfully set as deleted.",
  "data": {
    "id": "1253",
    "filename": "sample4.jpg",
    "shortUrl": "2Vv",
    status": "trash",
    ...
  },
  "_status": "success",
  "_datetime": "2026-09-21 00:32:17"
}

Possible Errors

200	Please provide the file_id param.
200	Please provide the account_id param.
200	Could not validate access_token and account_id, please reauthenticate or try again.
200	Could not find file based on file_id.

Move an active file to another folder.

URL Structure

https://bigbyteshare.com/api/v2/file/move

Parameters

• access_token The access token created previously by /authorize.
• account_id The account id returned by /authorize.
• file_id The file id to move.
• new_parent_folder_id The folder id to move the file into.

Returns

A JSON-encoded string with the response message.

Sample Successful JSON Response

{
  "response": "File successfully moved.",
  "data": {
    "id": "1162",
    "filename": "button_back_over.gif",
    "shortUrl": "2U2",
    ...
  },
  "_status": "success",
  "_datetime": "2026-09-21 00:32:17"
}

Possible Errors

200	Please provide the file_id param.
200	Please provide the account_id param.
200	Could not validate access_token and account_id, please reauthenticate or try again.
200	Could not find file based on file_id.
200	Please provide the new_parent_folder_id param.
200	Could not find the destination folder id defined by new_parent_folder_id.

Move multiple files and/or folders to trash, as per the file manager multi-select trash action.

URL Structure

https://bigbyteshare.com/api/v2/file/bulk_trash

Parameters

• access_token The access token.
• account_id The account id.
• file_ids Comma-separated file ids. Optional if folder_ids is provided.
• folder_ids Comma-separated folder ids. Optional if file_ids is provided.

Restore multiple trashed files and/or folders. Optional target_folder_id (or 0 / null for account root).

URL Structure

https://bigbyteshare.com/api/v2/file/bulk_restore

Parameters

• access_token The access token.
• account_id The account id.
• file_ids Comma-separated file ids.
• folder_ids Comma-separated folder ids.
• target_folder_id Optional destination folder when restoring.

Permanently delete trashed files and/or folders (not the same as /file/delete, which soft-trashes a single active file).

URL Structure

https://bigbyteshare.com/api/v2/file/bulk_delete

Parameters

• access_token The access token.
• account_id The account id.
• file_ids Comma-separated trashed file ids.
• folder_ids Comma-separated trashed folder ids.

Move multiple files and/or folders into a destination folder, as per the file manager move action.

URL Structure

https://bigbyteshare.com/api/v2/file/bulk_move

Parameters

• access_token The access token.
• account_id The account id.
• file_ids Comma-separated file ids.
• folder_ids Comma-separated folder ids.
• target_folder_id Required. Destination folder id (0 or null for account root). new_parent_folder_id is also accepted.

Copy an active file to another folder.

URL Structure

https://bigbyteshare.com/api/v2/file/copy

Parameters

• access_token The access token created previously by /authorize.
• account_id The account id returned by /authorize.
• file_id The file id to copy.
• copy_to_folder_id The folder id to copy the file into.

Returns

A JSON-encoded string with the response message.

Sample Successful JSON Response

{
  "response": "File successfully copyied.",
  "original_file": {
    "data": {
      "id": "1162",
      "filename": "button_back_over.gif",
      "shortUrl": "2U2",
      ...
    }
  },
  "new_file": {
    "data": {
      "id": "1254",
      "filename": "button_back_over.gif",
      "shortUrl": "2Vw",
      ...
    }
  },
  "_status": "success",
  "_datetime": "2026-09-21 00:32:17"
}

Possible Errors

200	Please provide the file_id param.
200	Please provide the account_id param.
200	Could not validate access_token and account_id, please reauthenticate or try again.
200	Could not find file based on file_id.
200	Please provide the copy_to_folder_id param.
200	Could not find the destination folder id defined by copy_to_folder_id.

Create a new folder.

URL Structure

https://bigbyteshare.com/api/v2/folder/create

Parameters

• access_token The access token created previously by /authorize.
• account_id The account id returned by /authorize.
• folder_name The new folder name.
• parent_id The folder parent id. Optional.
• is_public Whether a folder is available publicly or private only. 0 = Private, 1 = Unlisted, 2 = Public in site search. Default Private.
• access_password An MD5 hash of an access password. Expects 32 characters in length. Optional.

Returns

A JSON-encoded string with the response message.

Sample Successful JSON Response

{
  "response": "Folder successfully created.",
  "data": {
    "id": "125",
    "parentId": null,
    "folderName": "My New Folder",
    "totalSize": "0",
    "isPublic": "2",
    "accessPassword": "d9729feb74992cc3482b350163a1a010",
    "date_added": "2017-02-18 12:26:06",
    "date_updated": null,
    "url_folder": "https://yoursite.com/folder/125/My_New_Folder",
    "total_downloads": 0,
    "child_folder_count": 0,
    "file_count": 0
  },
  "_status": "success",
  "_datetime": "2026-09-21 00:32:17"
}

Possible Errors

200	Please provide the folder_name param.
200	Please provide the account_id param.
200	Could not validate access_token and account_id, please reauthenticate or try again.

Returns folders and files for the authenticated account. By default this mirrors a single folder level (legacy behaviour). Pass listing_type and optional filters to use the same listing logic as the file manager (trash, recent, all files, shared with me, search), including paging and sorting.

URL Structure

https://bigbyteshare.com/api/v2/folder/listing

Parameters

• access_token The access token created previously by /authorize.
• account_id The account id returned by /authorize.
• parent_folder_id Folder id to list within when listing_type is folder or shared. Optional (root when blank).
• listing_type Optional. One of folder (default), trash, recent, all, shared, or search. When set (or when search/paging params are used), the file manager listing engine is used.
• search_term Optional filename/keyword search (use with listing_type=search or alone to auto-enable search).
• page_start Optional page number (1-based).
• per_page Optional page size (for example 30, 50, 100).
• filter_order_by Optional sort key (for example order_by_filename_asc, order_by_uploaded_date_desc).
• filter_type Optional file-type filter for search (for example image, video, folders).
• filter_file_size_range Optional size band: small, medium, large, huge.
• filter_visibility Optional: public or private.
• filter_folder_id Optional folder scope for search results.
• filter_uploaded_date_range Optional upload date range as YYYY-MM-DD|YYYY-MM-DD.

Returns

A JSON-encoded string with the response message.

Sample Successful JSON Response

{
  "data": {
    "folders": [
      {
        "id": "123",
        "parentId": null,
        "folderName": "My Folder 1",
        "totalSize": "868689",
        "isPublic": "1",
        "date_added": "2017-02-15 20:02:05",
        "date_updated": null,
        "color": "#3b6fe0",
        "url_folder": "https://yoursite.com/folder/123/My_Folder_1",
        "total_downloads": 5864,
        "child_folder_count": 1,
        "file_count": 0
      },
      {
        "id": "107",
        "parentId": null,
        "folderName": "My Folder 2",
        ...
      },
      {
        "id": "108",
        "parentId": null,
        "folderName": "My Folder 3",
        ....
      }
    ],
    "files": [
      {
        "id": "1161",
        "filename": "button_back.gif",
        "shortUrl": "2U1",
        "fileType": "image/gif",
        "extension": "gif",
        "fileSize": "1116",
        "status": "active",
        "downloads": "5865",
        "folderId": null,
        "keywords": "button,back,gif",
        "url_file": "https://yoursite.com/2U1",
        "thumbnail_url": "https://yoursite.com/themes/nova/assets/images/file_icons/48px/gif.png"
      },
      {
        "id": "1163",
        "filename": "button_cancel.gif",
        "shortUrl": "2U3",
        ...
      },
      {
        "id": "1164",
        "filename": "button_cancel_over.gif",
        "shortUrl": "2U4",
        ...
      }
    ]
  },
  "_status": "success",
  "_datetime": "2026-09-21 00:32:17"
}

Each file in the files array includes thumbnail_url, resolved using the same thumbnail/icon logic as the file manager listings.

Each folder in the folders array includes color — a lowercase hex value such as #3b6fe0, or an empty string when no custom colour is set (same as the file manager).

Possible Errors

200	Please provide the access_token param.
200	Please provide the account_id param.
200	Could not validate access_token and account_id, please reauthenticate or try again.

Provides information for a specific folder id.

URL Structure

https://bigbyteshare.com/api/v2/folder/info

Parameters

• access_token The access token created previously by /authorize.
• account_id The account id returned by /authorize.
• parent_folder_id The folder parent id. Optional.

Returns

A JSON-encoded string with the response message.

Sample Successful JSON Response

{
  "data": {
    "id": "123",
    "parentId": null,
    "folderName": "My Folder 1",
    "totalSize": "868689",
    "isPublic": "1",
    "accessPassword": null,
    "date_added": "2017-02-15 20:02:05",
    "date_updated": null,
    "color": "#3b6fe0",
    "url_folder": "https://yoursite.com/folder/123/My_Folder_1",
    "total_downloads": 5864,
    "child_folder_count": 1,
    "file_count": 0
  },
  "_status": "success",
  "_datetime": "2026-09-21 00:32:17"
}

Possible Errors

200	Please provide the access_token param.
200	Please provide the account_id param.
200	Could not validate access_token and account_id, please reauthenticate or try again.
200	Could not find folder based on folder_id.

Provides an interface to edit a folder.

URL Structure

https://bigbyteshare.com/api/v2/folder/edit

Parameters

• access_token The access token created previously by /authorize.
• account_id The account id returned by /authorize.
• folder_id The folder id to update.
• folder_name The new folder name. Optional.
• parent_id The new parent id to move the folder. Optional.
• is_public Whether a folder is available publicly or private only. 0 = Private, 1 = Unlisted, 2 = Public in site search. Optional.
• access_password An MD5 hash of an access password. Expects 32 characters in length. Optional.

Returns

A JSON-encoded string with the response message.

Sample Successful JSON Response

{
  "response": "Folder successfully updated.",
  "data": {
    "id": "118",
    "parentId": "117",
    "folderName": "My New Folder Name",
    "totalSize": "1024538",
    "isPublic": "1",
    "accessPassword": null,
    "date_added": null,
    "date_updated": null,
    "url_folder": "https://yoursite.com/folder/118/My_New_Folder_Name",
    "total_downloads": 0,
    "child_folder_count": 0,
    "file_count": 11
  },
  "_status": "success",
  "_datetime": "2026-09-21 00:32:17"
}

Possible Errors

200	Please provide the access_token param.
200	Please provide the account_id param.
200	Could not validate access_token and account_id, please reauthenticate or try again.
200	Could not find folder based on folder_id.

Provides an interface to delete a folder.

URL Structure

https://bigbyteshare.com/api/v2/folder/delete

Parameters

• access_token The access token created previously by /authorize.
• account_id The account id returned by /authorize.
• folder_id The folder id to update.

Returns

A JSON-encoded string with the response message.

Sample Successful JSON Response

{
  "response": "Folder successfully set as deleted.",
  "_status": "success",
  "_datetime": "2026-09-21 00:32:17"
}

Possible Errors

200	Please provide the access_token param.
200	Please provide the account_id param.
200	Could not validate access_token and account_id, please reauthenticate or try again.
200	Could not find folder based on folder_id.

Provides an interface to move a folder.

URL Structure

https://bigbyteshare.com/api/v2/folder/move

Parameters

• access_token The access token created previously by /authorize.
• account_id The account id returned by /authorize.
• folder_id The folder id to update.
• new_parent_folder_id The folder id to move the folder into.

Returns

A JSON-encoded string with the response message.

Sample Successful JSON Response

{
  "response": "Folder successfully moved.",
  "data": {
    "id": "117",
    "parentId": "99",
    "folderName": "layered_png_files",
    ...
  },
  "_status": "success",
  "_datetime": "2026-09-21 00:32:17"
}

Possible Errors

200	Please provide the access_token param.
200	Please provide the account_id param.
200	Could not validate access_token and account_id, please reauthenticate or try again.
200	Please provide the folder_id param.
200	Could not find folder based on folder_id.

Create a public sharing link for one or more files and/or folders, as per the file manager Share → URL tab. At least one file id or folder id is required. Ownership of all referenced items is validated against the authenticated account.

/share/create is retained as a deprecated alias for this endpoint.

URL Structure

https://bigbyteshare.com/api/v2/share/create_public_url

Parameters

• access_token The access token created previously by /authorize.
• account_id The account id returned by /authorize.
• file_ids Comma-separated list of file ids to include in the share. Optional if folder_ids is provided.
• folder_ids Comma-separated list of folder ids to include in the share. Child folders are included recursively. Optional if file_ids is provided.
• expiry_date Optional expiry date for the share link in Y-m-d format (for example 2026-12-31).
• access_password Optional plain-text password required to access the share link.

Returns

A JSON-encoded string with the response message and sharing link details.

Sample Successful JSON Response

{
  "response": "Created sharing url.",
  "data": {
    "share_id": "42",
    "sharing_url": "https://yoursite.com/shared/abc123..."
  },
  "_status": "success",
  "_datetime": "2026-09-21 00:32:17"
}

Possible Errors

200	Failed loading file or folders.
200	Could not create sharing url.
200	This API feature is not available in demo mode.

List all active public share URLs created by the authenticated account.

URL Structure

https://bigbyteshare.com/api/v2/share/public_url_listing

Parameters

• access_token The access token created previously by /authorize.
• account_id The account id returned by /authorize.

Returns

Sample Successful JSON Response

{
  "data": {
    "shares": [
      {
        "share_id": "42",
        "sharing_url": "https://yoursite.com/shared/abc123...",
        "date_created": "2026-08-25 10:15:00",
        "expiry_date": "2026-12-31",
        "has_password": true,
        "permission_level": "view",
        "last_accessed": null,
        "file_ids": [1161, 1163],
        "folder_ids": [123]
      }
    ]
  },
  "_status": "success",
  "_datetime": "2026-09-21 00:32:17"
}

Delete (revoke) a share created by the authenticated account. Works for both public share URLs and internal shares.

URL Structure

https://bigbyteshare.com/api/v2/share/delete

Parameters

• access_token The access token created previously by /authorize.
• account_id The account id returned by /authorize.
• share_id The share id to delete.

Returns

Sample Successful JSON Response

{
  "response": "Share removed successfully.",
  "data": {
    "share_id": "42"
  },
  "_status": "success",
  "_datetime": "2026-09-21 00:32:17"
}

Possible Errors

200	Please provide the share_id param.
200	Could not find share based on share_id.
200	This API feature is not available in demo mode.

List internal shares (shared with registered users) created by the authenticated account. Optionally filter by comma-separated file_ids and/or folder_ids to match the file manager Share modal behaviour.

URL Structure

https://bigbyteshare.com/api/v2/share/internal_listing

Parameters

• access_token The access token created previously by /authorize.
• account_id The account id returned by /authorize.
• file_ids Optional comma-separated file ids to filter results.
• folder_ids Optional comma-separated folder ids to filter results.

Returns

Sample Successful JSON Response

{
  "data": {
    "shares": [
      {
        "share_id": "55",
        "sharing_url": "https://yoursite.com/shared/def456...",
        "shared_with_user_id": "158642",
        "shared_with_email": "[email protected]",
        "date_created": "2026-08-25 11:00:00",
        "expiry_date": null,
        "permission_level": "view",
        "last_accessed": null,
        "file_ids": [1161],
        "folder_ids": []
      }
    ]
  },
  "_status": "success",
  "_datetime": "2026-09-21 00:32:17"
}

Share files and/or folders with one or more registered users, as per the file manager Share → Internal tab. Sends a notification email to each matched account.

URL Structure

https://bigbyteshare.com/api/v2/share/create_internal

Parameters

• access_token The access token created previously by /authorize.
• account_id The account id returned by /authorize.
• file_ids Comma-separated list of file ids. Optional if folder_ids is provided.
• folder_ids Comma-separated list of folder ids. Optional if file_ids is provided.
• emails Comma-separated list of registered account email addresses to share with.
• permission_type Optional. One of view, upload_download, or all. Default view.
• expiry_date Optional expiry date in Y-m-d format.

Returns

Sample Successful JSON Response

{
  "response": "If the email address exists within our system, this folder will now be available to the user within their account.",
  "data": {
    "created": 1
  },
  "_status": "success",
  "_datetime": "2026-09-21 00:32:17"
}

Create a public share link for the selected items and email it to a recipient, as per the file manager Share → Email tab.

URL Structure

https://bigbyteshare.com/api/v2/share/send_email

Parameters

• access_token The access token created previously by /authorize.
• account_id The account id returned by /authorize.
• file_ids Comma-separated list of file ids. Optional if folder_ids is provided.
• folder_ids Comma-separated list of folder ids. Optional if file_ids is provided.
• recipient_email Email address to send the share link to.
• extra_message Optional message to include in the email.
• expiry_date Optional expiry date in Y-m-d format.
• access_password Optional plain-text password for the share link.

Returns

Sample Successful JSON Response

{
  "response": "Items shared via email to [email protected]",
  "data": {
    "share_id": "42",
    "sharing_url": "https://yoursite.com/shared/abc123..."
  },
  "_status": "success",
  "_datetime": "2026-09-21 00:32:17"
}

Provides details of an account based on the account_id.

URL Structure

https://bigbyteshare.com/api/v2/account/info

Parameters

• access_token The access token created previously by /authorize.
• account_id The account id returned by /authorize.

Returns

A JSON-encoded string including a username (username), account level id (level_id), email address (email) and more.

Sample Successful JSON Response

{
  "data": {
    "id": "158642",
    "username": "admin",
    "level_id": "20",
    "email": "[email protected]",
    "lastlogindate": "2017-02-18 11:43:39",
    "lastloginip": "192.168.33.1",
    "status": "active",
    "title": "Mr",
    "firstname": "Admin",
    "lastname": "User",
    "languageId": "1",
    "datecreated": null,
    "lastPayment": "2011-12-27 13:45:22",
    "paidExpiryDate": null,
    "storageLimitOverride": null
  },
  "_status": "success",
  "_datetime": "2026-09-21 00:32:17"
}

Possible Errors

200	Please provide the access_token param.
200	Please provide the account_id param.
200	Could not validate access_token and account_id, please reauthenticate or try again.