OPSWAT MetaDefender Vault 1.0.0

/vault_rest/authenticate

/vault_rest/tokens/{start}/{count}

/vault_rest/authenticate

Request An API Key

Summary

This API allows a user to sign in and obtain an API key to use in subsequent API requests.

Use Cases (used by)

All clients accessing MetaDefender Vault REST must call this API first to obtain an API key.

Auth

GET /vault_rest/authenticate

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

Responses

200

Successful response

No response body

Response

xxxxxxxxxx
 
No response
Copy

Cancel Or Expire An API Key

Auth

DELETE /vault_rest/authenticate

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

Responses

200

Successful response

No response body

Response

xxxxxxxxxx
 
No response
Copy

Extend API Key

Summary

This API allows a user to extend an API key.

Use Cases (used by)

Used by clients that want to prevent an API to expire due to inactivity or change the expiration of an existing generated API key.

Auth

Headers

Token	string
ExtendBy	string
ExtendUntil	number

Request Body

object object

PUT /vault_rest/token

xxxxxxxxxx
 
curl --request PUT \ --url 'http://localhost:8010/vault_rest/token' \ --header 'Token: RHjO1SH9GqjBAbGxFOh2jqI9HjNAJD' \ --header 'ExtendBy: 01:00:00' \ --header 'ExtendUntil: 2020-11-13T10:40:00.0000000Z' \ --header 'Authorization: Bearer {token}' \ --data '{}'
Copy

Responses

200

Successful response

No response body

Response

xxxxxxxxxx
 
No response
Copy

Create A 3rd Party API Key

Auth

Request Body

object object

POST /vault_rest/token

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

Responses

200

Successful response

No response body

Response

xxxxxxxxxx
 
No response
Copy

Enumerate API Keys

Auth

Headers

sort_column	string
sort_direction	string
find	string
findB64	string

Path Params

start	string
count	string

GET /vault_rest/tokens/{start}/{count}

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

Responses

200

Successful response

No response body

Response

xxxxxxxxxx
 
No response
Copy

File Management

/vault_rest/file/{file_id}

/vault_rest/file/{file_id}

/vault_rest/file/status/{file_id}

/vault_rest/files

/vault_rest/files/{type}/{start}/{count}

/vault_rest/move_files

/vault_rest/rename_file

/vault_rest/update_file_share

Download a file

Auth

Headers

Authorization string

Path Params

file_id string

GET /vault_rest/file/{file_id}

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

Responses

200

Successful response

No response body

Response

xxxxxxxxxx
 
No response
Copy

Delete A File

Auth

Headers

Authorization string

Path Params

file_id string

DELETE /vault_rest/file/{file_id}

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

Responses

200

Successful response

No response body

Response

xxxxxxxxxx
 
No response
Copy

Query File status

Auth

Headers

Authorization string

Path Params

file_id string

GET /vault_rest/file/status/{file_id}

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

Responses

200

Successful response

No response body

Response

xxxxxxxxxx
 
No response
Copy

Delete Multiple Files

Auth

Headers

Authorization string

DELETE /vault_rest/files

xxxxxxxxxx
 
curl --request DELETE \ --url 'http://localhost:8010/vault_rest/files' \ --header 'Authorization: {{BearerToken}}'
Copy

Responses

200

Successful response

No response body

Response

xxxxxxxxxx
 
No response
Copy

Enumerate Files

Auth

Headers

Authorization	string
sort_column	string
sort_direction	string
find	string
findB64	string
colums	string
AvailabilityState	string

Path Params

type	string
start	string
count	string

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

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

Responses

200

Successful response

No response body

Response

xxxxxxxxxx
 
No response
Copy

Move A File

Auth

Headers

Authorization string

Request Body

object object

PUT /vault_rest/move_files

xxxxxxxxxx
 
curl --request PUT \ --url 'http://localhost:8010/vault_rest/move_files' \ --header 'Authorization: Bearer {{BearerToken}}' \ --data '{  "files": [    {      "file_id": "",      "name": ""    }  ],  "new_path": ""}'
Copy

Responses

200

Successful response

No response body

Response

xxxxxxxxxx
 
No response
Copy

Rename A File

Auth

Headers

Authorization string

Request Body

object object

PUT /vault_rest/rename_file

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

Responses

200

Successful response

No response body

Response

xxxxxxxxxx
 
No response
Copy

Share A File

Auth

Headers

Authorization string

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 {{BearerToken}}' \ --data '{  "file_id": "",  "groupIds": [],  "userIds": []}'
Copy

