The API

FileRun 2026, API migration guide🔗

The error response property has been replaced with the property named msg which is expected to by an array of messages. This property also returns messages on successfull actions now.

All API endpoint URLs have changed, as follows:

/api.php/Core/account/info🔗

• No longer returns the user id. Instead, it returns the public id as puid (string).

/api.php/Core/account/avatar🔗

• Requires the POST variable puid with the user's public id instead of the record id (id).
• It no longer returns an image for an invalid puid but instead responds with an HTTP 404 error.

/api.php/Drive/files/unshare🔗

• No longer takes uid (int) but instead it takes puid (string).

/api.php/Drive/files/share🔗

• No longer takes a set of individual permissions, but instead it takes a role (string) which can have one of the values viewer, commenter, distributor, editor, uploader, contributor or manager. See Sharing files and folders.
• It no longer takes uid (int) but instead it takes puid (string).

/api.php/Drive/files/browse🔗

• Whatever you can access via the web user interface, you can now access via the API and follows the folders structure identically. You can access things like collections, the media folders with albums, etc.
• The following paths have changed as follows:

• For more details on the new paths, please see the API documentation.
• The meta[perms] data is no longer included in the response.
• The items permissions (perms) is no longer included in the response.
• Folder contents can no longer be listed recursively. A request which sends the parameter recursive is refused.
• The color, tags, rating and filetype (metadata filetype) can be now retrieved for files/folders.
• The details[uuid] argument no longer exists.

/api.php/Core/!admin/users/edit🔗

• When modifying user account credentials via the API, you can POST the variable notify (with the value 1) to have FileRun e-mail the new credentials to the user. It works the same as the Send a notification now checkbox available when modifiying the user account from the FileRun control panel.

/api.php/Drive/files/upload🔗

• It now accepts only PUT HTTP requests and takes a set of new parameters. For more details, please see: API documentation

/api.php/Drive/files/zip🔗

• New API method for zipping files and folders. More details here.

/api.php/Drive/files/metadata/set🔗

• New API method for setting metadata. More details here.

/api.php/Drive/files/metadata/fields🔗

• New API method for getting information about existing metadata fields. More details here.

Searching files/folders🔗

Searching has an endpoint of its own, /api.php/Drive/files/search, which takes filename, contents, metatype and meta[field-id] and answers like the listing endpoint. See Searching files and folders.

/api.php/Drive/files/weblink🔗

• It now accepts only POST requests.
• The options of getting a temporary or a one-time download URL via the API, without affecting an existing web link, is no longer available. This is because this type of shared links can now be created only tied to a user browser session.
• It now requires a role, which can be: viewer, commenter, editor, uploader.
• The response format also changed. See: https://docs.filerun.com/api_create_web_links_on_files_and_folders