Developer Guide
This is the API documentation for MetaDefender Sandbox. If you would like to evaluate or have any questions about this documentation, please contact us via our Contact Us form.
Scan
Upload file or URL resource for scan
Scan File
Perform scan of uploaded file
Successful Response
Bad request
Not authorized
Forbidden
Content too large
Validation Error
Too many requests
Scan URL
Scan URL resource
Successful Response
Bad request
Not authorized
Forbidden
Validation Error
Too many requests
Save Scan Profile
Add/edit scan profile
Successful Response
Validation Error
Remove Scan Profile
Remove scan profile
Successful Response
Validation Error
Reports
Retrieve a variety of report related data
Get Chat Gpt SummaryDeprecated
Request ChatGPT summary on report
Successful Response
Bad request
Item not found
Validation Error
Get All Files
Obtain all files for given report
Successful Response
Item not found
Validation Error
Start Report Format Creation
Start creation of HTML or PDF formated report
Successful Response
Item not found
Validation Error
Download Export Formats
Download the report in HTML, PDF, MISP and STIX format
Successful Response
Accepted
No content
Bad request
Item not found
Request timeout
Validation Error
Internal server error
Get Downloads List
Get list of all reports downloads by current user
Successful Response
Validation Error
Internal server error
Get Specific Report
Obtain a report for given report_id.
Successful Response
Bad request
Item not found
Validation Error
Get Pe Emulation File
Get PE emulation files
Successful Response
Item not found
Validation Error
Advanced Search
Search for reports and uploaded files by various tokens, like hash, filename, verdict, IOCs etc.
Successful Response
Bad request
Validation Error
Simple Search
Search for reports and uploaded files by various tokens, like hash, filename, verdict, IOCs etc. Simple search only uses the query param (and some other defaults), other params are ignored.
Successful Response
Bad request
Validation Error
Get Public Reports
Get all public reports
Successful Response
Bad request
Not authorized
Validation Error
Get User Reports
Get reports of current user
Successful Response
Bad request
Not authorized
Validation Error
Get User Reports Links
Get links of all user's reports as a .CSV file.
In case of no reports for selected time frame empty response is returned.
Successful Response
Bad request
Not authorized
Validation Error
Get Frequent Tags
Get most frequently seen tags recently
Successful Response
Not authorized
Get Most Interesting
Get most interesting report recently
Successful Response
Not authorized
Files
Get a file by its hash or id in various format
Get Single File
Obtain single file for given report by hash
Successful Response
Item not found
Validation Error
Download Samples Archive
Download an archive file
Successful Response
Not authorized
Forbidden
Item not found
Validation Error
Download Samples ArchiveDeprecated
Download an archive file
Successful Response
Not authorized
Forbidden
Item not found
Validation Error
Get Reports Feed
Get reports feed.
For API documentation page we show smaller amount of reports. To get full feed, query feed endpoint directly from browser address bar or from any suitable app.
Successful Response
Not authorized
Get Reports FeedDeprecated
Get reports feed.
For API documentation page we show smaller amount of reports. To get full feed, query feed endpoint directly from browser address bar or from any suitable app.
Successful Response
Not authorized
Get Reports Feed Info
Get reports feed info
Successful Response
Not authorized
Get Reports Feed InfoDeprecated
Get reports feed info
Successful Response
Not authorized
Get Daily Samples Archives
Get daily samples
Successful Response
Not authorized
Get Daily Samples ArchivesDeprecated
Get daily samples
Successful Response
Not authorized
Get Yara Feed
Get YARA rules feed
Successful Response
Not authorized
Get Yara Feed Info
Get YARA rules feed info
Successful Response
Not authorized
Get Daily Yara Archives
Get daily YARA rules, generated for malicious reports
Successful Response
Not authorized
Download Yara Archive
Get daily YARA rules archive
Successful Response
Not authorized
Forbidden
Item not found
Validation Error
Users
Report-related and other functionality used by ordinary users.
Get Current User
Get user model of currently authenticated user
Successful Response
Get Profile
Get user profile data
Successful Response
Not authorized
Post Profile
Update user profile data
Successful Response
Bad request
Not authorized
Unsupported media type
Validation Error
Internal server error
Reset Timezone Locale
Reset user timezone and locale settings
Successful Response
Not authorized
Get Avatar Image
Get use avatar image
Successful Response
Not authorized
Item not found
Validation Error
Create API Key
Create API key for current user
Successful Response
Bad request
Not authorized
Set API key
Set API key for current user
Successful Response
Bad request
Not authorized
Validation Error
Remove API Key
Remove user's API key
Successful Response
Not authorized
Item not found
Mark notification as viewed by user
Mark notification as viewed by user
Successful Response
Not authorized
Validation Error
Delete Report
Delete a report
Users can only delete their own reports
Successful Response
Not authorized
Forbidden
Item not found
Validation Error
Get Public ReportsDeprecated
Get all public reports
Successful Response
Bad request
Not authorized
Validation Error
Get User ReportsDeprecated
Get reports of current user
Successful Response
Bad request
Not authorized
Validation Error
Get User Stat
Get app statistics for current user or for all users
Successful Response
Not authorized
Forbidden
Validation Error
Get User Generic Stat
Get app statistics not related to specific user
Successful Response
Bad request
Not authorized
Forbidden
Validation Error
Get Malicious Ips Stat
Get statistics on malicious IPs
Successful Response
Bad request
Not authorized
Validation Error
Get Ioc Stat
Get app statistics
Successful Response
Not authorized
Get Yara Stat
Get yara statistics
Successful Response
Not authorized
Get Mitre Stat
Get statistics on MITRE techniques used in reports
Successful Response
Not authorized
Get Yara Info
Get yara repo info
Successful Response
Not authorized
System
Various helper and system functionality.
Get Default
Return general information about webservice, just to indicate that API is working
Successful Response
Get Version
Return the version of the webservice
Successful Response
Get Config
Obtain project configuration to use on front-end
Successful Response
Get Terms
Obtain privacy policy and terms & conditions
Successful Response
Item not found
Validation Error
Get Signal Groups
Obtain signal groups list
Successful Response
Not authorized
Get Mime Types
Obtain mime type list
Successful Response
Not authorized
Get Yara Rules
Get extended data of yara rules
If the name parameter is left empty, it returns the list of yara rules that already has a match in the system.
Otherwise it will return a list of yara rules where the yara rule name matches the name parameter even if the yara rule has no match in the system.
Successful Response
Not authorized
Validation Error
Get Yara Authors
Get yara rules authors
If the name parameter is left empty, it returns the list of yara rule authors that already has a match in the system.
Otherwise it will return a list of yara rule authors where the yara rule name matches the name parameter even if the yara rule has no match in the system.
Successful Response
Not authorized
Validation Error
Get Translations
Obtain translations for specific language
Successful Response
Validation Error
Get Languages
Obtain list of all detectable (and probably even more) languages
Successful Response
Item not found
Get Countries
Obtain list of all countries
Successful Response
Item not found
Get Mitre Data
Obtain MITRE tactics and techniques
Successful Response
Item not found
Log Client Error
Log frontend cliend errors
Successful Response
Bad request
Get Logo
Get logo image
Successful Response
Item not found
Validation Error
Do Healthcheck
Do an immediate healthcheck and return the state
Successful Response
Not authorized
Query Healthcheck
Query past healthcheck logs
Successful Response
Not authorized
Validation Error
Query Healthcheck
Query sanitized past healthcheck logs
Successful Response
Validation Error
Check License Info
Get license information
Successful Response
Not authorized
Activate License Online
Activate license online, using license key
Successful Response
Bad request
Not authorized
Validation Error
Activate License Offline
Activate license, using license file
Successful Response
Bad request
Not authorized
Validation Error
Deactivate License
Deactivate license
Successful Response
Not authorized
Item not found
Validation Error
Internal server error
Reputation Check Config
Check if MD Cloud Reputation is enabled
If in the /reputation-config opswatReputationAPIKeySource value FALLBACK, it returns False.
If opswatReputationAPIKeySource is LICENSE or USER, it returns True
Successful Response
Get News
Get news
Successful Response
Admin
Functionality for site admins.
Get Report
Get reports in raw format
Successful Response
Bad request
Item not found
Validation Error
Save News Item
Save news item data
Successful Response
Bad request
Not authorized
Item not found
Validation Error
Remove News Item
Remove news item
Successful Response
Bad request
Not authorized
Item not found
Validation Error
Delete ReportDeprecated
Delete a report
Users can only delete their own reports
Successful Response
Not authorized
Forbidden
Item not found
Validation Error
Get Access Groups
Get a list of all access groups
Successful Response
Not authorized
Save Access Group
Add or edit group.
Note: ID is a required parameter to modify a group
Successful Response
Bad request
Not authorized
Item not found
Validation Error
Remove Access Group
Remove group
Successful Response
Bad request
Not authorized
Item not found
Validation Error
Get Api Quota
Get all api quota settings
Successful Response
Not authorized
Save Api Quota
Save single API quota setting
Successful Response
Bad request
Not authorized
Validation Error
Remove Api Quota
Remove single api quota setting
Successful Response
Bad request
Not authorized
Item not found
Validation Error
Get Settings Group
Get a group of admin settings
Successful Response
Not authorized
Validation Error
Save Settings Group
Update group of admin settings
Successful Response
Bad request
Not authorized
Validation Error
Get Auth Services
Get all external auth services settings
Successful Response
Not authorized
Save Auth Service
Update settings of external auth service
Successful Response
Bad request
Not authorized
Validation Error
Remove Auth Service
Remove external auth service settings
Successful Response
Not authorized
Validation Error
Get Users
Get list of users.
Use filter parameter to find users by email or username. It will match in any part of a word.
If ids parameter is specified, filter is ignored.
Successful Response
Not authorized
Validation Error
Get Users Overview
Download basic users info as csv file
Successful Response
Not authorized
Get User
Get user by user id
Successful Response
Bad request
Not authorized
Item not found
Validation Error
Edit User
Edit user
Successful Response
Bad request
Not authorized
Item not found
Validation Error
Delete User
Delete a user
Successful Response
Not authorized
Item not found
Validation Error
Get User Uploads
Get user's uploads
Successful Response
Not authorized
Validation Error
Get User Reset Password Link
Generate user's reset-password link
Successful Response
Not authorized
Validation Error
Get App Config
Get app basic config values
Successful Response
Not authorized
Get Services Stat
Get statistics of various running services
Successful Response
Not authorized
Generate Invite Token
Generate invitation token for user
Successful Response
Not authorized
Validation Error
Generate External Tokens Secret
Generate secret key to encript external auth tokens
Successful Response
Not authorized
Get App Errors
Obtain saved errors
Params:
- type - can be 'server' or 'client'
- page - (default: 1)
- filter - match the given string to error message
- sort - can be 'date', 'count' or 'note'
Successful Response
Bad request
Not authorized
Validation Error
Remove App Errors
Remove saved errors matching filter
Params:
- type - can be 'server' or 'client'
- filter - match the given string to error message
Successful Response
Bad request
Not authorized
Validation Error
App Error
Remove single saved error
Successful Response
Bad request
Not authorized
Validation Error
Edit App Error Note
Edit saved error note, to help memorize it's specifics
Successful Response
Bad request
Not authorized
Validation Error
Export Errors
Export application errors in a .csv format
Successful Response
Not authorized
Get Generic Logs
Obtain custom logs, usually aimed to trace problems
Params:
- page - (default: 1)
- filter - match the given string to the 'key' and the beginning of the 'related_url' and 'note' fields
- sort - can be 'date' or 'note'
Successful Response
Bad request
Not authorized
Validation Error
Remove Generic Logs
Remove custom logs matching filter
Params:
- filter - match the given string to the 'key' and the beginning of the 'related_url' and 'note' fields
Successful Response
Bad request
Not authorized
Validation Error
Calculate Retention
Calculate affected number of reports by retention config changes
Successful Response
Not authorized
Validation Error
Get Full Generic Log
Obtain full log record data
Successful Response
Bad request
Not authorized
Item not found
Validation Error
Remove Generic Log
Remove single log record
Successful Response
Bad request
Not authorized
Validation Error
Edit Generic Log Note
Edit log note, to help memorize it's specifics
Successful Response
Bad request
Not authorized
Validation Error
Get Logos List
Get list of all available logos
Successful Response
Not authorized
Select Logo
Select new logo
Successful Response
Not authorized
Validation Error
Get Stat
Get app statistics
Successful Response
Bad request
Not authorized
Forbidden
Validation Error
Get Daily Stat
Get app statistics, which is saved separately in daily stat collection
Successful Response
Bad request
Not authorized
Validation Error
Get Jobs
Get all available jobs with some additional information
Successful Response
Not authorized
Validation Error
Get Jobs Config
Get jobs launch and runtime config
Successful Response
Not authorized
Validation Error
Get Jobs Memory Peaks
Get peak jobs memory usage
Successful Response
Not authorized
Get Job Memory Details
Get job memory usage details
Successful Response
Not authorized
Validation Error
Edit Job Config
Edit job config
Successful Response
Bad request
Not authorized
Forbidden
Item not found
Validation Error
Get Job Log
Get job public log
Successful Response
Not authorized
Item not found
Validation Error
Stop All Jobs
Stop all existing jobs
Successful Response
Not authorized
Enable All Jobs
Enable all existing jobs
Successful Response
Not authorized
Get Scan Jobs Health
Get health statistics about scan jobs queues
Successful Response
Not authorized
Validation Error
Get Scans States
Get statistics on scans progress
Successful Response
Bad request
Not authorized
Validation Error
Get User Daily Stat
Get app statistics, which is saved separately in daily stat collection, available for ordinary users
Successful Response
Bad request
Not authorized
Validation Error
Get Emails History
Get history of sending mass emails
Successful Response
Not authorized
Validation Error
Add Email Queue Item
Add record to emails queue
Successful Response
Not authorized
Validation Error
Get Emails Templates
Get predefined email templates
Successful Response
Not authorized
Get Files
Get list of files obtained from scan sources
Successful Response
Not authorized
Validation Error
Get Scan Sources Configs
Obtain scan sources config records
Successful Response
Not authorized
Validation Error
Edit Scan Source Config
Add or edit scan source config record
Successful Response
Bad request
Not authorized
Item not found
Validation Error
Remove Scan Sources Config
Remove scan sources configs records by id
Note: This will also remove scan source files from the database. The quick overview and verdicts of these files won't be available in the Admin Panel anymore. The scan results will only remain accessible from standard reports search.
Successful Response
Validation Error
Check Scan Source Connection
Verify if scan source credentials are working ok
Successful Response
Not authorized
Item not found
Validation Error
Get Scan Sources Jobs State
Get state of scan sources handlers
Successful Response
Not authorized
Validation Error
Get Full Scan Source Subjob State
Obtain full scan source job record data
Successful Response
Bad request
Not authorized
Item not found
Validation Error
Audit-logger
Audit Logger
Get Audit Logs
Obtain saved audit logs
Successful Response
Bad request
Not authorized
Validation Error
Get prevalence of IOCs
Get prevalences of IOCs
Successful Response
Bad request
Not authorized
Validation Error
Modify verdict for a given report
Modify verdict for a given report
Successful Response
Not authorized
Item not found
Validation Error
Get reports with the same special hashes (fuzzyfsio, imphash, ssdeep, authentihash)
Get reports with the same special hashes
Successful Response
Bad request
Not authorized
Validation Error
Get feeds with more data
Get advanced feed containing all IOCs and signatures compared to the basic feed
Successful Response
Not authorized
Download iocs of reports in csv format
Download iocs of all reports
Successful Response
Not authorized
Validation Error