Table of contents:

A packaging task triggers the creation of a container, in which all uploaded files are encrypted and signed.

Find more information on the access rights needed for each operation in S&E Access Control Lists.

Create a packaging task

  1. Open the endpoint POST /api/v1/packagingTask.
  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 files to the inputFiles field.
    Use the Add string item button to add a new input field if multiple files need to be uploaded.
  6. Optionally:
    1. upload a metadata file
    2. type in a name
    3. add one or more sha256checksum
  7. Click Execute.
  8. A successful response with 201 code will have status CREATED and will provide the full package information, as well as its id, which you might use later on.

Check the status of a packaging task

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

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

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

  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 a packaged file of a DONE packaging task

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

  3. Fill in the taskId.

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

Approve a packaging task

  1. Open the POST /api/v1/packagingTask/{packagingTaskId}/approval endpoint.
  2. Click Try it out.
  3. Fill in the packagingTaskId.
  4. Fill in the tenant header in the X-SE-TENANT field.

  5. Fill in the Request body following the form:

    {
    "decision": "APPROVED",
    "reason": "string"
    }
  6. Click Execute.
  7. A successful response with 202 code will confirm your action, e.g., Accepted.


If your use case requires only encrypting or sign then you are welcome to use the following two APIs: