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

objectobject
Response

Create Active Directory

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

OK

objectobject
Response

Enumerate Available Active Directory Users

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

OK

objectobject
Response

Enumerate Available Active Directory Groups

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

OK

objectobject
Response

Enumerate Available Active Directory Organizational Units

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

OK

objectobject
Response

Get Active Directory Sync Status

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

OK

objectobject
Response

Trigger Active Directory Sync

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

OK

objectobject
Response

Get Active Directory Settings

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

OK

objectobject
Response

Delete Active Directory

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

OK

objectobject
Response

Update Active Directory Filter Settings

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

OK

objectobject
Response

Groups Of Active Directory Filter Settings

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

OK

objectobject
Response

Users Of Active Directory Filter Settings

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

OK

objectobject
Response

Update Active Directory Synchronization Settings

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

OK

objectobject
Response

Update Active Directory Account Settings

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

OK

objectobject
Response

Update Active Directory Status

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

OK

objectobject
Response

Read Alteregos

Retrieves a paginated list of alteregos for the specified user.

Auth
Headers
x-mft-clientstring
x-mft-user-idstring
Path Params
userIdinteger
Query String
page_sizestring

Default: 25

page_numstring

Default: 0

GET /vault_rest/account/{userId}/alterego
Responses
200

OK

objectobject
Response

Create Alterego

Creates a new alterego for the specified user.

Auth
Headers
x-mft-clientstring
x-mft-user-idstring
Path Params
userIdinteger
Request Body
objectobject
POST /vault_rest/account/{userId}/alterego
Responses
201

Created

objectobject
Response

Read Alterego

Retrieves a specific alterego by ID.

Auth
Headers
x-mft-clientstring
x-mft-user-idstring
Path Params
userIdinteger
idstring
GET /vault_rest/account/{userId}/alterego/{id}
Responses
200

OK

objectobject
Response

Update Alterego

Updates a specific alterego.

Auth
Headers
x-mft-clientstring
x-mft-user-idstring
Path Params
userIdinteger
idstring
Request Body
objectobject
PUT /vault_rest/account/{userId}/alterego/{id}
Responses
200

OK

objectobject
Response

Delete Alterego

Deletes a specific alterego.

Auth
Headers
x-mft-clientstring
x-mft-user-idstring
Path Params
userIdinteger
idstring
DELETE /vault_rest/account/{userId}/alterego/{id}
Responses
200

OK

objectobject
Response

Import Alteregos

Imports a list of alteregos.

Auth
Headers
x-mft-clientstring
Request Body
arrayarray[object]
POST /vault_rest/accounts/alteregos/import
Responses
200

OK

objectobject
Response

Export Alteregos

Exports all alteregos as a JSON file attachment.

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

OK

arrayarray[object]
Response

Create Archive Download

Auth
Request Body
objectobject
POST /vault_rest/create_archive_download
Responses
200

OK

objectobject
Response

Public Create Archive Download

Auth
Request Body
objectobject
POST /vault_rest/public_create_archive_download
Responses
200

OK

objectobject
Response

Get Archive Download Status

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

OK

objectobject
Response

Download Archive

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

OK

filefile
Response

Download Public Archive

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

OK

filefile
Response

Cancel Archive Download

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

OK

objectobject
Response

Enumerate Audit

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

OK

objectobject
Response

Export Audit CSV

Auth
GET /vault_rest/audit/export
Responses
200

OK

filefile
Response

Export Verbose Audit

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

OK

filefile
Response

SSO Pre-Authenticate

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

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

OK

objectobject
Response

SSO Authenticate (GET)

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

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

OK

objectobject
Response

SSO Authenticate (POST)

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

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

OK

objectobject
Response

SSO Token Authenticate

Summary ## Authenticates a user using an SSO token.

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

OK

objectobject
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

objectobject
Response

Log Out

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

Auth
DELETE /vault_rest/authenticate
Responses
200

OK

objectobject
Response

Validate OTP

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

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

OK

objectobject
Response

Pre-Exchange Token

Summary ## Initiates the token exchange process.

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

OK

objectobject
Response

Exchange Token

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

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

OK

objectobject
Response

Authenticate Windows

Summary ## Initiates negotiation-based Windows authentication.

Auth
Headers
X-Forwarded-Forstring
GET /vault_rest/authenticate-windows
Responses
200

OK

objectobject
Response

Get Login Info

Retrieves current login information and policies.

Auth
GET /vault_rest/login_info
Responses
200

OK

objectobject
Response

Authorization

Endpoints for checking user permissions and resource access.

Authorize Resource

Summary ## Checks authorization for a specific resource type.

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

OK

objectobject
Response

Read Certificate Credentials

Retrieves a paginated list of certificate credentials.

Auth
Headers
X-Mft-Clientstring
X-Mft-User-Idinteger
Query String
page_sizestring

Default: 25

page_numstring

Default: 0

GET /vault_rest/creds/cert
Responses
200

OK

objectobject
Response

Create Certificate Credential

Creates a new certificate credential.

Auth
Headers
X-Mft-Clientstring
X-Mft-User-Idinteger
Request Body
objectobject
POST /vault_rest/creds/cert
Responses
201

Created

objectobject
Response

Read Certificate Credential

Retrieves a specific certificate credential by ID.

Auth
Headers
X-Mft-Clientstring
X-Mft-User-Idinteger
Path Params
idstring
GET /vault_rest/creds/cert/{id}
Responses
200

OK

objectobject
Response

Update Certificate Credential

Updates an existing certificate credential.

Auth
Headers
X-Mft-Clientstring
X-Mft-User-Idinteger
Path Params
idstring
Request Body
objectobject
PUT /vault_rest/creds/cert/{id}
Responses
200

OK

objectobject
Response

Delete Certificate Credential

Deletes a specific certificate credential.

Auth
Headers
X-Mft-Clientstring
X-Mft-User-Idinteger
Path Params
idstring
DELETE /vault_rest/creds/cert/{id}
Responses
200

OK

objectobject
Response

Custom Resource

Custom resource synchronization

Create Resource

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

OK

objectobject
Response

Get User Types

Auth
GET /vault_rest/dashboard/user_types
Responses
200

OK

objectobject
Response

Get File Size Volumes

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

OK

objectobject
Response

Get Average File Size Volumes

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

OK

objectobject
Response

Get File Security Statistics

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

OK

objectobject
Response

Get File Security Trend

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

OK

arrayarray[object]
Response

Get File Processing Summary

Auth
Headers
intervalstring
GET /vault_rest/dashboard/processing_summary
Responses
200

OK

objectobject
Response

Get File Statistics

Auth
Headers
intervalstring
GET /vault_rest/dashboard/file_statistics
Responses
200

OK

objectobject
Response

Get Login Statistics

Auth
Headers
intervalstring
GET /vault_rest/dashboard/login_statistics
Responses
200

OK

objectobject
Response

Database

Database information and storage

Get DB Storage Info

Auth
GET /vault_rest/database/storage
Responses
200

OK

objectobject
Response

Get DB Info

Auth
GET /vault_rest/database/info
Responses
200

OK

objectobject
Response

Events

System events management

Raise Event

Auth
Request Body
objectobject
POST /vault_rest/event
Responses
200

OK

objectobject
Response

Export

Data export operations

Export Process History

Auth
GET /vault_rest/export_history
Responses
200

OK

filefile
Response

Cancel Scan

Cancels an ongoing scan for a specific file.

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

OK

objectobject
Response

Cancel Scan Bulk

Cancels ongoing scans for multiple files.

Auth
Request Body
objectobject
POST /vault_rest/cancel_scan
Responses
200

OK

objectobject
Response

Override Scan Result

Overrides the scan result for a specific file.

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

OK

objectobject
Response

Approve File

Approves a specific file.

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

OK

objectobject
Response

Deny Approval File

Denies approval for a specific file.

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

OK

objectobject
Response

Approve Multiple Files

Approves multiple files.

Auth
Request Body
objectobject
POST /vault_rest/approve_files
Responses
200

OK

objectobject
Response

Deny Approval Multiple Files

Denies approval for multiple files.

Auth
Request Body
objectobject
DELETE /vault_rest/approve_files
Responses
200

OK

objectobject
Response

Unlock File

Unlocks a specific file.

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

OK

objectobject
Response

Schedule File To Rescan

Schedules a specific file to be rescanned.

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

OK

objectobject
Response

Move Files V2

Moves files to a new location (Version 2).

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

OK

objectobject
Response

Move Files

Moves files to a new location.

Auth
Request Body
objectobject
PUT /vault_rest/move_files
Responses
200

OK

arrayarray[object]
Response

Rename File

Renames a specific file.

Auth
Request Body
objectobject
PUT /vault_rest/rename_file
Responses
200

OK

objectobject
Response

Update File Password

Updates the password for a specific file.

Auth
Request Body
objectobject
PUT /vault_rest/file_password
Responses
200

OK

objectobject
Response

Insert File Password

Inserts a password for a specific file.

Auth
Request Body
objectobject
POST /vault_rest/file_password
Responses
200

OK

objectobject
Response

Update File Tags

Updates tags for a specific file.

Auth
Request Body
objectobject
PUT /vault_rest/file_tags
Responses
200

OK

objectobject
Response

Enumerate File Tags

Enumerates tags for a specific file.

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

OK

objectobject
Response

Enumerate Approval History

Enumerates the supervisor approval history for a specific file.

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

OK

objectobject
Response

File Retry Processing

Retries processing for a specific file.

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

OK

objectobject
Response

Insert Supervisor Message

Inserts a supervisor comment/message for a specific file.

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

OK

objectobject
Response

Preview File

Retrieves a preview of a specific file.

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

OK

objectobject
Response

Trash Files

Moves specified files to the trash.

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

OK

objectobject
Response

Empty Recycle Bin

Empties the recycle bin.

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

OK

objectobject
Response

Archive Files

Archives specified files.

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

OK

objectobject
Response

Restore Files

Restores specified files from the trash or archive.

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

OK

objectobject
Response

Release File

Releases a specific file.

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

OK

objectobject
Response

Release Multiple Files

Releases multiple files.

Auth
Request Body
objectobject
POST /vault_rest/release_files
Responses
200

OK

objectobject
Response

Get File Upload Reason

Retrieves the upload reason for a specific file.

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

OK

objectobject
Response

Update Upload Reason

Updates the upload reason for a file.

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

OK

objectobject
Response

Overrule Core Verdict

Overrules the core verdict for a specific file.

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

OK

objectobject
Response

Mark File As Favorite

Marks a specific file as a favorite.

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

OK

objectobject
Response

Remove File From Favorites

Removes a specific file from favorites.

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

OK

objectobject
Response

Enumerate File Audit

Enumerates file audit entries.

Auth
Path Params
startstring
countstring
GET /vault_rest/fileaudit/{start}/{count}
Responses
200

OK

objectobject
Response

Get File Audit Entries

Retrieves audit entries for a specific file.

Auth
Path Params
fileGuidstring
startstring
countstring
GET /vault_rest/fileaudit/{fileGuid}/{start}/{count}
Responses
200

OK

objectobject
Response

Export File Audit Csv

Exports the file audit history as a CSV file.

Auth
GET /vault_rest/fileaudit/export_history
Responses
200

OK

objectobject
Response

Export File Audit By File Guid

Exports the file audit history for a specific file as a CSV file.

Auth
Path Params
fileGuidstring
GET /vault_rest/fileaudit/{fileGuid}/export_history
Responses
200

OK

objectobject
Response

Get All Classification

Retrieves all file classifications.

Auth
GET /vault_rest/classification
Responses
200

OK

objectobject
Response

Insert Classification

Inserts a new file classification.

Auth
Request Body
objectobject
POST /vault_rest/classification
Responses
200

OK

objectobject
Response

Update Classification

Updates an existing file classification.

Auth
Path Params
idstring
Request Body
objectobject
PUT /vault_rest/classification/{id}
Responses
200

OK

objectobject
Response

Delete Classification

Deletes a file classification.

Auth
Path Params
idstring
DELETE /vault_rest/classification/{id}
Responses
200

OK

objectobject
Response

Update Classification On File

Updates the classification assigned to a specific file.

Auth
Request Body
objectobject
PUT /vault_rest/file_classification
Responses
200

OK

objectobject
Response

Enumerate My Files

Enumerates files owned by the current user.

Auth
Path Params
startstring
countstring
GET /vault_rest/files/my/{start}/{count}
Responses
200

OK

objectobject
Response

Enumerate All Files

Enumerates all files in the system.

Auth
Path Params
startstring
countstring
GET /vault_rest/files/all/{start}/{count}
Responses
200

OK

objectobject
Response

Enumerate Supervisor Files

Enumerates files available to the supervisor.

Auth
Path Params
startstring
countstring
GET /vault_rest/files/supervisor/{start}/{count}
Responses
200

OK

objectobject
Response

Enumerate Approval History Files

Enumerates files in the supervisor approval history.

Auth
Path Params
startstring
countstring
GET /vault_rest/files/supervisor/history/{start}/{count}
Responses
200

OK

objectobject
Response

Enumerate Outbreak Files

Enumerates files involved in outbreaks.

Auth
Path Params
startstring
countstring
GET /vault_rest/files/outbreaks/{start}/{count}
Responses
200

OK

objectobject
Response

Enumerate Recycle Bin Files

Enumerates files currently in the recycle bin.

Auth
Path Params
startstring
countstring
GET /vault_rest/files/trash/{start}/{count}
Responses
200

OK

objectobject
Response

Enumerate Archive Files

Enumerates archived files.

Auth
Path Params
startstring
countstring
GET /vault_rest/files/archive/{start}/{count}
Responses
200

OK

objectobject
Response

Update File Share

Updates file sharing settings.

Auth
Request Body
objectobject
POST /vault_rest/update_file_share
Responses
200

OK

objectobject
Response

Unshare FilesDeprecated

Deprecated: Endpoint not used by frontend

Auth
Request Body
objectobject
DELETE /vault_rest/update_file_share
Responses
200

OK

objectobject
Response

Bulk Update File Share

Updates file sharing settings for multiple files.

Auth
Request Body
objectobject
POST /vault_rest/bulk_update_file_share
Responses
200

OK

objectobject
Response

Download File

Summary

Downloads the content of a specific file by its ID.

Auth
Path Params
idstring
GET /vault_rest/file/{id}
Responses
200

OK

filefile
Response

Delete File

Summary

Deletes a specific file by its ID.

Auth
Path Params
idstring
DELETE /vault_rest/file/{id}
Responses
200

OK

objectobject
Response

Download Public File

Summary

Downloads a publicly shared file by its ID.

Auth
Path Params
idstring
GET /vault_rest/public/{id}
Responses
200

OK

filefile
Response

Get File Share Status

Summary

Retrieves the sharing status of a specific file.

Auth
Path Params
idstring
GET /vault_rest/file/share_status/{id}
Responses
200

OK

objectobject
Response

Get File Status

Summary

Retrieves the processing and general status of a specific file.

Auth
Path Params
idstring
GET /vault_rest/file/status/{id}
Responses
200

OK

objectobject
Response

Get File Brief Details

Summary

Retrieves brief metadata details for a specific file.

Auth
Path Params
idstring
GET /vault_rest/file/brief/{id}
Responses
200

OK

objectobject
Response

Delete Multiple Files

Summary

Deletes multiple files based on the provided request body.

Auth
Request Body
objectobject
DELETE /vault_rest/files
Responses
200

OK

objectobject
Response

List File Name Duplicates

Summary

Checks for duplicate file names during a transfer process.

Auth
Request Body
objectobject
POST /vault_rest/transfer/duplicates
Responses
200

OK

objectobject
Response

Initialize Group Transfer

Summary

Initializes a new group transfer session.

Auth
GET /vault_rest/transfer
Responses
200

OK

objectobject
Response

Complete Group Transfer

Summary

Completes an active group transfer session.

Auth
POST /vault_rest/transfer
Responses
200

OK

objectobject
Response

Delete Group Transfer

Summary

Deletes or cancels an active group transfer session.

Auth
DELETE /vault_rest/transfer
Responses
200

OK

objectobject
Response

Initialize Group Transfer Diode

Summary

Initializes a new group transfer session specifically for diode environments.

Auth
Request Body
objectobject
POST /vault_rest/transfer_diode
Responses
200

OK

objectobject
Response

Initialize File Transfer

Summary

Initializes a single file transfer within a group.

Auth
GET /vault_rest/transfer_file
Responses
200

OK

objectobject
Response

Complete File Transfer

Summary

Completes a single file transfer.

Auth
Request Body
objectobject
POST /vault_rest/transfer_file
Responses
200

OK

objectobject
Response

Delete File From Group Transfer

Summary

Removes a file from an active group transfer.

Auth
DELETE /vault_rest/transfer_file
Responses
200

OK

objectobject
Response

Upload File Chunk

Summary

Uploads a chunk of a file for an active file transfer.

Auth
Request Body
filefile
PATCH /vault_rest/transfer_file
Responses
200

OK

objectobject
Response

Initialize File Transfer Diode

Summary

Initializes a single file transfer within a group for diode environments.

Auth
POST /vault_rest/transfer_file_diode
Responses
200

OK

objectobject
Response

Upload Chunk Multipart Diode

Summary

Uploads a file chunk using multipart format for diode environments.

Auth
Request Body
objectobject
POST /vault_rest/transfer_file_chunk_multipart_diode
Responses
200

OK

objectobject
Response

Upload Chunk Diode

Summary

Uploads a file chunk for diode environments.

Auth
Request Body
filefile
POST /vault_rest/transfer_file_chunk_diode
Responses
200

OK

objectobject
Response

Resync Files and Folders MFT to MFT

Summary

Triggers a synchronization of files and folders between MFT instances.

Auth
Request Body
objectobject
POST /vault_rest/sync_to_mft
Responses
200

OK

objectobject
Response

Lookup Files Status

Summary

Looks up the status of multiple files in a single request.

Auth
Request Body
objectobject
POST /vault_rest/lookup/filestatus
Responses
200

OK

arrayarray[object]
Response

Filter

Filter properties and operators

Get Filter Properties

Auth
Query String
presetstring
GET /vault_rest/filter/properties
Responses
200

OK

objectobject
Response

Get Filter Operators

Auth
GET /vault_rest/filter/operators
Responses
200

OK

objectobject
Response

Enumerate Folder Content

Summary

Retrieves a paginated list of contents within a specific folder.

Auth
Path Params
folderGuidstring

The unique identifier (GUID) of the folder.

startstring

The starting index for pagination.

countstring

The number of items to retrieve.

GET /vault_rest/folder_content/{folderGuid}/{start}/{count}
Responses
200

OK

objectobject
Response

Search Folder Content

Summary

Searches for contents within a specific folder with pagination.

Auth
Path Params
folderGuidstring

The unique identifier (GUID) of the folder to search within.

startstring

The starting index for pagination.

countstring

The number of items to retrieve.

GET /vault_rest/folder_search/{folderGuid}/{start}/{count}
Responses
200

OK

objectobject
Response

Create Folder

Summary

Creates a new folder.

Auth
Request Body
objectobject
POST /vault_rest/folder
Responses
200

OK

objectobject
Response

Rename Folder

Summary

Renames an existing folder.

Auth
Request Body
objectobject
PUT /vault_rest/rename_folder
Responses
200

OK

objectobject
Response

Move Folders V2

Summary

Moves one or more folders to a new destination (Version 2).

Auth
Request Body
objectobject
PUT /vault_rest/v2/move_folders
Responses
200

OK

objectobject
Response

Move Folders

Summary

Moves one or more folders to a new destination.

Auth
Request Body
objectobject
PUT /vault_rest/move_folders
Responses
200

OK

arrayarray[object]
Response

Get Root Folder

Summary

Retrieves the root folder entry for the authenticated user.

Auth
GET /vault_rest/root_folder
Responses
200

OK

objectobject
Response

Get Folder

Summary

Retrieves details for a specific folder by its ID.

Auth
Path Params
folderIdstring

The unique identifier of the folder.

GET /vault_rest/folder/{folderId}
Responses
200

OK

objectobject
Response

Delete Folder

Summary

Deletes a specific folder by its ID.

Auth
Path Params
idstring

The unique identifier of the folder to delete.

DELETE /vault_rest/folder/{folderId}
Responses
200

OK

objectobject
Response

Get Shared Folder

Summary

Retrieves details for a specific shared folder by its ID.

Auth
Path Params
folderIdstring

The unique identifier of the shared folder.

GET /vault_rest/shared_folder/{folderId}
Responses
200

