Protect API for files

With this API, you can protect files by using eperi sEcure Platform to encrypt their content and optionally tokenize their file names.

Before you begin

Make sure you are logged in as a user with sufficient permissions.

About this task

Starting with eperi sEcure Platform 23.13.1.0, this REST API endpoint provides functionality for protecting files.

Note: The following example uses the Swagger UI to illustrate how to interactively protect data. Swagger provides API documentention for each endpoint and allows you to test them interactively. However, in a production environment, you will probably use an automated approach for accessing the REST API.

Procedure

  1. Launch a web browser and enter the URL for the Swagger UI using the following syntax: https://<GatewayHostname>:<GatewayPort>/swagger-ui/index.html#/.
    Example URL: https://crm.example.com:8443/swagger-ui/index.html#/
  2. Select the Protect and Unveil Data section and then the /api/dataprotection/protect/file operation.
  3. Click Try it out.


  4. Set the required parameters:
    • In the Parameters section, select either true or false for Tokenize file name.
    • Click Choose file to open a file browser dialog for selecting the file you want to encrypt. After you have set both required parameters, click Execute.


  5. In the Responses section, copy the Curl command that is generated if you would like to perform this operation later on via CLI or within a shell script.


  6. Click the Download file link. After the download is complete, you will have a protected version of your file.


Results

You have successfully protected a file using the Protect API for files.

What to do next

With the Unveil API for files, you can unveil the protected file back to its original state.