MetaDefender Managed File Transfer API - File Management 3.11.1

File operations, status, enumeration, tags, classification, sharing, audit, and actions for MetaDefender MFT. This is part of the full API documentation, split by feature area.

Server

http://localhost:8010

Authentication

http basicAuth

http bearerAuth

File Download

Overview

APIs for downloading files from MetaDefender Vault.

GET

/vault_rest/file/{file_id}

GET

/vault_rest/public/{id}

Download a file

Summary

This API call allows you to download the files stored in MetaDefender Vault. The call should be made to vault_rest/file/{file_id} through a GET request. Please note that you need to obtain {file_id} in order to retrieve the file.

Auth

Path Params

file_id

string

[required] Id of the file you wish to download

GET /vault_rest/file/{file_id}

xxxxxxxxxx
 
curl --get \ --url 'http://localhost:8010/vault_rest/file/%7Bfile_id%7D' \ --header 'Authorization: Bearer {token}'
Copy

Responses

200

Successful response

file file

Response

xxxxxxxxxx
 
File Content
Copy

Download Public File

Summary

Download a file using a public link. No authentication required.

Since

Version 3.7.0

Auth

Path Params

string

[required] Public file ID

GET /vault_rest/public/{id}

xxxxxxxxxx
 
curl --get \ --url 'http://localhost:8010/vault_rest/public/%7Bid%7D'
Copy

Responses

200

Successful response

file file

Response

xxxxxxxxxx
 
{ "schema": "{file}"}
Copy

File Operations

Overview

APIs for file operations: delete, move, rename, password management.

DELETE

/vault_rest/file/{file_id}

DELETE

/vault_rest/files

PUT

/vault_rest/v2/move_files

PUT

/vault_rest/rename_file

PUT

/vault_rest/file_password

POST

/vault_rest/file_password

GET

/vault_rest/preview_file/{id}

Delete A File

Summary

Delete a file from the MetaDefender Vault storage. This API will only mark the file for deletion. The file will be physically deleted by the background worker.

Permissions Restrictions

Administrators can delete any file, including other user's files. Users can only delete their own files.

Auth

Path Params

file_id

string

[required] ID of file to delete

DELETE /vault_rest/file/{file_id}

xxxxxxxxxx
 
curl --request DELETE \ --url 'http://localhost:8010/vault_rest/file/%7Bfile_id%7D' \ --header 'Authorization: Bearer {token}'
Copy

Responses

200

Successful response

No response body

Response

xxxxxxxxxx
 
No response
Copy

Delete Multiple Files

Summary

Delete a group of files from the MetaDefender Managed File Transfer storage. This API will only mark the files for deletion. The files will be physically removed by a background worker.

Permissions Restrictions

Administrators can delete any file, including other user's files. Users can only delete their own files.

Auth

Request Body

array array[string]

DELETE /vault_rest/files

xxxxxxxxxx
 
curl --request DELETE \ --url 'http://localhost:8010/vault_rest/files' \ --header 'Authorization: Bearer {token}' \ --data '[  "file_id_1",  "file_id_2"]'
Copy

Responses

200

object object

Response

xxxxxxxxxx
 
{ "successful_results": {  "entities": [   {},   {}  ],  "success_counter": 2 }, "failed_results": {  "entities": [],  "failed_counter": 0 }, "total_count": 2}
Copy

Move Files (V2)

Summary

This API allows moving one or multiple files in MetaDefender Vault.

Auth

Request Body

object object

PUT /vault_rest/v2/move_files

xxxxxxxxxx
 
curl --request PUT \ --url 'http://localhost:8010/vault_rest/v2/move_files' \ --header 'Authorization: Bearer {token}' \ --data '{  "files": [    {      "file_id": "de5ae8d09fa5478aad61b3451b04bf57",      "name": "file1.pdf"    }  ],  "new_path": "test"}'
Copy

Responses

200

Successful response

object object

Response

xxxxxxxxxx
 
{ "successful_results": {  "entities": [   {}  ],  "success_counter": 1 }, "failed_results": {  "entities": [],  "failed_counter": 0 }, "total_counter": 1}
Copy

Rename A File

Summary

This API allows renaming a file in MetaDefender Vault.

Auth

Request Body

object object

PUT /vault_rest/rename_file

xxxxxxxxxx
 
curl --request PUT \ --url 'http://localhost:8010/vault_rest/rename_file' \ --header 'Authorization: Bearer {token}' \ --data '{  "file_id": "849137c80bd443cca3c49328f4a32fe9",  "new_file_name": "test"}'
Copy

Responses

200

Successful response

No response body

Response

xxxxxxxxxx
 
No response
Copy

Update File Password

Summary

Update the download password for a file.

Since

Version 3.7.0

Auth

Request Body

object object

PUT /vault_rest/file_password

xxxxxxxxxx
 
curl --request PUT \ --url 'http://localhost:8010/vault_rest/file_password' \ --header 'Authorization: Bearer {token}' \ --data '{}'
Copy

Responses

200

Successful response

No response body

Response

xxxxxxxxxx
 
No response
Copy

Insert File Password

Summary

Set a download password for a file.

Since

Version 3.7.0

Auth

Request Body

object object

POST /vault_rest/file_password

xxxxxxxxxx
 
curl --request POST \ --url 'http://localhost:8010/vault_rest/file_password' \ --header 'Authorization: Bearer {token}' \ --data '{}'
Copy

Responses

200

Successful response

No response body

Response

xxxxxxxxxx
 
No response
Copy

Preview File

Summary

Preview a file (returns sanitized/converted preview content).

Since

Version 3.8.0

Auth

Path Params

string

[required] File ID

GET /vault_rest/preview_file/{id}

xxxxxxxxxx
 
curl --get \ --url 'http://localhost:8010/vault_rest/preview_file/%7Bid%7D' \ --header 'Authorization: Bearer {token}'
Copy

Responses

200

Successful response

file file

Response

xxxxxxxxxx
 
{ "schema": "{file}"}
Copy

File Status

Overview

APIs for querying file status and metadata.

GET

/vault_rest/file/status/{file_id}

GET

/vault_rest/file/share_status/{id}

GET

/vault_rest/file/public_link/{id}

GET

/vault_rest/file/brief/{id}

POST

/vault_rest/lookup/filestatus

Query File Status

Summary

This API lets you query the current status of a file in MetaDefender Vault.

Auth

Path Params

file_id

string

[required] File ID of MetaDefender Vault file returned by Upload file call.

GET /vault_rest/file/status/{file_id}

xxxxxxxxxx
 
curl --get \ --url 'http://localhost:8010/vault_rest/file/status/%7Bfile_id%7D' \ --header 'Authorization: Bearer {token}'
Copy

Responses

200

object object

Response

xxxxxxxxxx
 
{ "administrator_approval_state": "ApprovalDisabled", "availability_state": "Available", "availability_state_key": "FILE_STATE_SANITIZED", "can_access_scan_results": true, "can_be_archived": true, "can_be_deleted": true, "can_be_downloaded": true, "can_be_moved": true, "can_be_permanently_deleted": true, "can_be_previewed": true, "can_be_rescanned": true, "can_update_file_password": true, "cdr_result_key": "Sanitized", "current_approval_count": 0, "dlp_result_key": "DLP_SENSITIVE_DATA_NOT_DETECTED", "duration": 920, "file_id": "7963c14842274e519d0fae185bf4aee7", "file_type": "OpenDocument Sheet", "is_blocked_by_core": false, "is_converted": true, "is_dlp_processed": false, "is_filescanned": false, "is_locked": false, "is_sanitized": true, "name": "Metadefender_MFT.ods", "processing_state": "Available", "processing_state_key": "PROCESSING_STATE_Available", "required_approval_count": 2, "sandbox_result_key": "FILE_INFO_SANDBOX_NOT_CONFIGURED", "scan_result_key": "METASCAN_RESULT_CORE_THREAT_NOT_FOUND", "supervisor_approval_state": "ApprovalDisabled", "first_upload_time": "2024-01-10T11:41:57.0000000", "folder_id": "e801a217bd7c49189e01e3f1e8b9ada4", "is_file_owned": true, "path": "", "size": 3956}
Copy

Get Public Link

Summary

Returns a public download link for a file.

Since

Version 3.7.0

Auth

Path Params

string

[required] File ID

GET /vault_rest/file/public_link/{id}

xxxxxxxxxx
 
curl --get \ --url 'http://localhost:8010/vault_rest/file/public_link/%7Bid%7D' \ --header 'Authorization: Bearer {token}'
Copy

Responses

200

object object

Response

xxxxxxxxxx
 
{}
Copy

Get File Brief Details

Summary

Returns brief details for a file.

Since

Version 3.7.0

Auth

Path Params

string

[required] File ID

GET /vault_rest/file/brief/{id}

xxxxxxxxxx
 
curl --get \ --url 'http://localhost:8010/vault_rest/file/brief/%7Bid%7D' \ --header 'Authorization: Bearer {token}'
Copy

Responses

200

object object

Response

xxxxxxxxxx
 
{}
Copy

Lookup Files Status

Summary

Lookup status for multiple files at once.

Since

Version 3.9.0

Auth

Request Body

object object

POST /vault_rest/lookup/filestatus

xxxxxxxxxx
 
curl --request POST \ --url 'http://localhost:8010/vault_rest/lookup/filestatus' \ --header 'Authorization: Bearer {token}' \ --data '{}'
Copy

Responses

200

object object

Response

xxxxxxxxxx
 
{}
Copy

File Enumeration

Overview

APIs for listing and enumerating files by category.

GET

/vault_rest/files/my/{start}/{count}

GET

/vault_rest/files/all/{start}/{count}

GET

/vault_rest/files/supervisor/{start}/{count}

GET

/vault_rest/files/supervisor/history/{start}/{count}

GET

/vault_rest/files/outbreaks/{start}/{count}

GET

/vault_rest/files/trash/{start}/{count}

GET

/vault_rest/files/archive/{start}/{count}

Enumerate My Files

Summary

Retrieve a list of the current user's files.

Auth

Headers

sort_column	string	Possible values: expires, name, size
sort_direction	string	Possible values: asc, desc
find	string	Free text search string (Use only with English characters)
findB64	string	Free text search string (Base64 encoded to support all charsets). Will override any value specified in 'find' header.
AvailabilityState	string	Filter by availability state. Separate multiple states with comma. Possible states: Composing, QueuedForProcessing, BeingProcessed, Available, Expired, Deleted, Blocked, BlockedNoSanitization, ProcessingFailed

Path Params

start	integer	[required] Zero based position in list from where to start returning data
count	integer	[required] Maximum number of list entries to return

GET /vault_rest/files/my/{start}/{count}

xxxxxxxxxx
 
curl --get \ --url 'http://localhost:8010/vault_rest/files/my/%7Bstart%7D/%7Bcount%7D' \ --header 'sort_column: {sort_column}' \ --header 'sort_direction: {sort_direction}' \ --header 'find: {find}' \ --header 'findB64: {findB64}' \ --header 'AvailabilityState: {AvailabilityState}' \ --header 'Authorization: Bearer {token}'
Copy

Responses

200

object object

Response

xxxxxxxxxx
 
{ "filter_count": 4, "items": [], "total_count": 4}
Copy

Enumerate All Files

Summary

Retrieve a list of all files (administrator access).

Auth

Headers

sort_column	string
sort_direction	string
find	string
findB64	string
AvailabilityState	string

Path Params

start	integer
count	integer

GET /vault_rest/files/all/{start}/{count}

xxxxxxxxxx
 
curl --get \ --url 'http://localhost:8010/vault_rest/files/all/%7Bstart%7D/%7Bcount%7D' \ --header 'sort_column: {sort_column}' \ --header 'sort_direction: {sort_direction}' \ --header 'find: {find}' \ --header 'findB64: {findB64}' \ --header 'AvailabilityState: {AvailabilityState}' \ --header 'Authorization: Bearer {token}'
Copy

Responses

200

object object

Response

xxxxxxxxxx
 
{}
Copy

Enumerate Supervisor Files

Summary

Retrieve files pending supervisor approval.

Since

Version 3.7.0

Auth

Path Params

start	integer
count	integer

GET /vault_rest/files/supervisor/{start}/{count}

xxxxxxxxxx
 
curl --get \ --url 'http://localhost:8010/vault_rest/files/supervisor/%7Bstart%7D/%7Bcount%7D' \ --header 'Authorization: Bearer {token}'
Copy

Responses

200

object object

Response

xxxxxxxxxx
 
{}
Copy

Enumerate Approval History Files

Summary

Retrieve files with approval history.

Since

Version 3.8.0

Auth

Path Params

start	integer
count	integer

GET /vault_rest/files/supervisor/history/{start}/{count}

xxxxxxxxxx
 
curl --get \ --url 'http://localhost:8010/vault_rest/files/supervisor/history/%7Bstart%7D/%7Bcount%7D' \ --header 'Authorization: Bearer {token}'
Copy

Responses

200

object object

Response

xxxxxxxxxx
 
{}
Copy

Enumerate Outbreak Files

Summary

Retrieve files flagged by outbreak prevention.

Since

Version 3.7.0

Auth

Path Params

start	integer
count	integer

GET /vault_rest/files/outbreaks/{start}/{count}

xxxxxxxxxx
 
curl --get \ --url 'http://localhost:8010/vault_rest/files/outbreaks/%7Bstart%7D/%7Bcount%7D' \ --header 'Authorization: Bearer {token}'
Copy

Responses

200

object object

Response

xxxxxxxxxx
 
{}
Copy

Enumerate Recycle Bin Files

Summary

Retrieve files in the recycle bin (trash).

Since

Version 3.9.0

Auth

Path Params

start	integer
count	integer

GET /vault_rest/files/trash/{start}/{count}

xxxxxxxxxx
 
curl --get \ --url 'http://localhost:8010/vault_rest/files/trash/%7Bstart%7D/%7Bcount%7D' \ --header 'Authorization: Bearer {token}'
Copy

Responses

200

object object

Response

xxxxxxxxxx
 
{}
Copy

Enumerate Archive Files

Summary

Retrieve archived files.

Since

Version 3.9.0

Auth

Path Params

start	integer
count	integer

GET /vault_rest/files/archive/{start}/{count}

xxxxxxxxxx
 
curl --get \ --url 'http://localhost:8010/vault_rest/files/archive/%7Bstart%7D/%7Bcount%7D' \ --header 'Authorization: Bearer {token}'
Copy

Responses

200

object object

Response

xxxxxxxxxx
 
{}
Copy

File Actions

Overview

APIs for file scan actions: cancel scan, rescan, unlock, retry processing, release.

POST

/vault_rest/cancel_scan/{id}

POST

/vault_rest/cancel_scan

POST

/vault_rest/override_scan_result/{id}

POST

/vault_rest/overrule_core_verdict/{id}

POST

/vault_rest/unlock_file/{id}

POST

/vault_rest/schedule_file_to_rescan/{id}

POST

/vault_rest/file_retry_processing/{fileGuid}

POST

/vault_rest/release_file/{id}

POST

/vault_rest/release_files

Cancel Scan

Summary

Cancel an in-progress scan for a specific file.

Since

Version 3.7.0

Auth

Path Params

string

[required] File ID

POST /vault_rest/cancel_scan/{id}

xxxxxxxxxx
 
curl --request POST \ --url 'http://localhost:8010/vault_rest/cancel_scan/%7Bid%7D' \ --header 'Authorization: Bearer {token}'
Copy

Responses

200

Successful response

No response body

Response

xxxxxxxxxx
 
No response
Copy

Bulk Cancel Scan

Summary

Cancel scans for multiple files.

Since

Version 3.7.0

Auth

Request Body

array array[string]

POST /vault_rest/cancel_scan

xxxxxxxxxx
 
curl --request POST \ --url 'http://localhost:8010/vault_rest/cancel_scan' \ --header 'Authorization: Bearer {token}' \ --data '[  "{array[string]...}"]'
Copy

Responses

200

Successful response

No response body

Response

xxxxxxxxxx
 
No response
Copy

Override Scan Result

Summary

Override the scan result for a file.

Since

Version 3.7.0

Auth

Path Params

string

[required] File ID

POST /vault_rest/override_scan_result/{id}

xxxxxxxxxx
 
curl --request POST \ --url 'http://localhost:8010/vault_rest/override_scan_result/%7Bid%7D' \ --header 'Authorization: Bearer {token}'
Copy

Responses

200

Successful response

No response body

Response

xxxxxxxxxx
 
No response
Copy

Overrule Core Verdict

Summary

Override the MetaDefender Core verdict for a file.

Since

Version 3.10.0

Auth

Path Params

string

[required] File ID

POST /vault_rest/overrule_core_verdict/{id}

xxxxxxxxxx
 
curl --request POST \ --url 'http://localhost:8010/vault_rest/overrule_core_verdict/%7Bid%7D' \ --header 'Authorization: Bearer {token}'
Copy

Responses

200

Successful response

No response body

Response

xxxxxxxxxx
 
No response
Copy

Unlock File

Summary

Unlock a locked file.

Since

Version 3.7.0

Auth

Path Params

string

[required] File ID

POST /vault_rest/unlock_file/{id}

xxxxxxxxxx
 
curl --request POST \ --url 'http://localhost:8010/vault_rest/unlock_file/%7Bid%7D' \ --header 'Authorization: Bearer {token}'
Copy

Responses

200

Successful response

No response body

Response

xxxxxxxxxx
 
No response
Copy