OK

objectobject
Response

Delete Folders

Summary

Deletes multiple folders in a single request.

Auth
Request Body
objectobject
DELETE /vault_rest/folders
Responses
200

OK

objectobject
Response

Get Folder Status

Summary

Retrieves the current status of a specific folder.

Auth
Path Params
folderIdstring

The unique identifier of the folder.

GET /vault_rest/folder/status/{folderId}
Responses
200

OK

objectobject
Response

Check Folder Availability

Summary

Checks if a folder is available for download.

Auth
Request Body
objectobject
POST /vault_rest/folder/availability
Responses
200

OK

objectobject
Response

Mark Folder As Favorite

Summary

Marks a specific folder as a favorite for the authenticated user.

Auth
Path Params
guidstring

The unique identifier of the folder.

POST /vault_rest/favorite/folder/{guid}
Responses
200

OK

objectobject
Response

Remove Folder From Favorites

Summary

Removes a specific folder from the authenticated user's favorites.

Auth
Path Params
guidstring

The unique identifier of the folder.

DELETE /vault_rest/favorite/folder/{guid}
Responses
200

OK

objectobject
Response

Enumerate Shared Content

Summary

Retrieves a paginated list of shared content available to the user.

Auth
Path Params
startstring

The starting index for pagination.

countstring

The number of items to retrieve.

GET /vault_rest/shared_content/{start}/{count}
Responses
200

OK

objectobject
Response

Update Folder Share

Summary

Updates the sharing settings for a specific folder.

Auth
Request Body
objectobject
POST /vault_rest/update_folder_share
Responses
200

OK

objectobject
Response

Bulk Update Folder Share

Summary

Updates the sharing settings for multiple folders in a single request.

Auth
Request Body
objectobject
POST /vault_rest/bulk_update_folder_share
Responses
200

OK

objectobject
Response

Remove Folder Shares

Summary

Removes sharing settings from one or more folders.

Auth
Request Body
objectobject
DELETE /vault_rest/remove_folder_shares
Responses
200

OK

objectobject
Response

Read FTPS Integrations

Retrieves a paginated list of FTPS integrations.

Auth
Headers
X-Mft-Clientstring
X-Mft-User-Idinteger
Query String
page_sizestring

Default: 25

page_numstring

Default: 0

GET /vault_rest/integrations/ftps
Responses
200

OK

objectobject
Response

Create FTPS Integration

Creates a new FTPS integration configuration.

Auth
Headers
X-Mft-Clientstring
X-Mft-User-Idinteger
Request Body
objectobject
POST /vault_rest/integrations/ftps
Responses
201

Created

objectobject
Response

Read FTPS Integration

Retrieves a specific FTPS integration by ID.

Auth
Headers
X-Mft-Clientstring
X-Mft-User-Idinteger
Path Params
idstring
GET /vault_rest/integrations/ftps/{id}
Responses
200

OK

objectobject
Response

Update FTPS Integration

Updates an existing FTPS integration.

Auth
Headers
X-Mft-Clientstring
X-Mft-User-Idinteger
Path Params
idstring
Request Body
objectobject
PUT /vault_rest/integrations/ftps/{id}
Responses
200

OK

objectobject
Response

Delete FTPS Integration

Deletes a specific FTPS integration.

Auth
Headers
X-Mft-Clientstring
X-Mft-User-Idinteger
Path Params
idstring
DELETE /vault_rest/integrations/ftps/{id}
Responses
200

OK

objectobject
Response

Test FTPS Integration Connection

Tests the connection to a specific FTPS integration.

Auth
Headers
X-Mft-User-Idinteger
Path Params
idstring
GET /vault_rest/integrations/ftps/{id}/test_connection
Responses
200

OK

objectobject
successboolean
Response

Create Group

Creates a new user group.

Auth
Request Body
objectobject
POST /vault_rest/groups
Responses
200

OK

objectobject
Response

Enumerate Groups To Share Files With

Retrieves a list of groups that the current user can share files with.

Auth
Query String
startstring
countstring
searchstring
fileidstring
folderidstring
GET /vault_rest/groups/tosharefiles
Responses
200

OK

objectobject
Response

Enumerate Groups

Enumerates all groups with pagination.

Auth
Path Params
startstring
countstring
GET /vault_rest/groups/{start}/{count}
Responses
200

OK

objectobject
Response

Update Group

Updates the settings of a specific group.

Auth
Path Params
idstring
Request Body
objectobject
PUT /vault_rest/groups/{id}
Responses
200

OK

objectobject
Response

Delete Group

Deletes a specific group.

Auth
Path Params
idstring
DELETE /vault_rest/groups/{id}
Responses
200

OK

objectobject
Response

Enumerate Group Accounts

Enumerates the members of a specific group with pagination.

Auth
Path Params
idstring
startstring
countstring
GET /vault_rest/groups/{id}/members/{start}/{count}
Responses
200

OK

objectobject
Response

Set Group Memberships

Sets the members for a specific group.

Auth
Path Params
idstring
Request Body
objectobject
PUT /vault_rest/groups/{id}/members
Responses
200

OK

objectobject
Response

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.

Auth
Path Params
pinCodeLengthstring
GET /vault_rest/guest/pin/{pinCodeLength}
Responses
200

OK

objectobject
Response

Update Guest Account

Updates an existing guest account.

Auth
Request Body
objectobject
PUT /vault_rest/guest
Responses
200

OK

objectobject
Response

Create Guest Account

Creates a new guest account.

Auth
Request Body
objectobject
POST /vault_rest/guest
Responses
200

OK

objectobject
Response

Create Guest Account V2

Creates a new guest account using the V2 endpoint.

Auth
Request Body
objectobject
POST /vault_rest/v2/guest
Responses
200

OK

objectobject
Response

Get IP Location Mapping

Auth
Path Params
startstring
countstring
GET /vault_rest/location_mapping/{start}/{count}
Responses
200

OK

objectobject
Response

Create IP Location Mapping

Auth
Request Body
objectobject
POST /vault_rest/location_mapping
Responses
200

OK

objectobject
Response

Delete Location Mappings

Auth
Request Body
objectobject
DELETE /vault_rest/location_mapping
Responses
200

OK

objectobject
Response

Update IP Location Mapping

Auth
Path Params
idstring
Request Body
objectobject
PUT /vault_rest/location_mapping/{id}
Responses
200

OK

objectobject
Response

Delete Location Mapping

Auth
Path Params
idstring
DELETE /vault_rest/location_mapping/{id}
Responses
200

OK

objectobject
Response

Read Job Executions

Retrieves a paginated history of executions for a specific job.

Auth
Path Params
idstring

Job ID

Query String
page_sizestring

Number of items per page

Default: 25

page_numstring

Page number to retrieve

Default: 0

GET /vault_rest/jobs/{id}/history
Responses
200

OK

objectobject
Response

Read All Job Executions

Retrieves a paginated history of all executions for a specific job across the system.

Auth
Path Params
idstring

Job ID

Query String
page_sizestring

Number of items per page

Default: 25

page_numstring

Page number to retrieve

Default: 0

GET /vault_rest/jobs/all/{id}/history
Responses
200

OK

objectobject
Response

Read Job Execution

Retrieves details of a specific job execution.

Auth
Path Params
idstring

Job ID

executionIdstring

Execution ID

GET /vault_rest/jobs/{id}/history/{executionId}
Responses
200

OK

objectobject
Response

Read All Job Execution

Retrieves details of a specific job execution across the system.

Auth
Path Params
idstring

Job ID

executionIdstring

Execution ID

GET /vault_rest/jobs/all/{id}/history/{executionId}
Responses
200

OK

objectobject
Response

Download Job Execution Log

Downloads the log file for a specific job execution.

Auth
Path Params
idstring

Job ID

executionIdstring

Execution ID

Query String
attachmentboolean

Whether to download as an attachment

Default: false

GET /vault_rest/jobs/{id}/history/{executionId}/log
Responses
200

OK

filefile
Response

Download All Job Execution Log

Downloads the log file for a specific job execution across the system.

Auth
Path Params
idstring

Job ID

executionIdstring

Execution ID

Query String
attachmentboolean

Whether to download as an attachment

Default: false

GET /vault_rest/jobs/all/{id}/history/{executionId}/log
Responses
200

OK

filefile
Response

Get Recent Job Executions

Retrieves the most recent job executions for the current user.

Auth
GET /vault_rest/jobs/executions/recent
Responses
200

OK

objectobject
Response

Job Settings

Global configuration and settings for jobs

Get Jobs Settings

Retrieves the global configuration settings for jobs.

Auth
GET /vault_rest/jobs/config
Responses
200

OK

objectobject
Response

Update Jobs Settings

Updates the global configuration settings for jobs.

Auth
Request Body
objectobject
POST /vault_rest/jobs/config
Responses
200

OK

objectobject
Response

Read Jobs

Retrieves a paginated list of jobs.

Auth
Query String
page_sizestring

Number of items per page

Default: 25

page_numstring

Page number to retrieve

Default: 0

GET /vault_rest/jobs
Responses
200

OK

objectobject
Response

Create Job

Creates a new job.

Auth
Request Body
objectobject
POST /vault_rest/jobs
Responses
201

Created

objectobject
Response

Read Job Statuses

Retrieves a paginated list of job statuses for the current user.

Auth
Query String
page_sizestring

Number of items per page

Default: 25

page_numstring

Page number to retrieve

Default: 0

pull_type_onlyboolean

Filter by pull type jobs only

Default: false

push_type_onlyboolean

Filter by push type jobs only

Default: false

GET /vault_rest/jobs/status
Responses
200

OK

objectobject
Response

Read All Job Statuses

Retrieves a paginated list of all job statuses across the system.

Auth
Query String
page_sizestring

Number of items per page

Default: 25

page_numstring

Page number to retrieve

Default: 0

pull_type_onlyboolean

Filter by pull type jobs only

Default: false

push_type_onlyboolean

Filter by push type jobs only

Default: false

GET /vault_rest/jobs/all/status
Responses
200

OK

objectobject
Response

Read Job

Retrieves details of a specific job by ID.

Auth
Path Params
idstring

Job ID

GET /vault_rest/jobs/{id}
Responses
200

OK

objectobject
Response

Update Job

Updates an existing job by ID.

Auth
Path Params
idstring

Job ID

Request Body
objectobject
PUT /vault_rest/jobs/{id}
Responses
200

