API keys
Manage API keys for headless applications
Last updated
Manage API keys for headless applications
Last updated
Copyright © 2023 Scaleflex
API keys allow to call the Filerobot file management API and are suited for backend or headless application where no user context is needed and where the key is not exposed to the browser
Authentication against the Filerobot API is done with an API Secret Key available under Settings > Developers > API keys.
New API keys can be created with the button. On click, user will be requested to
Enter the API key description so it can be easily identified
Select the permissions to be attached with the API key (multi selection from the permissions list) -- these defines what the user will be able to do with the assets
API Permission | Description |
---|---|
| List files |
| Fetch file |
| Upload file |
| Create file metadata |
| Rename file |
| Move file |
| Delete file |
| Set file visibility |
| Create directory |
| Rename directory |
| Create directory metadata |
| Move directory |
| Delete directory |
| Set dir visibility |
| Change container configuration |
| List container configuration |
| Change product information |
| Perform autotaggin |
| Manage shares |
| Manage airbox |
| Manage approval |
| Manage approval voting |
Existing API keys can be managed individually or in bulk for status (Active <> Deactivate). The following settings can be edited:
Setting | Description |
---|---|
Description | To identify the API keys |
Secret key | To be kept secret |
Created at | The API key creation date |
Active | The API key status that can be toggled from active to deactivated using the ... options -- If used, deactivated API keys will return an error |
Copy | Copy the secret key in the notepad for easy integration |