Schedule File To Rescan

Summary

Schedule a file for rescanning by MetaDefender Core.

Since

Version 3.7.0

Auth

Path Params

string

[required] File ID

POST /vault_rest/schedule_file_to_rescan/{id}

xxxxxxxxxx
 
curl --request POST \ --url 'http://localhost:8010/vault_rest/schedule_file_to_rescan/%7Bid%7D' \ --header 'Authorization: Bearer {token}'
Copy

Responses

200

Successful response

No response body

Response

xxxxxxxxxx
 
No response
Copy

Retry File Processing

Summary

Retry processing for a file that failed processing.

Since

Version 3.8.0

Auth

Path Params

fileGuid

string

[required] File GUID

POST /vault_rest/file_retry_processing/{fileGuid}

xxxxxxxxxx
 
curl --request POST \ --url 'http://localhost:8010/vault_rest/file_retry_processing/%7BfileGuid%7D' \ --header 'Authorization: Bearer {token}'
Copy

Responses

200

Successful response

No response body

Response

xxxxxxxxxx
 
No response
Copy

Release File

Summary

Release a single file.

Since

Version 3.9.0

Auth

Path Params

string

[required] File ID

POST /vault_rest/release_file/{id}

xxxxxxxxxx
 
curl --request POST \ --url 'http://localhost:8010/vault_rest/release_file/%7Bid%7D' \ --header 'Authorization: Bearer {token}'
Copy

Responses

200

Successful response

No response body

Response

xxxxxxxxxx
 
No response
Copy

Release Multiple Files

Summary

Release multiple files at once.

Since

Version 3.9.0

Auth

Request Body

array array[string]

POST /vault_rest/release_files

xxxxxxxxxx
 
curl --request POST \ --url 'http://localhost:8010/vault_rest/release_files' \ --header 'Authorization: Bearer {token}' \ --data '[  "{array[string]...}"]'
Copy

Responses

200

Successful response

No response body

Response

xxxxxxxxxx
 
No response
Copy

File Approval

Overview

APIs for the supervisor approval workflow: approve, deny, view history.

POST

/vault_rest/approve_file/{id}

POST

/vault_rest/approve_files

DELETE

/vault_rest/approve_files

POST

/vault_rest/revoke_file/{id}

GET

/vault_rest/approval_history/{guid}

POST

/vault_rest/supervisor_message/{id}

Approve File

Summary

Approve a file in the supervisor approval workflow.

Since

Version 3.7.0

Auth

Path Params

string

[required] File ID

POST /vault_rest/approve_file/{id}

xxxxxxxxxx
 
curl --request POST \ --url 'http://localhost:8010/vault_rest/approve_file/%7Bid%7D' \ --header 'Authorization: Bearer {token}'
Copy

Responses

200

Successful response

No response body

Response

xxxxxxxxxx
 
No response
Copy

Bulk Approve Files

Summary

Approve multiple files.

Since

Version 3.7.0

Auth

Request Body

array array[string]

POST /vault_rest/approve_files

xxxxxxxxxx
 
curl --request POST \ --url 'http://localhost:8010/vault_rest/approve_files' \ --header 'Authorization: Bearer {token}' \ --data '[  "{array[string]...}"]'
Copy

Responses

200

Successful response

No response body

Response

xxxxxxxxxx
 
No response
Copy

Bulk Deny Approval

Summary

Deny approval for multiple files.

Since

Version 3.7.0

Auth

DELETE /vault_rest/approve_files

xxxxxxxxxx
 
curl --request DELETE \ --url 'http://localhost:8010/vault_rest/approve_files' \ --header 'Authorization: Bearer {token}'
Copy

Responses

200

Successful response

No response body

Response

xxxxxxxxxx
 
No response
Copy

Deny File Approval

Summary

Deny approval for a specific file.

Since

Version 3.7.0

Auth

Path Params

string

[required] File ID

POST /vault_rest/revoke_file/{id}

xxxxxxxxxx
 
curl --request POST \ --url 'http://localhost:8010/vault_rest/revoke_file/%7Bid%7D' \ --header 'Authorization: Bearer {token}'
Copy

Responses

200

Successful response

No response body

Response

xxxxxxxxxx
 
No response
Copy

Enumerate Approval History

Summary

Returns the approval history for a file.

Since

Version 3.8.0

Auth

Path Params

guid

string

[required] File GUID

GET /vault_rest/approval_history/{guid}

xxxxxxxxxx
 
curl --get \ --url 'http://localhost:8010/vault_rest/approval_history/%7Bguid%7D' \ --header 'Authorization: Bearer {token}'
Copy

Responses

200

object object

Response

xxxxxxxxxx
 
{}
Copy

Insert Supervisor Message

Summary

Add a supervisor message to a file in the approval workflow.

Since

Version 3.8.0

Auth

Path Params

string

[required] File ID

POST /vault_rest/supervisor_message/{id}

xxxxxxxxxx
 
curl --request POST \ --url 'http://localhost:8010/vault_rest/supervisor_message/%7Bid%7D' \ --header 'Authorization: Bearer {token}'
Copy

Responses

200

Successful response

No response body

Response

xxxxxxxxxx
 
No response
Copy

Share A File

Summary

This API allows sharing a file in MetaDefender Vault.

Auth

Request Body

object object

POST /vault_rest/update_file_share

xxxxxxxxxx
 
curl --request POST \ --url 'http://localhost:8010/vault_rest/update_file_share' \ --header 'Authorization: Bearer {token}' \ --data '{  "fileId": "849137c80bd443cca3c49328f4a32fe9",  "groupIds": [    19  ],  "userIds": [    24  ]}'
Copy

Responses

200

Successful response

No response body

Response

xxxxxxxxxx
 
No response
Copy

Unshare Files

Summary

Remove file sharing.

Since

Version 3.7.0

Auth

DELETE /vault_rest/update_file_share

xxxxxxxxxx
 
curl --request DELETE \ --url 'http://localhost:8010/vault_rest/update_file_share' \ --header 'Authorization: Bearer {token}'
Copy

Responses

200

Successful response

No response body

Response

xxxxxxxxxx
 
No response
Copy

File Tags

Overview

APIs for managing file tags and upload reasons.

GET

/vault_rest/file_tags/{file_id}

PUT

/vault_rest/file_tags

GET

/vault_rest/file_upload_reason/{guid}

POST

/vault_rest/files/update_reason

Get File Tags

This API endpoint provides a list of {file_id} file's tags.

Auth

Path Params

file_id

string

[required] File ID (GUID)

GET /vault_rest/file_tags/{file_id}

xxxxxxxxxx
 
curl --get \ --url 'http://localhost:8010/vault_rest/file_tags/%7Bfile_id%7D' \ --header 'Authorization: Bearer {token}'
Copy

Responses

200

Successful response

object object

Response

xxxxxxxxxx
 
{ "tags": [  "file_tag1",  "file_tag2" ]}
Copy

Add/Modify File Tags

This API endpoint allows user to modify file tags.

Auth

Request Body

object object

PUT /vault_rest/file_tags

xxxxxxxxxx
 
curl --request PUT \ --url 'http://localhost:8010/vault_rest/file_tags' \ --header 'Authorization: Bearer {token}' \ --data '{  "file_guid": "7743da0c40f645a48ae39caf1f454f6e",  "tags": [    "tag1",    "tag2"  ]}'
Copy

Responses

200

Successful response

No response body

Response

xxxxxxxxxx
 
No response
Copy

Get File Upload Reason

Summary

Returns the upload reason for a file.

Since

Version 3.9.0

Auth

Path Params

guid

string

[required] File GUID

GET /vault_rest/file_upload_reason/{guid}

xxxxxxxxxx
 
curl --get \ --url 'http://localhost:8010/vault_rest/file_upload_reason/%7Bguid%7D' \ --header 'Authorization: Bearer {token}'
Copy

Responses

200

object object

Response

xxxxxxxxxx
 
{}
Copy

Update Upload Reason

Summary

Update the upload reason for files.

Since

Version 3.9.0

Auth

Request Body

object object

POST /vault_rest/files/update_reason

xxxxxxxxxx
 
curl --request POST \ --url 'http://localhost:8010/vault_rest/files/update_reason' \ --header 'Authorization: Bearer {token}' \ --data '{}'
Copy

Responses

200

Successful response

No response body

Response

xxxxxxxxxx
 
No response
Copy

File Classification

Overview

APIs for managing file classification definitions and assignments.

GET

/vault_rest/classification

POST

/vault_rest/classification

PUT

/vault_rest/classification/{id}

DELETE

/vault_rest/classification/{id}

PUT

/vault_rest/file_classification

Get All Classifications

Summary

Returns all file classification definitions.

Since

Version 3.8.0

Auth

GET /vault_rest/classification

xxxxxxxxxx
 