OK

objectobject
Response

Delete Job

Deletes a specific job by ID.

Auth
Path Params
idstring

Job ID

DELETE /vault_rest/jobs/{id}
Responses
200

OK

objectobject
Response

Update Job Transfer Condition

Updates the transfer conditions for a specific job.

Auth
Path Params
idstring

Job ID

Request Body
objectobject
PUT /vault_rest/jobs/{id}/transfer_condition
Responses
200

OK

objectobject
Response

Read Job Status

Retrieves the status of a specific job by ID.

Auth
Path Params
idstring

Job ID

GET /vault_rest/jobs/{id}/status
Responses
200

OK

objectobject
Response

Execute Job

Manually starts the execution of a specific job.

Auth
Path Params
idstring

Job ID

POST /vault_rest/jobs/{id}/start
Responses
200

OK

objectobject
Response

Pause Job

Pauses the execution of a specific job.

Auth
Path Params
idstring

Job ID

POST /vault_rest/jobs/{id}/pause
Responses
200

OK

objectobject
Response

Fork Job

Creates a copy (fork) of an existing job.

Auth
Path Params
idstring

Job ID

Request Body
objectobject
POST /vault_rest/jobs/{id}/fork
Responses
200

OK

objectobject
Response

Get Jobs Progress

Retrieves the progress of multiple jobs based on the provided request.

Auth
Request Body
objectobject
POST /vault_rest/jobs/progress
Responses
200

OK

objectobject
Response

Get Licensing Info

Auth
GET /vault_rest/license
Responses
200

OK

objectobject
Response

Get License

Auth
GET /vault_rest/admin/license
Responses
200

OK

objectobject
Response

Activate License Offline

Auth
Request Body
objectobject
POST /vault_rest/admin/license
Responses
200

OK

objectobject
Response

Activate License

Auth
Request Body
objectobject
POST /vault_rest/admin/license/activation
Responses
200

OK

objectobject
Response

Deactivate License

Auth
POST /vault_rest/admin/license/deactivation
Responses
200

OK

objectobject
Response

Deprecated Enumerate Licenses

Since ## August 2019

Auth
GET /vault_rest/settings/license
Responses
200

OK

objectobject
Response

Deprecated Add License

Since ## August 2019

Auth
Request Body
objectobject
POST /vault_rest/settings/license
Responses
200

OK

objectobject
Response

Deprecated Add Offline License

Since ## August 2019

Auth
Request Body
objectobject
POST /vault_rest/settings/offlinelicense
Responses
200

OK

objectobject
Response

Get Deployment ID

Auth
GET /vault_rest/deploymentid
Responses
200

OK

objectobject
Response

Deprecated Delete License

Since ## August 2019

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

OK

objectobject
Response

Mfa Settings

Endpoints for managing Multi-Factor Authentication configuration.

Get MFA Settings

Summary ## Retrieves the current Multi-Factor Authentication (MFA) settings.

Auth
GET /vault_rest/settings/mfa
Responses
200

OK

objectobject
Response

Update MFA Settings

Summary ## Updates the Multi-Factor Authentication (MFA) settings.

Auth
Request Body
objectobject
POST /vault_rest/settings/mfa
Responses
200

OK

objectobject
Response

Read MFT API Keys

Retrieves a paginated list of MFT API key credentials.

Auth
Headers
X-Mft-Clientstring
X-Mft-User-Idinteger
Query String
page_sizestring

Default: 25

page_numstring

Default: 0

GET /vault_rest/creds/mft_api
Responses
200

OK

objectobject
Response

Create MFT API Key

Creates a new MFT API key credential.

Auth
Headers
X-Mft-Clientstring
X-Mft-User-Idinteger
Request Body
objectobject
POST /vault_rest/creds/mft_api
Responses
201

Created

objectobject
Response

Read MFT API Key

Retrieves a specific MFT API key credential by ID.

Auth
Headers
X-Mft-Clientstring
X-Mft-User-Idinteger
Path Params
idstring
GET /vault_rest/creds/mft_api/{id}
Responses
200

OK

objectobject
Response

Update MFT API Key

Updates an existing MFT API key credential.

Auth
Headers
X-Mft-Clientstring
X-Mft-User-Idinteger
Path Params
idstring
Request Body
objectobject
PUT /vault_rest/creds/mft_api/{id}
Responses
200

OK

objectobject
Response

Delete MFT API Key

Deletes a specific MFT API key credential.

Auth
Headers
X-Mft-Clientstring
X-Mft-User-Idinteger
Path Params
idstring
DELETE /vault_rest/creds/mft_api/{id}
Responses
200

OK

objectobject
Response

Get MFT Integrations

Retrieves MFT integration configurations.

Auth
GET /vault_rest/integrations/mft
Responses
200

OK

objectobject
Response

Update MFT Integrations

Updates MFT integration configurations.

Auth
Request Body
objectobject
PUT /vault_rest/integrations/mft
Responses
200

OK

objectobject
Response

Delete MFT Integrations

Deletes MFT integration configurations.

Auth
Request Body
objectobject
DELETE /vault_rest/integrations/mft
Responses
200

OK

objectobject
Response

Test MFT Integration Connection

Tests the connection to a specific MFT integration.

Auth
Headers
X-Mft-User-Idinteger
Path Params
idinteger
GET /vault_rest/integrations/mft/{id}/test_connection
Responses
200

OK

objectobject
successboolean
Response

Get MFT Instances

Summary

Retrieves a list of configured MFT pull instances.

Auth
GET /vault_rest/mft_pull/instances
Responses
200

OK

objectobject
Response

MFT Pull Login

Summary

Authenticates against a remote MFT instance for pull operations.

Auth
Request Body
objectobject
POST /vault_rest/mft_pull/login
Responses
200

OK

objectobject
Response

MFT Pull Validate OTP

Summary

Validates an OTP for a remote MFT instance login.

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

OK

objectobject
Response

Enumerate Folder Content

Summary

Enumerates the contents of a folder on a remote MFT instance.

Auth
Path Params
mftIntegrationIdstring
folderGuidstring
pageCountstring
GET /vault_rest/mft_pull/list_files/{mftIntegrationId}/{folderGuid}/{pageCount}
Responses
200

OK

objectobject
Response

Initiate Pull Files

Summary

Initiates a pull operation to download files from a remote MFT instance.

Auth
Request Body
objectobject
POST /vault_rest/mft_pull/pull
Responses
200

OK

objectobject
Response

Get Pull Status

Summary

Retrieves the status of an active MFT pull operation.

Auth
Path Params
mftIntegrationIdstring
pullIdstring
GET /vault_rest/mft_pull/pull_status/{mftIntegrationId}/{pullId}
Responses
200

OK

objectobject
Response

Miscellaneous

Miscellaneous utility endpoints.

Log Request

Logs a request.

Auth
POST /vault_rest/log
Responses
200

OK

objectobject
Response

Get Version

Retrieves the current version of the API.

Auth
GET /vault_rest/version
Responses
200

OK

objectobject
Response

Get Mft Id

Retrieves the MFT ID.

Auth
GET /vault_rest/mft_id
Responses
200

OK

objectobject
Response

Create Network Rule

Auth
Request Body
objectobject
POST /vault_rest/network_rule
Responses
200

OK

objectobject
Response

Enumerate Network Rules

Auth
Path Params
startstring
countstring
GET /vault_rest/network_rules/{start}/{count}
Responses
200

OK

objectobject
Response

Get Network Rule By ID

Auth
Path Params
ruleIdstring
GET /vault_rest/network_rule/{ruleId}
Responses
200

OK

objectobject
Response

Update Network Rule

Auth
Path Params
ruleIdstring
Request Body
objectobject
PUT /vault_rest/network_rule/{ruleId}
Responses
200

OK

objectobject
Response

Delete Network Rule

Auth
Path Params
ruleGuidStrstring
DELETE /vault_rest/network_rule/{ruleGuidStr}
Responses
200

OK

objectobject
Response

Delete Network Rules

Auth
Request Body
objectobject
DELETE /vault_rest/network_rules
Responses
200

OK

objectobject
Response

Expand IP Network

Auth
GET /vault_rest/network_rule/expand
Responses
200

OK

objectobject
Response

Get IP Address Info

Auth
GET /vault_rest/network_rule/get_ipaddress_info
Responses
200

OK

objectobject
Response

Get Authentication Details

Auth
GET /vault_rest/network_rule/authentication_details
Responses
200

OK

objectobject
Response

Enroll

Auth
Request Body
objectobject
POST /vault_rest/OCM8/enroll
Responses
200

OK

objectobject
Response

UnEnroll

Auth
POST /vault_rest/OCM8/unenroll
Responses
200

OK

objectobject
Response

Force UnEnroll

Auth
POST /vault_rest/OCM8/force_unenroll
Responses
200

OK

objectobject
Response

Reconnect

Auth
POST /vault_rest/OCM8/reconnect
Responses
200

OK

objectobject
Response

Get OCM Config

Auth
GET /vault_rest/centralmanagement/config
Responses
200

OK

objectobject
Response

Send Reset Password Email

Sends a password reset email to the specified user.

Auth
Path Params
emailOrUsernamestring
PUT /vault_rest/account/password/{emailOrUsername}
Responses
200

OK

objectobject
Response

Reset Password

Resets the password for a user account.

Auth
Request Body
objectobject
POST /vault_rest/account/password
Responses
200

OK

objectobject
Response

Forced Password Reset

Forces a password reset for a specific account.

Auth
Request Body
objectobject
POST /vault_rest/account/forcedpasswordreset
Responses
200

OK

objectobject
Response

Bulk Force Password Reset

Forces a password reset for multiple accounts.

Auth
Request Body
objectobject
POST /vault_rest/accounts/forcepasswordreset
Responses
200

OK

arrayarray[object]
Response

Change User Password

Changes the password for a specific user account.

Auth
Path Params
userIdstring
Request Body
objectobject
POST /vault_rest/account/changepassword/{userId}
Responses
200

OK

objectobject
Response

Permissions

Endpoints for retrieving and managing user permissions.

Get Current User Permission

Retrieves the permissions of the currently authenticated user.

Auth
GET /vault_rest/permission
Responses
200

OK

objectobject
Response

Get User Permission

Retrieves the permissions of a specific user.

Auth
Path Params
userIdstring
GET /vault_rest/permission/{userId}
Responses
200

OK

objectobject
Response

Invalidate Permission Cache

Invalidates the cached permissions.

Auth
GET /vault_rest/permission/invalidate_cache
Responses
200

OK

booleanboolean
Response

Get Radius Settings

Auth
GET /vault_rest/settings/radius
Responses
200

OK

objectobject
Response

Update Radius Settings

Auth
Request Body
objectobject
POST /vault_rest/settings/radius
Responses
200

OK

objectobject
Response

Invalidate Radius Settings Cache

Auth
GET /vault_rest/settings/radius/invalidate_cache
Responses
200

OK

booleanboolean
Response

Add Scan

Auth
Request Body
objectobject
POST /vault_rest/scan
Responses
200

OK

objectobject
Response

Get Scan Config

Auth
GET /vault_rest/scan/settings
Responses
200

OK

objectobject
Response

Update Scan Config

Auth
Request Body
objectobject
POST /vault_rest/scan/settings
Responses
200

OK

objectobject
Response

Enumerate Scans

Auth
Path Params
fileIdstring
startstring
countstring
GET /vault_rest/scans/{fileId}/{start}/{count}
Responses
200

OK

objectobject
Response

Scan Result From Core

Auth
Path Params
dataIdstring
GET /vault_rest/scan_from_core/{dataId}
Responses
200

OK

objectobject
Response

Get Last Scan

Auth
Path Params
fileIdstring
GET /vault_rest/scan/last/{fileId}
Responses
200

OK

objectobject
Response

Settings

System settings and configuration

Get Syslog Configuration

Auth
GET /vault_rest/settings/syslog
Responses
200

OK

objectobject
Response

Update Syslog Configuration

Auth
Request Body
objectobject
POST /vault_rest/settings/syslog
Responses
200

OK

objectobject
Response

Get Notifications Configuration

Auth
GET /vault_rest/settings/notifications
Responses
200

OK

objectobject
Response

Update Notifications Configuration

Auth
Request Body
objectobject
POST /vault_rest/settings/notifications
Responses
200

OK

objectobject
Response

Send Test Notification

Auth
Request Body
objectobject
POST /vault_rest/settings/templates/test
Responses
200

OK

objectobject
Response

Get Audit Settings

Auth
GET /vault_rest/settings/audit
Responses
200

OK

objectobject
Response

Update Audit Settings

Auth
Request Body
objectobject
POST /vault_rest/settings/audit
Responses
200

OK

objectobject
Response

Get Log Settings

Auth
GET /vault_rest/settings/logging
Responses
200

OK

objectobject
Response

Update Log Settings

Auth
Request Body
objectobject
POST /vault_rest/settings/logging
Responses
200

OK

objectobject
Response

Get Transfer Settings

Auth
GET /vault_rest/settings/transfer
Responses
200

OK

objectobject
Response

Update Global Transfer Settings

Auth
Request Body
objectobject
POST /vault_rest/settings/transfer
Responses
200

OK

objectobject
Response

Invalidate Transfer Settings Cache

Auth
GET /vault_rest/settings/transfer/invalidate_cache
Responses
200

OK

booleanboolean
Response

Enumerate Core Settings

Auth
GET /vault_rest/settings/mdcores
Responses
200

OK

objectobject
Response

Get Core Common Workflows

Auth
GET /vault_rest/settings/mdcore/workflows
Responses
200

OK

objectobject
Response

Get Core Workflows By URL

Auth
Request Body
objectobject
POST /vault_rest/settings/mdcore/workflows
Responses
200

OK

objectobject
Response

Get Core Workflows By ID

Auth
Path Params
idstring
GET /vault_rest/settings/mdcore/{id}/workflows
Responses
200

OK

objectobject
Response

Get Detailed Core Workflows By ID

Auth
Path Params
idstring
GET /vault_rest/settings/mdcore/{id}/detailed_workflows
Responses
200

OK

objectobject
Response

Get Core Modules By ID

Auth
Path Params
idstring
GET /vault_rest/settings/mdcore/{id}/modules
Responses
200

OK

objectobject
Response

Get Core Load Balancing Settings

Auth
GET /vault_rest/settings/mdcore/loadbalancing
Responses
200

OK

objectobject
Response

Update Core Load Balancing Settings

Auth
Request Body
objectobject
POST /vault_rest/settings/mdcore/loadbalancing
Responses
200

OK

objectobject
Response

Get Core Settings

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

OK

objectobject
Response

Update Core Settings

Auth
Path Params
idstring
Request Body
objectobject
PUT /vault_rest/settings/mdcore/{id}
Responses
200

OK

objectobject
Response

Delete Core Settings

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

OK

objectobject
Response

Add Core Settings

Auth
Request Body
objectobject
POST /vault_rest/settings/mdcore
Responses
200

OK

objectobject
Response

Get Outbreak Settings

Auth
GET /vault_rest/settings/outbreak
Responses
200

OK

objectobject
Response

Update Outbreak Settings

Auth
Request Body
objectobject
POST /vault_rest/settings/outbreak
Responses
200

OK

objectobject
Response

Get SMTP Settings

Auth
GET /vault_rest/settings/smtp
Responses
200

OK

objectobject
Response

Update SMTP Settings

Auth
Request Body
objectobject
POST /vault_rest/settings/smtp
Responses
200

OK

objectobject
Response

Get Graph Settings

Auth
GET /vault_rest/settings/notifications/graph
Responses
200

OK

objectobject
Response

Update Graph Settings

Auth
Request Body
objectobject
POST /vault_rest/settings/notifications/graph
Responses
200

OK

objectobject
Response

Export SFT Configuration

Auth
Query String
performLicenseTransferboolean

Default: false

GET /vault_rest/settings/export
Responses
200

OK

filefile
Response

Import SFT Configuration

Auth
Request Body
filefile
POST /vault_rest/settings/import
Responses
200

OK

objectobject
Response

Enumerate Email Templates

Auth
GET /vault_rest/settings/templates
Responses
200

OK

objectobject
Response

Get Email Templates By Type And Version

Auth
Path Params
typestring
versionstring
GET /vault_rest/settings/template/{type}/{version}
Responses
200

OK

objectobject
Response

Add Email Template Version

Auth
Path Params
typestring
Request Body
objectobject
PUT /vault_rest/settings/template/{type}
Responses
200

OK

objectobject
Response

Activate Email Template Version

Auth
Path Params
typestring
versionstring
POST /vault_rest/settings/template/{type}/{version}/activate
Responses
200

OK

objectobject
Response

Activate All Email Template Latest Version

Auth
POST /vault_rest/settings/template/reset_all
Responses
200

OK

objectobject
Response

Reset Email Template

Auth
Path Params
typestring
actionstring
POST /vault_rest/settings/template/{type}/{action}
Responses
200

OK

objectobject
Response

Export Email Template

Auth
Request Body
objectobject
POST /vault_rest/settings/template/export
Responses
200

OK

objectobject
Response

Enumerate Supported Languages

Auth
GET /vault_rest/settings/languages
Responses
200

OK

objectobject
Response

Get Language Settings

Auth
GET /vault_rest/settings/language
Responses
200

OK

objectobject
Response

Add Custom Language

Auth
Request Body
objectobject
PUT /vault_rest/settings/language
Responses
200

OK

objectobject
Response

Update Language Settings

Auth
Request Body
objectobject
POST /vault_rest/settings/language
Responses
200

OK

objectobject
Response

Download Language Draft

Auth
Path Params
fileNamestring
GET /vault_rest/settings/language/download/{fileName}
Responses
200

OK

filefile
Response

Enumerate Supported Time Zones

Auth
GET /vault_rest/settings/timezones
Responses
200

OK

objectobject
Response

Get SSO Settings

Auth
GET /vault_rest/settings/sso
Responses
200

OK

objectobject
Response

Update SSO Settings

Auth
Request Body
objectobject
POST /vault_rest/settings/sso
Responses
200

OK

objectobject
Response

Fetch Redirect URI

Auth
Request Body
objectobject
POST /vault_rest/settings/sso/redirect_uri
Responses
200

OK

objectobject
Response

Get SSO Claim Settings

Auth
GET /vault_rest/settings/sso/claims
Responses
200

OK

objectobject
Response

Update SSO Claim Settings

Auth
Request Body
objectobject
POST /vault_rest/settings/sso/claims
Responses
200

OK

objectobject
Response

Invalidate SSO Settings Cache

Auth
GET /vault_rest/settings/sso/invalidate_cache
Responses
200

OK

booleanboolean
Response

Get Security Settings

Auth
GET /vault_rest/settings/security
Responses
200

OK

objectobject
Response

Update Security Settings

Auth
Request Body
objectobject
POST /vault_rest/settings/security
Responses
200

OK

objectobject
Response

Create Encryption Key

Auth
POST /vault_rest/settings/security/encryption_key
Responses
200

OK

objectobject
Response

Download Encryption Key

Auth
Path Params
guidstring
GET /vault_rest/settings/security/encryption_key/{guid}
Responses
200

OK

filefile
Response

Get Default Encryption Key

Auth
GET /vault_rest/settings/security/encryption_key/default
Responses
200

OK

objectobject
Response

Get Theme Configuration

Auth
GET /vault_rest/settings/theme
Responses
200

OK

objectobject
Response

Update Theme Configuration

Auth
Request Body
objectobject
POST /vault_rest/settings/theme
Responses
200

OK

objectobject
Response

Reset Theme Configuration

Auth
PUT /vault_rest/settings/theme/reset
Responses
200

OK

objectobject
Response

Get Recycle Bin Settings

Auth
GET /vault_rest/settings/recycle_bin
Responses
200

OK

objectobject
Response

Update Recycle Bin Settings

Auth
Request Body
objectobject
PUT /vault_rest/settings/recycle_bin
Responses
200

OK

objectobject
Response

Get Core Status

Auth
Path Params
idstring
GET /vault_rest/settings/mdcore/{id}/status
Responses
200

OK

objectobject
Response

Get Events Settings

Auth
GET /vault_rest/settings/events
Responses
200

OK

objectobject
Response

Update Events Settings

Auth
Request Body
objectobject
POST /vault_rest/settings/events
Responses
200

OK

objectobject
Response

Get General Template Settings

Auth
GET /vault_rest/settings/template/general
Responses
200

OK

objectobject
Response

Update General Template Settings

Auth
Request Body
objectobject
PUT /vault_rest/settings/template/general
Responses
200

OK

objectobject
Response

Setup Administration

Endpoints for initial setup and default administrator configuration.

Get Default Administrator Info

Retrieves information about the default administrator setup.

Auth
GET /vault_rest/usersetup
Responses
200

OK

objectobject
Response

Setup Default Administrator

Configures the default administrator account.

Auth
Request Body
objectobject
POST /vault_rest/usersetup
Responses
200

OK

objectobject
Response

Check Password Reset Capability

Checks if the specified user can reset their password.

Auth
Path Params
userNamestring
GET /vault_rest/usersetup/{userName}
Responses
200

OK

objectobject
Response

Get Setup Wizard Info

Retrieves information for the setup wizard.

Auth
GET /vault_rest/setupwizard
Responses
200

OK

objectobject
Response

Complete Setup Wizard

Completes the setup wizard process.

Auth
POST /vault_rest/setupwizard
Responses
200

OK

objectobject
Response

Read SFTP Integrations

Retrieves a paginated list of SFTP integrations.

Auth
Headers
X-Mft-Clientstring
X-Mft-User-Idinteger
Query String
page_sizestring

Default: 25

page_numstring

Default: 0

GET /vault_rest/integrations/sftp
Responses
200

OK

objectobject
Response

Create SFTP Integration

Creates a new SFTP integration configuration.

Auth
Headers
X-Mft-Clientstring
X-Mft-User-Idinteger
Request Body
objectobject
POST /vault_rest/integrations/sftp
Responses
201

Created

objectobject
Response

Read SFTP Integration

Retrieves a specific SFTP integration by ID.

Auth
Headers
X-Mft-Clientstring
X-Mft-User-Idinteger
Path Params
idstring
GET /vault_rest/integrations/sftp/{id}
Responses
200

OK

objectobject
Response

Update SFTP Integration

Updates an existing SFTP integration.

Auth
Headers
X-Mft-Clientstring
X-Mft-User-Idinteger
Path Params
idstring
Request Body
objectobject
PUT /vault_rest/integrations/sftp/{id}
Responses
200

OK

objectobject
Response

Delete SFTP Integration

Deletes a specific SFTP integration.

Auth
Headers
X-Mft-Clientstring
X-Mft-User-Idinteger
Path Params
idstring
DELETE /vault_rest/integrations/sftp/{id}
Responses
200

OK

objectobject
Response

Test SFTP Integration Connection

Tests the connection to a specific SFTP integration.

Auth
Headers
X-Mft-User-Idinteger
Path Params
idstring
GET /vault_rest/integrations/sftp/{id}/test_connection
Responses
200

OK

objectobject
successboolean
Response

Read SPOP Integrations

Retrieves a paginated list of SharePoint On-Premise (SPOP) integrations.

Auth
Headers
X-Mft-Clientstring
X-Mft-User-Idinteger
Query String
page_sizestring

Default: 25

page_numstring

Default: 0

GET /vault_rest/integrations/spop
Responses
200

OK

objectobject
Response

Create SPOP Integration

Creates a new SharePoint On-Premise (SPOP) integration configuration.

Auth
Headers
X-Mft-Clientstring
X-Mft-User-Idinteger
Request Body
objectobject
POST /vault_rest/integrations/spop
Responses
201

Created

objectobject
Response

Read SPOP Integration

Retrieves a specific SharePoint On-Premise (SPOP) integration by ID.

Auth
Headers
X-Mft-Clientstring
X-Mft-User-Idinteger
Path Params
idstring
GET /vault_rest/integrations/spop/{id}
Responses
200

OK

objectobject
Response

Update SPOP Integration

Updates an existing SharePoint On-Premise (SPOP) integration.

Auth
Headers
X-Mft-Clientstring
X-Mft-User-Idinteger
Path Params
idstring
Request Body
objectobject
PUT /vault_rest/integrations/spop/{id}
Responses
200

OK

objectobject
Response

Delete SPOP Integration

Deletes a specific SharePoint On-Premise (SPOP) integration.

Auth
Headers
X-Mft-Clientstring
X-Mft-User-Idinteger
Path Params
idstring
DELETE /vault_rest/integrations/spop/{id}
Responses
200

OK

objectobject
Response

Test SPOP Integration Connection

Tests the connection to a specific SharePoint On-Premise (SPOP) integration.

Auth
Path Params
idstring
Request Body
objectobject
POST /vault_rest/integrations/spop/{id}/test_connection
Responses
200

OK

objectobject
Response

Read SPO Integrations

Retrieves a paginated list of SharePoint Online (SPO) integrations.

Auth
Headers
X-Mft-Clientstring
X-Mft-User-Idinteger
Query String
page_sizestring

Default: 25

page_numstring

Default: 0

GET /vault_rest/integrations/spo
Responses
200

OK

objectobject
Response

Create SPO Integration

Creates a new SharePoint Online (SPO) integration configuration.

Auth
Headers
X-Mft-Clientstring
X-Mft-User-Idinteger
Request Body
objectobject
POST /vault_rest/integrations/spo
Responses
201

Created

objectobject
Response

Read SPO Integration

Retrieves a specific SharePoint Online (SPO) integration by ID.

Auth
Headers
X-Mft-Clientstring
X-Mft-User-Idinteger
Path Params
idstring
GET /vault_rest/integrations/spo/{id}
Responses
200

OK

objectobject
Response

Update SPO Integration

Updates an existing SharePoint Online (SPO) integration.

Auth
Headers
X-Mft-Clientstring
X-Mft-User-Idinteger
Path Params
idstring
Request Body
objectobject
PUT /vault_rest/integrations/spo/{id}
Responses
200

OK

objectobject
Response

Delete SPO Integration

Deletes a specific SharePoint Online (SPO) integration.

Auth
Headers
X-Mft-Clientstring
X-Mft-User-Idinteger
Path Params
idstring
DELETE /vault_rest/integrations/spo/{id}
Responses
200

OK

objectobject
Response

Test SPO Integration Connection

Tests the connection to a specific SharePoint Online (SPO) integration.

Auth
Headers
X-Mft-User-Idinteger
Path Params
idstring
Request Body
objectobject
POST /vault_rest/integrations/spo/{id}/test_connection
Responses
200

OK

objectobject
Response

Read SMB Integrations

Retrieves a paginated list of SMB integrations.

Auth
Headers
X-Mft-Clientstring
X-Mft-User-Idinteger
Query String
page_sizestring

Default: 25

page_numstring

Default: 0

GET /vault_rest/integrations/smb
Responses
200

OK

objectobject
Response

Create SMB Integration

Creates a new SMB integration configuration.

Auth
Headers
X-Mft-Clientstring
X-Mft-User-Idinteger
Request Body
objectobject
POST /vault_rest/integrations/smb
Responses
201

Created

objectobject
Response

Read SMB Integration

Retrieves a specific SMB integration by ID.

Auth
Headers
X-Mft-Clientstring
X-Mft-User-Idinteger
Path Params
idstring
GET /vault_rest/integrations/smb/{id}
Responses
200

OK

objectobject
Response

Update SMB Integration

Updates an existing SMB integration.

Auth
Headers
X-Mft-Clientstring
X-Mft-User-Idinteger
Path Params
idstring
Request Body
objectobject
PUT /vault_rest/integrations/smb/{id}
Responses
200

OK

objectobject
Response

Delete SMB Integration

Deletes a specific SMB integration.

Auth
Headers
X-Mft-Clientstring
X-Mft-User-Idinteger
Path Params
idstring
DELETE /vault_rest/integrations/smb/{id}
Responses
200

OK

objectobject
Response

Test SMB Integration Connection

Tests the connection to a specific SMB integration.

Auth
Headers
X-Mft-User-Idinteger
Path Params
idstring
GET /vault_rest/integrations/smb/{id}/test_connection
Responses
200

OK

objectobject
successboolean
Response

Add-In Authenticate

Authenticates the SPO Add-In.

Auth
GET /vault_rest/add_in/spo/authenticate
Responses
200

OK

objectobject
Response

Add-In SSO Token Authenticate

Authenticates the SPO Add-In using an SSO token.

Auth
Request Body
objectobject
POST /vault_rest/add_in/spo/authenticate-sso-token
Responses
200

OK

objectobject
Response

Enumerate SharePoint Users

Enumerates users from SharePoint.

Auth
Path Params
startstring
countstring
GET /vault_rest/add_in/spo/users/{start}/{count}
Responses
200

OK

objectobject
Response

Start Pull File From SharePoint Async

Starts an asynchronous process to pull and share a file from SharePoint.

Auth
Headers
X-Mft-User-Idinteger
Request Body
objectobject
POST /vault_rest/add_in/spo/file/share/async
Responses
200

OK

objectobject
progressIdstring
Response

Get Progress Snapshot

Retrieves the progress snapshot of an asynchronous file pull operation.

Auth
Path Params
progressIdstring
GET /vault_rest/add_in/spo/file/share/progress/{progressId}
Responses
200

OK

objectobject
Response

Get SPO Add-In Config

Retrieves the configuration for the SPO Add-In.

Auth
GET /vault_rest/add_in/spo/config
Responses
200

OK

objectobject
Response

Update SPO Add-In Config

Updates the configuration for the SPO Add-In.

Auth
Request Body
objectobject
POST /vault_rest/add_in/spo/config
Responses
200

OK

No response body
Response

Read SPO Plugin Integrations

Retrieves a paginated list of SharePoint Online Plugin integrations.

Auth
Query String
page_sizestring

Default: 25

page_numstring

Default: 0

GET /vault_rest/integrations/spo_addin
Responses
200

OK

objectobject
Response

Create SPO Plugin Integration

Creates a new SharePoint Online Plugin integration.

Auth
Request Body
objectobject
POST /vault_rest/integrations/spo_addin
Responses
201

Created

objectobject
Response

Read SPO Plugin Integration

Retrieves a specific SharePoint Online Plugin integration by ID.

Auth
Path Params
idstring
GET /vault_rest/integrations/spo_addin/{id}
Responses
200

OK

objectobject
Response

Update SPO Plugin Integration

Updates an existing SharePoint Online Plugin integration.

Auth
Path Params
idstring
Request Body
objectobject
PUT /vault_rest/integrations/spo_addin/{id}
Responses
200

OK

objectobject
Response

Patch SPO Plugin Integration

Partially updates an existing SharePoint Online Plugin integration.