Responses

200

Successful response

No response body

Response

xxxxxxxxxx
 
No response
Copy

User Management

/vault_rest/accounts/guest/0/50

/vault_rest/guest

/vault_rest/account/10248

/vault_rest/account

Enumerate Guest Accounts

Auth

Headers

Authorization string

GET /vault_rest/accounts/guest/0/50

xxxxxxxxxx
 
curl --get \ --url 'http://localhost:8010/vault_rest/accounts/guest/0/50' \ --header 'Authorization: Bearer {{BearerToken}}'
Copy

Responses

200

Successful response

No response body

Response

xxxxxxxxxx
 
No response
Copy

Create A Guest Account

Auth

Headers

Authorization	string
Content-Type	string

Request Body

object object

POST /vault_rest/guest

xxxxxxxxxx
 
curl --request POST \ --url 'http://localhost:8010/vault_rest/guest' \ --header 'Authorization: Bearer {{BearerToken}}' \ --header 'Content-Type: application/json' \ --data '{  "pin_code": "111-223-562",  "expires": "2029-06-15T04:14:50.0000000Z",  "display_name": "Guest User"}'
Copy

Responses

200

Successful response

No response body

Response

xxxxxxxxxx
 
No response
Copy

Change User Status

Auth

Headers

Authorization	string
Content-Type	string

Request Body

object object

PUT /vault_rest/account/10248

xxxxxxxxxx
 
curl --request PUT \ --url 'http://localhost:8010/vault_rest/account/10248' \ --header 'Authorization: Bearer {{BearerToken}}' \ --header 'Content-Type: application/json' \ --data '{  "status": "Enabled"}'
Copy

Responses

200

Successful response

No response body

Response

xxxxxxxxxx
 
No response
Copy

Create An Account

Auth

Headers

Authorization string

Request Body

object object

POST /vault_rest/account

xxxxxxxxxx
 
curl --request POST \ --url 'http://localhost:8010/vault_rest/account' \ --header 'Authorization: {Authorization}' \ --data '{  "first_name": "John",  "last_name": "Doe",  "display_name": "John Doe",  "user_name": "JohnD",  "password": "password",  "email": "jdoe@opswat.com",  "role": "user",  "expires": "2019-07-15T04:14:50.0000000Z",  "expires_after": ""}'
Copy

Responses

200

Successful response

No response body

Response

xxxxxxxxxx
 
No response
Copy

Archive Download

/vault_rest/cancel_archive_download/{id}

/vault_rest/create_archive_download

/vault_rest/archive_download/{id}

/vault_rest/archive_download_status/{id}

Cancel Archive Download

Auth

Headers

Authorization string

Path Params

string

[required] Unique identifier of the archive to be canceled

Request Body

No request body

PUT /vault_rest/cancel_archive_download/{id}

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

Responses

200

Successful response

No response body

Response

xxxxxxxxxx
 
No response
Copy

Create Archive

Auth

Headers

Authorization string

Request Body

object object

POST /vault_rest/create_archive_download

xxxxxxxxxx
 
curl --request POST \ --url 'http://localhost:8010/vault_rest/create_archive_download' \ --header 'Authorization: Bearer {{BearerToken}}' \ --data '{  "file_ids": [],  "folder_ids": []}'
Copy

Responses

200

Successful response

No response body

Response

xxxxxxxxxx
 
No response
Copy

Download Archive

Auth

Headers

Authorization string

Path Params

id string

GET /vault_rest/archive_download/{id}

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

Responses

200

Successful response

No response body

Response

xxxxxxxxxx
 
No response
Copy

Get Archive Status

Auth

Headers

Authorization string

Path Params

id string

GET /vault_rest/archive_download_status/{id}

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

Responses

200

Successful response

No response body

Response

xxxxxxxxxx
 
No response
Copy

Audit Events

/vault_rest/audit/{start}/{count}

/vault_rest/audit/export

Enumerate Audit Events

Auth

Headers

Authorization	string
sort_column	string
sort_direction	string
find	string
findB64	string

Path Params

start	string
count	string

GET /vault_rest/audit/{start}/{count}

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

Responses

200

Successful response

No response body

Response

xxxxxxxxxx
 
No response
Copy

Export Audit Events

Auth

Headers

Authorization string

Query String

locale string

GET /vault_rest/audit/export

xxxxxxxxxx
 
curl --get \ --url 'http://localhost:8010/vault_rest/audit/export' \ --header 'Authorization: Bearer {{BearerToken}}' \ --data locale=locale-en_US
Copy