curl --get \ --url 'http://localhost:8010/vault_rest/classification' \ --header 'Authorization: Bearer {token}'
Copy

Responses

200

object object

Response

xxxxxxxxxx
 
{}
Copy

Create Classification

Summary

Create a new file classification.

Since

Version 3.8.0

Auth

Request Body

object object

POST /vault_rest/classification

xxxxxxxxxx
 
curl --request POST \ --url 'http://localhost:8010/vault_rest/classification' \ --header 'Authorization: Bearer {token}' \ --data '{}'
Copy

Responses

200

Successful response

No response body

Response

xxxxxxxxxx
 
No response
Copy

Update Classification

Summary

Update an existing file classification.

Since

Version 3.8.0

Auth

Path Params

string

[required] Classification ID

Request Body

object object

PUT /vault_rest/classification/{id}

xxxxxxxxxx
 
curl --request PUT \ --url 'http://localhost:8010/vault_rest/classification/%7Bid%7D' \ --header 'Authorization: Bearer {token}' \ --data '{}'
Copy

Responses

200

Successful response

No response body

Response

xxxxxxxxxx
 
No response
Copy

Delete Classification

Summary

Delete a file classification.

Since

Version 3.8.0

Auth

Path Params

string

[required] Classification ID

DELETE /vault_rest/classification/{id}

xxxxxxxxxx
 
curl --request DELETE \ --url 'http://localhost:8010/vault_rest/classification/%7Bid%7D' \ --header 'Authorization: Bearer {token}'
Copy

Responses

200

Successful response

No response body

Response

xxxxxxxxxx
 
No response
Copy

Update File Classification

Summary

Update the classification on a specific file.

Since

Version 3.8.0

Auth

Request Body

object object

PUT /vault_rest/file_classification

xxxxxxxxxx
 
curl --request PUT \ --url 'http://localhost:8010/vault_rest/file_classification' \ --header 'Authorization: Bearer {token}' \ --data '{}'
Copy

Responses

200

Successful response

No response body

Response

xxxxxxxxxx
 
No response
Copy

File Audit

Overview

APIs for file-level audit trail and export.

GET

/vault_rest/fileaudit/{start}/{count}

GET

/vault_rest/fileaudit/{fileGuid}/{start}/{count}

GET

/vault_rest/fileaudit/export_history

GET

/vault_rest/fileaudit/{fileGuid}/export_history

Enumerate File Audit

Summary

Returns file audit events with pagination.

Since

Version 3.8.0

Auth

Path Params

start	integer
count	integer

GET /vault_rest/fileaudit/{start}/{count}

xxxxxxxxxx
 
curl --get \ --url 'http://localhost:8010/vault_rest/fileaudit/%7Bstart%7D/%7Bcount%7D' \ --header 'Authorization: Bearer {token}'
Copy

Responses

200

object object

Response

xxxxxxxxxx
 
{}
Copy

Get File Audit Entries

Summary

Returns audit entries for a specific file.

Since

Version 3.8.0

Auth

Path Params

fileGuid	string	[required] File GUID
start	integer
count	integer

GET /vault_rest/fileaudit/{fileGuid}/{start}/{count}

xxxxxxxxxx
 
curl --get \ --url 'http://localhost:8010/vault_rest/fileaudit/%7BfileGuid%7D/%7Bstart%7D/%7Bcount%7D' \ --header 'Authorization: Bearer {token}'
Copy

Responses

200

object object

Response

xxxxxxxxxx
 
{}
Copy

Export File Audit CSV

Summary

Export file audit events as CSV.

Since

Version 3.8.0

Auth

GET /vault_rest/fileaudit/export_history

xxxxxxxxxx
 
curl --get \ --url 'http://localhost:8010/vault_rest/fileaudit/export_history' \ --header 'Authorization: Bearer {token}'
Copy

Responses

200

string string

Response

xxxxxxxxxx
 
{ "schema": "{string}"}
Copy

Export File Audit By File GUID

Summary

Export audit entries for a specific file as CSV.

Since

Version 3.8.0

Auth

Path Params

fileGuid

string

[required] File GUID

GET /vault_rest/fileaudit/{fileGuid}/export_history

xxxxxxxxxx
 
curl --get \ --url 'http://localhost:8010/vault_rest/fileaudit/%7BfileGuid%7D/export_history' \ --header 'Authorization: Bearer {token}'
Copy

Responses

200

string string

Response

xxxxxxxxxx
 
{ "schema": "{string}"}
Copy

File Archive

Overview