Auth
Path Params
idstring
Request Body
objectobject
PATCH /vault_rest/integrations/spo_addin/{id}
Responses
200

OK

objectobject
Response

Test SPO Plugin Integration Connection

Tests the connection for a SharePoint Online Plugin integration.

Auth
Request Body
objectobject
POST /vault_rest/integrations/spo_addin/test_connection
Responses
200

OK

objectobject
Response

Download SPO Plugin Integration

Downloads the SharePoint Online Plugin integration package.

Auth
Path Params
idstring
GET /vault_rest/integrations/spo_addin/{id}/download
Responses
200

OK

filefile
Response

Read SSH Keys

Retrieves a paginated list of SSH key credentials.

Auth
Headers
X-Mft-Clientstring
X-Mft-User-Idinteger
Query String
page_sizestring

Default: 25

page_numstring

Default: 0

GET /vault_rest/creds/ssh
Responses
200

OK

objectobject
Response

Create SSH Key

Creates a new SSH key credential.

Auth
Headers
X-Mft-Clientstring
X-Mft-User-Idinteger
Request Body
objectobject
POST /vault_rest/creds/ssh
Responses
201

Created

objectobject
Response

Read SSH Key

Retrieves a specific SSH key credential by ID.

Auth
Headers
X-Mft-Clientstring
X-Mft-User-Idinteger
Path Params
idstring
GET /vault_rest/creds/ssh/{id}
Responses
200

OK

objectobject
Response

Update SSH Key

Updates an existing SSH key credential.

Auth
Headers
X-Mft-Clientstring
X-Mft-User-Idinteger
Path Params
idstring
Request Body
objectobject
PUT /vault_rest/creds/ssh/{id}
Responses
200

OK

objectobject
Response

Delete SSH Key

Deletes a specific SSH key credential.

Auth
Headers
X-Mft-Clientstring
X-Mft-User-Idinteger
Path Params
idstring
DELETE /vault_rest/creds/ssh/{id}
Responses
200

OK

objectobject
Response

Get Statistics Config

Auth
GET /vault_rest/statistics/config
Responses
200

OK

objectobject
Response

Update Statistics Config

Auth
Request Body
objectobject
POST /vault_rest/statistics/config
Responses
200

OK

objectobject
Response

Get Outbreak Statistics

Auth
Path Params
typestring
GET /vault_rest/statistics/outbreak/{type}
Responses
200

OK

objectobject
Response

Create Storage

Auth
Request Body
objectobject
POST /vault_rest/settings/storage
Responses
200

OK

objectobject
Response

Get Storage

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

OK

objectobject
Response

Update Storage

Auth
Path Params
idstring
Request Body
objectobject
PUT /vault_rest/settings/storage/{id}
Responses
200

OK

objectobject
Response

Delete Storage

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

OK

objectobject
Response

Enumerate Storages

Auth
GET /vault_rest/settings/storages
Responses
200

OK

objectobject
Response

Get Storage Info

Auth
GET /vault_rest/storage
Responses
200

OK

objectobject
Response

Move Files From Inactive To Active Storage

Auth
Headers
X-MFT-User-Idinteger
Request Body
objectobject
POST /vault_rest/settings/storage/movefiles
Responses
200

OK

objectobject
Response

Move Files From Inactive To Active Storage Internal

Auth
Request Body
objectobject
POST /vault_rest/settings/storage/movefiles_internal
Responses
200

OK

objectobject
Response

Get Move Files Progress

Auth
Path Params
idstring
GET /vault_rest/settings/storage/movefiles/{id}
Responses
200

OK

objectobject
Response

Delete Multiple Container Filters

Deletes multiple container filters.

Auth
Query String
typestring
Request Body
objectobject
DELETE /vault_rest/supervisor/containers
Responses
200

OK

objectobject
Response

Get Container

Retrieves a specific supervisor container.

Auth
Path Params
containerIdstring
Query String
typestring
GET /vault_rest/supervisor/container/{containerId}
Responses
200

OK

objectobject
Response

Delete Container Filters

Deletes filters for a specific container.

Auth
Path Params
containerIdstring
Query String
typestring
DELETE /vault_rest/supervisor/container/{containerId}
Responses
200

OK

objectobject
Response

Enumerate Available Users From Container

Enumerates available users from a specific container.

Auth
Path Params
containerIdstring
startstring
countstring
Query String
typestring
Request Body
objectobject
POST /vault_rest/supervisor/container/available_users/{containerId}/{start}/{count}
Responses
200

OK

objectobject
Response

Enumerate Containers

Enumerates supervisor containers.

Auth
Path Params
activeDirectoryIdstring
startstring
countstring
Query String
typestring
GET /vault_rest/supervisor/containers/{activeDirectoryId}/{start}/{count}
Responses
200

OK

objectobject
Response

Update Container

Updates a supervisor container.

Auth
Query String
typestring
Request Body
objectobject
POST /vault_rest/supervisor/container
Responses
200

OK

objectobject
Response

Get Delegate

Retrieves the current supervisor delegation.

Auth
GET /vault_rest/supervisor/delegate
Responses
200

OK

objectobject
Response

Update Delegate

Updates a supervisor delegation.

Auth
Request Body
objectobject
PUT /vault_rest/supervisor/delegate
Responses
200

OK

objectobject
Response

Delegate

Creates a supervisor delegation.

Auth
Request Body
objectobject
POST /vault_rest/supervisor/delegate
Responses
200

OK

objectobject
Response

Get Delegate Candidates

Retrieves candidates for supervisor delegation.

Auth
Path Params
startstring
countstring
Request Body
objectobject
POST /vault_rest/supervisor/delegate/candidates/{start}/{count}
Responses
200

OK

objectobject
Response

Check Delegate

Checks the status of a supervisor delegation.

Auth
GET /vault_rest/supervisor/delegate/check
Responses
200

OK

objectobject
Response

Enumerate Groups To Container

Enumerates available groups to a specific container.

Auth
Path Params
containerIdstring
startstring
countstring
Query String
typestring
Request Body
objectobject
POST /vault_rest/supervisor/container/available_groups/{containerId}/{start}/{count}
Responses
200

OK

objectobject
Response

Get All Restricted Supervisors

Retrieves all restricted supervisors.

Auth
Path Params
typestring
startstring
countstring
GET /vault_rest/supervisor/restricted/all/{type}/{start}/{count}
Responses
200

OK

objectobject
Response

Get All Regular Supervisors

Retrieves all regular supervisors.

Auth
Path Params
typestring
startstring
countstring
GET /vault_rest/supervisor/regular/all/{type}/{start}/{count}
Responses
200

OK

objectobject
Response

Add All To Restricted Supervisors

Adds all users to restricted supervisors.

Auth
PUT /vault_rest/supervisor/restricted/all
Responses
200

OK

objectobject
Response

Add All To Regular Supervisors

Adds all users to regular supervisors.

Auth
PUT /vault_rest/supervisor/regular/all
Responses
200

OK

objectobject
Response

Add To Restricted Supervisors

Adds specific users to restricted supervisors.

Auth
Request Body
objectobject
PUT /vault_rest/supervisor/restricted
Responses
200

OK

objectobject
Response

Add To Regular Supervisors

Adds specific users to regular supervisors.

Auth
Request Body
objectobject
PUT /vault_rest/supervisor/regular
Responses
200

OK

objectobject
Response

Get Supervisor Configuration List

Retrieves the list of supervisor configurations.

Auth
GET /vault_rest/settings/supervisor
Responses
200

OK

objectobject
Response

Update Supervisor Feature

Updates a supervisor feature configuration.

Auth
Request Body
objectobject
POST /vault_rest/settings/supervisor
Responses
200

OK

objectobject
Response

Get Supervisor Configuration

Retrieves a specific supervisor configuration by type.

Auth
Path Params
typestring
GET /vault_rest/settings/supervisor/{type}
Responses
200

OK

objectobject
Response

Update Supervisor Configuration

Updates a draft supervisor configuration.

Auth
Request Body
objectobject
PUT /vault_rest/settings/supervisor/draft
Responses
200

OK

objectobject
Response

Create Supervisor Configuration

Creates a draft supervisor configuration.

Auth
Request Body
objectobject
POST /vault_rest/settings/supervisor/draft
Responses
200

OK

objectobject
Response

Remove Supervisor Configuration

Removes a draft supervisor configuration.

Auth
Request Body
objectobject
DELETE /vault_rest/settings/supervisor/draft
Responses
200

OK

objectobject
Response

Lock Supervisor Configuration

Locks a draft supervisor configuration.

Auth
Request Body
objectobject
POST /vault_rest/settings/supervisor/draft/lock
Responses
200

OK

objectobject
Response

Unlock Supervisor Configuration

Unlocks a draft supervisor configuration.

Auth
Request Body
objectobject
POST /vault_rest/settings/supervisor/draft/unlock
Responses
200

OK

objectobject
Response

Log Supervisor Configuration Edit Activity

Logs edit activity for a supervisor configuration.

Auth
Request Body
objectobject
POST /vault_rest/settings/supervisor/draft/activity
Responses
200

OK

objectobject
Response

Get Global Supervisor Active

Retrieves the active status of the global supervisor.

Auth
GET /vault_rest/settings/supervisor/globalsupervisor_active
Responses
200

OK

objectobject
Response

Extend Authentication Token

Summary ## Extends the expiration time of the current authentication token.

Auth
Request Body
objectobject
PUT /vault_rest/token
Responses
200

OK

objectobject
Response

Create Authentication Token

Summary ## Creates a new authentication token.

Auth
Request Body
objectobject
POST /vault_rest/token
Responses
200

OK

objectobject
Response

Delete Authentication Token

Summary ## Deletes a specific authentication token.

Auth
Request Body
objectobject
DELETE /vault_rest/token
Responses
200

OK

objectobject
Response

Extend Personal Authentication Token

Summary ## Extends the expiration time of a personal authentication token.

Auth
Request Body
objectobject
PUT /vault_rest/token/personal
Responses
200

OK

objectobject
Response

Create Personal Authentication Token

Summary ## Creates a new personal authentication token.

Auth
Request Body
objectobject
POST /vault_rest/token/personal
Responses
200

OK

objectobject
Response

Delete Personal Authentication Token

Summary ## Deletes a specific personal authentication token.

Auth
Request Body
objectobject
DELETE /vault_rest/token/personal
Responses
200

