Table of contents:

Find more information on what access rights are needed for which operation at S&E Access Control Lists.

Create an encryption task

  1. From the Encryption Task API tab open the POST /api/v1/encryptionTask endpoint.
  2. Click Try it out.
  3. Fill in the tenant header in the X-SE-TENANT field.
  4. Fill in the deviceConfigId
  5. Upload the file
  6. Optionally fill in:
    1. name
    2. sha256checksum
  7. Click Execute.
  8. A successful response with 201 code will have status CREATED and will provide the encryptionTaskId.

Check the status of an encryption task

  1. Open the endpoint to GET /api/v1/encryptionTask/{encryptionTaskId}.
  2. Click Try it out.

  3. Fill in the encryptionTaskId from the response body of your previous call. 

    Another option would be to check the status of all the tasks via GET /api/v1/encryptionTask.

  4. Fill in the tenant header in the X-SE-TENANT field.
  5. Click Execute.
  6. When the task is ready the response body will have status DONE and you have to use the Download endpoint.

Download an encrypted file of a DONE encryption task

  1. Open the endpoint to GET /api/v1/encryptionTask/{encryptionTaskId}/download.
  2. Click Try it out.

  3. Fill in the encryptionTaskId.

  4. Fill in the tenant header in the X-SE-TENANT field.
  5. Click Execute.
  6. A successful response will start the download process automatically.