Responses

200

Successful response

No response body

Response

xxxxxxxxxx
 
No response
Copy

File Upload

/vault_rest/settings/transfer

PATCH

Initialize group transfer

Auth

Headers

Authorization	string
impersonate_as	string
share_with	string
subject	string
message	string
source	string
group_id	string

GET /vault_rest/settings/transfer

xxxxxxxxxx
 
curl --get \ --url 'http://localhost:8010/vault_rest/settings/transfer' \ --header 'Authorization: Bearer adneVqpVDc3EaMYklRWwRBTj1gfSbl' \ --header 'impersonate_as: {impersonate_as}' \ --header 'share_with: {share_with}' \ --header 'subject: {subject}' \ --header 'message: {message}' \ --header 'source: {source}' \ --header 'group_id: {group_id}'
Copy

Responses

200

Successful response

No response body

Response

xxxxxxxxxx
 
No response
Copy

Initialize File Transfer

Auth

Headers

Authorization	string
transfer_method	string
group_id	string	from GET Initialize group transfer
file_name	string
file_size	integer
path	string	relative to storage's root
file_id	string
file_checksum	string
user_agent	string
core_rule	string
archivepwdX	string

GET /vault_rest/transfer_file

xxxxxxxxxx
 
curl --get \ --url 'http://localhost:8010/vault_rest/transfer_file' \ --header 'Authorization: Bearer {{BearerToken}}' \ --header 'transfer_method: Chunk' \ --header 'group_id: 84204abb505e4077bf0db00014ae6d3e' \ --header 'file_name: test.txt' \ --header 'file_size: 9' \ --header 'path: test/moretest' \ --header 'file_id: {file_id}' \ --header 'file_checksum: {file_checksum}' \ --header 'user_agent: {user_agent}' \ --header 'core_rule: {core_rule}' \ --header 'archivepwdX: {archivepwdX}'
Copy

Responses

200

Successful response

No response body

Response

xxxxxxxxxx
 
No response
Copy

Upload File Chunk

Auth

Headers

Authorization	string
group_id	string	from GET Initialize group transfer
file_id	string	from GET Create a file transfer
chunk_offset	string
chunk_checksum	string

Request Body

No request body

PATCH /vault_rest/transfer_file

xxxxxxxxxx
 
curl --request PATCH \ --url 'http://localhost:8010/vault_rest/transfer_file' \ --header 'Authorization: Bearer {{BearerToken}}' \ --header 'group_id: 84204abb505e4077bf0db00014ae6d3e' \ --header 'file_id: dedaeef0855f445eb659f9096bd19440' \ --header 'chunk_offset: {chunk_offset}' \ --header 'chunk_checksum: {chunk_checksum}'
Copy

Responses

200

Successful response

No response body

Response

xxxxxxxxxx
 
No response
Copy

Complete file transfer

Auth

Headers

Authorization	string
group_id	string	from GET Initialize group transfer
file_id	string	from GET Create a file transfer

Request Body

object object

POST /vault_rest/transfer_file

xxxxxxxxxx
 
curl --request POST \ --url 'http://localhost:8010/vault_rest/transfer_file' \ --header 'Authorization: Bearer {{BearerToken}}' \ --header 'group_id: 84204abb505e4077bf0db00014ae6d3e' \ --header 'file_id: dedaeef0855f445eb659f9096bd19440' \ --data '{}'
Copy

Responses

200

Successful response

No response body

Response

xxxxxxxxxx
 
No response
Copy

Delete File From File Transfer

Auth

Headers

Authorization	string
group_id	string
file_id	string

DELETE /vault_rest/transfer_file

xxxxxxxxxx
 
curl --request DELETE \ --url 'http://localhost:8010/vault_rest/transfer_file' \ --header 'Authorization: {Authorization}' \ --header 'group_id: {group_id}' \ --header 'file_id: {file_id}'
Copy

Responses

200

Successful response

No response body

Response

xxxxxxxxxx
 
No response
Copy

Complete group transfer

Auth

Headers

Authorization	string
group_id	string	from GET Initialize group transfer
expires_after	string

Request Body

object object

POST /vault_rest/transfer

xxxxxxxxxx
 
curl --request POST \ --url 'http://localhost:8010/vault_rest/transfer' \ --header 'Authorization: Bearer {{BearerToken}}' \ --header 'group_id: 84204abb505e4077bf0db00014ae6d3e' \ --header 'expires_after: {expires_after}' \ --data '{}'
Copy

Responses

200

Successful response

No response body

Response

xxxxxxxxxx
 