OK

objectobject
Response

Extend Idle Session

Summary ## Extends the current idle session.

Auth
GET /vault_rest/token/extend_session
Responses
200

OK

objectobject
Response

Generate Authentication Token

Summary ## Generates a new authentication token string.

Auth
GET /vault_rest/tokens/generate
Responses
200

OK

stringstring
Response

Generate Personal Authentication Token

Summary ## Generates a new personal authentication token string.

Auth
GET /vault_rest/tokens/generate/personal
Responses
200

OK

stringstring
Response

Enumerate Authentication Tokens

Summary ## Retrieves a paginated list of authentication tokens.

Auth
Path Params
startstring
countstring
GET /vault_rest/tokens/{start}/{count}
Responses
200

OK

objectobject
Response

Enumerate Personal Authentication Tokens

Summary ## Retrieves a paginated list of personal authentication tokens.

Auth
Path Params
startstring
countstring
GET /vault_rest/tokens/personal/{start}/{count}
Responses
200

OK

objectobject
Response

Recycle Authentication Token

Summary ## Recycles the current authentication token.

Auth
POST /vault_rest/token/recycle
Responses
200

OK

objectobject
Response

Create Trusted Forwarder

Auth
Request Body
objectobject
POST /vault_rest/trusted-forwarders
Responses
200

OK

objectobject
Response

Update Trusted Forwarder

Auth
Path Params
trustedForwarderIdstring
Request Body
objectobject
PUT /vault_rest/trusted-forwarders/{trustedForwarderId}
Responses
200

OK

objectobject
Response

Delete Trusted Forwarder

Auth
Path Params
trustedForwarderIdstring
DELETE /vault_rest/trusted-forwarders/{trustedForwarderId}
Responses
200

OK

objectobject
Response

Get Trusted Forwarders

Auth
Path Params
startstring
countstring
GET /vault_rest/trusted-forwarders/{start}/{count}
Responses
200

OK

objectobject
Response

Get User Language

Retrieves the language preference of the current user.

Auth
GET /vault_rest/userlanguage
Responses
200

OK

objectobject
Response

Set User Language

Sets the language preference for the current user.

Auth
Path Params
languageTagstring
PUT /vault_rest/userlanguage/{languageTag}
Responses
200

OK

objectobject
Response

Get User Configuration

Retrieves the configuration for the specified user.

Auth
Headers
x-mft-user-idinteger
GET /vault_rest/account/userconfig
Responses
200

OK

stringstring
Response

Set User Configuration

Sets the configuration for the specified user.

Auth
Headers
x-mft-user-idinteger
Request Body
objectobject
PUT /vault_rest/account/userconfig
Responses
201

Created

objectobject
Response

Delete User Configuration

Deletes the configuration for the specified user.

Auth
Headers
x-mft-user-idinteger
DELETE /vault_rest/account/userconfig
Responses
200

OK

stringstring
Response

Get User Groups

Retrieves the groups associated with the current user.

Auth
GET /vault_rest/account/groups
Responses
200

OK

objectobject
Response

Get Self

Retrieves the account details of the currently authenticated user.

Auth
GET /vault_rest/account
Responses
200

OK

objectobject
Response

Update Self

Updates the account details of the currently authenticated user.

Auth
Request Body
objectobject
PUT /vault_rest/account
Responses
200

OK

objectobject
Response

Create Account

Creates a new user account.

Auth
Request Body
objectobject
POST /vault_rest/account
Responses
200

OK

objectobject
Response

Get Account

Retrieves the details of a specific user account.

Auth
Path Params
userIdstring
GET /vault_rest/account/{userId}
Responses
200

OK

objectobject
Response

Update Account

Updates the details of a specific user account.

Auth
Path Params
userIdstring
Request Body
objectobject
PUT /vault_rest/account/{userId}
Responses
200

OK

objectobject
Response

Delete Account

Deletes a specific user account.

Auth
Path Params
userIdstring
DELETE /vault_rest/account/{userId}
Responses
200

OK

objectobject
Response

Get Account By Email Or Username

Retrieves account details using an email address or username.

Auth
Path Params
emailOrUsernamestring
GET /vault_rest/account/username/{emailOrUsername}
Responses
200

OK

objectobject
Response

Reset User MFA

Resets the Multi-Factor Authentication configuration for a specific user.

Auth
Path Params
userIdstring
PUT /vault_rest/account/resetmfa/{userId}
Responses
200

OK

objectobject
Response

Update Account Workflows

Updates the workflow settings for an account.

Auth
Request Body
objectobject
PUT /vault_rest/account/workflow
Responses
200

OK

objectobject
Response

Update Account Status

Updates the status (e.g., active, disabled) of a specific user account.

Auth
Path Params
userIdstring
statusstring
PUT /vault_rest/account/{userId}/{status}
Responses
200

OK

objectobject
Response

Delete Accounts

Deletes multiple user accounts in bulk.

Auth
Request Body
objectobject
DELETE /vault_rest/accounts
Responses
200

OK

objectobject
Response

Enumerate Accounts

Enumerates user accounts with pagination and type filtering.

Auth
Path Params
typestring
startstring
countstring
GET /vault_rest/accounts/{type}/{start}/{count}
Responses
200

OK

objectobject
Response

Enumerate AD Accounts

Enumerates Active Directory accounts with pagination.

Auth
Path Params
idstring
startstring
countstring
GET /vault_rest/accounts/ad/{id}/{start}/{count}
Responses
200

OK

objectobject
Response

Enumerate Users To Share Files With

Retrieves a list of users that the current user can share files with.

Auth
Query String
typestring
startstring
countstring
searchstring
fileidstring
folderidstring
GET /vault_rest/account/tosharefiles
Responses
200

OK

objectobject
Response

Enumerate Users

Enumerates all users with pagination.

Auth
Path Params
startstring
countstring
GET /vault_rest/users/{start}/{count}
Responses
200

OK

objectobject
Response

Update Managed Account

Updates a managed user account.

Auth
Path Params
userIdstring
Request Body
objectobject
PUT /vault_rest/manageduser/{userId}
Responses
200

OK

objectobject
Response

Import User Notification Emails

Imports notification email addresses for users.

Auth
Request Body
objectobject
POST /vault_rest/account/import/notification_emails
Responses
200

OK

objectobject
Response

Search Users By Name

Searches for users by their name.

Auth
Request Body
objectobject
POST /vault_rest/users/search
Responses
200

OK

objectobject
Response

Search Users By Email And Subject

Searches for users by email and subject.

Auth
Request Body
objectobject
POST /vault_rest/users/search/email-subject
Responses
200

OK

objectobject
Response

Search Users By Subject

Searches for users by subject.

Auth
Request Body
objectobject
POST /vault_rest/users/search/subject
Responses
200

OK

objectobject
Response

Export Users

Exports user accounts.

Auth
Headers
x-mft-clientstring
x-mft-user-idinteger
archivepwdstring
GET /vault_rest/account/export
Responses
200

OK

filefile
Response

Get Vault To Vault Settings

Auth
GET /vault_rest/settings/vault_to_vault
Responses
200

OK

objectobject
Response

Update Vault To Vault Settings

Auth
Request Body
objectobject
POST /vault_rest/settings/vault_to_vault
Responses
200

OK

objectobject
Response

Get All Operation Modes

Auth
GET /vault_rest/settings/vault_to_vault/operation_modes
Responses
200

OK

objectobject
Response

Get All Vault Sites

Auth
GET /vault_rest/settings/vault_to_vault/targets
Responses
200

OK

objectobject
Response

Update Vault Sites

Auth
Request Body
objectobject
POST /vault_rest/settings/vault_to_vault/targets
Responses
200

OK

objectobject
Response

Delete Vault Sites

Auth
Request Body
objectobject
DELETE /vault_rest/settings/vault_to_vault/targets
Responses
200

OK

objectobject
Response

Get Available Vault Sites

Auth
GET /vault_rest/settings/vault_to_vault/available_targets
Responses
200

OK

objectobject
Response

Get MFT Filter

Auth
Path Params
idstring
GET /vault_rest/settings/vault_to_vault/target/{id}/filter
Responses
200

OK

objectobject
Response

Update MFT Filter

Auth
Path Params
idstring
Request Body
objectobject
PUT /vault_rest/settings/vault_to_vault/target/{id}/filter
Responses
200

OK

objectobject
Response

Get MFT Status

Auth
Path Params
idstring
GET /vault_rest/settings/vault_to_vault/target/{id}/status
Responses
200

OK

objectobject
Response

Get Vault File Sync Targets

Auth
GET /vault_rest/settings/vault_to_vault/synced_targets
Responses
200

OK

objectobject
Response

Get Discovery

Auth
GET /vault_rest/settings/vault_to_vault/discovery
Responses
200

OK

objectobject
Response

Add Discovery

Auth
Request Body
objectobject
POST /vault_rest/settings/vault_to_vault/discovery
Responses
200

OK

objectobject
Response

Modify Discovery

Auth
Path Params
idstring
Request Body
objectobject
PUT /vault_rest/settings/vault_to_vault/discovery/{id}
Responses
200

OK

objectobject
Response

Delete Discovery

Auth
Path Params
idstring
DELETE /vault_rest/settings/vault_to_vault/discovery/{id}
Responses
200

OK

objectobject
Response

Generate Manifest File

Auth
GET /vault_rest/vpack/manifest
Responses
200

OK

filefile
Response

Get VPack File Entry

Auth
Path Params
fileNamestring
GET /vault_rest/vpack/{fileName}
Responses
200

OK

filefile
Response

Get VPack Config

Auth
Path Params
configTypestring
GET /vault_rest/vpack-config/{configType}
Responses
200

OK

filefile
Response

Update VPack Config

Auth
Path Params
configTypestring
Request Body
objectobject
PUT /vault_rest/vpack-config/{configType}
Responses
200

OK

objectobject
Response

Get VPack Managed

Auth
GET /vault_rest/admin/manage
Responses
200

OK

objectobject
Response

Set Instance To VPack Managed

Auth
POST /vault_rest/admin/manage
Responses
200

OK

objectobject
Response

Remove Instance As VPack Managed

Auth
DELETE /vault_rest/admin/manage
Responses
200

OK

objectobject
Response

Update OCM Show At Startup Setting

Auth
Request Body
objectobject
PUT /vault_rest/admin/update
Responses
200

OK

objectobject
Response