Complete API documentation for MetaDefender Managed File Transfer, combining all feature scopes.
Active Directory
Active Directory integration and synchronization
Enumerate Active Directories
OK
Create Active Directory
OK
Enumerate Available Active Directory Users
OK
Enumerate Available Active Directory Groups
OK
Enumerate Available Active Directory Organizational Units
OK
Get Active Directory Sync Status
OK
Trigger Active Directory Sync
OK
Get Active Directory Settings
OK
Delete Active Directory
OK
Update Active Directory Filter Settings
OK
Groups Of Active Directory Filter Settings
OK
Users Of Active Directory Filter Settings
OK
Update Active Directory Synchronization Settings
OK
Update Active Directory Account Settings
OK
Update Active Directory Status
OK
Alteregos
Endpoints for managing user alteregos and mappings.
Read Alteregos
Retrieves a paginated list of alteregos for the specified user.
OK
Create Alterego
Creates a new alterego for the specified user.
Created
Read Alterego
Retrieves a specific alterego by ID.
OK
Update Alterego
Updates a specific alterego.
OK
Delete Alterego
Deletes a specific alterego.
OK
Import Alteregos
Imports a list of alteregos.
OK
Export Alteregos
Exports all alteregos as a JSON file attachment.
OK
Archive Download
Archive creation and download management
Create Archive Download
OK
Public Create Archive Download
OK
Get Archive Download Status
OK
Download Archive
OK
Download Public Archive
OK
Cancel Archive Download
OK
Audit
Audit logs and exports
Enumerate Audit
OK
Export Audit CSV
OK
Export Verbose Audit
OK
Authentication Management
Endpoints for user login, SSO, OTP validation, and session termination.
SSO Pre-Authenticate
Summary ## Initiates the Single Sign-On (SSO) pre-authentication process.
OK
SSO Authenticate (GET)
Summary ## Processes the Single Sign-On (SSO) authentication callback with code and state.
OK
SSO Authenticate (POST)
Summary ## Processes the Single Sign-On (SSO) authentication payload.
OK
SSO Token Authenticate
Summary ## Authenticates a user using an SSO token.
OK
Request An API Key
Summary ## Authenticates a user and returns an API key (token) for subsequent requests.
OK
Log Out
Summary ## Cancels the current authentication token and logs the user out.
OK
Validate OTP
Summary ## Validates a One-Time Password (OTP) for Multi-Factor Authentication.
OK
Pre-Exchange Token
Summary ## Initiates the token exchange process.
OK
Exchange Token
Summary ## Exchanges an existing token for a new one.
OK
Authenticate Windows
Summary ## Initiates negotiation-based Windows authentication.
OK
Get Login Info
Retrieves current login information and policies.
OK
Authorization
Endpoints for checking user permissions and resource access.
Authorize Resource
Summary ## Checks authorization for a specific resource type.
OK
Certificate Credentials
Endpoints for managing certificate credentials.
Read Certificate Credentials
Retrieves a paginated list of certificate credentials.
OK
Create Certificate Credential
Creates a new certificate credential.
Created
Read Certificate Credential
Retrieves a specific certificate credential by ID.
OK
Update Certificate Credential
Updates an existing certificate credential.
OK
Delete Certificate Credential
Deletes a specific certificate credential.
OK
Custom Resource
Custom resource synchronization
Create Resource
OK
Dashboard
Dashboard statistics and metrics
Get User Types
OK
Get File Size Volumes
OK
Get Average File Size Volumes
OK
Get File Security Statistics
OK
Get File Security Trend
OK
Get File Processing Summary
OK
Get File Statistics
OK
Get Login Statistics
OK
Database
Database information and storage
Get DB Storage Info
OK
Get DB Info
OK
Events
System events management
Raise Event
OK
Export
Data export operations
Export Process History
OK
File Actions
Endpoints for performing actions on files such as approve, reject, move, and rename.
Cancel Scan
Cancels an ongoing scan for a specific file.
OK
Cancel Scan Bulk
Cancels ongoing scans for multiple files.
OK
Override Scan Result
Overrides the scan result for a specific file.
OK
Approve File
Approves a specific file.
OK
Deny Approval File
Denies approval for a specific file.
OK
Approve Multiple Files
Approves multiple files.
OK
Deny Approval Multiple Files
Denies approval for multiple files.
OK
Unlock File
Unlocks a specific file.
OK
Schedule File To Rescan
Schedules a specific file to be rescanned.
OK
Move Files V2
Moves files to a new location (Version 2).
OK
Move Files
Moves files to a new location.
OK
Rename File
Renames a specific file.
OK
Update File Password
Updates the password for a specific file.
OK
Insert File Password
Inserts a password for a specific file.
OK
Update File Tags
Updates tags for a specific file.
OK
Enumerate File Tags
Enumerates tags for a specific file.
OK
Enumerate Approval History
Enumerates the supervisor approval history for a specific file.
OK
File Retry Processing
Retries processing for a specific file.
OK
Insert Supervisor Message
Inserts a supervisor comment/message for a specific file.
OK
Preview File
Retrieves a preview of a specific file.
OK
Trash Files
Moves specified files to the trash.
OK
Empty Recycle Bin
Empties the recycle bin.
OK
Archive Files
Archives specified files.
OK
Restore Files
Restores specified files from the trash or archive.
OK
Release File
Releases a specific file.
OK
Release Multiple Files
Releases multiple files.
OK
Get File Upload Reason
Retrieves the upload reason for a specific file.
OK
Update Upload Reason
Updates the upload reason for a file.
OK
Overrule Core Verdict
Overrules the core verdict for a specific file.
OK
Mark File As Favorite
Marks a specific file as a favorite.
OK
Remove File From Favorites
Removes a specific file from favorites.
OK
File Audit
Endpoints for retrieving and exporting file audit logs.
Enumerate File Audit
Enumerates file audit entries.
OK
Get File Audit Entries
Retrieves audit entries for a specific file.
OK
Export File Audit Csv
Exports the file audit history as a CSV file.
OK
Export File Audit By File Guid
Exports the file audit history for a specific file as a CSV file.
OK
File Classification
Endpoints for managing file classifications.
Get All Classification
Retrieves all file classifications.
OK
Insert Classification
Inserts a new file classification.
OK
Update Classification
Updates an existing file classification.
OK
Delete Classification
Deletes a file classification.
OK
Update Classification On File
Updates the classification assigned to a specific file.
OK
File Enumeration
Endpoints for listing files in various states and locations.
Enumerate My Files
Enumerates files owned by the current user.
OK
Enumerate All Files
Enumerates all files in the system.
OK
Enumerate Supervisor Files
Enumerates files available to the supervisor.
OK
Enumerate Approval History Files
Enumerates files in the supervisor approval history.
OK
Enumerate Outbreak Files
Enumerates files involved in outbreaks.
OK
Enumerate Recycle Bin Files
Enumerates files currently in the recycle bin.
OK
Enumerate Archive Files
Enumerates archived files.
OK
File Transfer
Endpoints for uploading, downloading, and managing file transfers, including diode support.
Download File
Summary
Downloads the content of a specific file by its ID.
OK
Delete File
Summary
Deletes a specific file by its ID.
OK
Download Public File
Summary
Downloads a publicly shared file by its ID.
OK
Get File Status
Summary
Retrieves the processing and general status of a specific file.
OK
Get Public Link
Summary
Retrieves the public link details for a specific file.
OK
Get File Brief Details
Summary
Retrieves brief metadata details for a specific file.
OK
Delete Multiple Files
Summary
Deletes multiple files based on the provided request body.
OK
List File Name Duplicates
Summary
Checks for duplicate file names during a transfer process.
OK
Initialize Group Transfer
Summary
Initializes a new group transfer session.
OK
Complete Group Transfer
Summary
Completes an active group transfer session.
OK
Delete Group Transfer
Summary
Deletes or cancels an active group transfer session.
OK
Initialize Group Transfer Diode
Summary
Initializes a new group transfer session specifically for diode environments.
OK
Initialize File Transfer
Summary
Initializes a single file transfer within a group.
OK
Complete File Transfer
Summary
Completes a single file transfer.
OK
Delete File From Group Transfer
Summary
Removes a file from an active group transfer.
OK
Upload File Chunk
Summary
Uploads a chunk of a file for an active file transfer.
OK
Initialize File Transfer Diode
Summary
Initializes a single file transfer within a group for diode environments.
OK
Upload Chunk Multipart Diode
Summary
Uploads a file chunk using multipart format for diode environments.
OK
Upload Chunk Diode
Summary
Uploads a file chunk for diode environments.
OK
Resync Files and Folders MFT to MFT
Summary
Triggers a synchronization of files and folders between MFT instances.
OK
Lookup Files Status
Summary
Looks up the status of multiple files in a single request.
OK
Filter
Filter properties and operators
Get Filter Properties
OK
Get Filter Operators
OK
Folder Management
Endpoints for managing folders, including creation, deletion, renaming, moving, and favorites.
Enumerate Folder Content
Summary
Retrieves a paginated list of contents within a specific folder.
OK
Search Folder Content
Summary
Searches for contents within a specific folder with pagination.
OK
Create Folder
Summary
Creates a new folder.
OK
Rename Folder
Summary
Renames an existing folder.
OK
Move Folders V2
Summary
Moves one or more folders to a new destination (Version 2).
OK
Move Folders
Summary
Moves one or more folders to a new destination.
OK
Get Root Folder
Summary
Retrieves the root folder entry for the authenticated user.
OK
Get Folder
Summary
Retrieves details for a specific folder by its ID.
OK
Delete Folder
Summary
Deletes a specific folder by its ID.
OK
Delete Folders
Summary
Deletes multiple folders in a single request.
OK
Get Folder Status
Summary
Retrieves the current status of a specific folder.
OK
Check Folder Availability
Summary
Checks if a folder is available for download.
OK
Mark Folder As Favorite
Summary
Marks a specific folder as a favorite for the authenticated user.
OK
Remove Folder From Favorites
Summary
Removes a specific folder from the authenticated user's favorites.
OK
Ftps Integrations
Endpoints for managing FTPS integrations.
Read FTPS Integrations
Retrieves a paginated list of FTPS integrations.
OK
Create FTPS Integration
Creates a new FTPS integration configuration.
Created
Read FTPS Integration
Retrieves a specific FTPS integration by ID.
OK
Update FTPS Integration
Updates an existing FTPS integration.
OK
Delete FTPS Integration
Deletes a specific FTPS integration.
OK
Test FTPS Integration Connection
Tests the connection to a specific FTPS integration.
OK
Groups
Endpoints for managing user groups and memberships.
Create Group
Creates a new user group.
OK
Enumerate Groups
Enumerates all groups with pagination.
OK
Update Group
Updates the settings of a specific group.
OK
Delete Group
Deletes a specific group.
OK
Enumerate Group Accounts
Enumerates the members of a specific group with pagination.
OK
Set Group Memberships
Sets the members for a specific group.
OK
Guest Accounts
Endpoints for creating and managing guest accounts.
Generate Guest PIN Code
Generates a random PIN code of the specified length for a guest account.
OK
Update Guest Account
Updates an existing guest account.
OK
Create Guest Account
Creates a new guest account.
OK
Create Guest Account V2
Creates a new guest account using the V2 endpoint.
OK
Ip Location Mapping
IP to location mapping rules
Get IP Location Mapping
OK
Create IP Location Mapping
OK
Delete Location Mappings
OK
Update IP Location Mapping
OK
Delete Location Mapping
OK
Job Executions
Job execution history, details, and logs
Read Job Executions
Retrieves a paginated history of executions for a specific job.
OK
Read All Job Executions
Retrieves a paginated history of all executions for a specific job across the system.
OK
Read Job Execution
Retrieves details of a specific job execution.
OK
Read All Job Execution
Retrieves details of a specific job execution across the system.
OK
Download Job Execution Log
Downloads the log file for a specific job execution.
OK
Download All Job Execution Log
Downloads the log file for a specific job execution across the system.
OK
Get Recent Job Executions
Retrieves the most recent job executions for the current user.
OK
Job Settings
Global configuration and settings for jobs
Get Jobs Settings
Retrieves the global configuration settings for jobs.
OK
Update Jobs Settings
Updates the global configuration settings for jobs.
OK
Jobs
Job management, scheduling, and status tracking
Read Jobs
Retrieves a paginated list of jobs.
OK
Create Job
Creates a new job.
Created
Read Job Statuses
Retrieves a paginated list of job statuses for the current user.
OK
Read All Job Statuses
Retrieves a paginated list of all job statuses across the system.
OK
Read Job
Retrieves details of a specific job by ID.
OK
Update Job
Updates an existing job by ID.
OK
Delete Job
Deletes a specific job by ID.
OK
Update Job Transfer Condition
Updates the transfer conditions for a specific job.
OK
Read Job Status
Retrieves the status of a specific job by ID.
OK
Execute Job
Manually starts the execution of a specific job.
OK
Pause Job
Pauses the execution of a specific job.
OK
Fork Job
Creates a copy (fork) of an existing job.
OK
Get Jobs Progress
Retrieves the progress of multiple jobs based on the provided request.
OK
Licensing
License management and activation
Get Licensing Info
OK
Get License
OK
Activate License Offline
OK
Activate License
OK
Deactivate License
OK
Deprecated Enumerate Licenses
Since ## August 2019
OK
Deprecated Add License
Since ## August 2019
OK
Deprecated Add Offline License
Since ## August 2019
OK
Get Deployment ID
OK
Deprecated Delete License
Since ## August 2019
OK
Mfa Settings
Endpoints for managing Multi-Factor Authentication configuration.
Get MFA Settings
Summary ## Retrieves the current Multi-Factor Authentication (MFA) settings.
OK
Update MFA Settings
Summary ## Updates the Multi-Factor Authentication (MFA) settings.
OK
Mft Api Credentials
Endpoints for managing MFT API key credentials.
Read MFT API Keys
Retrieves a paginated list of MFT API key credentials.
OK
Create MFT API Key
Creates a new MFT API key credential.
Created
Read MFT API Key
Retrieves a specific MFT API key credential by ID.
OK
Update MFT API Key
Updates an existing MFT API key credential.
OK
Delete MFT API Key
Deletes a specific MFT API key credential.
OK
Mft Integrations
Endpoints for managing MFT integrations.
Get MFT Integrations
Retrieves MFT integration configurations.
OK
Update MFT Integrations
Updates MFT integration configurations.
OK
Delete MFT Integrations
Deletes MFT integration configurations.
OK
Test MFT Integration Connection
Tests the connection to a specific MFT integration.
OK
Mft Pull
Endpoints for integrating and pulling files from remote MFT instances.
Get MFT Instances
Summary
Retrieves a list of configured MFT pull instances.
OK
MFT Pull Login
Summary
Authenticates against a remote MFT instance for pull operations.
OK
MFT Pull Validate OTP
Summary
Validates an OTP for a remote MFT instance login.
OK
Enumerate Folder Content
Summary
Enumerates the contents of a folder on a remote MFT instance.
OK
Initiate Pull Files
Summary
Initiates a pull operation to download files from a remote MFT instance.
OK
Get Pull Status
Summary
Retrieves the status of an active MFT pull operation.
OK
Miscellaneous
Miscellaneous utility endpoints.
Log Request
Logs a request.
OK
Get Version
Retrieves the current version of the API.
OK
Get Mft Id
Retrieves the MFT ID.
OK
Network
Network rules and IP location mapping
Create Network Rule
OK
Enumerate Network Rules
OK
Get Network Rule By ID
OK
Update Network Rule
OK
Delete Network Rule
OK
Delete Network Rules
OK
Expand IP Network
OK
Get IP Address Info
OK
Get Authentication Details
OK
Ocm8
Central Management enrollment and configuration
Enroll
OK
UnEnroll
OK
Force UnEnroll
OK
Reconnect
OK
Get OCM Config
OK
Password Management
Endpoints for resetting and forcing password changes.
Send Reset Password Email
Sends a password reset email to the specified user.
OK
Reset Password
Resets the password for a user account.
OK
Forced Password Reset
Forces a password reset for a specific account.
OK
Bulk Force Password Reset
Forces a password reset for multiple accounts.
OK
Change User Password
Changes the password for a specific user account.
OK
Permissions
Endpoints for retrieving and managing user permissions.
Get Current User Permission
Retrieves the permissions of the currently authenticated user.
OK
Get User Permission
Retrieves the permissions of a specific user.
OK
Invalidate Permission Cache
Invalidates the cached permissions.
OK
Radius
Radius authentication settings
Get Radius Settings
OK
Update Radius Settings
OK
Invalidate Radius Settings Cache
OK
Add Scan
OK
Get Scan Config
OK
Update Scan Config
OK
Enumerate Scans
OK
Scan Result From Core
OK
Get Last Scan
OK
Settings
System settings and configuration
Get Syslog Configuration
OK
Update Syslog Configuration
OK
Get Notifications Configuration
OK
Update Notifications Configuration
OK
Send Test Notification
OK
Get Audit Settings
OK
Update Audit Settings
OK
Get Log Settings
OK
Update Log Settings
OK
Get Transfer Settings
OK
Update Global Transfer Settings
OK
Invalidate Transfer Settings Cache
OK
Enumerate Core Settings
OK
Get Core Common Workflows
OK
Get Core Workflows By URL
OK
Get Core Workflows By ID
OK
Get Detailed Core Workflows By ID
OK
Get Core Modules By ID
OK
Get Core Load Balancing Settings
OK
Update Core Load Balancing Settings
OK
Get Core Settings
OK
Update Core Settings
OK
Delete Core Settings
OK
Add Core Settings
OK
Get Outbreak Settings
OK
Update Outbreak Settings
OK
Get SMTP Settings
OK
Update SMTP Settings
OK
Get Graph Settings
OK
Update Graph Settings
OK
Export SFT Configuration
OK
Import SFT Configuration
OK
Enumerate Email Templates
OK
Get Email Templates By Type And Version
OK
Add Email Template Version
OK
Activate Email Template Version
OK
Activate All Email Template Latest Version
OK
Reset Email Template
OK
Export Email Template
OK
Enumerate Supported Languages
OK
Get Language Settings
OK
Add Custom Language
OK
Update Language Settings
OK
Download Language Draft
OK
Enumerate Supported Time Zones
OK
Get SSO Settings
OK
Update SSO Settings
OK
Fetch Redirect URI
OK
Get SSO Claim Settings
OK
Update SSO Claim Settings
OK
Invalidate SSO Settings Cache
OK
Get Security Settings
OK
Update Security Settings
OK
Create Encryption Key
OK
Download Encryption Key
OK
Get Default Encryption Key
OK
Get Theme Configuration
OK
Update Theme Configuration
OK
Reset Theme Configuration
OK
Get Recycle Bin Settings
OK
Update Recycle Bin Settings
OK
Get Core Status
OK
Get Events Settings
OK
Update Events Settings
OK
Get General Template Settings
OK
Update General Template Settings
OK
Setup Administration
Endpoints for initial setup and default administrator configuration.
Get Default Administrator Info
Retrieves information about the default administrator setup.
OK
Setup Default Administrator
Configures the default administrator account.
OK
Check Password Reset Capability
Checks if the specified user can reset their password.
OK
Get Setup Wizard Info
Retrieves information for the setup wizard.
OK
Complete Setup Wizard
Completes the setup wizard process.
OK
Sftp Integrations
Endpoints for managing SFTP integrations.
Read SFTP Integrations
Retrieves a paginated list of SFTP integrations.
OK
Create SFTP Integration
Creates a new SFTP integration configuration.
Created
Read SFTP Integration
Retrieves a specific SFTP integration by ID.
OK
Update SFTP Integration
Updates an existing SFTP integration.
OK
Delete SFTP Integration
Deletes a specific SFTP integration.
OK
Test SFTP Integration Connection
Tests the connection to a specific SFTP integration.
OK
Read SPOP Integrations
Retrieves a paginated list of SharePoint On-Premise (SPOP) integrations.
OK
Create SPOP Integration
Creates a new SharePoint On-Premise (SPOP) integration configuration.
Created
Read SPOP Integration
Retrieves a specific SharePoint On-Premise (SPOP) integration by ID.
OK
Update SPOP Integration
Updates an existing SharePoint On-Premise (SPOP) integration.
OK
Delete SPOP Integration
Deletes a specific SharePoint On-Premise (SPOP) integration.
OK