How to upload files via API?

Uploading Files via REST API Using Postman

Below is a step-by-step guide to help visualize the process of uploading files to %product_name% using Postman.

1. Initialize Group Transfer

Endpoint: GET /vault_rest/transfer

Begin by sending a request to initialize a group transfer. This step will return a group_id, which is required in the subsequent file transfer steps.

Administrators must include a valid Bearer token in the request headers. The token can be obtained through the authentication endpoint:

Endpoint: GET /vault_rest/authenticate (reference: Request an API key)

2. Initialize File Transfer:

Endpoint: GET /vault_rest/transfer_file

To begin the file upload process, you must first initialize a file transfer using the group_id obtained from the previous Group Transfer Initialization step. This request will return a unique file_id which is required for the subsequent file upload.

In the request headers, be sure to include the following details:

• transfer_method – Method used for transferring the file as Binary data either Stream or Chunk.
• group_id – The transfer group ID.
• file_size – Size of the file in bytes.
• file_name – Name of the file to be uploaded. (Example: Testing image 2.png → Testing image 2)

3. Upload File

Endpoint: PATCH /vault_rest/transfer_file

In this step, you will upload the actual file content. Ensure that the file you are uploading matches the file details (e.g., file name and size) specified during the Initialize File Transfer step.

Headers:

To allow MetaDefender MFT to correctly identify the request, include the following headers:

• group_id – The group transfer ID received from the Initialize Group Transfer step
• file_id – The file ID received from the Initialize File Transfer step

Body:

In the Body tab of Postman, select binary, and upload the file you intend to transfer.

4. Complete File Transfer

Endpoint: POST /vault_rest/transfer_file

After finishing the PATCH request, the user needs to confirm that they are finished with the file upload. They will need to confirm with the MFT with a request to close the File Upload request.

Headers

Please include the following headers for MFT to confirm the POST request.

• group_id – The group transfer ID received from the Initialize Group Transfer step
• file_id – The file ID received from the Initialize File Transfer step

5. Complete Group Transfer

Endpoint: POST /vault_rest/transfer On the final steps to confirm that your file transfer is complete please send a final POST request for group transfer to close both file transfer and group transfer correctly.

Once the post request has been completed, it can be confirmed by accessing the MFT.