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-administrator user account if at all possible. Site-wide keys or keys associated with a Site Administrator's user account will be able to perform any function on the site, including things like deleting all files, or deleting all users.
Site-wide keys
Site-wide keys can only be created by Site Administrators.
Navigate to the API Keys page by typing API Keys in the search at the top of the screen and clicking on the matching result. On this page, you can create new site-wide API Keys and delete any site-wide or user keys that exist.
User Keys
Users can create their own API Keys. Site administrators can also create API Keys for any user.
Creating User Keys - Site Administrators
Navigate to the Users listing by typing Manage Users in the search at the top of the screen and clicking the matching result. Select the user you wish to add an API Key for, then select the Authentication tab for the user. Scroll down to the API Keys section and click 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.
Creating User Keys - Other Users
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.
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.
API keys can be revoked by deleting them from Files.com. Site-wide keys can only be deleted by Administrators.
Removing Site-wide and User keys - Site Administrators
Navigate to the API Keys page by typing API Keys in the search at the top of the screen and clicking on the matching result. On the API Keys page, you can select the Delete action for any listed site or user key.
Removing User keys - Other Users
Users can delete their own keys. In the Files.com web UI, select your 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