The API

API methods🔗

Migrating from an older version🔗

The first API changes were introduced with the FileRun version 2026.1.0. To migrate, please use this guide.

The endpoints added and changed with the versions 2026.3.0 and 2026.3.1 are listed on this page.

User info methods🔗

• Getting user account information
• Getting the account avatar

Files methods🔗

• Retrieving lists of files and folders
• Retrieving metadata
• Setting metadata
• Listing metadata fields
• Adding tags
• Listing tags
• Removing tags
• File comments
• Searching files and folders
• Creating folders
• Uploading files
• Downloading files
• Downloading thumbnails
• Renaming files or folders
• Moving files or folders
• Copying files or folders
• Extracting archives
• Zipping files and folders
• Deleting files or folders
• Managing the trash
• Locking files
• Starring files or folders
• Create web links on files and folders
• Removing web links
• Sharing files and folders
• Unsharing files and folders

Other methods🔗

• Search user accounts

Admin methods🔗

• Get FileRun user account information
• Add FileRun user accounts
• Modify FileRun user accounts
• Set the groups of a FileRun user account
• Deactivate FileRun user accounts
• Delete FileRun user accounts
• Managing groups
• Managing roles

Superuser methods🔗

• Generate app passwords