Complete API documentation for MetaDefender Managed File Transfer, combining all feature scopes.

Server
http://localhost:8010
Server Variables

Enumerate Active Directories

Auth
GET /vault_rest/settings/activedirectories
Responses
200

OK

Response

Create Active Directory

Auth
Request Body
POST /vault_rest/settings/ad
Responses
200

OK

Response

Enumerate Available Active Directory Users

Auth
Path Params
GET /vault_rest/settings/ad/available_users/{activeDirectoryId}
Responses
200

OK

Response

Enumerate Available Active Directory Groups

Auth
Path Params
GET /vault_rest/settings/ad/available_groups/{activeDirectoryId}
Responses
200

OK

Response

Enumerate Available Active Directory Organizational Units

Auth
Path Params
GET /vault_rest/settings/ad/available_organizational_units/{activeDirectoryId}
Responses
200

OK

Response

Get Active Directory Sync Status

Auth
Path Params
GET /vault_rest/settings/ad/sync_status/{id}
Responses
200

OK

Response

Trigger Active Directory Sync

Auth
Path Params
GET /vault_rest/settings/ad/sync/{id}
Responses
200

OK

Response

Get Active Directory Settings

Auth
Path Params
GET /vault_rest/settings/ad/{id}
Responses
200

OK

Response

Delete Active Directory

Auth
Path Params
DELETE /vault_rest/settings/ad/{id}
Responses
200

OK

Response

Update Active Directory Filter Settings

Auth
Path Params
Request Body
PUT /vault_rest/settings/ad_filter_settings/{id}
Responses
200

OK

Response

Groups Of Active Directory Filter Settings

Auth
Path Params
Request Body
POST /vault_rest/settings/ad_filter_preview/{id}/groups
Responses
200

OK

Response

Users Of Active Directory Filter Settings

Auth
Path Params
Request Body
POST /vault_rest/settings/ad_filter_preview/{id}/users
Responses
200

OK

Response

Update Active Directory Synchronization Settings

Auth
Path Params
Request Body
PUT /vault_rest/settings/ad_synchronization_settings/{id}
Responses
200

OK

Response

Update Active Directory Account Settings

Auth
Path Params
Request Body
PUT /vault_rest/settings/ad_account_settings/{id}
Responses
200

OK

Response

Update Active Directory Status

Auth
Path Params
PUT /vault_rest/settings/ad_status/{id}/{status}
Responses
200

OK

Response

Read Alteregos

Retrieves a paginated list of alteregos for the specified user.

Auth
Headers
Path Params
Query String
GET /vault_rest/account/{userId}/alterego
Responses
200

OK

Response

Create Alterego

Creates a new alterego for the specified user.

Auth
Headers
Path Params
Request Body
POST /vault_rest/account/{userId}/alterego
Responses
201

Created

Response

Read Alterego

Retrieves a specific alterego by ID.

Auth
Headers
Path Params
GET /vault_rest/account/{userId}/alterego/{id}
Responses
200

OK

Response

Update Alterego

Updates a specific alterego.

Auth
Headers
Path Params
Request Body
PUT /vault_rest/account/{userId}/alterego/{id}
Responses
200

OK

Response

Delete Alterego

Deletes a specific alterego.

Auth
Headers
Path Params
DELETE /vault_rest/account/{userId}/alterego/{id}
Responses
200

OK

Response

Import Alteregos

Imports a list of alteregos.

Auth
Headers
Request Body
POST /vault_rest/accounts/alteregos/import
Responses
200

OK

Response

Export Alteregos

Exports all alteregos as a JSON file attachment.

Auth
GET /vault_rest/accounts/alteregos/export
Responses
200

OK

Response

Create Archive Download

Auth
Request Body
POST /vault_rest/create_archive_download
Responses
200

OK

Response

Public Create Archive Download

Auth
Request Body
POST /vault_rest/public_create_archive_download
Responses
200

OK

Response

Get Archive Download Status

Auth
Path Params
GET /vault_rest/archive_download_status/{guid}
Responses
200

OK

Response

Download Archive

Auth
Path Params
GET /vault_rest/archive_download/{guid}
Responses
200

OK

Response

Download Public Archive

Auth
Path Params
GET /vault_rest/archive_public_download/{guid}
Responses
200

OK

Response

Cancel Archive Download

Auth
Path Params
PUT /vault_rest/cancel_archive_download/{guid}
Responses
200

OK

Response

Enumerate Audit

Auth
Path Params
GET /vault_rest/audit/{start}/{count}
Responses
200

OK

Response

Export Audit CSV

Auth
GET /vault_rest/audit/export
Responses
200

OK

Response

