Skip to main content
Files are the objects you store. This page orients you across the file operations and points to the detailed guides.

Operations

Every listing is scoped to a bucketId. There is no documented cross-bucket or company-wide file listing.

What to know first

  1. Uploads return 200, not 201.
  2. Multi-file uploads return only the first file’s result. List the folder afterward.
  3. File delete returns data: "". That is a success.
  4. Version list, restore, and delete operations return HTTP 200 with a nested status.
  5. name excludes the extension; extFile holds it.
  6. Soft delete keeps bytes and remains billable until purge.

File details is not available to API keys

GET /files/details/{fileId} is a session-only route. A key cannot call it, and it is not part of this reference. Use the list operations instead.

Guides

Upload files

Multipart behavior, limits, and prerequisites.

Download files

Streaming and range requests.

Manage file lifecycle

Update, move, copy, delete, and restore.

Versions and restore

Version listing and nested status semantics.

Common patterns

Enumerate everything in a bucket

Use folder content rather than a global file list when you need structure.

Find a file by name

Use searchTerm on the file list, then verify name and extFile exactly. Names are not unique.

Replace a file’s contents

Prefer uploading a new version through the upload route with the same name in the same folder scope, or update the file explicitly. Do not delete and re-upload unless you intend to lose the version lineage.

Conventions

Envelopes and identifiers.

Pagination

List shape.

Errors

Failure handling.

Limits and quotas

Size and rate limits.