APIs for archiving and restoring files.

POST

/vault_rest/files/archive

POST

/vault_rest/files/restore

Archive Files

Summary

Move files to the archive.

Since

Version 3.9.0

Auth

Request Body

array array[string]

POST /vault_rest/files/archive

xxxxxxxxxx
 
curl --request POST \ --url 'http://localhost:8010/vault_rest/files/archive' \ --header 'Authorization: Bearer {token}' \ --data '[  "{array[string]...}"]'
Copy

Responses

200

Successful response

No response body

Response

xxxxxxxxxx
 
No response
Copy

Restore Files

Summary

Restore files from archive or recycle bin.

Since

Version 3.9.0

Auth

Request Body

array array[string]

POST /vault_rest/files/restore

xxxxxxxxxx
 
curl --request POST \ --url 'http://localhost:8010/vault_rest/files/restore' \ --header 'Authorization: Bearer {token}' \ --data '[  "{array[string]...}"]'
Copy

Responses

200

Successful response

No response body

Response

xxxxxxxxxx
 
No response
Copy

Recycle Bin

Overview

APIs for managing the recycle bin (trash).

POST

/vault_rest/files/trash

POST

/vault_rest/files/trash/empty

Trash Files

Summary

Move files to the recycle bin (trash).

Since

Version 3.9.0

Auth

Request Body

array array[string]

POST /vault_rest/files/trash

xxxxxxxxxx
 
curl --request POST \ --url 'http://localhost:8010/vault_rest/files/trash' \ --header 'Authorization: Bearer {token}' \ --data '[  "{array[string]...}"]'
Copy

Responses

200

Successful response

No response body

Response

xxxxxxxxxx
 
No response
Copy

Empty Recycle Bin

Summary

Permanently delete all files in the recycle bin.

Since

Version 3.9.0

Auth

POST /vault_rest/files/trash/empty

xxxxxxxxxx
 
curl --request POST \ --url 'http://localhost:8010/vault_rest/files/trash/empty' \ --header 'Authorization: Bearer {token}'
Copy

Responses

200

Successful response

No response body

Response

xxxxxxxxxx
 
No response
Copy

Favorites

Overview

APIs for marking files and folders as favorites.

POST

/vault_rest/favorite/file/{guid}

DELETE

/vault_rest/favorite/file/{guid}

Mark File As Favorite

Summary

Mark a file as favorite for the current user.

Since

Version 3.10.0

Auth

Path Params

guid

string

[required] File GUID

POST /vault_rest/favorite/file/{guid}

xxxxxxxxxx
 
curl --request POST \ --url 'http://localhost:8010/vault_rest/favorite/file/%7Bguid%7D' \ --header 'Authorization: Bearer {token}'
Copy

Responses

200

Successful response

No response body

Response

xxxxxxxxxx
 
No response
Copy

Remove File From Favorites

Summary

Remove a file from the current user's favorites.

Since

Version 3.10.0

Auth

Path Params

guid

string

[required] File GUID

DELETE /vault_rest/favorite/file/{guid}

xxxxxxxxxx
 
curl --request DELETE \ --url 'http://localhost:8010/vault_rest/favorite/file/%7Bguid%7D' \ --header 'Authorization: Bearer {token}'
Copy

Responses

200

Successful response

No response body

Response

xxxxxxxxxx
 
No response
Copy

MetaDefender Managed File Transfer API - File Management 3.11.1

Authentication

File Download

Overview

Download a file

Summary

Download Public File

Summary

Since

File Operations

Overview

Delete A File

Summary

Permissions Restrictions

Delete Multiple Files

Summary

Permissions Restrictions

Move Files (V2)

Summary

Rename A File

Summary

Update File Password

Summary

Since

Insert File Password

Summary

Since

Preview File

Summary

Since

File Status

Overview

Query File Status

Summary

Get File Share Status

Summary

Since

Get Public Link

Summary

Since

Get File Brief Details

Summary

Since

Lookup Files Status

Summary

Since

File Enumeration

Overview

Enumerate My Files

Summary

Enumerate All Files

Summary

Enumerate Supervisor Files

Summary

Since

Enumerate Approval History Files

Summary

Since

Enumerate Outbreak Files

Summary

Since

Enumerate Recycle Bin Files

Summary

Since

Enumerate Archive Files

Summary

Since

File Actions

Overview

Cancel Scan

Summary

Since

Bulk Cancel Scan

Summary

Since

Override Scan Result

Summary

Since

Overrule Core Verdict

Summary