Export Verbose Audit

Auth
Query String
GET /vault_rest/audit/export_verbose
Responses
200

OK

Response

SSO Pre-Authenticate

Summary ## Initiates the Single Sign-On (SSO) pre-authentication process.

Auth
GET /vault_rest/pre-authenticate-sso
Responses
200

OK

Response

SSO Authenticate (GET)

Summary ## Processes the Single Sign-On (SSO) authentication callback with code and state.

Auth
Query String
GET /vault_rest/authenticate-sso
Responses
200

OK

Response

SSO Authenticate (POST)

Summary ## Processes the Single Sign-On (SSO) authentication payload.

Auth
Request Body
POST /vault_rest/authenticate-sso
Responses
200

OK

Response

SSO Token Authenticate

Summary ## Authenticates a user using an SSO token.

Auth
GET /vault_rest/authenticate-sso-token
Responses
200

OK

Response

Request An API Key

Summary ## Authenticates a user and returns an API key (token) for subsequent requests.

Auth
GET /vault_rest/authenticate
Responses
200

OK

Response

Log Out

Summary ## Cancels the current authentication token and logs the user out.

Auth
DELETE /vault_rest/authenticate
Responses
200

OK

Response

Validate OTP

Summary ## Validates a One-Time Password (OTP) for Multi-Factor Authentication.

Auth
Request Body
POST /vault_rest/validate-otp
Responses
200

OK

Response

Pre-Exchange Token

Summary ## Initiates the token exchange process.

Auth
POST /vault_rest/pre-exchange-token
Responses
200

OK

Response

Exchange Token

Summary ## Exchanges an existing token for a new one.

Auth
Request Body
POST /vault_rest/exchange-token
Responses
200

OK

Response

Authenticate Windows

Summary ## Initiates negotiation-based Windows authentication.

Auth
Headers
GET /vault_rest/authenticate-windows
Responses
200

OK

Response

Get Login Info

Retrieves current login information and policies.

Auth
GET /vault_rest/login_info
Responses
200

OK

Response

Authorization

Endpoints for checking user permissions and resource access.

Authorize Resource

Summary ## Checks authorization for a specific resource type.

Auth
Path Params
GET /vault_rest/authorization/{resourceType}
Responses
200

OK

Response

Read Certificate Credentials

Retrieves a paginated list of certificate credentials.

Auth
Headers
Query String
GET /vault_rest/creds/cert
Responses
200

OK

Response

Create Certificate Credential

Creates a new certificate credential.

Auth
Headers
Request Body
POST /vault_rest/creds/cert
Responses
201

Created

Response

Read Certificate Credential

Retrieves a specific certificate credential by ID.

Auth
Headers
Path Params
GET /vault_rest/creds/cert/{id}
Responses
200

OK

Response

Update Certificate Credential

Updates an existing certificate credential.

Auth
Headers
Path Params
Request Body
PUT /vault_rest/creds/cert/{id}
Responses
200

OK

Response

Delete Certificate Credential

Deletes a specific certificate credential.

Auth
Headers
Path Params
DELETE /vault_rest/creds/cert/{id}
Responses
200

OK

Response

Custom Resource

Custom resource synchronization

Create Resource

Auth
Request Body
POST /vault_rest/resources/sync_resource
Responses
200

OK

Response

Get User Types

Auth
GET /vault_rest/dashboard/user_types
Responses
200

OK

Response

Get File Size Volumes

Auth
Headers
GET /vault_rest/dashboard/volumes
Responses
200

OK

Response

Get Average File Size Volumes

Auth
Headers
GET /vault_rest/dashboard/volumes/average
Responses
200

OK

Response

Get File Security Statistics

Auth
Headers
GET /vault_rest/dashboard/file_security
Responses
200

OK

Response

Get File Security Trend

Auth
Headers
GET /vault_rest/dashboard/file_security/trend
Responses
200

OK

Response

Get File Processing Summary

Auth
Headers
GET /vault_rest/dashboard/processing_summary
Responses
200

OK

Response

Get File Statistics

Auth
Headers
GET /vault_rest/dashboard/file_statistics
Responses
200

OK

Response

Get Login Statistics

Auth
Headers
GET /vault_rest/dashboard/login_statistics
Responses
200

OK

Response

Database

Database information and storage

Get DB Storage Info

Auth
GET /vault_rest/database/storage
Responses
200

OK

Response

Get DB Info

Auth
GET /vault_rest/database/info
Responses
200

OK

Response

Events

System events management

Raise Event

Auth
Request Body
POST /vault_rest/event
Responses
200

OK

Response

Export

Data export operations

Export Process History

