API Keys


An API key is an authentication credential that can be used with the Files.com API and SDKs. This API (and our SDKs) can be used for integrating Files.com with your own applications, as well as other applications via our Zapier integration. API keys are independent from one another, and are easily disposable. By generating unique API keys for each of your applications or servers, you can easily revoke them if needed without disrupting your other integrations.

Files.com supports two types of API keys: Site-wide keys and User keys. Site-wide keys provide full access to the entire API, while user keys will provide access based on the permissions of the associated user. For example, the key of an administrator will provide full access to the entire API, while the key of a non-administrator will only provide access to files that the user can access, and no access to site administration functions in the API.

Actions performed by an API key will be recorded in logs as if they were performed by their associated user.

You can also use an API key as the password to sign in to FTP, SFTP, and WebDAV. This is useful when you have scripts or applications that need to sign in using FTP, SFTP, and WebDAV protocols. In this case, the user login name will be @api-[key-id or API key name] and the password will be API key content.

We strongly recommend associating all API keys with a non-admin user account if at all possible. Site-wide keys or keys associated with a Site Admin's user account will be able to perform any function on the site, including things like deleting all files, or deleting all users.

Creating API Keys

Site-wide keys

Site-wide keys can only be created by Administrators. Navigate to Settings > Integrations > Others > API Keys and select Add key. Enter a name for the key, specify an expiration date (optional), and select Save. When the key is created you will be presented with the key and the option to copy the key to your clipboard.

User keys

User keys can be created by Administrators or by the user.

Administrators can navigate to Settings > Users > Manage Users, select a user, select the Authentication tab for the selected user, and select Add key in the API Keys section.

Users can log into the Files.com web UI, select their username at the top-right, select My Account, and select Add key in the API Keys section.

Removing and Revoking API Keys

API keys can be revoked by deleting them from Files.com.

Site-wide keys

Site-wide keys can only be deleted by Administrators. Navigate to Settings > Integrations > Others > API Keys and select the Delete action for the listed key.

User keys

User keys can be deleted by Administrators or by the user.

Administrators can navigate to Settings > Users > Manage Users, select a user, select the Authentication tab for the selected user, and select the Delete action for the listed key.

Users can log into the Files.com web UI, select their username at the top-right, select My Account, and select the Delete action for the listed key in the API Keys section.

Get Instant Access to Files.com

The button below will take you to our Free Trial signup page. Click on the white "Start My Free Trial" button, then fill out the short form on the next page. Your account will be activated instantly. You can dive in and start yourself or let us help. The choice is yours.

Start My Free Trial

©2022 Files.com. All right reserved

FILES.COM

  • Start My Free Trial
  • Pricing
  • Docs
  • API and SDKs
  • Contact

CONTACT & SUPPORT

support@files.com

(800) 286-8372

Monday–Friday

9am–8pm Eastern