An API authentication key has the following attributes:
A predefined quota (total quota, monthly quota, and daily quota) that depends on your IVX Cloud subscription.
An expiration date that you set when generating the key in the DOD portal.
You can add multiple API authentication keys to your virtual File Protect appliance and set one API key as Active to enable your appliance to submit files for analysis to a quota corresponding to the API key that is set as Active. If the active API key exhausts its quota or expires, a standby key automatically becomes active, allowing detection to continue uninterrupted. If there is more than one standby key, the key that is added first takes precedence over the other keys and is automatically configured as active.
You can add, edit, delete, and activate an API authentication key using the virtual File Protect appliance Web UI:
Log in to the virtual File Protect appliance Web UI.
Click Settings > Submission Engine.
To edit the key description, click the settings icon under the Actions column. Edit the description and click Update to save the changes.
To delete an API key, click the settings icon under the Actions column. Select Delete and confirm the deletion.
Note
You cannot delete the active API authentication key.
To set a key as active, toggle the switch under Key Primary column to change its status from NO to YES, and confirm the change.