No response
Copy

Delete Group Transfer

Auth

Headers

Authorization	string
group_id	string

DELETE /vault_rest/transfer

xxxxxxxxxx
 
curl --request DELETE \ --url 'http://localhost:8010/vault_rest/transfer' \ --header 'Authorization: {Authorization}' \ --header 'group_id: {group_id}'
Copy

Responses

200

Successful response

No response body

Response

xxxxxxxxxx
 
No response
Copy

Folder Management

/vault_rest/folder/{folder_id}

/vault_rest/folders

/vault_rest/{id}/{start}/{count}

/vault_rest/folder_search/{id}/{start}/{count}

/vault_rest/root_folder

/vault_rest/move_folders

/vault_rest/rename_folder

/vault_rest/update_folder_share

Delete A Folder

Auth

Headers

Authorization string

Path Params

folder_id string

DELETE /vault_rest/folder/{folder_id}

xxxxxxxxxx
 
curl --request DELETE \ --url 'http://localhost:8010/vault_rest/folder/%7Bfolder_id%7D' \ --header 'Authorization: {Authorization}'
Copy

Responses

200

Successful response

No response body

Response

xxxxxxxxxx
 
No response
Copy

Delete Multiple Folders

Auth

Headers

Authorization string

DELETE /vault_rest/folders

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

Responses

200

Successful response

No response body

Response

xxxxxxxxxx
 
No response
Copy

Enumerate Folder Content

Auth

Headers

Authorization	string
sort_column	string
sort_direction	string
find	string
findB64	string

Path Params

id	string
start	string
count	string

GET /vault_rest/{id}/{start}/{count}

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

Responses

200

Successful response

No response body

Response

xxxxxxxxxx
 
No response
Copy

Folder Search

Auth

Headers

Authorization	string
sort_column	string
sort_direction	string
find	string
findB64	string

Path Params

id	string
start	string
count	string

GET /vault_rest/folder_search/{id}/{start}/{count}

xxxxxxxxxx
 
curl --get \ --url 'http://localhost:8010/vault_rest/folder_search/%7Bid%7D/%7Bstart%7D/%7Bcount%7D' \ --header 'Authorization: {Authorization}' \ --header 'sort_column: {sort_column}' \ --header 'sort_direction: {sort_direction}' \ --header 'find: {find}' \ --header 'findB64: {findB64}'
Copy

Responses

200

Successful response

No response body

Response

xxxxxxxxxx
 
No response
Copy

Get Root Folder

Auth

Headers

Authorization string

GET /vault_rest/root_folder

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

Responses

200

Successful response

No response body

Response

xxxxxxxxxx
 
No response
Copy

New Request

Auth

Headers

Authorization string

Request Body

object object

PUT /vault_rest/move_folders

xxxxxxxxxx
 
curl --request PUT \ --url 'http://localhost:8010/vault_rest/move_folders' \ --header 'Authorization: {Authorization}' \ --data '{  "folders": [    {      "folder_id": "c5133a2deb5a4f4798b45731cc1bcda9",      "name": "folder3",      "path": "test\\folder3"    },    {      "folder_id": "433beb56d2c94effb24bccdce6823a7b",      "name": "folder2",      "path": "test\\folder2"    },    {      "folder_id": "4db39640b3ef4f068b66ead001f5bbd2",      "name": "folder1",      "path": "test\\folder1"    }  ],  "new_path": ""}'
Copy

Responses

200

Successful response

No response body

Response

xxxxxxxxxx
 
No response
Copy

Rename A Folder

Auth

Headers

Authorization string

Request Body

object object

PUT /vault_rest/rename_folder

xxxxxxxxxx
 
curl --request PUT \ --url 'http://localhost:8010/vault_rest/rename_folder' \ --header 'Authorization: {Authorization}' \ --data '{  "folder_id": "2927ac9127dd472198f30f907c67bdac",  "new_folder_name": "test"}'
Copy

Responses

200

Successful response

No response body

Response

xxxxxxxxxx
 
No response
Copy

Share A Folder

Auth

Headers

Authorization string

Request Body

object object

POST /vault_rest/update_folder_share

xxxxxxxxxx
 
curl --request POST \ --url 'http://localhost:8010/vault_rest/update_folder_share' \ --header 'Authorization: {Authorization}' \ --data '{  "folderId": "2927ac9127dd472198f30f907c67bdac",  "userIds": [    26  ]}'
Copy

Responses

200

Successful response

No response body

Response

xxxxxxxxxx
 
No response
Copy

Default