Unveil API for files

With this API, you can unveil files that the eperi sEcure Platform has encrypted.

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 unveiling encrypted files with tokenized names.

Note: The following example uses the Swagger UI to illustrate how to interactively uveil 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/unveil/file operation.
  3. Click Try it out.


  4. In the Parameters section, click Choose file to open a file browser dialog for selecting the file you want to unveil and then 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 copy of your unveiled file. If its file name was tokenized, it will be restored to its original name.


Results

You have successfully unveiled a protected file using the Unveil API for files