API keys

Manage API keys for headless applications

API keys allow to call of the Scaleflex DAM file management API and are suited for backend or headless applications where no user context is needed and where the key is not exposed to the browser

Create new API keys

Authentication against the Scaleflex API is done with an API Secret Key, available under Settings > Project > Access (page) > API keys (tab).

New API keys can be created with the +Add key button. On click, the 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 define what the user will be able to do with the assets

Permissions

API Permission	Description
OBJECTS_LIST	List assets
OBJECTS_FETCH	Fetch assets
FILE_UPLOAD	Upload file
FILE_META_CREATE	Create file metadata
FILE_META_CHANGE	Update file metadata
FILE_RENAME	Rename file
FILE_MOVE	Move file
FILE_DELETE	Delete file
FILE_SET_VISIBILITY	Set file visibility
FILE_LABEL_CHANGE	Update file labels
FILE_IMAGE_EDITOR	Edit file
DIR_CREATE	Create directory
DIR_RENAME	Rename directory
DIR_META_CHANGE	Create and update directory metadata
DIR_MOVE	Move directory
DIR_DELETE	Delete directory
DIR_SET_VISIBILITY	Set dir visibility
CONFIG_CHANGE	Change container configuration
CONFIG_LIST	List container configuration
FILE_PRODUCT_CHANGE	Change product information
FILE_PROCESS_AUTOTAGGING	Perform autotagging
COLLECTIONS_LIST	List collections
COLLECTIONS_MANAGE	Manage collections
LABELS_LIST	View labels
LABEL_MANAGE	Manage labels
OBJECTS_SHARE_MANAGE	Manage sharebox
OBJECTS_AIRBOX_MANAGE	Manage airbox
OBJECTS_APPROVAL_MANAGE	Manage approval
OBJECTS_APPROVAL_VOTE	Approve/Reject assets
ACCESS_READ	View accesses
ACCESS_MANAGE	Manage accesses

Manage Existing API Keys

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	The API key value. To be kept secret
Created at	The API key creation date
Active	The API key status that can be toggled from activated to deactivated using the ... options Note: If used, deactivated API keys will return an error
Copy	Copy the secret key in the clipboard for easy integration