Get Archive Status

Title

Get archive availability status

URL Path

vault_rest/ archive_download_status/{id}

Method

GET

HTTP return

200, 400, 401, 403, 500

Table of Contents

Last Updated

09 Mar 2021

Summary

This API allows checking the availability status of an archive from MetaDefender Vault.

HTTP header parameters

Authorization

The API key of the caller

REQUIRED

This header should have the following format:
Bearer

Example: Bearer Cp01BwnXAIOLZXxn7yogjKqIZnZpQD

Method: GET

id

Unique identifier of the 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 the body will contain the availability state of the archive together with the total count of the files in the archive. If the state in the response indicates "Available", then the archive is ready to be downloaded.

Example of a successful request:

{
"added_file_count": 11,
"availability_state": "Available",
"total_file_count": 11
}

Descriptions of response:

added_file_count

The count of added files

The total number of available files that were added to the archive

availability_state

Availability state of the archive

Indicates if the archive is available to be downloaded.

total_file_count

The total file count

The total number of files in the archive