Auth
GET /vault_rest/export_history
Responses
200

OK

Response

Cancel Scan

Cancels an ongoing scan for a specific file.

Auth
Path Params
POST /vault_rest/cancel_scan/{id}
Responses
200

OK

Response

Cancel Scan Bulk

Cancels ongoing scans for multiple files.

Auth
Request Body
POST /vault_rest/cancel_scan
Responses
200

OK

Response

Override Scan Result

Overrides the scan result for a specific file.

Auth
Path Params
POST /vault_rest/override_scan_result/{id}
Responses
200

OK

Response

Approve File

Approves a specific file.

Auth
Path Params
Request Body
POST /vault_rest/approve_file/{id}
Responses
200

OK

Response

Deny Approval File

Denies approval for a specific file.

Auth
Path Params
Request Body
POST /vault_rest/revoke_file/{id}
Responses
200

OK

Response

Approve Multiple Files

Approves multiple files.

Auth
Request Body
POST /vault_rest/approve_files
Responses
200

OK

Response

Deny Approval Multiple Files

Denies approval for multiple files.

Auth
Request Body
DELETE /vault_rest/approve_files
Responses
200

OK

Response

Unlock File

Unlocks a specific file.

Auth
Path Params
POST /vault_rest/unlock_file/{id}
Responses
200

OK

Response

Schedule File To Rescan

Schedules a specific file to be rescanned.

Auth
Path Params
POST /vault_rest/schedule_file_to_rescan/{id}
Responses
200

OK

Response

Move Files V2

Moves files to a new location (Version 2).

Auth
Request Body
PUT /vault_rest/v2/move_files
Responses
200

OK

Response

Move Files

Moves files to a new location.

Auth
Request Body
PUT /vault_rest/move_files
Responses
200

OK

Response

Rename File

Renames a specific file.

Auth
Request Body
PUT /vault_rest/rename_file
Responses
200

OK

Response

Update File Password

Updates the password for a specific file.

Auth
Request Body
PUT /vault_rest/file_password
Responses
200

OK

Response

Insert File Password

Inserts a password for a specific file.

Auth
Request Body
POST /vault_rest/file_password
Responses
200

OK

Response

Update File Tags

Updates tags for a specific file.

Auth
Request Body
PUT /vault_rest/file_tags
Responses
200

OK

Response

Enumerate File Tags

Enumerates tags for a specific file.

Auth
Path Params
GET /vault_rest/file_tags/{guid}
Responses
200

OK

Response

Enumerate Approval History

Enumerates the supervisor approval history for a specific file.

Auth
Path Params
GET /vault_rest/approval_history/{guid}
Responses
200

OK

Response

File Retry Processing

Retries processing for a specific file.

Auth
Path Params
POST /vault_rest/file_retry_processing/{fileGuid}
Responses
200

OK

Response

Insert Supervisor Message

Inserts a supervisor comment/message for a specific file.

Auth
Path Params
Request Body
POST /vault_rest/supervisor_message/{id}
Responses
200

OK

Response

Preview File

Retrieves a preview of a specific file.

Auth
Path Params
GET /vault_rest/preview_file/{id}
Responses
200

OK

Response

Trash Files

Moves specified files to the trash.

Auth
Request Body
POST /vault_rest/files/trash
Responses
200

OK

Response

Empty Recycle Bin

Empties the recycle bin.

Auth
POST /vault_rest/files/trash/empty
Responses
200

OK

Response

Archive Files

Archives specified files.

Auth
Request Body
POST /vault_rest/files/archive
Responses
200

OK

Response

Restore Files

Restores specified files from the trash or archive.

Auth
Request Body
POST /vault_rest/files/restore
Responses
200

OK

Response

Release File

Releases a specific file.

Auth
Path Params
Request Body
POST /vault_rest/release_file/{id}
Responses
200

OK

Response

Release Multiple Files

Releases multiple files.

Auth
Request Body
POST /vault_rest/release_files
Responses
200

OK

Response

Get File Upload Reason

Retrieves the upload reason for a specific file.

Auth
Path Params
GET /vault_rest/file_upload_reason/{guid}
Responses
200

OK

Response

Update Upload Reason

Updates the upload reason for a file.

Auth
Request Body
POST /vault_rest/files/update_reason
Responses
200

OK

Response

Overrule Core Verdict

Overrules the core verdict for a specific file.

Auth
Path Params
Request Body
POST /vault_rest/overrule_core_verdict/{id}
Responses
200

OK

Response

Mark File As Favorite

Marks a specific file as a favorite.

Auth
Path Params
POST /vault_rest/favorite/file/{guid}
Responses
200

OK

Response

Responses
Response