Cancel Archive Download

Title

Cancel Archive Download

URL Path

vault_rest/ cancel_archive_download/{id}

Method

PUT

HTTP return

200, 400, 401, 403, 500

Table of Contents

Last Updated

09 Mar 2021

Summary

This API allows the cancelation of a previously created archive.

HTTP header parameters

Authorization

The API key of the caller

REQUIRED

This header should have the following format:
Bearer

Example: Bearer Cp01BwnXAIOLZXxn7yogjKqIZnZpQD

Method: PUT

id

Unique identifier of the archive to be canceled

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 of the response can be ignored. This means that the archive has been successfully canceled.

Example of a failed request:

{
"message": "Cancellation of archiving operation is not available for this archive",
"ui_message_key": "API_ARCHIVE_DOWNLOAD_NOT_AVAILABLE_TO_CANCEL_ARCHIVING_OPERATION",
"status_code": "BadRequest"
}

Descriptions of response:

status_code

HTTP status code

message

A message describing the error

ui_message_key

A message key that is useful for localization