Download Archive

Title

Download Archive

URL Path

vault_rest/ archive_download/{id}

Method

GET

HTTP return

200, 400, 401, 403, 500

Table of Contents

Last Updated

20 Apr 2021

Summary

This API downloads an archive from MetaDefender Vault.

HTTP header parameters

Name

Value

Required

Description

Example

Authorization

The API key of the caller

REQUIRED

This header should have the following format:
Bearer API key obtained from authenticate the API
Example: Bearer OrRnBd9J0AzTiUe4Xrevj6IUoHbdMs

GET /vault_rest/archive_download/296fb5f15041430fa9cbc96710d3b21d HTTP/1.1
Host: localhost:8010
Authorization: Bearer OrRnBd9J0AzTiUe4Xrevj6IUoHbdMs
skip_notify: 0

Method Download Archive: GET

id

Unique identifier of the public archive

REQUIRED

Request Error

400

Bad Request

Invalid HTTP request

401

Unauthorized

Authentication unauthorized

403

Forbidden

Permission denied

500

Internal Server Error

The server is temporarily unavailable

Response

In case of a successful request status code, 200 will be returned and it will contain the content stream of the archive. This means that the archive was successfully downloaded.

Example of a successful request:

[Content Stream]

Descriptions of response:

The complete content stream of the archive.