Introduction

Our REST API is designed for people who require the highest level of integration between Files.com and their own application, website, or database.

The Files.com web interface, Desktop app, and FTP backend use this exact same API, so everything you can do in the UI can also be accomplished using the API.

Please First Consider One of Our SDKs

Files.com publishes SDKs for all popular programming languages. We strongly recommend using our SDKs over directly implementing our REST API, especially if working with files.

Our SDKs include developer-friendly features such as support for automatic pagination and tight integration with the File APIs in your language of choice.

Plus we have invested time into optimizing file operations, including parallelization of uploads and downloads in some SDKs. As we add support for more remote server backends via our Sync and Mount features, we will always update our SDKs with any optimizations that are available.

REST API Details

The REST API uses plain JSON or XML over HTTP. Resources (such as Users or Groups) are manipulated individually using HTTP verbs such as GET, POST, PUT, PATCH, and DELETE.

Details of how to use the API are described in the other pages of this book.

You can toggle between JSON and XML examples and documentation using the toggle in the upper left of this page. We strongly recommend JSON as it provides considerably improved performance vs. XML.

OpenAPI

Files.com also publishes a OpenAPI/Swagger v2 Definition File for the API. This swagger_doc.json file includes much of the information available on this documentation site in a machine-readable JSON format.

The most common use of the OpenAPI definition file is in conjunction with API debugging tools like Postman.

It can also be used to generate SDKs in languages that we don't support, but we'd prefer that you reach out to us if you find yourself in that situation. We'd much rather provide an officially supported SDK.

Getting Support

The Files.com Support team provides official support for all of our official Files.com integration tools.

To initiate a support conversation, you can send an Authenticated Support Request or simply send an E-Mail to support@files.com.