Query file status

Title

Query the current status of a file

URL Path

vault_rest/file/status/{file_id}

Method

GET

Http return

200, 400, 401, 403, 404, 500

Table of Contents

Last Updated

02 Nov 2018

Summary

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

HTTP header parameters

Authorization

The authentication token of the caller

REQUIRED

This header should have the following format: Bearer [

Example: Bearer Cp01BwnXAIOLZXxn7yogjKqIZnZpQD

Method: GET

file_id

File ID of MetaDefender Vault file returned by Upload file call.

REQUIRED

Request Error

400

Bad Request

Invalid HTTP request

401

Unauthorized

Access to the file status is not available to the current user.

404

Not found

File was not found in the database

500

Internal Server Error

Server is temporarily unavailable

Response

Example of a successful scan request:

{
"group_id": "e60c304041d649209d671676429f2e7d",
"availability": 3,
"shared_with_active_users": [
],
"shared_with_guests": [
],
"sender": "a@a.ro",
"subject": "You have uploaded new file(s)",
"expiration_date": "11-02-2019",
"can_be_rescanned": true,
"can_be_deleted": true,
"displayed_name": "done.gif",
"first_upload_time": "2018-11-02T13:22:16.0000000",
"shared_with_groups": [
],
"path": "My Folder\\Documents",
"access_mode": 1,
"file_id": "f3c65a22b48947eb98d206a09ba0c4ab",
"scan_result": {
"workflow_result": "Allowed",
"blocked_reason": "",
"actions_failed": ""
},
"availability_state": "Available",
"processing_state": "Available",
"unlock_eta": null,
"is_locked": false,
"expires": "2019-11-02T13:22:17.0000000",
"can_be_downloaded": true,
"supervisor_approval_state": "ApprovalDisabled",
"administrator_approval_state": "ApprovalDisabled",
"is_false_positive": false,
"can_be_approved": false,
"can_be_overridden": false,
"can_be_denied_access": false,
"is_file_owned": true,
"can_update_sharing": true,
"is_sanitized": false,
"date_created": "2018-11-02T13:22:16.0000000Z",
"message": "",
"ui_message_key": null
}

Descriptions of response:

Parameter

Description

Details

file_id

GUID of the file

 

group_id

GUID of the transfer

Every file is part of a transfer

availability

The current status of the file (as integer)

Composing = 0,
QueuedForProcessing = 1,
BeingProcessed = 2,
Available = 3,
Expired = 4,
Deleted = 5,
Blocked = 9,
BlockedNoSanitization = 10,
ProcessingFailed = 11

availability_state

The current status of the file (as string)

 

processing_state

The current status of the file processing state

UploadingFromRestStreamMode = -3,
UploadingFromRestChunkMode = -4,
UploadingFromRestCommitted = -5,
New = 0,
CalculatingChecksum = 1,
Scanning = 5,
QueuedForTransferToFileStorage = 6,
TransferringToFileStorage = 7,
Available = 8,
WaitingForChecksum = 10,
RegularRescanning = 12,
ManualRescanning = 120,
RescanBeforeUnlock = 13,
WaitingForUnlockNotifications = 18,
SendingUnlockNotifications = 19,
WaitingForFinalState = 20,
SetFinalState = 21,
ChecksumFailed = 1001,
ScanFailed = 1005,
TransferToFileStorageFailed = 1007,
RescanFailed = 1009,
SendingUnlockNotificationsFailed = 1012,
SetFinalStateFailed = 1013

access_mode

The authentication type required for a user to access the file

0 - downloading does not require authentication
1 - downloading requires authentication

expiration_date

Date at which the file will expire.

The date format used is MM-dd-yyyy (e.g. 04-15-2015, i.e. 'April 15th 2015')

sender

Email address of the user that has sent the file

 

subject

Subject of the email that the user sent with the file

 

message

Message that was sent with the email

This field is optional when uploading a file, so it may be an empty string.

unlock_eta

Approximate time until the file will be unlocked

 

is_locked

Flag that will specify if the file is locked by Outbreak Prevention

 

can_be_downloaded

Flag that specifies if the file is available for download

 

can_be_rescanned

Flag that specifies if the file can be re-processed again with Metadefender Core

 

can_be_deleted

Flag that specifies if the file can be deleted

 

is_sanitized

Flag that specifies if the file was sanitized

 

supervisor_approval_state

The state of the file in terms of Supervisor Approval Process

 

administrator_approval_state

The state of the file in terms of Supervisor Approval Process

 

displayed_name

The name of the file that will be displayed

 

path

The path of the file

for example: My Folder\Documents