MetaDefender Sandbox API Reference 2.0

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.

Authentication

apiKey apiKey

Fields

Key	In
X-Api-Key	Header

Scan

Upload file or URL resource for scan

/api/scan/{flow_id}/report

Scan File

Perform scan of uploaded file

Auth

Request Body

Body_scan_file_api_scan_file_post	object
file	file
save_preset	boolean	Default: false
description	string	Uploaded file/url description
tags	string	Tags array to propagate
propagate_tags	boolean	If tags from description should be added to produced report(s) Default: true
password	string	Custom password, in case uploaded archive is protected
is_private	boolean	If file should not be available for download by other users Default: false
skip_whitelisted	boolean	If file is detected as whitelisted, report is not created Default: false
rapid_mode	boolean	Disable some scan long-running features Default: false
osint	boolean	Enable OSINT (e.g. VirusTotal, ClamAV) lookups Default: true
extended_osint	boolean	Enable OSINT lookups on extracted IOCs Default: true
extracted_files_osint	boolean	Enable OSINT lookups on extracted files Default: true
visualization	boolean	Enable file visualization (e.g. PDF rendering) Default: true
files_download	boolean	Enable download of files from extracted URLs Default: true
resolve_domains	boolean	Enable resolving domains to IPs (DNS) Default: true
input_file_yara	boolean	Enable YARA rule matches on input file Default: true
extracted_files_yara	boolean	Enable YARA rule matches on extracted files Default: true
whois	boolean	Enable WHOIS record lookups Default: true
ips_meta	boolean	Enable meta-data lookups for extracted IPs Default: true
images_ocr	boolean	Enable OCR text recognition on extracted images Default: true

POST /api/scan/file

 --url 'https://opswat.developerhub.io/api/scan/file' \
 
Copy

Responses

200

Successful Response

ScanResponse	object	Model for an initiated scan response
flow_id	string
priority	object	Priority part of the scan respoms model
applied	integer
max_posibble	integer
note	string

400

Bad request

401

Not authorized

403

Forbidden

422

Validation Error

429

Too many requests

Response

 "flow_id": "66f1905b318df2831b854ce5",
 
Copy

Scan URL

Scan URL resource

Auth

Request Body

Body_scan_file_api_scan_url_post	object
save_preset	boolean	Default: false
url	string	Url of internet resource to be scanned
description	string	Uploaded file/url description
tags	string	Tags array to propagate
propagate_tags	boolean	If tags from description should be added to produced report(s) Default: true
password	string	Custom password, in case uploaded archive is protected
is_private	boolean	If file should not be available for download by other users Default: false
skip_whitelisted	boolean	If file is detected as whitelisted, report is not created Default: false
rapid_mode	boolean	Disable some scan long-running features Default: false
osint	boolean	Enable OSINT (e.g. VirusTotal, ClamAV) lookups Default: true
extended_osint	boolean	Enable OSINT lookups on extracted IOCs Default: true
extracted_files_osint	boolean	Enable OSINT lookups on extracted files Default: true
visualization	boolean	Enable file visualization (e.g. PDF rendering) Default: true
files_download	boolean	Enable download of files from extracted URLs Default: true
resolve_domains	boolean	Enable resolving domains to IPs (DNS) Default: true
input_file_yara	boolean	Enable YARA rule matches on input file Default: true
extracted_files_yara	boolean	Enable YARA rule matches on extracted files Default: true
whois	boolean	Enable WHOIS record lookups Default: true
ips_meta	boolean	Enable meta-data lookups for extracted IPs Default: true
images_ocr	boolean	Enable OCR text recognition on extracted images Default: true

POST /api/scan/url

 --url 'https://opswat.developerhub.io/api/scan/url' \
 
Copy

Responses

200

Successful Response

ScanResponse	object	Model for an initiated scan response
flow_id	string
priority	object	Priority part of the scan respoms model
applied	integer
max_posibble	integer
note	string

400

Bad request

401

Not authorized

403

Forbidden

422

Validation Error

429

Too many requests

Response

 "flow_id": "66f1905b318df2831b854ce5",
 
Copy

Reports

Retrieve a variety of report related data

GET

/api/reports/{report_id}/chat-gpt

GET

/api/reports/{report_id}/files

GET

/api/reports/{report_id}/download

GET

/api/reports/{report_id}/{file_hash}

GET

/api/reports/advanced-search

GET

/api/reports/search

GET

/api/users/get-frequent-tags

GET

/api/users/most-interesting

Get Chat Gpt Summary

Request ChatGPT summary on report

Auth

Path Params

report_id string

GET /api/reports/{report_id}/chat-gpt

 --url 'https://opswat.developerhub.io/api/reports/{report_id}/chat-gpt' \
 
Copy

Responses

200

Successful Response

ChatGptSummary	object	Summary generated for report by ChatGPT
data	string	Summary itself
created_date	date-time	Time of summary generation

400

Bad request

404

Item not found

422

Validation Error

Response

 "data": "- Data Manipulation: The malware has the ability to change files and their attributes, which can lead to the concealment of its activities or the modification of legitimate files.",
 
Copy

Get All Files

Obtain all files for given report

Auth

Path Params

report_id string

Query String

type

Default: all

with_content

boolean

Compressed base64 data

Default: false

GET /api/reports/{report_id}/files

 --url 'https://opswat.developerhub.io/api/reports/{report_id}/files' \
 
Copy

Responses

200

Successful Response

ReportAllFilesResponse	array[object]
id	string
hash	string
size	integer
mediaType	string
type	string	Smaller set of ReportFileType for the get_all_files() endpoint Enum: `all`,`extracted`,`downloaded`

404

Item not found

422

Validation Error

Response

  "hash": "38cd7b61b24fa1124f13365d74e45f05ac8f1cf99119a3efaaf861e8d935e695",
 
Copy

Download Export Formats

Download the report in HTML, PDF, MISP and STIX format

Auth

Path Params

report_id

string

Report Id

Query String

format

string

Enum: misp,stix,html,pdf

GET /api/reports/{report_id}/download

 
curl --get \ --url 'https://opswat.developerhub.io/api/reports/{report_id}/download' \ --header 'X-Api-Key: {X-Api-Key}' \ --data format={format}
Copy

Responses

200

Successful Response

No response body

202

Accepted

204

No content

400

Bad request

404

Item not found

408

Request timeout

422

Validation Error

500

Internal server error

Response

Copy

Get Specific Report

Obtain a report for given report_id.

Auth

Path Params

report_id	string	Report Id
file_hash	string	File hash

Query String

filter	array	Report fields that should be fetched
sorting	array	Sort parameters to be applied to fetched report data
other	array	Extra options to get special data

GET /api/reports/{report_id}/{file_hash}

Responses

200

Successful Response

AllUploadRelatedReportsResponse	object	Model for get_all_upload_related_reports() endpoint
flowId	string
allFinished	boolean
allFilesDownloadFinished	boolean
allAdditionalStepsDone	boolean
reportsAmount	integer
priority	string
pollPause	integer
state	string	Scan state of ScanInit instance Enum: `created`,`queued`,`scanning`,`finished`
scanStartedDate	string
positionInQueue	integer
queueSize	integer
fileSize	integer
job	object	Model for job field in AllUploadRelatedReportsResponse
error	boolean
reason	string
fileReadProgressBytes	integer
rejected_files	array[object]
name	string
rejected_reason	string
sourceArchive	object	Model for sourceArchive field in AllUploadRelatedReportsResponse
scan_task_id	string
name	string
mimeType	string
sha256	string
private	boolean
is_link_upload	boolean
sha1	string
sha512	string
md5	string
tags	object	Model for tags field in AllUploadRelatedReportsResponse
source	string
tag	object	Model for tag field in TagsResponse
name	string
verdict	string
reports	object
*	object

400

Bad request

404

Item not found

422

Validation Error

Response

Search Report

Search for reports.

Finds reports and uploaded files by various tokens, like hash, filename, verdict, IOCs etc.

If query param is used, other params are ignored.

Auth

Query String

age	integer	Search reports with age of "age" days Default: -1
page	integer	Page number starting from 1 minimum: 1 Default: 1
page_size		Page size Default: 10
unique_files	boolean	Default: false
method		Default: and
no_date_limit	boolean	Default: false
query	string
verdict	string
source_type	string	Enum: `url`,`url-to-file`,`file`
filetype	string	Enum: `ace`,`apk`,`bat`,`64bits`,`bmp`,`csv`,`doc`,`docm`,`docx`,`dot`,`dotm`,`dotx`,`elf`,`eml`,`gif`,`hta`,`htm`,`html`,`img`,`iso`,`java`,`java-bytecode`,`javascript`,`jpg`,`lnk`,`mbox`,`mthml`,`msg`,`msi`,`mso`,`ole`,`one`,`pdf`,`pedll`,`peexe`,`png`,`pot`,`potm`,`potx`,`powershell`,`ppt`,`pptm`,`pptx`,`ps`,`pub`,`rar`,`rfc822`,`rtf`,`svg`,`txt`,`vbs`,`wmv`,`wsf`,`xlm`,`xls`,`xlsb`,`xlsm`,`xlsx`,`xlt`,`xltm`,`xltx`,`xsl`,`zip`,`7zip`,`exe`,`mail`,`ms-office`,`script`
tag	string
tags	string
date_from	string
date_to	string
rate_from	integer
rate_to	integer
uuid	string
email	string
registry_path	string
revision_save_id	string
yara_rule	string
retry_count	integer
scan_init_id	string
report_id	string
country	string
filename	string
sha1	string
sha256	string
sha512	string
md5	string
domain	string
ip	string
url	string
media_type	string
imphash	string
ssdeep	string
authentihash	string
fuzzyfsiohash	string
signal_groups	string
mitre_techniques	string
verdict_groups	string
main_task_state		Default: success
exclude	string

GET /api/reports/advanced-search

Responses

200

Successful Response

ReportSearchResponse	object	Search response returned to user
items	array
count	integer
count_search_params	integer
method	string
dbs_sync	boolean

400

Bad request

422

Validation Error

Response

Search Report

Search for reports.

Finds reports and uploaded files by various tokens, like hash, filename, verdict, IOCs etc.

If query param is used, other params are ignored.

Auth

Query String

age	integer	Search reports with age of "age" days Default: -1
page	integer	Page number starting from 1 minimum: 1 Default: 1
page_size		Page size Default: 10
method		Default: and
no_date_limit	boolean	Default: false
query	string
verdict	string
source_type	string	Enum: `url`,`url-to-file`,`file`
filetype	string	Enum: `ace`,`apk`,`bat`,`64bits`,`bmp`,`csv`,`doc`,`docm`,`docx`,`dot`,`dotm`,`dotx`,`elf`,`eml`,`gif`,`hta`,`htm`,`html`,`img`,`iso`,`java`,`java-bytecode`,`javascript`,`jpg`,`lnk`,`mbox`,`mthml`,`msg`,`msi`,`mso`,`ole`,`one`,`pdf`,`pedll`,`peexe`,`png`,`pot`,`potm`,`potx`,`powershell`,`ppt`,`pptm`,`pptx`,`ps`,`pub`,`rar`,`rfc822`,`rtf`,`svg`,`txt`,`vbs`,`wmv`,`wsf`,`xlm`,`xls`,`xlsb`,`xlsm`,`xlsx`,`xlt`,`xltm`,`xltx`,`xsl`,`zip`,`7zip`,`exe`,`mail`,`ms-office`,`script`
tag	string
tags	string
date_from	string
date_to	string
rate_from	integer
rate_to	integer
uuid	string
email	string
registry_path	string
revision_save_id	string
yara_rule	string
retry_count	integer
scan_init_id	string
report_id	string
country	string
filename	string
sha1	string
sha256	string
sha512	string
md5	string
domain	string
ip	string
url	string
media_type	string
imphash	string
ssdeep	string
authentihash	string
fuzzyfsiohash	string
signal_groups	string
mitre_techniques	string
verdict_groups	string
main_task_state		Default: success
exclude	string

GET /api/reports/search

Responses

200

Successful Response

ReportSearchResponse	object	Search response returned to user
items	array
count	integer
count_search_params	integer
method	string
dbs_sync	boolean

400

Bad request

422

Validation Error

Response

Get Frequent Tags

Get most frequently seen tags recently

Auth

GET /api/users/get-frequent-tags

Responses

200

Successful Response

FrequentTagsResponse	object
tags	array[object]
updated	date-time

401

Not authorized

Response

Get Most Interesting

Get most interesting report recently

Auth

GET /api/users/most-interesting

Responses

200

Successful Response

MostInterestingResponse	object
report	object
updated	date-time

401

Not authorized

Response

Files

Get a file by its hash or id in various format

GET

/api/files/{hash}

GET

/api/feed/archives/{publicity}/{type}/{date}

Get Single File

Obtain single file for given report by hash

Auth

Path Params

hash

string

File hash

Query String

report_id	string	Report Id (only needed if `original_name` is true)
type		Default: base64
original_name	boolean	(only used if `type` is raw) Default: false
password	string	Password to be used on compression (only used if `type` is raw)

GET /api/files/{hash}

Responses

200

Successful Response

GetSingleFileResponse

object

Model for get_single_file() endpoint

type

string

An enumeration.

Enum: base64,compressedBase64

content string

404

Item not found

422

Validation Error

Response

Download Archive File

Download an archive file

Auth

Path Params

publicity	string	Enum: `public`,`private`
type	string	Enum: `doc`,`exec`
date	string

GET /api/feed/archives/{publicity}/{type}/{date}

Responses

200

Successful Response

No response body

404

Item not found

422

Validation Error

Response

Feed

Atom feed

Get 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.

Auth

GET /api/feed/atom

Responses

200

Successful Response

No response body

Response

Get Feed Info

Get reports feed info

Auth

GET /api/feed/info

Responses

200

Successful Response

No response body

Response

Get Daily Reports Archives

Get daily samples

Auth

GET /api/feed/archives

Responses

200

Successful Response

DailyReportsArchiveResponse	array[object]
name	string	Archive file name
link	string	Link to file download
reports_date	string	Date of reports creation
files_count	integer	Amount of files in archive
files_type	string	An enumeration. Enum: `doc`,`exec`
size	integer	Archive size in bytes
is_public	boolean	If archive contains only public or only private files

Response

Users

Report-related and other functionality used by ordinary users.

/api/users/me/uploads

/api/users/reset-timezone-locale

GET

/api/users/{account_id}/avatar

POST

/api/users/api-key/create

POST

/api/users/api-key/set

POST

/api/users/api-key/remove

POST

/api/users/notifications/{notification}

GET

/api/users/stat

GET

/api/users/stat/generic

GET

/api/users/stat/malicious-ips

/api/users/stat/mitre

GET

/api/users/info/yara

Get Current User

Get user model of currently authenticated user

Auth

GET /api/users/me

Responses

200

Successful Response

No response body

Response

Get Uploads

Get list of uploaded files

Auth

Query String

page

integer

Page number starting from 1

minimum: 1

Default: 1

page_size

Page size

Default: 10

GET /api/users/uploads

Responses

200

Successful Response

No response body

400

Bad request

422

Validation Error

Response

Get User Uploads

Get list of uploaded files for current user

Auth

Query String

page	integer	Page number starting from 1 minimum: 1 Default: 1
page_size		Page size Default: 10
date_from	string
verdict	string	Enum: `unknown`,`benign`,`informational`,`no_threat`,`suspicious`,`likely_malicious`,`malicious`

GET /api/users/me/uploads

Responses

200

Successful Response

No response body

400

Bad request

422

Validation Error

Response

Get Profile

Get user profile data

Auth

GET /api/users/profile

Responses

200

Successful Response

UserResponse	object	System user for out
account_id	string
email	string
username	string
pseudoname	string
groups	array[object]
name	string
has_avatar	boolean
profile	object
first_name	string
last_name	string
phone	string
company	string
job	string
role	string
department	string
industry	string
subscribe	boolean
api_key	string
theme	string
timezone	string	An enumeration. Enum: `Africa/Abidjan`,`Africa/Accra`,`Africa/Addis_Ababa`,`Africa/Algiers`,`Africa/Asmara`,`Africa/Asmera`,`Africa/Bamako`,`Africa/Bangui`,`Africa/Banjul`,`Africa/Bissau`,`Africa/Blantyre`,`Africa/Brazzaville`,`Africa/Bujumbura`,`Africa/Cairo`,`Africa/Casablanca`,`Africa/Ceuta`,`Africa/Conakry`,`Africa/Dakar`,`Africa/Dar_es_Salaam`,`Africa/Djibouti`,`Africa/Douala`,`Africa/El_Aaiun`,`Africa/Freetown`,`Africa/Gaborone`,`Africa/Harare`,`Africa/Johannesburg`,`Africa/Juba`,`Africa/Kampala`,`Africa/Khartoum`,`Africa/Kigali`,`Africa/Kinshasa`,`Africa/Lagos`,`Africa/Libreville`,`Africa/Lome`,`Africa/Luanda`,`Africa/Lubumbashi`,`Africa/Lusaka`,`Africa/Malabo`,`Africa/Maputo`,`Africa/Maseru`,`Africa/Mbabane`,`Africa/Mogadishu`,`Africa/Monrovia`,`Africa/Nairobi`,`Africa/Ndjamena`,`Africa/Niamey`,`Africa/Nouakchott`,`Africa/Ouagadougou`,`Africa/Porto-Novo`,`Africa/Sao_Tome`,`Africa/Timbuktu`,`Africa/Tripoli`,`Africa/Tunis`,`Africa/Windhoek`,`America/Adak`,`America/Anchorage`,`America/Anguilla`,`America/Antigua`,`America/Araguaina`,`America/Argentina/Buenos_Aires`,`America/Argentina/Catamarca`,`America/Argentina/ComodRivadavia`,`America/Argentina/Cordoba`,`America/Argentina/Jujuy`,`America/Argentina/La_Rioja`,`America/Argentina/Mendoza`,`America/Argentina/Rio_Gallegos`,`America/Argentina/Salta`,`America/Argentina/San_Juan`,`America/Argentina/San_Luis`,`America/Argentina/Tucuman`,`America/Argentina/Ushuaia`,`America/Aruba`,`America/Asuncion`,`America/Atikokan`,`America/Atka`,`America/Bahia`,`America/Bahia_Banderas`,`America/Barbados`,`America/Belem`,`America/Belize`,`America/Blanc-Sablon`,`America/Boa_Vista`,`America/Bogota`,`America/Boise`,`America/Buenos_Aires`,`America/Cambridge_Bay`,`America/Campo_Grande`,`America/Cancun`,`America/Caracas`,`America/Catamarca`,`America/Cayenne`,`America/Cayman`,`America/Chicago`,`America/Chihuahua`,`America/Coral_Harbour`,`America/Cordoba`,`America/Costa_Rica`,`America/Creston`,`America/Cuiaba`,`America/Curacao`,`America/Danmarkshavn`,`America/Dawson`,`America/Dawson_Creek`,`America/Denver`,`America/Detroit`,`America/Dominica`,`America/Edmonton`,`America/Eirunepe`,`America/El_Salvador`,`America/Ensenada`,`America/Fort_Nelson`,`America/Fort_Wayne`,`America/Fortaleza`,`America/Glace_Bay`,`America/Godthab`,`America/Goose_Bay`,`America/Grand_Turk`,`America/Grenada`,`America/Guadeloupe`,`America/Guatemala`,`America/Guayaquil`,`America/Guyana`,`America/Halifax`,`America/Havana`,`America/Hermosillo`,`America/Indiana/Indianapolis`,`America/Indiana/Knox`,`America/Indiana/Marengo`,`America/Indiana/Petersburg`,`America/Indiana/Tell_City`,`America/Indiana/Vevay`,`America/Indiana/Vincennes`,`America/Indiana/Winamac`,`America/Indianapolis`,`America/Inuvik`,`America/Iqaluit`,`America/Jamaica`,`America/Jujuy`,`America/Juneau`,`America/Kentucky/Louisville`,`America/Kentucky/Monticello`,`America/Knox_IN`,`America/Kralendijk`,`America/La_Paz`,`America/Lima`,`America/Los_Angeles`,`America/Louisville`,`America/Lower_Princes`,`America/Maceio`,`America/Managua`,`America/Manaus`,`America/Marigot`,`America/Martinique`,`America/Matamoros`,`America/Mazatlan`,`America/Mendoza`,`America/Menominee`,`America/Merida`,`America/Metlakatla`,`America/Mexico_City`,`America/Miquelon`,`America/Moncton`,`America/Monterrey`,`America/Montevideo`,`America/Montreal`,`America/Montserrat`,`America/Nassau`,`America/New_York`,`America/Nipigon`,`America/Nome`,`America/Noronha`,`America/North_Dakota/Beulah`,`America/North_Dakota/Center`,`America/North_Dakota/New_Salem`,`America/Ojinaga`,`America/Panama`,`America/Pangnirtung`,`America/Paramaribo`,`America/Phoenix`,`America/Port-au-Prince`,`America/Port_of_Spain`,`America/Porto_Acre`,`America/Porto_Velho`,`America/Puerto_Rico`,`America/Punta_Arenas`,`America/Rainy_River`,`America/Rankin_Inlet`,`America/Recife`,`America/Regina`,`America/Resolute`,`America/Rio_Branco`,`America/Rosario`,`America/Santa_Isabel`,`America/Santarem`,`America/Santiago`,`America/Santo_Domingo`,`America/Sao_Paulo`,`America/Scoresbysund`,`America/Shiprock`,`America/Sitka`,`America/St_Barthelemy`,`America/St_Johns`,`America/St_Kitts`,`America/St_Lucia`,`America/St_Thomas`,`America/St_Vincent`,`America/Swift_Current`,`America/Tegucigalpa`,`America/Thule`,`America/Thunder_Bay`,`America/Tijuana`,`America/Toronto`,`America/Tortola`,`America/Vancouver`,`America/Virgin`,`America/Whitehorse`,`America/Winnipeg`,`America/Yakutat`,`America/Yellowknife`,`Antarctica/Casey`,`Antarctica/Davis`,`Antarctica/DumontDUrville`,`Antarctica/Macquarie`,`Antarctica/Mawson`,`Antarctica/McMurdo`,`Antarctica/Palmer`,`Antarctica/Rothera`,`Antarctica/South_Pole`,`Antarctica/Syowa`,`Antarctica/Troll`,`Antarctica/Vostok`,`Arctic/Longyearbyen`,`Asia/Aden`,`Asia/Almaty`,`Asia/Amman`,`Asia/Anadyr`,`Asia/Aqtau`,`Asia/Aqtobe`,`Asia/Ashgabat`,`Asia/Ashkhabad`,`Asia/Atyrau`,`Asia/Baghdad`,`Asia/Bahrain`,`Asia/Baku`,`Asia/Bangkok`,`Asia/Barnaul`,`Asia/Beirut`,`Asia/Bishkek`,`Asia/Brunei`,`Asia/Calcutta`,`Asia/Chita`,`Asia/Choibalsan`,`Asia/Chongqing`,`Asia/Chungking`,`Asia/Colombo`,`Asia/Dacca`,`Asia/Damascus`,`Asia/Dhaka`,`Asia/Dili`,`Asia/Dubai`,`Asia/Dushanbe`,`Asia/Famagusta`,`Asia/Gaza`,`Asia/Harbin`,`Asia/Hebron`,`Asia/Ho_Chi_Minh`,`Asia/Hong_Kong`,`Asia/Hovd`,`Asia/Irkutsk`,`Asia/Istanbul`,`Asia/Jakarta`,`Asia/Jayapura`,`Asia/Jerusalem`,`Asia/Kabul`,`Asia/Kamchatka`,`Asia/Karachi`,`Asia/Kashgar`,`Asia/Kathmandu`,`Asia/Katmandu`,`Asia/Khandyga`,`Asia/Kolkata`,`Asia/Krasnoyarsk`,`Asia/Kuala_Lumpur`,`Asia/Kuching`,`Asia/Kuwait`,`Asia/Macao`,`Asia/Macau`,`Asia/Magadan`,`Asia/Makassar`,`Asia/Manila`,`Asia/Muscat`,`Asia/Nicosia`,`Asia/Novokuznetsk`,`Asia/Novosibirsk`,`Asia/Omsk`,`Asia/Oral`,`Asia/Phnom_Penh`,`Asia/Pontianak`,`Asia/Pyongyang`,`Asia/Qatar`,`Asia/Qostanay`,`Asia/Qyzylorda`,`Asia/Rangoon`,`Asia/Riyadh`,`Asia/Saigon`,`Asia/Sakhalin`,`Asia/Samarkand`,`Asia/Seoul`,`Asia/Shanghai`,`Asia/Singapore`,`Asia/Srednekolymsk`,`Asia/Taipei`,`Asia/Tashkent`,`Asia/Tbilisi`,`Asia/Tehran`,`Asia/Tel_Aviv`,`Asia/Thimbu`,`Asia/Thimphu`,`Asia/Tokyo`,`Asia/Tomsk`,`Asia/Ujung_Pandang`,`Asia/Ulaanbaatar`,`Asia/Ulan_Bator`,`Asia/Urumqi`,`Asia/Ust-Nera`,`Asia/Vientiane`,`Asia/Vladivostok`,`Asia/Yakutsk`,`Asia/Yangon`,`Asia/Yekaterinburg`,`Asia/Yerevan`,`Atlantic/Azores`,`Atlantic/Bermuda`,`Atlantic/Canary`,`Atlantic/Cape_Verde`,`Atlantic/Faeroe`,`Atlantic/Faroe`,`Atlantic/Jan_Mayen`,`Atlantic/Madeira`,`Atlantic/Reykjavik`,`Atlantic/South_Georgia`,`Atlantic/St_Helena`,`Atlantic/Stanley`,`Australia/ACT`,`Australia/Adelaide`,`Australia/Brisbane`,`Australia/Broken_Hill`,`Australia/Canberra`,`Australia/Currie`,`Australia/Darwin`,`Australia/Eucla`,`Australia/Hobart`,`Australia/LHI`,`Australia/Lindeman`,`Australia/Lord_Howe`,`Australia/Melbourne`,`Australia/NSW`,`Australia/North`,`Australia/Perth`,`Australia/Queensland`,`Australia/South`,`Australia/Sydney`,`Australia/Tasmania`,`Australia/Victoria`,`Australia/West`,`Australia/Yancowinna`,`Brazil/Acre`,`Brazil/DeNoronha`,`Brazil/East`,`Brazil/West`,`CET`,`CST6CDT`,`Canada/Atlantic`,`Canada/Central`,`Canada/Eastern`,`Canada/Mountain`,`Canada/Newfoundland`,`Canada/Pacific`,`Canada/Saskatchewan`,`Canada/Yukon`,`Chile/Continental`,`Chile/EasterIsland`,`Cuba`,`EET`,`EST5EDT`,`Egypt`,`Eire`,`Etc/GMT`,`Etc/GMT+0`,`Etc/GMT+1`,`Etc/GMT+10`,`Etc/GMT+11`,`Etc/GMT+12`,`Etc/GMT+2`,`Etc/GMT+3`,`Etc/GMT+4`,`Etc/GMT+5`,`Etc/GMT+6`,`Etc/GMT+7`,`Etc/GMT+8`,`Etc/GMT+9`,`Etc/GMT-0`,`Etc/GMT-1`,`Etc/GMT-10`,`Etc/GMT-11`,`Etc/GMT-12`,`Etc/GMT-13`,`Etc/GMT-14`,`Etc/GMT-2`,`Etc/GMT-3`,`Etc/GMT-4`,`Etc/GMT-5`,`Etc/GMT-6`,`Etc/GMT-7`,`Etc/GMT-8`,`Etc/GMT-9`,`Etc/GMT0`,`Etc/Greenwich`,`Etc/UCT`,`Etc/UTC`,`Etc/Universal`,`Etc/Zulu`,`Europe/Amsterdam`,`Europe/Andorra`,`Europe/Astrakhan`,`Europe/Athens`,`Europe/Belfast`,`Europe/Belgrade`,`Europe/Berlin`,`Europe/Bratislava`,`Europe/Brussels`,`Europe/Bucharest`,`Europe/Budapest`,`Europe/Busingen`,`Europe/Chisinau`,`Europe/Copenhagen`,`Europe/Dublin`,`Europe/Gibraltar`,`Europe/Guernsey`,`Europe/Helsinki`,`Europe/Isle_of_Man`,`Europe/Istanbul`,`Europe/Jersey`,`Europe/Kaliningrad`,`Europe/Kiev`,`Europe/Kirov`,`Europe/Lisbon`,`Europe/Ljubljana`,`Europe/London`,`Europe/Luxembourg`,`Europe/Madrid`,`Europe/Malta`,`Europe/Mariehamn`,`Europe/Minsk`,`Europe/Monaco`,`Europe/Moscow`,`Europe/Nicosia`,`Europe/Oslo`,`Europe/Paris`,`Europe/Podgorica`,`Europe/Prague`,`Europe/Riga`,`Europe/Rome`,`Europe/Samara`,`Europe/San_Marino`,`Europe/Sarajevo`,`Europe/Saratov`,`Europe/Simferopol`,`Europe/Skopje`,`Europe/Sofia`,`Europe/Stockholm`,`Europe/Tallinn`,`Europe/Tirane`,`Europe/Tiraspol`,`Europe/Ulyanovsk`,`Europe/Uzhgorod`,`Europe/Vaduz`,`Europe/Vatican`,`Europe/Vienna`,`Europe/Vilnius`,`Europe/Volgograd`,`Europe/Warsaw`,`Europe/Zagreb`,`Europe/Zaporozhye`,`Europe/Zurich`,`GB`,`GB-Eire`,`GMT`,`GMT0`,`Greenwich`,`Hongkong`,`Iceland`,`Indian/Antananarivo`,`Indian/Chagos`,`Indian/Christmas`,`Indian/Cocos`,`Indian/Comoro`,`Indian/Kerguelen`,`Indian/Mahe`,`Indian/Maldives`,`Indian/Mauritius`,`Indian/Mayotte`,`Indian/Reunion`,`Iran`,`Israel`,`Jamaica`,`Japan`,`Kwajalein`,`Libya`,`MET`,`MST7MDT`,`Mexico/BajaNorte`,`Mexico/BajaSur`,`Mexico/General`,`NZ`,`NZ-CHAT`,`Navajo`,`PRC`,`PST8PDT`,`Pacific/Apia`,`Pacific/Auckland`,`Pacific/Bougainville`,`Pacific/Chatham`,`Pacific/Chuuk`,`Pacific/Easter`,`Pacific/Efate`,`Pacific/Enderbury`,`Pacific/Fakaofo`,`Pacific/Fiji`,`Pacific/Funafuti`,`Pacific/Galapagos`,`Pacific/Gambier`,`Pacific/Guadalcanal`,`Pacific/Guam`,`Pacific/Honolulu`,`Pacific/Johnston`,`Pacific/Kiritimati`,`Pacific/Kosrae`,`Pacific/Kwajalein`,`Pacific/Majuro`,`Pacific/Marquesas`,`Pacific/Midway`,`Pacific/Nauru`,`Pacific/Niue`,`Pacific/Norfolk`,`Pacific/Noumea`,`Pacific/Pago_Pago`,`Pacific/Palau`,`Pacific/Pitcairn`,`Pacific/Pohnpei`,`Pacific/Ponape`,`Pacific/Port_Moresby`,`Pacific/Rarotonga`,`Pacific/Saipan`,`Pacific/Samoa`,`Pacific/Tahiti`,`Pacific/Tarawa`,`Pacific/Tongatapu`,`Pacific/Truk`,`Pacific/Wake`,`Pacific/Wallis`,`Pacific/Yap`,`Poland`,`Portugal`,`ROK`,`Singapore`,`Turkey`,`UCT`,`US/Alaska`,`US/Aleutian`,`US/Arizona`,`US/Central`,`US/East-Indiana`,`US/Eastern`,`US/Hawaii`,`US/Indiana-Starke`,`US/Michigan`,`US/Mountain`,`US/Pacific`,`US/Pacific-New`,`US/Samoa`,`UTC`,`Universal`,`W-SU`,`WET`,`Zulu`
locale	string	An enumeration. Enum: `de`,`en`,`hu`,`it`,`nl`,`sv`

Response

Post Profile

Update user profile data

Auth

Request Body

Body_post_profile_api_users_profile_post	object
email	string	pattern: `^[a-zA-Z0-9.!#$%&'+=?^_`{\|}~-]+@a-zA-Z0-9?(?:.a-zA-Z0-9?)$`
username	string
old_password	string
new_password	string
password_confirm	string
file	file
first_name	string
last_name	string
phone	string
company	string
job	string
role	string
department	string
industry	string
subscribe	boolean	Default: true
theme	string
timezone	string	An enumeration. Enum: `Africa/Abidjan`,`Africa/Accra`,`Africa/Addis_Ababa`,`Africa/Algiers`,`Africa/Asmara`,`Africa/Asmera`,`Africa/Bamako`,`Africa/Bangui`,`Africa/Banjul`,`Africa/Bissau`,`Africa/Blantyre`,`Africa/Brazzaville`,`Africa/Bujumbura`,`Africa/Cairo`,`Africa/Casablanca`,`Africa/Ceuta`,`Africa/Conakry`,`Africa/Dakar`,`Africa/Dar_es_Salaam`,`Africa/Djibouti`,`Africa/Douala`,`Africa/El_Aaiun`,`Africa/Freetown`,`Africa/Gaborone`,`Africa/Harare`,`Africa/Johannesburg`,`Africa/Juba`,`Africa/Kampala`,`Africa/Khartoum`,`Africa/Kigali`,`Africa/Kinshasa`,`Africa/Lagos`,`Africa/Libreville`,`Africa/Lome`,`Africa/Luanda`,`Africa/Lubumbashi`,`Africa/Lusaka`,`Africa/Malabo`,`Africa/Maputo`,`Africa/Maseru`,`Africa/Mbabane`,`Africa/Mogadishu`,`Africa/Monrovia`,`Africa/Nairobi`,`Africa/Ndjamena`,`Africa/Niamey`,`Africa/Nouakchott`,`Africa/Ouagadougou`,`Africa/Porto-Novo`,`Africa/Sao_Tome`,`Africa/Timbuktu`,`Africa/Tripoli`,`Africa/Tunis`,`Africa/Windhoek`,`America/Adak`,`America/Anchorage`,`America/Anguilla`,`America/Antigua`,`America/Araguaina`,`America/Argentina/Buenos_Aires`,`America/Argentina/Catamarca`,`America/Argentina/ComodRivadavia`,`America/Argentina/Cordoba`,`America/Argentina/Jujuy`,`America/Argentina/La_Rioja`,`America/Argentina/Mendoza`,`America/Argentina/Rio_Gallegos`,`America/Argentina/Salta`,`America/Argentina/San_Juan`,`America/Argentina/San_Luis`,`America/Argentina/Tucuman`,`America/Argentina/Ushuaia`,`America/Aruba`,`America/Asuncion`,`America/Atikokan`,`America/Atka`,`America/Bahia`,`America/Bahia_Banderas`,`America/Barbados`,`America/Belem`,`America/Belize`,`America/Blanc-Sablon`,`America/Boa_Vista`,`America/Bogota`,`America/Boise`,`America/Buenos_Aires`,`America/Cambridge_Bay`,`America/Campo_Grande`,`America/Cancun`,`America/Caracas`,`America/Catamarca`,`America/Cayenne`,`America/Cayman`,`America/Chicago`,`America/Chihuahua`,`America/Coral_Harbour`,`America/Cordoba`,`America/Costa_Rica`,`America/Creston`,`America/Cuiaba`,`America/Curacao`,`America/Danmarkshavn`,`America/Dawson`,`America/Dawson_Creek`,`America/Denver`,`America/Detroit`,`America/Dominica`,`America/Edmonton`,`America/Eirunepe`,`America/El_Salvador`,`America/Ensenada`,`America/Fort_Nelson`,`America/Fort_Wayne`,`America/Fortaleza`,`America/Glace_Bay`,`America/Godthab`,`America/Goose_Bay`,`America/Grand_Turk`,`America/Grenada`,`America/Guadeloupe`,`America/Guatemala`,`America/Guayaquil`,`America/Guyana`,`America/Halifax`,`America/Havana`,`America/Hermosillo`,`America/Indiana/Indianapolis`,`America/Indiana/Knox`,`America/Indiana/Marengo`,`America/Indiana/Petersburg`,`America/Indiana/Tell_City`,`America/Indiana/Vevay`,`America/Indiana/Vincennes`,`America/Indiana/Winamac`,`America/Indianapolis`,`America/Inuvik`,`America/Iqaluit`,`America/Jamaica`,`America/Jujuy`,`America/Juneau`,`America/Kentucky/Louisville`,`America/Kentucky/Monticello`,`America/Knox_IN`,`America/Kralendijk`,`America/La_Paz`,`America/Lima`,`America/Los_Angeles`,`America/Louisville`,`America/Lower_Princes`,`America/Maceio`,`America/Managua`,`America/Manaus`,`America/Marigot`,`America/Martinique`,`America/Matamoros`,`America/Mazatlan`,`America/Mendoza`,`America/Menominee`,`America/Merida`,`America/Metlakatla`,`America/Mexico_City`,`America/Miquelon`,`America/Moncton`,`America/Monterrey`,`America/Montevideo`,`America/Montreal`,`America/Montserrat`,`America/Nassau`,`America/New_York`,`America/Nipigon`,`America/Nome`,`America/Noronha`,`America/North_Dakota/Beulah`,`America/North_Dakota/Center`,`America/North_Dakota/New_Salem`,`America/Ojinaga`,`America/Panama`,`America/Pangnirtung`,`America/Paramaribo`,`America/Phoenix`,`America/Port-au-Prince`,`America/Port_of_Spain`,`America/Porto_Acre`,`America/Porto_Velho`,`America/Puerto_Rico`,`America/Punta_Arenas`,`America/Rainy_River`,`America/Rankin_Inlet`,`America/Recife`,`America/Regina`,`America/Resolute`,`America/Rio_Branco`,`America/Rosario`,`America/Santa_Isabel`,`America/Santarem`,`America/Santiago`,`America/Santo_Domingo`,`America/Sao_Paulo`,`America/Scoresbysund`,`America/Shiprock`,`America/Sitka`,`America/St_Barthelemy`,`America/St_Johns`,`America/St_Kitts`,`America/St_Lucia`,`America/St_Thomas`,`America/St_Vincent`,`America/Swift_Current`,`America/Tegucigalpa`,`America/Thule`,`America/Thunder_Bay`,`America/Tijuana`,`America/Toronto`,`America/Tortola`,`America/Vancouver`,`America/Virgin`,`America/Whitehorse`,`America/Winnipeg`,`America/Yakutat`,`America/Yellowknife`,`Antarctica/Casey`,`Antarctica/Davis`,`Antarctica/DumontDUrville`,`Antarctica/Macquarie`,`Antarctica/Mawson`,`Antarctica/McMurdo`,`Antarctica/Palmer`,`Antarctica/Rothera`,`Antarctica/South_Pole`,`Antarctica/Syowa`,`Antarctica/Troll`,`Antarctica/Vostok`,`Arctic/Longyearbyen`,`Asia/Aden`,`Asia/Almaty`,`Asia/Amman`,`Asia/Anadyr`,`Asia/Aqtau`,`Asia/Aqtobe`,`Asia/Ashgabat`,`Asia/Ashkhabad`,`Asia/Atyrau`,`Asia/Baghdad`,`Asia/Bahrain`,`Asia/Baku`,`Asia/Bangkok`,`Asia/Barnaul`,`Asia/Beirut`,`Asia/Bishkek`,`Asia/Brunei`,`Asia/Calcutta`,`Asia/Chita`,`Asia/Choibalsan`,`Asia/Chongqing`,`Asia/Chungking`,`Asia/Colombo`,`Asia/Dacca`,`Asia/Damascus`,`Asia/Dhaka`,`Asia/Dili`,`Asia/Dubai`,`Asia/Dushanbe`,`Asia/Famagusta`,`Asia/Gaza`,`Asia/Harbin`,`Asia/Hebron`,`Asia/Ho_Chi_Minh`,`Asia/Hong_Kong`,`Asia/Hovd`,`Asia/Irkutsk`,`Asia/Istanbul`,`Asia/Jakarta`,`Asia/Jayapura`,`Asia/Jerusalem`,`Asia/Kabul`,`Asia/Kamchatka`,`Asia/Karachi`,`Asia/Kashgar`,`Asia/Kathmandu`,`Asia/Katmandu`,`Asia/Khandyga`,`Asia/Kolkata`,`Asia/Krasnoyarsk`,`Asia/Kuala_Lumpur`,`Asia/Kuching`,`Asia/Kuwait`,`Asia/Macao`,`Asia/Macau`,`Asia/Magadan`,`Asia/Makassar`,`Asia/Manila`,`Asia/Muscat`,`Asia/Nicosia`,`Asia/Novokuznetsk`,`Asia/Novosibirsk`,`Asia/Omsk`,`Asia/Oral`,`Asia/Phnom_Penh`,`Asia/Pontianak`,`Asia/Pyongyang`,`Asia/Qatar`,`Asia/Qostanay`,`Asia/Qyzylorda`,`Asia/Rangoon`,`Asia/Riyadh`,`Asia/Saigon`,`Asia/Sakhalin`,`Asia/Samarkand`,`Asia/Seoul`,`Asia/Shanghai`,`Asia/Singapore`,`Asia/Srednekolymsk`,`Asia/Taipei`,`Asia/Tashkent`,`Asia/Tbilisi`,`Asia/Tehran`,`Asia/Tel_Aviv`,`Asia/Thimbu`,`Asia/Thimphu`,`Asia/Tokyo`,`Asia/Tomsk`,`Asia/Ujung_Pandang`,`Asia/Ulaanbaatar`,`Asia/Ulan_Bator`,`Asia/Urumqi`,`Asia/Ust-Nera`,`Asia/Vientiane`,`Asia/Vladivostok`,`Asia/Yakutsk`,`Asia/Yangon`,`Asia/Yekaterinburg`,`Asia/Yerevan`,`Atlantic/Azores`,`Atlantic/Bermuda`,`Atlantic/Canary`,`Atlantic/Cape_Verde`,`Atlantic/Faeroe`,`Atlantic/Faroe`,`Atlantic/Jan_Mayen`,`Atlantic/Madeira`,`Atlantic/Reykjavik`,`Atlantic/South_Georgia`,`Atlantic/St_Helena`,`Atlantic/Stanley`,`Australia/ACT`,`Australia/Adelaide`,`Australia/Brisbane`,`Australia/Broken_Hill`,`Australia/Canberra`,`Australia/Currie`,`Australia/Darwin`,`Australia/Eucla`,`Australia/Hobart`,`Australia/LHI`,`Australia/Lindeman`,`Australia/Lord_Howe`,`Australia/Melbourne`,`Australia/NSW`,`Australia/North`,`Australia/Perth`,`Australia/Queensland`,`Australia/South`,`Australia/Sydney`,`Australia/Tasmania`,`Australia/Victoria`,`Australia/West`,`Australia/Yancowinna`,`Brazil/Acre`,`Brazil/DeNoronha`,`Brazil/East`,`Brazil/West`,`CET`,`CST6CDT`,`Canada/Atlantic`,`Canada/Central`,`Canada/Eastern`,`Canada/Mountain`,`Canada/Newfoundland`,`Canada/Pacific`,`Canada/Saskatchewan`,`Canada/Yukon`,`Chile/Continental`,`Chile/EasterIsland`,`Cuba`,`EET`,`EST5EDT`,`Egypt`,`Eire`,`Etc/GMT`,`Etc/GMT+0`,`Etc/GMT+1`,`Etc/GMT+10`,`Etc/GMT+11`,`Etc/GMT+12`,`Etc/GMT+2`,`Etc/GMT+3`,`Etc/GMT+4`,`Etc/GMT+5`,`Etc/GMT+6`,`Etc/GMT+7`,`Etc/GMT+8`,`Etc/GMT+9`,`Etc/GMT-0`,`Etc/GMT-1`,`Etc/GMT-10`,`Etc/GMT-11`,`Etc/GMT-12`,`Etc/GMT-13`,`Etc/GMT-14`,`Etc/GMT-2`,`Etc/GMT-3`,`Etc/GMT-4`,`Etc/GMT-5`,`Etc/GMT-6`,`Etc/GMT-7`,`Etc/GMT-8`,`Etc/GMT-9`,`Etc/GMT0`,`Etc/Greenwich`,`Etc/UCT`,`Etc/UTC`,`Etc/Universal`,`Etc/Zulu`,`Europe/Amsterdam`,`Europe/Andorra`,`Europe/Astrakhan`,`Europe/Athens`,`Europe/Belfast`,`Europe/Belgrade`,`Europe/Berlin`,`Europe/Bratislava`,`Europe/Brussels`,`Europe/Bucharest`,`Europe/Budapest`,`Europe/Busingen`,`Europe/Chisinau`,`Europe/Copenhagen`,`Europe/Dublin`,`Europe/Gibraltar`,`Europe/Guernsey`,`Europe/Helsinki`,`Europe/Isle_of_Man`,`Europe/Istanbul`,`Europe/Jersey`,`Europe/Kaliningrad`,`Europe/Kiev`,`Europe/Kirov`,`Europe/Lisbon`,`Europe/Ljubljana`,`Europe/London`,`Europe/Luxembourg`,`Europe/Madrid`,`Europe/Malta`,`Europe/Mariehamn`,`Europe/Minsk`,`Europe/Monaco`,`Europe/Moscow`,`Europe/Nicosia`,`Europe/Oslo`,`Europe/Paris`,`Europe/Podgorica`,`Europe/Prague`,`Europe/Riga`,`Europe/Rome`,`Europe/Samara`,`Europe/San_Marino`,`Europe/Sarajevo`,`Europe/Saratov`,`Europe/Simferopol`,`Europe/Skopje`,`Europe/Sofia`,`Europe/Stockholm`,`Europe/Tallinn`,`Europe/Tirane`,`Europe/Tiraspol`,`Europe/Ulyanovsk`,`Europe/Uzhgorod`,`Europe/Vaduz`,`Europe/Vatican`,`Europe/Vienna`,`Europe/Vilnius`,`Europe/Volgograd`,`Europe/Warsaw`,`Europe/Zagreb`,`Europe/Zaporozhye`,`Europe/Zurich`,`GB`,`GB-Eire`,`GMT`,`GMT0`,`Greenwich`,`Hongkong`,`Iceland`,`Indian/Antananarivo`,`Indian/Chagos`,`Indian/Christmas`,`Indian/Cocos`,`Indian/Comoro`,`Indian/Kerguelen`,`Indian/Mahe`,`Indian/Maldives`,`Indian/Mauritius`,`Indian/Mayotte`,`Indian/Reunion`,`Iran`,`Israel`,`Jamaica`,`Japan`,`Kwajalein`,`Libya`,`MET`,`MST7MDT`,`Mexico/BajaNorte`,`Mexico/BajaSur`,`Mexico/General`,`NZ`,`NZ-CHAT`,`Navajo`,`PRC`,`PST8PDT`,`Pacific/Apia`,`Pacific/Auckland`,`Pacific/Bougainville`,`Pacific/Chatham`,`Pacific/Chuuk`,`Pacific/Easter`,`Pacific/Efate`,`Pacific/Enderbury`,`Pacific/Fakaofo`,`Pacific/Fiji`,`Pacific/Funafuti`,`Pacific/Galapagos`,`Pacific/Gambier`,`Pacific/Guadalcanal`,`Pacific/Guam`,`Pacific/Honolulu`,`Pacific/Johnston`,`Pacific/Kiritimati`,`Pacific/Kosrae`,`Pacific/Kwajalein`,`Pacific/Majuro`,`Pacific/Marquesas`,`Pacific/Midway`,`Pacific/Nauru`,`Pacific/Niue`,`Pacific/Norfolk`,`Pacific/Noumea`,`Pacific/Pago_Pago`,`Pacific/Palau`,`Pacific/Pitcairn`,`Pacific/Pohnpei`,`Pacific/Ponape`,`Pacific/Port_Moresby`,`Pacific/Rarotonga`,`Pacific/Saipan`,`Pacific/Samoa`,`Pacific/Tahiti`,`Pacific/Tarawa`,`Pacific/Tongatapu`,`Pacific/Truk`,`Pacific/Wake`,`Pacific/Wallis`,`Pacific/Yap`,`Poland`,`Portugal`,`ROK`,`Singapore`,`Turkey`,`UCT`,`US/Alaska`,`US/Aleutian`,`US/Arizona`,`US/Central`,`US/East-Indiana`,`US/Eastern`,`US/Hawaii`,`US/Indiana-Starke`,`US/Michigan`,`US/Mountain`,`US/Pacific`,`US/Pacific-New`,`US/Samoa`,`UTC`,`Universal`,`W-SU`,`WET`,`Zulu`
locale	string	An enumeration. Enum: `de`,`en`,`hu`,`it`,`nl`,`sv`

POST /api/users/profile

Responses

200

Successful Response

UserResponse	object	System user for out
account_id	string
email	string
username	string
pseudoname	string
groups	array[object]
name	string
has_avatar	boolean
profile	object
first_name	string
last_name	string
phone	string
company	string
job	string
role	string
department	string
industry	string
subscribe	boolean
api_key	string
theme	string
timezone	string	An enumeration. Enum: `Africa/Abidjan`,`Africa/Accra`,`Africa/Addis_Ababa`,`Africa/Algiers`,`Africa/Asmara`,`Africa/Asmera`,`Africa/Bamako`,`Africa/Bangui`,`Africa/Banjul`,`Africa/Bissau`,`Africa/Blantyre`,`Africa/Brazzaville`,`Africa/Bujumbura`,`Africa/Cairo`,`Africa/Casablanca`,`Africa/Ceuta`,`Africa/Conakry`,`Africa/Dakar`,`Africa/Dar_es_Salaam`,`Africa/Djibouti`,`Africa/Douala`,`Africa/El_Aaiun`,`Africa/Freetown`,`Africa/Gaborone`,`Africa/Harare`,`Africa/Johannesburg`,`Africa/Juba`,`Africa/Kampala`,`Africa/Khartoum`,`Africa/Kigali`,`Africa/Kinshasa`,`Africa/Lagos`,`Africa/Libreville`,`Africa/Lome`,`Africa/Luanda`,`Africa/Lubumbashi`,`Africa/Lusaka`,`Africa/Malabo`,`Africa/Maputo`,`Africa/Maseru`,`Africa/Mbabane`,`Africa/Mogadishu`,`Africa/Monrovia`,`Africa/Nairobi`,`Africa/Ndjamena`,`Africa/Niamey`,`Africa/Nouakchott`,`Africa/Ouagadougou`,`Africa/Porto-Novo`,`Africa/Sao_Tome`,`Africa/Timbuktu`,`Africa/Tripoli`,`Africa/Tunis`,`Africa/Windhoek`,`America/Adak`,`America/Anchorage`,`America/Anguilla`,`America/Antigua`,`America/Araguaina`,`America/Argentina/Buenos_Aires`,`America/Argentina/Catamarca`,`America/Argentina/ComodRivadavia`,`America/Argentina/Cordoba`,`America/Argentina/Jujuy`,`America/Argentina/La_Rioja`,`America/Argentina/Mendoza`,`America/Argentina/Rio_Gallegos`,`America/Argentina/Salta`,`America/Argentina/San_Juan`,`America/Argentina/San_Luis`,`America/Argentina/Tucuman`,`America/Argentina/Ushuaia`,`America/Aruba`,`America/Asuncion`,`America/Atikokan`,`America/Atka`,`America/Bahia`,`America/Bahia_Banderas`,`America/Barbados`,`America/Belem`,`America/Belize`,`America/Blanc-Sablon`,`America/Boa_Vista`,`America/Bogota`,`America/Boise`,`America/Buenos_Aires`,`America/Cambridge_Bay`,`America/Campo_Grande`,`America/Cancun`,`America/Caracas`,`America/Catamarca`,`America/Cayenne`,`America/Cayman`,`America/Chicago`,`America/Chihuahua`,`America/Coral_Harbour`,`America/Cordoba`,`America/Costa_Rica`,`America/Creston`,`America/Cuiaba`,`America/Curacao`,`America/Danmarkshavn`,`America/Dawson`,`America/Dawson_Creek`,`America/Denver`,`America/Detroit`,`America/Dominica`,`America/Edmonton`,`America/Eirunepe`,`America/El_Salvador`,`America/Ensenada`,`America/Fort_Nelson`,`America/Fort_Wayne`,`America/Fortaleza`,`America/Glace_Bay`,`America/Godthab`,`America/Goose_Bay`,`America/Grand_Turk`,`America/Grenada`,`America/Guadeloupe`,`America/Guatemala`,`America/Guayaquil`,`America/Guyana`,`America/Halifax`,`America/Havana`,`America/Hermosillo`,`America/Indiana/Indianapolis`,`America/Indiana/Knox`,`America/Indiana/Marengo`,`America/Indiana/Petersburg`,`America/Indiana/Tell_City`,`America/Indiana/Vevay`,`America/Indiana/Vincennes`,`America/Indiana/Winamac`,`America/Indianapolis`,`America/Inuvik`,`America/Iqaluit`,`America/Jamaica`,`America/Jujuy`,`America/Juneau`,`America/Kentucky/Louisville`,`America/Kentucky/Monticello`,`America/Knox_IN`,`America/Kralendijk`,`America/La_Paz`,`America/Lima`,`America/Los_Angeles`,`America/Louisville`,`America/Lower_Princes`,`America/Maceio`,`America/Managua`,`America/Manaus`,`America/Marigot`,`America/Martinique`,`America/Matamoros`,`America/Mazatlan`,`America/Mendoza`,`America/Menominee`,`America/Merida`,`America/Metlakatla`,`America/Mexico_City`,`America/Miquelon`,`America/Moncton`,`America/Monterrey`,`America/Montevideo`,`America/Montreal`,`America/Montserrat`,`America/Nassau`,`America/New_York`,`America/Nipigon`,`America/Nome`,`America/Noronha`,`America/North_Dakota/Beulah`,`America/North_Dakota/Center`,`America/North_Dakota/New_Salem`,`America/Ojinaga`,`America/Panama`,`America/Pangnirtung`,`America/Paramaribo`,`America/Phoenix`,`America/Port-au-Prince`,`America/Port_of_Spain`,`America/Porto_Acre`,`America/Porto_Velho`,`America/Puerto_Rico`,`America/Punta_Arenas`,`America/Rainy_River`,`America/Rankin_Inlet`,`America/Recife`,`America/Regina`,`America/Resolute`,`America/Rio_Branco`,`America/Rosario`,`America/Santa_Isabel`,`America/Santarem`,`America/Santiago`,`America/Santo_Domingo`,`America/Sao_Paulo`,`America/Scoresbysund`,`America/Shiprock`,`America/Sitka`,`America/St_Barthelemy`,`America/St_Johns`,`America/St_Kitts`,`America/St_Lucia`,`America/St_Thomas`,`America/St_Vincent`,`America/Swift_Current`,`America/Tegucigalpa`,`America/Thule`,`America/Thunder_Bay`,`America/Tijuana`,`America/Toronto`,`America/Tortola`,`America/Vancouver`,`America/Virgin`,`America/Whitehorse`,`America/Winnipeg`,`America/Yakutat`,`America/Yellowknife`,`Antarctica/Casey`,`Antarctica/Davis`,`Antarctica/DumontDUrville`,`Antarctica/Macquarie`,`Antarctica/Mawson`,`Antarctica/McMurdo`,`Antarctica/Palmer`,`Antarctica/Rothera`,`Antarctica/South_Pole`,`Antarctica/Syowa`,`Antarctica/Troll`,`Antarctica/Vostok`,`Arctic/Longyearbyen`,`Asia/Aden`,`Asia/Almaty`,`Asia/Amman`,`Asia/Anadyr`,`Asia/Aqtau`,`Asia/Aqtobe`,`Asia/Ashgabat`,`Asia/Ashkhabad`,`Asia/Atyrau`,`Asia/Baghdad`,`Asia/Bahrain`,`Asia/Baku`,`Asia/Bangkok`,`Asia/Barnaul`,`Asia/Beirut`,`Asia/Bishkek`,`Asia/Brunei`,`Asia/Calcutta`,`Asia/Chita`,`Asia/Choibalsan`,`Asia/Chongqing`,`Asia/Chungking`,`Asia/Colombo`,`Asia/Dacca`,`Asia/Damascus`,`Asia/Dhaka`,`Asia/Dili`,`Asia/Dubai`,`Asia/Dushanbe`,`Asia/Famagusta`,`Asia/Gaza`,`Asia/Harbin`,`Asia/Hebron`,`Asia/Ho_Chi_Minh`,`Asia/Hong_Kong`,`Asia/Hovd`,`Asia/Irkutsk`,`Asia/Istanbul`,`Asia/Jakarta`,`Asia/Jayapura`,`Asia/Jerusalem`,`Asia/Kabul`,`Asia/Kamchatka`,`Asia/Karachi`,`Asia/Kashgar`,`Asia/Kathmandu`,`Asia/Katmandu`,`Asia/Khandyga`,`Asia/Kolkata`,`Asia/Krasnoyarsk`,`Asia/Kuala_Lumpur`,`Asia/Kuching`,`Asia/Kuwait`,`Asia/Macao`,`Asia/Macau`,`Asia/Magadan`,`Asia/Makassar`,`Asia/Manila`,`Asia/Muscat`,`Asia/Nicosia`,`Asia/Novokuznetsk`,`Asia/Novosibirsk`,`Asia/Omsk`,`Asia/Oral`,`Asia/Phnom_Penh`,`Asia/Pontianak`,`Asia/Pyongyang`,`Asia/Qatar`,`Asia/Qostanay`,`Asia/Qyzylorda`,`Asia/Rangoon`,`Asia/Riyadh`,`Asia/Saigon`,`Asia/Sakhalin`,`Asia/Samarkand`,`Asia/Seoul`,`Asia/Shanghai`,`Asia/Singapore`,`Asia/Srednekolymsk`,`Asia/Taipei`,`Asia/Tashkent`,`Asia/Tbilisi`,`Asia/Tehran`,`Asia/Tel_Aviv`,`Asia/Thimbu`,`Asia/Thimphu`,`Asia/Tokyo`,`Asia/Tomsk`,`Asia/Ujung_Pandang`,`Asia/Ulaanbaatar`,`Asia/Ulan_Bator`,`Asia/Urumqi`,`Asia/Ust-Nera`,`Asia/Vientiane`,`Asia/Vladivostok`,`Asia/Yakutsk`,`Asia/Yangon`,`Asia/Yekaterinburg`,`Asia/Yerevan`,`Atlantic/Azores`,`Atlantic/Bermuda`,`Atlantic/Canary`,`Atlantic/Cape_Verde`,`Atlantic/Faeroe`,`Atlantic/Faroe`,`Atlantic/Jan_Mayen`,`Atlantic/Madeira`,`Atlantic/Reykjavik`,`Atlantic/South_Georgia`,`Atlantic/St_Helena`,`Atlantic/Stanley`,`Australia/ACT`,`Australia/Adelaide`,`Australia/Brisbane`,`Australia/Broken_Hill`,`Australia/Canberra`,`Australia/Currie`,`Australia/Darwin`,`Australia/Eucla`,`Australia/Hobart`,`Australia/LHI`,`Australia/Lindeman`,`Australia/Lord_Howe`,`Australia/Melbourne`,`Australia/NSW`,`Australia/North`,`Australia/Perth`,`Australia/Queensland`,`Australia/South`,`Australia/Sydney`,`Australia/Tasmania`,`Australia/Victoria`,`Australia/West`,`Australia/Yancowinna`,`Brazil/Acre`,`Brazil/DeNoronha`,`Brazil/East`,`Brazil/West`,`CET`,`CST6CDT`,`Canada/Atlantic`,`Canada/Central`,`Canada/Eastern`,`Canada/Mountain`,`Canada/Newfoundland`,`Canada/Pacific`,`Canada/Saskatchewan`,`Canada/Yukon`,`Chile/Continental`,`Chile/EasterIsland`,`Cuba`,`EET`,`EST5EDT`,`Egypt`,`Eire`,`Etc/GMT`,`Etc/GMT+0`,`Etc/GMT+1`,`Etc/GMT+10`,`Etc/GMT+11`,`Etc/GMT+12`,`Etc/GMT+2`,`Etc/GMT+3`,`Etc/GMT+4`,`Etc/GMT+5`,`Etc/GMT+6`,`Etc/GMT+7`,`Etc/GMT+8`,`Etc/GMT+9`,`Etc/GMT-0`,`Etc/GMT-1`,`Etc/GMT-10`,`Etc/GMT-11`,`Etc/GMT-12`,`Etc/GMT-13`,`Etc/GMT-14`,`Etc/GMT-2`,`Etc/GMT-3`,`Etc/GMT-4`,`Etc/GMT-5`,`Etc/GMT-6`,`Etc/GMT-7`,`Etc/GMT-8`,`Etc/GMT-9`,`Etc/GMT0`,`Etc/Greenwich`,`Etc/UCT`,`Etc/UTC`,`Etc/Universal`,`Etc/Zulu`,`Europe/Amsterdam`,`Europe/Andorra`,`Europe/Astrakhan`,`Europe/Athens`,`Europe/Belfast`,`Europe/Belgrade`,`Europe/Berlin`,`Europe/Bratislava`,`Europe/Brussels`,`Europe/Bucharest`,`Europe/Budapest`,`Europe/Busingen`,`Europe/Chisinau`,`Europe/Copenhagen`,`Europe/Dublin`,`Europe/Gibraltar`,`Europe/Guernsey`,`Europe/Helsinki`,`Europe/Isle_of_Man`,`Europe/Istanbul`,`Europe/Jersey`,`Europe/Kaliningrad`,`Europe/Kiev`,`Europe/Kirov`,`Europe/Lisbon`,`Europe/Ljubljana`,`Europe/London`,`Europe/Luxembourg`,`Europe/Madrid`,`Europe/Malta`,`Europe/Mariehamn`,`Europe/Minsk`,`Europe/Monaco`,`Europe/Moscow`,`Europe/Nicosia`,`Europe/Oslo`,`Europe/Paris`,`Europe/Podgorica`,`Europe/Prague`,`Europe/Riga`,`Europe/Rome`,`Europe/Samara`,`Europe/San_Marino`,`Europe/Sarajevo`,`Europe/Saratov`,`Europe/Simferopol`,`Europe/Skopje`,`Europe/Sofia`,`Europe/Stockholm`,`Europe/Tallinn`,`Europe/Tirane`,`Europe/Tiraspol`,`Europe/Ulyanovsk`,`Europe/Uzhgorod`,`Europe/Vaduz`,`Europe/Vatican`,`Europe/Vienna`,`Europe/Vilnius`,`Europe/Volgograd`,`Europe/Warsaw`,`Europe/Zagreb`,`Europe/Zaporozhye`,`Europe/Zurich`,`GB`,`GB-Eire`,`GMT`,`GMT0`,`Greenwich`,`Hongkong`,`Iceland`,`Indian/Antananarivo`,`Indian/Chagos`,`Indian/Christmas`,`Indian/Cocos`,`Indian/Comoro`,`Indian/Kerguelen`,`Indian/Mahe`,`Indian/Maldives`,`Indian/Mauritius`,`Indian/Mayotte`,`Indian/Reunion`,`Iran`,`Israel`,`Jamaica`,`Japan`,`Kwajalein`,`Libya`,`MET`,`MST7MDT`,`Mexico/BajaNorte`,`Mexico/BajaSur`,`Mexico/General`,`NZ`,`NZ-CHAT`,`Navajo`,`PRC`,`PST8PDT`,`Pacific/Apia`,`Pacific/Auckland`,`Pacific/Bougainville`,`Pacific/Chatham`,`Pacific/Chuuk`,`Pacific/Easter`,`Pacific/Efate`,`Pacific/Enderbury`,`Pacific/Fakaofo`,`Pacific/Fiji`,`Pacific/Funafuti`,`Pacific/Galapagos`,`Pacific/Gambier`,`Pacific/Guadalcanal`,`Pacific/Guam`,`Pacific/Honolulu`,`Pacific/Johnston`,`Pacific/Kiritimati`,`Pacific/Kosrae`,`Pacific/Kwajalein`,`Pacific/Majuro`,`Pacific/Marquesas`,`Pacific/Midway`,`Pacific/Nauru`,`Pacific/Niue`,`Pacific/Norfolk`,`Pacific/Noumea`,`Pacific/Pago_Pago`,`Pacific/Palau`,`Pacific/Pitcairn`,`Pacific/Pohnpei`,`Pacific/Ponape`,`Pacific/Port_Moresby`,`Pacific/Rarotonga`,`Pacific/Saipan`,`Pacific/Samoa`,`Pacific/Tahiti`,`Pacific/Tarawa`,`Pacific/Tongatapu`,`Pacific/Truk`,`Pacific/Wake`,`Pacific/Wallis`,`Pacific/Yap`,`Poland`,`Portugal`,`ROK`,`Singapore`,`Turkey`,`UCT`,`US/Alaska`,`US/Aleutian`,`US/Arizona`,`US/Central`,`US/East-Indiana`,`US/Eastern`,`US/Hawaii`,`US/Indiana-Starke`,`US/Michigan`,`US/Mountain`,`US/Pacific`,`US/Pacific-New`,`US/Samoa`,`UTC`,`Universal`,`W-SU`,`WET`,`Zulu`
locale	string	An enumeration. Enum: `de`,`en`,`hu`,`it`,`nl`,`sv`

400

Bad request

415

Unsupported media type

422

Validation Error

Response

Reset Timezone Locale

Reset user timezone and locale settings

Auth

DELETE /api/users/reset-timezone-locale

Responses

200

Successful Response

No response body

401

Not authorized

Response

Get Avatar Image

Get use avatar image

Auth

Path Params

account_id string

GET /api/users/{account_id}/avatar

Responses

200

Successful Response

No response body

422

Validation Error

Response

Create API Key

Create API key for current user

Auth

POST /api/users/api-key/create

Responses

200

Successful Response

No response body

Response

Set API key

Set API key for current user

Auth

Request Body

SetApiKeyRequest	object	Request model to set API key
api_key	string

POST /api/users/api-key/set

Responses

200

Successful Response

No response body

400

Bad request

422

Validation Error

Response

Remove API Key

Remove user's API key

Auth

POST /api/users/api-key/remove

Responses

200

Successful Response

No response body

Response

Mark notification as viewed by user

Auth

Path Params

notification

string

Enum: dark_theme

POST /api/users/notifications/{notification}

Responses

200

Successful Response

No response body

422

Validation Error

Response

Get User Stat

Get app statistics for current user or for all users

Auth

Query String

types	array	Enum: `count_malicious_ips_by_user`,`count_verdicts_by_user`,`count_reports_by_user`,`count_uploads_by_user`
all_users	boolean	Default: false
period	string

GET /api/users/stat

Responses

200

Successful Response

UserStatResponse	array[object]
user	object
account_id	string
username	string
pseudoname	string
name	string
updated_date	date-time

401

Not authorized

403

Forbidden

422

Validation Error

Response

Get User Generic Stat

Get app statistics not related to specific user

Auth

Query String

types	array	Enum: `count_reports`,`count_verdicts`,`count_iocs`,`count_yaras`,`count_users`,`count_users_signup_by_day`,`count_users_signin_by_day`,`fix_old_count_users_signin_by_day`,`count_active_users`,`count_users_uploads`,`count_uploads_by_date`,`count_reports_by_extension`,`count_malicious_reports_by_extension`,`count_malicious_reports_by_language`,`count_malicious_reports_by_country`,`count_malicious_ips`,`count_malicious_ips_by_user`,`count_malicious_ips_ratio`,`count_verdicts_by_date`,`count_verdicts_by_user`,`count_reports_by_date`,`count_reports_by_user`,`count_uploads_by_user`,`frequent_tags`,`frequent_yara_tags`,`most_interesting`,`finalize_fakely_hanged_reports`,`system_info`,`clean_storage`,`do_retention`,`do_healthcheck`,`get_fuzzyhashes_verdicts`,`delete_reports`,`postprocess_iocs`,`new_search_fix_search_params`,`count_initial_scan_jobs_by_date`,`count_rescan_jobs_by_date`,`count_mitre_techniques`,`load_mitre_data`,`get_intersting_score`,`collect_daily_reports`,`fix_link_mime_type`,`update_xml_feed`,`update_sitemap`,`send_emails_queue`,`update_sourcetype_based_on_shorttype`,`copy_app_errors`,`add_country_search_param`,`set_pseudonames`,`normalize_verdict_history`,`delete_search_indexes`,`create_search_indexes`,`count_search_params`,`report_ocm_status`,`set_uploads_date_fields`,`set_auditor_features`,`change_additional_scan_steps`,`set_new_logos`,`count_reports_states_by_date`,`count_reports_extensions_by_date`,`report_usage_to_ocm`,`old_errors_cleanup`,`frequent_signal_tags`,`frequent_malware_tags`
period	string

GET /api/users/stat/generic

Responses

200

Successful Response

AppStatResponse	array[object]
name	string
value
boolean	boolean
updated_date	date-time

400

Bad request

401

Not authorized

403

Forbidden

422

Validation Error

Response

Get Malicious Ips Stat

Get statistics on malicious IPs

Auth

Query String

period	string
target	string

GET /api/users/stat/malicious-ips

Responses

200

Successful Response

AppStat	object	Generic statistic record. Can hold statistics of any type.
name	string
period	string
updated_date	date-time
id	string

400

Bad request

401

Not authorized

422

Validation Error

Response

Get Ioc Stat

Get app statistics

Auth

GET /api/users/stat/iocs

Responses

200

Successful Response

StatForResponse	object
count
integer	integer
updated	date-time

401

Not authorized

Response

Get Yara Stat

Get yara statistics

Auth

GET /api/users/stat/yara

Responses

200

Successful Response

StatForYaraResponse	object
count
integer	integer
updated	date-time

401

Not authorized

Response

Get Mitre Stat

Get statistics on MITRE techniques used in reports

Auth

GET /api/users/stat/mitre

Responses

200

Successful Response

StatForResponse	object
count
integer	integer
updated	date-time

401

Not authorized

Response

Get Yara Info

Get yara repo info

Auth

GET /api/users/info/yara

Responses

200

Successful Response

YaraInfoResponse	object
info	array[object]
revision	string
url	string

401

Not authorized

Response

Get Default

Return general information about webservice, just to indicate that API is working

Auth

GET /api/system/info

Responses

200

Successful Response

No response body

Response

Get Version

Return the version of the webservice

Auth

GET /api/system/version

Responses

200

Successful Response

No response body

Response

Get Config

Obtain project configuration to use on front-end

Auth

GET /api/system/config

Responses

200

Successful Response

No response body

Response

Get Terms

Obtain privacy policy and terms & conditions

Auth

Path Params

terms_type

string

Enum: privacy-policy,terms-condition,cookie-policy

GET /api/system/get-terms/{terms_type}

Responses

200

Successful Response

No response body

422

Validation Error

Response

Get Signal Groups

Obtain signal groups list

Auth

GET /api/system/signal-groups

Responses

200

Successful Response

No response body

Response

Get Mime Types

Obtain mime type list

Auth

GET /api/system/mime-types

Responses

200

Successful Response

No response body

Response

Get Yara Rules

Get extended data of yara rules

Auth

Query String

name

array

Default: []

GET /api/system/yara

Responses

200

Successful Response

YaraRuleResponse	array[object]
name	string
author	string
strength	number
created_date	date-time
description	string
other_data	object
content	string

422

Validation Error

Response

Get Yara Authors

Get yara rules authors

Auth

Query String

name

array

Default: []

GET /api/system/yara-authors

Responses

200

Successful Response

array array[string]

422

Validation Error

Response

Get Translations

Obtain translations for specific language

Auth

Path Params

lang

string

Enum: en,de,zh-CN,es,hi,ar,pt,bn,ru,ja,ko,fr,te,mr,tr,ta,vi,ur

GET /api/system/translations/{lang}

Responses

200

Successful Response

No response body

422

Validation Error

Response

Get Languages

Obtain list of all detectable (and probably even more) languages

Auth

GET /api/system/languages

Responses

200

Successful Response

No response body

Response

Get Countries

Obtain list of all countries

Auth

GET /api/system/countries

Responses

200

Successful Response

No response body

Response

Get Mitre Data

Obtain MITRE tactics and techniques

Auth

GET /api/system/mitre

Responses

200

Successful Response

No response body

Response

Log Client Error

Perform needed actions with error data, obtained from front-end

Auth

POST /api/system/errors/log

Responses

200

Successful Response

No response body

Response

Get Logo

Get logo image

Auth

Query String

type	string
theme	string
name	string

GET /api/system/logo

Responses

200

Successful Response

No response body

422

Validation Error

Response

Do Healthcheck

Do an immediate healthcheck and return the state

Auth

GET /api/system/do-healthcheck

Responses

200

Successful Response

DoHealthcheckOutput	object
created_date	date-time
frontend_health	object	Frontent health log
http_info	object	HTTP health log
response_time_ms	integer
response_code_http	integer
request_success	boolean
calculated_health	boolean	Default: false
webservice_health	object	Webservice health log
http_info_direct	object	HTTP health log
response_time_ms	integer
response_code_http	integer
request_success	boolean
response_direct	object
http_info_nginx	object	HTTP health log
response_time_ms	integer
response_code_http	integer
request_success	boolean
response_nginx	object
number_of_all_users	integer
number_of_active_users	integer
tasks_queues	object
total_healthy	boolean	Health verdict
queues	array[object]	Details about each queue health verdict
queue_name	string	Name of tasks queue
check_type	string	Type of health check we have verdict for Enum: `long_run`,`new_run`,`all`
healthy	boolean	Health verdict
last_date_healthy	date-time	Last time queue was reported as working
data	object	Arbitrary data we can save as health state
calculated_health	boolean	Default: false
fstransform_health	array[object]
response	object
instance_id	string
calculated_health	boolean	Default: false
fsbroker_health	object	Fsbroker health log
http_info	object	HTTP health log
response_time_ms	integer
response_code_http	integer
request_success	boolean
response	object
calculated_health	boolean	Default: false

Response

Query Healthcheck

Query past healthcheck logs

Auth

Query String

days	integer	Default: 90
days_from	integer	Default: 0

GET /api/system/query-full-healthcheck

Responses

200

Successful Response

DoHealthcheckOutput	array[object]
created_date	date-time
frontend_health	object	Frontent health log
http_info	object	HTTP health log
response_time_ms	integer
response_code_http	integer
request_success	boolean
calculated_health	boolean	Default: false
webservice_health	object	Webservice health log
http_info_direct	object	HTTP health log
response_time_ms	integer
response_code_http	integer
request_success	boolean
response_direct	object
http_info_nginx	object	HTTP health log
response_time_ms	integer
response_code_http	integer
request_success	boolean
response_nginx	object
number_of_all_users	integer
number_of_active_users	integer
tasks_queues	object
total_healthy	boolean	Health verdict
queues	array[object]	Details about each queue health verdict
queue_name	string	Name of tasks queue
check_type	string	Type of health check we have verdict for Enum: `long_run`,`new_run`,`all`
healthy	boolean	Health verdict
last_date_healthy	date-time	Last time queue was reported as working
data	object	Arbitrary data we can save as health state
calculated_health	boolean	Default: false
fstransform_health	array[object]
response	object
instance_id	string
calculated_health	boolean	Default: false
fsbroker_health	object	Fsbroker health log
http_info	object	HTTP health log
response_time_ms	integer
response_code_http	integer
request_success	boolean
response	object
calculated_health	boolean	Default: false

422

Validation Error

Response

Query Healthcheck

Query sanitized past healthcheck logs

Auth

Query String

days	integer	Default: 90
days_from	integer	Default: 0

GET /api/system/query-healthcheck

Responses

200

Successful Response

SanitizedHealthCheckOutput	array[object]
created_date	date-time
frontend_health	object
webservice_health	object
fstransform_health	array[object]
fsbroker_health	object

422

Validation Error

Response

Check License Info

Auth

GET /api/system/license

Responses

200

Successful Response

No response body

Response

Activate License Online

Activate license online, using license key

Auth

Request Body

LicenseActivateOnlinePayload	object
app_server	string
license_key	string

POST /api/system/license/activate/online

Responses

200

Successful Response

No response body

422

Validation Error

Response

Activate License Offline

Activate license, using license file

Auth

Request Body

Body_activate_license_offline_api_system_license_activate_offline_post	object
app_server	string

POST /api/system/license/activate/offline

Responses

200

Successful Response

No response body

422

Validation Error

Response

Deactivate License

Auth

Query String

app_server string

DELETE /api/system/license/deactivate

Responses

200

Successful Response

No response body

422

Validation Error

Response

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

Auth

GET /api/system/reputation/check-config

Responses

200

Successful Response

ReputationCheckConfigResponse	object
reputation_enabled	boolean

Response

Get News

Auth

GET /api/system/news

Responses

200

Successful Response

NewsItemResponse	array[object]
id	string
link	string
date	string	Represenation of news date, is shown as is
text	string
images	string	Comma separated list of images URLs
order	integer	In what order news should be shown
active	boolean	If this news item should be shown

Response

Admin

Functionality for site admins.

GET

/api/debug/reports/{scan_init}

/api/admin/access-groups

POST

/api/admin/access-groups

POST

/api/admin/access-groups/{group_id}/remove

GET

/api/admin/settings/api-quota

POST

/api/admin/settings/api-quota

POST

/api/admin/settings/api-quota/{quota_id}/remove

GET

/api/admin/settings/{group}

POST

/api/admin/settings/{group}

POST

/api/admin/oauth-services/{service}/remove

POST

/api/admin/oauth-services

GET

/api/admin/users

GET

/api/admin/users/import

GET

/api/admin/users/{user_id}

POST

/api/admin/users/{user_id}

DELETE

/api/admin/users/{user_id}

GET

/api/admin/users/{user_id}/uploads

GET

/api/admin/users/{user_id}/reset-password

DELETE

/api/admin/reports/{report_id}

GET

/api/admin/app-config

GET

/api/admin/stat/services

POST

/api/admin/invite

GET

/api/admin/generate-external-tokens-secret

/api/admin/errors/{error_id}

POST

/api/admin/errors/{error_id}/note

GET

/api/admin/errors/export

/api/admin/retention-calculation

GET

/api/admin/logs/{log_id}

DELETE

/api/admin/logs/{log_id}

POST

/api/admin/logs/{log_id}/note

GET

/api/admin/logos

POST

/api/admin/logos/select

GET

/api/admin/stat

GET

/api/admin/stat/daily

GET

/api/admin/jobs

GET

/api/admin/jobs/config

GET

/api/admin/jobs/memory/peaks

GET

/api/admin/jobs/memory

POST

/api/admin/jobs/{job_name}

GET

/api/admin/jobs/{job_name}/log

POST

/api/admin/jobs/stop/all

POST

/api/admin/jobs/enable/all

GET

/api/admin/stat/scan/health

GET

/api/admin/stat/scan/states

GET

/api/users/stat/daily

/api/admin/emails/templates

GET

/api/admin/scan-sources/files

GET

/api/admin/scan-sources/config

POST

/api/admin/scan-sources/config

DELETE

/api/admin/scan-sources/config

GET

/api/admin/scan-sources/{config_id}/check-connection

GET

/api/admin/scan-sources/subjobs

GET

/api/admin/scan-sources/subjobs/{job_id}

Get Report

Get report in raw format

Auth

Path Params

scan_init string

GET /api/debug/reports/{scan_init}

Responses

200

Successful Response

RawReportResponse	object	Model for report raw format
scan_init	object	Model for ScanInit.get_fields()
file	object	Scanned file model
name	string
link	string
hash	string
size	integer
category	string
mime_type	string
short_type	string	Short unified file type description, like peexe, pdf, xls etc.
description	string
password	string
is_private	boolean	Prevent other users of this service to access this sample Default: false
additional_hashes	object	Other possible hashes, needed in some situations
scan_options	object	Options to turn on/off various scan features
rapid_mode	boolean	Disable some scan long-running features Default: false
osint	boolean	Enable OSINT (e.g. VirusTotal, ClamAV) lookups Default: true
extended_osint	boolean	Enable OSINT lookups on extracted IOCs Default: true
extracted_files_osint	boolean	Enable OSINT lookups on extracted files Default: true
visualization	boolean	Enable file visualization (e.g. PDF rendering) Default: true
files_download	boolean	Enable download of files from extracted URLs Default: true
resolve_domains	boolean	Enable resolving domains to IPs (DNS) Default: true
input_file_yara	boolean	Enable YARA rule matches on input file Default: true
extracted_files_yara	boolean	Enable YARA rule matches on extracted files Default: true
whois	boolean	Enable WHOIS record lookups Default: true
ips_meta	boolean	Enable meta-data lookups for extracted IPs Default: true
images_ocr	boolean	Enable OCR text recognition on extracted images Default: true
default_options_used	boolean
scan_started_date	date-time
data	object
job	object
tags	array[string]
propagate_tags	boolean
priority	integer
reports	object
*	object	Model for ScanReport.get_fields()
id	string
file	object	Scanned file model
name	string
link	string
hash	string
size	integer
category	string
mime_type	string
short_type	string	Short unified file type description, like peexe, pdf, xls etc.
description	string
password	string
is_private	boolean	Prevent other users of this service to access this sample Default: false
additional_hashes	object	Other possible hashes, needed in some situations
data	object
created_date	date-time
state	string	An enumeration. Enum: `success`,`success_partial`,`failed`,`failed_partial`,`in_progress`,`in_queue`
verdict	string	An enumeration. Enum: `unknown`,`benign`,`informational`,`no_threat`,`suspicious`,`likely_malicious`,`malicious`
job	object
scan_options	object	Options to turn on/off various scan features
rapid_mode	boolean	Disable some scan long-running features Default: false
osint	boolean	Enable OSINT (e.g. VirusTotal, ClamAV) lookups Default: true
extended_osint	boolean	Enable OSINT lookups on extracted IOCs Default: true
extracted_files_osint	boolean	Enable OSINT lookups on extracted files Default: true
visualization	boolean	Enable file visualization (e.g. PDF rendering) Default: true
files_download	boolean	Enable download of files from extracted URLs Default: true
resolve_domains	boolean	Enable resolving domains to IPs (DNS) Default: true
input_file_yara	boolean	Enable YARA rule matches on input file Default: true
extracted_files_yara	boolean	Enable YARA rule matches on extracted files Default: true
whois	boolean	Enable WHOIS record lookups Default: true
ips_meta	boolean	Enable meta-data lookups for extracted IPs Default: true
images_ocr	boolean	Enable OCR text recognition on extracted images Default: true
default_options_used	boolean

400

Bad request

404

Item not found

422

Validation Error

Response

Save News Item

Save news item data

Auth

Request Body

AdminNewsPayload	object
id	string
link	string
date	string
text	string
images	string
order	integer
active	boolean

POST /api/system/news

Responses

200

Successful Response

No response body

400

Bad request

401

Not authorized

404

Item not found

422

Validation Error

Response

Remove News Item

Remove news item

Auth

Query String

news_id

DELETE /api/system/news

Responses

200

Successful Response

No response body

400

Bad request

401

Not authorized

404

Item not found

422

Validation Error

Response

Get Access Groups

Get a list of all access groups

Auth

GET /api/admin/access-groups

Responses

200

Successful Response

AdminGroupResponse	array[object]
id	string
name	string	maxLength: 100
description	string	maxLength: 300
default	boolean	If group is provided by app by default

401

Not authorized

Response

Save Access Group

Add or edit group.

Note: ID is a required parameter to modify a group

Auth

Request Body

SaveAccessGroupRequest	object	Request model to save access groups
id	string
name	string
description	string

POST /api/admin/access-groups

Responses

200

Successful Response

No response body

400

Bad request

401

Not authorized

404

Item not found

422

Validation Error

Response

Remove Access Group

Remove group

Auth

Path Params

group_id string

POST /api/admin/access-groups/{group_id}/remove

Responses

200

Successful Response

No response body

400

Bad request

401

Not authorized

404

Item not found

422

Validation Error

Response

Get Api Quota

Get all api quota settings

Auth

GET /api/admin/settings/api-quota

Responses

200

Successful Response

ApiQuotaSetting	array[object]
route_id	string
groups	array[string]	User groups to apply quota settings to
time_settings	object
seconds	object
seconds_amount	integer	Seconds period to count requests
requests	integer	Requests amount per seconds period
minute	integer	Max requests amount per minute
hour	integer	Max requests amount per hour
day	integer	Max requests amount per day
week	integer	Max requests amount per week
month	integer	Max requests amount per month
credits_settings	object
request_cost	integer	Credits cost for single request
total_credits	integer	Total credits available per month
id	string

401

Not authorized

Response

Save Api Quota

Save single API quota setting

Auth

Request Body

SaveApiQuotaSettingRequest	object	Request model to save api quota setting
route_id	string
groups	array[string]
time_settings	object
seconds	object
seconds_amount	integer	Seconds period to count requests
requests	integer	Requests amount per seconds period
minute	integer	Max requests amount per minute
hour	integer	Max requests amount per hour
day	integer	Max requests amount per day
week	integer	Max requests amount per week
month	integer	Max requests amount per month
credits_settings	object
request_cost	integer	Credits cost for single request
total_credits	integer	Total credits available per month

POST /api/admin/settings/api-quota

Responses

200

Successful Response

No response body

400

Bad request

401

Not authorized

422

Validation Error

Response

Remove Api Quota

Remove single api quota setting

Auth

Path Params

quota_id string

POST /api/admin/settings/api-quota/{quota_id}/remove

Responses

200

Successful Response

No response body

400

Bad request

401

Not authorized

404

Item not found

422

Validation Error

Response

Get Settings Group

Get a group of admin settings

Auth

Path Params

group

string

Enum: access,auth,environment,oauth_services

GET /api/admin/settings/{group}

Responses

200

Successful Response

AdminSettingOutput	array[object]
id	string
name	string
group	string	An enumeration. Enum: `access`,`auth`,`environment`,`oauth_services`
subgroup	string
value
integer	integer

401

Not authorized

422

Validation Error

Response

Save Settings Group

Update group of admin settings

Auth

Path Params

group

string

Enum: access,auth,environment,oauth_services

Request Body

Data	object
*	object

POST /api/admin/settings/{group}

Responses

200

Successful Response

No response body

400

Bad request

401

Not authorized

422

Validation Error

Response

Remove Oauth Service

Remove external oauth service settings

Auth

Path Params

service string

POST /api/admin/oauth-services/{service}/remove

Responses

200

Successful Response

No response body

401

Not authorized

422

Validation Error

Response

Save Oauth Services

Update settings of external oauth services

Auth

Request Body

Data	object
*	object	Request model to save OAuth services
active	boolean
client_id	string
discovery_base_url	string
discovery_path	string
home_page	string
key	string
name	string
order	string
secret	string

POST /api/admin/oauth-services

Responses

200

Successful Response

No response body

400

Bad request

401

Not authorized

422

Validation Error

Response

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.

Auth

Query String

page		Default: 1
ids	array
filter	string

GET /api/admin/users

Responses

200

Successful Response

AdminUsersResponse	object	Customize admin response models
items	array[object]
id	string
account_id	string	Permanent id to use, say, in urls
email	string
username	string	User nickname in system
groups	array[string]	Groups user is a member of
confirmed	boolean	Default: false
active	boolean	Default: false
created_date	date-time
last_login_date	date-time
count_uploads	integer	Amount of user uploads Default: 0
total_count	integer
matched_count	integer

401

Not authorized

422

Validation Error

Response

Get Users Overview

Download basic users info as csv file

Auth

GET /api/admin/users/import

Responses

200

Successful Response

No response body

401

Not authorized

Response

Get User

Get user by user id

Auth

Path Params

user_id string

GET /api/admin/users/{user_id}

Responses

200

Successful Response

AdminUserResponse	object
id	string
account_id	string	Permanent id to use, say, in urls
email	string
username	string	User nickname in system
groups	array[string]	Groups user is a member of
confirmed	boolean	Default: false
active	boolean	Default: false
created_date	date-time
last_login_date	date-time
count_uploads	integer	Amount of user uploads Default: 0

400

Bad request

401

Not authorized

404

Item not found

422

Validation Error

Response

Edit User

Edit user

Auth

Path Params

user_id string

Request Body

EditUserRequest	object	Request model to edit user
active	boolean
confirmed	boolean
groups	array[string]

POST /api/admin/users/{user_id}

Responses

200

Successful Response

No response body

400

Bad request

401

Not authorized

404

Item not found

422

Validation Error

Response

Delete User

Delete a user

Auth

Path Params

user_id string

DELETE /api/admin/users/{user_id}

Responses

200

Successful Response

No response body

401

Not authorized

404

Item not found

422

Validation Error

Response

Get User Uploads

Get user's uploads

Auth

Path Params

user_id string

Query String

page

integer

minimum: 1

Default: 1

page_size

Default: 10

GET /api/admin/users/{user_id}/uploads

Responses

200

Successful Response

UserUploadsResponse	object
items	array[object]
count	integer
timing	array[object]
method	string	An enumeration. Enum: `or`,`and`
count_search_params	integer

401

Not authorized

422

Validation Error

Response

Get User Reset Password Link

Generate user's reset-password link

Auth

Path Params

user_id string

GET /api/admin/users/{user_id}/reset-password

Responses

200

Successful Response

UserResetPasswordResponse	object
token	string

401

Not authorized

422

Validation Error

Response

Delete Report

Delete a report

Auth

Path Params

report_id string

DELETE /api/admin/reports/{report_id}

Responses

200

Successful Response

No response body

401

Not authorized

404

Item not found

422

Validation Error

Response

Get App Config

Get app basic config values

Auth

GET /api/admin/app-config

Responses

200

Successful Response

Response Get App Config Api Admin App Config Get object

401

Not authorized

Response

Get Services Stat

Get statistics of various running services

Auth

GET /api/admin/stat/services

Responses

200

Successful Response

ServicesStatResponse	object
queues	object	Service Stat Response nested model
scan	object
redis	object	Service Stat Response nested model
info	object

401

Not authorized

Response

Generate Invite Token

Generate invitation token for user

Auth

Request Body

AdminGenerateInviteLinkResponse	object
groups	array[string]

POST /api/admin/invite

Responses

200

Successful Response

GenerateInviteTokenResponse	object
token	string

401

Not authorized

422

Validation Error

Response

Generate External Tokens Secret

Generate secret key to encript external auth tokens

Auth

GET /api/admin/generate-external-tokens-secret

Responses

200

Successful Response

No response body

401

Not authorized

Response

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'

Auth

Query String

type		Default: client
page	integer	minimum: 1 Default: 1
filter	string
sort	string	Enum: `date`,`count`,`note`

GET /api/admin/errors

Responses

200

Successful Response

AdminAppErrorsResponse	object	Customize admin response models
items	array[object]
id	string
type	string	Type of application error that we can save Enum: `server`,`client`
message	string
url	string
context	string	Short description of error context Enum: `Scanning job`,`HTML/PDF report job`,`Scheduled job`
trace	string
first_occurance_date	date-time
last_occurance_date	date-time
occurance_count	integer	How often error was noticed Default: 1
is_signed_in	boolean	If user was signed in during error
report_flow_id	string
report_flow_file_sha256	string
report_id	string
report_file_sha256	string
note	string
total_count	integer
matched_count	integer

400

Bad request

401

Not authorized

422

Validation Error

Response

Remove App Errors

Remove saved errors matching filter

Params:

type - can be 'server' or 'client'
filter - match the given string to error message

Auth

Query String

type		Default: client
filter	string

DELETE /api/admin/errors

Responses

200

Successful Response

AdminAppErrorsRemovedResponse	object
removed_count	integer

400

Bad request

401

Not authorized

422

Validation Error

Response

App Error

Remove single saved error

Auth

Path Params

error_id string

DELETE /api/admin/errors/{error_id}

Responses

200

Successful Response

No response body

400

Bad request

401

Not authorized

422

Validation Error

Response

Edit App Error Note

Edit saved error note, to help memorize it's specifics

Auth

Path Params

error_id string

Request Body

AdminAppErrorNotePayload	object
note	string

POST /api/admin/errors/{error_id}/note

Responses

200

Successful Response

No response body

400

Bad request

401

Not authorized

422

Validation Error

Response

Export Errors

Export application errors in a .csv format

Auth

GET /api/admin/errors/export

Responses

200

Successful Response

No response body

401

Not authorized

Response

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'

Auth

Query String

page

integer

minimum: 1

Default: 1

filter string

sort

string

Enum: date,note

GET /api/admin/logs

Responses

200

Successful Response

AdminGenericLogsResponse	object	Customize admin response models
items	array[object]
id	string
key	string
key_type	string	Type of key attribute for logging record Enum: `scan_init_id`,`new_search`
note	string	Note describing log specifics
related_url	string	Related site page, if it exists
saved_date	date-time	Date when logging record was created
total_count	integer
matched_count	integer

400

Bad request

401

Not authorized

422

Validation Error

Response

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

Auth

Query String

filter string

DELETE /api/admin/logs

Responses

200

Successful Response

AdminGenericLogsRemovedResponse	object
removed_count	integer

400

Bad request

401

Not authorized

422

Validation Error

Response

Calculate Retention

Calculate affected number of reports by retention config changes

Auth

Query String

retention_period_malicious	integer
retention_period_suspicious	integer
retention_period_informational	integer
retention_period_unknown	integer
retention_period_benign	integer

GET /api/admin/retention-calculation

Responses

200

Successful Response

AdminRetentionCalculationResponse	object	Customize admin response models
total_number_of_reports	integer
affected_number_of_reports	object

401

Not authorized

422

Validation Error

Response

Get Full Generic Log

Obtain full log record data

Auth

Path Params

log_id string

GET /api/admin/logs/{log_id}

Responses

200

Successful Response

AdminGenericLogResponse	object
id	string
key	string
key_type	string	Type of key attribute for logging record Enum: `scan_init_id`,`new_search`
note	string	Note describing log specifics
related_url	string	Related site page, if it exists
saved_date	date-time	Date when logging record was created

400

Bad request

401

Not authorized

404

Item not found

422

Validation Error

Response

Remove Generic Log

Remove single log record

Auth

Path Params

log_id string

DELETE /api/admin/logs/{log_id}

Responses

200

Successful Response

No response body

400

Bad request

401

Not authorized

422

Validation Error

Response

Edit Generic Log Note

Edit log note, to help memorize it's specifics

Auth

Path Params

log_id string

Request Body

AdminGenericLogNotePayload	object
note	string

POST /api/admin/logs/{log_id}/note

Responses

200

Successful Response

No response body

400

Bad request

401

Not authorized

422

Validation Error

Response

Get Logos List

Get list of all available logos

Auth

GET /api/admin/logos

Responses

200

Successful Response

array array[string]

401

Not authorized

Response

Select Logo

Select new logo

Auth

Request Body

Body_select_logo_api_admin_logos_select_post	object
file	file
name	string
type	string	Type of logo, representing it's usecase Enum: `main`,`top_menu`,`footer`
theme	string	All available themes Enum: `light`,`dark`

POST /api/admin/logos/select

Responses

200

Successful Response

No response body

401

Not authorized

422

Validation Error

Response

Get Stat

Get app statistics

Auth

Query String

types

array

Enum: count_reports,count_verdicts,count_iocs,count_yaras,count_users,count_active_users,count_users_uploads,count_reports_by_extension,count_malicious_reports_by_extension,count_malicious_reports_by_language,count_malicious_reports_by_country,count_malicious_ips,count_malicious_ips_ratio,frequent_tags,frequent_yara_tags,most_interesting,system_info,count_mitre_techniques,frequent_malware_tags

GET /api/admin/stat

Responses

200

Successful Response

AppStatResponse	array[object]
name	string
value
boolean	boolean
updated_date	date-time

400

Bad request

401

Not authorized

403

Forbidden

422

Validation Error

Response

Get Daily Stat

Get app statistics, which is saved separately in daily stat collection

Auth

Query String

types	array	Enum: `count_verdicts_by_date`,`count_reports_by_date`,`count_uploads_by_date`,`count_initial_scan_jobs_by_date`,`count_rescan_jobs_by_date`,`count_reports_states_by_date`,`count_reports_extensions_by_date`,`count_users_signup_by_day`,`count_users_signin_by_day`
date_from	string
date_to	string

GET /api/admin/stat/daily

Responses

200

Successful Response

DateStatResponse	array[object]
date	string
name	string
value
boolean	boolean
updated_date	date-time

400

Bad request

401

Not authorized

422

Validation Error

Response

Get Jobs

Get all available jobs with some additional information

Auth

Query String

Get Jobs Config

Get jobs launch and runtime config

Auth

Query String

jobs array

GET /api/admin/jobs/config

Responses

200

Successful Response

ScheduleTaskConfig	array[object]
name	string
trigger	string	All available trigger types Enum: `once`,`date`,`interval`,`cron`,`calendarinterval`
trigger_config	object
runtime_config	object
is_subprocess	boolean	Field to differ real scheduled jobs from custom ones Default: false
is_active	boolean	If job is available for running Default: true
is_editable	boolean	If user is allowed to edit this settings Default: true
updated_date	date-time	Last time when schedual was updated by user
update_applied_date	date-time	Last date when updated schedual was applied to job
id	string

401

Not authorized

422

Validation Error

Response

Get Jobs Memory Peaks

Get peak jobs memory usage

Auth

GET /api/admin/jobs/memory/peaks

Responses

200

Successful Response

ScheduleTaskPeakMemoryResponse	array[object]
name	string
description	string
memory	number
is_killed	boolean
is_unresponsive	boolean

401

Not authorized

Response

Get Job Memory Details

Get job memory usage details

Auth

Query String

job_name string

GET /api/admin/jobs/memory

Responses

200

Successful Response

ScheduleTaskMemoryResponse	array[object]
name	string
resident_memory	number
date	date-time
is_killed	boolean

401

Not authorized

422

Validation Error

Response

Edit Job Config

Edit job config

Auth

Path Params

job_name string

Request Body

ScheduleTaskConfigEdit	object	Job edit input model
trigger	string	All available trigger types Enum: `once`,`date`,`interval`,`cron`,`calendarinterval`
trigger_config	object
runtime_config	object
is_active	boolean

POST /api/admin/jobs/{job_name}

Responses

200

Successful Response

No response body

400

Bad request

401

Not authorized

403

Forbidden

404

Item not found

422

Validation Error

Response

Get Job Log

Get job public log

Auth

Path Params

job_name string

GET /api/admin/jobs/{job_name}/log

Responses

200

Successful Response

ScheduleTaskLogResponse

object

Job log response

state

string

Name of job state

Enum: succeeded,succeeded_with_errors,failed,running

log array

401

Not authorized

404

Item not found

422

Validation Error

Response

Stop All Jobs

Stop all existing jobs

Auth

POST /api/admin/jobs/stop/all

Responses

200

Successful Response

No response body

401

Not authorized

Response

Enable All Jobs

Enable all existing jobs

Auth

POST /api/admin/jobs/enable/all

Responses

200

Successful Response

No response body

401

Not authorized

Response

Get Scan Jobs Health

Get health statistics about scan jobs queues

Auth

Query String

queue_name	string
check_type	string	Enum: `long_run`,`new_run`
date_from	string

GET /api/admin/stat/scan/health

Responses

200

Successful Response

ScanHealthResponse	array[object]
date	date-time
value	integer

401

Not authorized

422

Validation Error

Response

Get Scans States

Get statistics on scans progress

Auth

Query String

queue_name	string
state	array	Enum: `created`,`queued`,`scanning`,`queued_cancelled`,`changed_priority`,`failed`,`running_timedout`
date_from	string

GET /api/admin/stat/scan/states

Responses

200

Successful Response

ScanStateStatResponse	array[object]
count_created	integer
count_queued	integer
count_scanning	integer
count_failed	integer
count_queued_cancelled	integer
count_changed_priority	integer
count_running_timedout	integer
date	date-time

400

Bad request

401

Not authorized

422

Validation Error

Response

Get User Daily Stat

Get app statistics, which is saved separately in daily stat collection, available for ordinary users

Auth

Query String

types	array	Enum: `count_verdicts_by_date`,`count_reports_by_date`,`count_uploads_by_date`
date_from	string
date_to	string

GET /api/users/stat/daily

Responses

200

Successful Response

DateStatResponse	array[object]
date	string
name	string
value
boolean	boolean
updated_date	date-time

400

Bad request

401

Not authorized

422

Validation Error

Response

Get Emails History

Get history of sending mass emails

Auth

Query String

page

integer

minimum: 1

Default: 1

GET /api/admin/emails

Responses

200

Successful Response

EmailHistoryResponse	object
items	array[object]
id	string
recipient_type	string	Recipient types of mass email sending Enum: `all_users`,`admins`,`selected_users`
recipient_emails	array[string]
subject	string
content	string
state	string	State of email queue item processing Enum: `created`,`queued`,`sending`,`succeeded`,`failed`
created_date	date-time
completed_date	date-time
count_emails_sent	integer
error	object
total_count	integer

401

Not authorized

422

Validation Error

Response

Add Email Queue Item

Add record to emails queue

Auth

Request Body

EmailQueueRequest	object	Email queue input model
recipient_type	string	Recipient types of mass email sending Enum: `all_users`,`admins`,`selected_users`
recipient_emails	array[string]
subject	string
content	string

POST /api/admin/emails

Responses

200

Successful Response

No response body

401

Not authorized

422

Validation Error

Response

Get Emails Templates

Get predefined email templates

Auth

GET /api/admin/emails/templates

Responses

200

Successful Response

EmailTemplatesResponse	object
terms_change
string	string

401

Not authorized

Response

Get Files

Get list of files obtained from scan sources

Auth

Query String

page	integer	minimum: 1 Default: 1
config	string
state	string	Enum: `queued_for_download`,`downloading`,`queued_for_scan`,`scanning`,`scan_completed`
verdict	string	Enum: `unknown`,`benign`,`informational`,`no_threat`,`suspicious`,`likely_malicious`,`malicious`

GET /api/admin/scan-sources/files

Responses

200

Successful Response

AdminScanSourcesFilesResponse	object	Customize admin response models
items	array[object]
config	object
id	string
provider	string
name	string
source_type	string	An enumeration. Enum: `email:IMAP`,`s3`
file	object
name	string
hash	string
mime_type	string
state	string	All possible states of processing of file from remote scan source Enum: `queued_for_download`,`downloading`,`queued_for_scan`,`scanning`,`scan_completed`
verdict	string	An enumeration. Enum: `unknown`,`benign`,`informational`,`no_threat`,`suspicious`,`likely_malicious`,`malicious`
folder	string	Unique path to file on source
id_on_source	integer	Unique id of file in its folder on source
flow_id	string	Id of scan flow record
created_date	date-time	Time of file record creation
created_date_on_source	date-time	Date of file creation on source
downloaded_date	date-time
total_count	integer
matched_count	integer

401

Not authorized

422

Validation Error

Response

Get Scan Sources Configs

Obtain scan sources config records

Auth

Query String

page

integer

minimum: 1

Default: 1

GET /api/admin/scan-sources/config

Responses

200

Successful Response

AdminScanSourcesConfigsResponse	object	Customize admin response models
items	array[object]
id	string
provider	string
name	string
source_type	string	An enumeration. Enum: `email:IMAP`,`s3`
host	string
port	string
connection_security	string	An enumeration. Enum: `ssl_tls`,`start_tls`
folders	array[string]
remove_files_on_source	boolean	If we should remove files on source after scanning Default: false
credentials		Can have various fields depending on scan source
AdminLoginPasswordCredentialsResponse	object
login	string
is_active	boolean	If config is activated for usage
source_type_specific	object	Options specific to email sources
mark_as_seen	boolean	If we should mark downloaded emails as seen on email service Default: false
append_scanned_flag	boolean	If we should add flag with scan result to email on service Default: false
first_fetch_mode	string	What emails to fetch on first time accessing account Enum: `all`,`recent`,`unseen`
files_are_private	boolean	If all downloaded files should be scanned as private
description	string	Description field that should be added to all downloaded files
propagate_tags	boolean	If tags should be extracted from description and added to reports
schedule	object	Return job config to user
name	string
trigger	string	All available trigger types Enum: `once`,`date`,`interval`,`cron`,`calendarinterval`
trigger_config	object
runtime_config	object
is_active	boolean
is_editable	boolean
total_count	integer

401

Not authorized

422

Validation Error

Response

Edit Scan Source Config

Add or edit scan source config record

Auth

Request Body

EmailSourceConfigRequest	object
id	string
provider	string
name	string
source_type	string	An enumeration. Enum: `email:IMAP`,`s3`
host	string
port	string
connection_security	string	An enumeration. Enum: `ssl_tls`,`start_tls`
folders	array[string]
remove_files_on_source	boolean
credentials
LoginPasswordCredentials	object	Standard credentials with login/password
login	string
password	string
is_active	boolean
source_type_specific	object	Options specific to email sources
mark_as_seen	boolean	If we should mark downloaded emails as seen on email service Default: false
append_scanned_flag	boolean	If we should add flag with scan result to email on service Default: false
first_fetch_mode	string	What emails to fetch on first time accessing account Enum: `all`,`recent`,`unseen`
files_are_private	boolean
description	string
propagate_tags	boolean
schedule	object
trigger	string	Available tirgger types when adding scan source from clientside Enum: `once`,`interval`,`cron`
trigger_config	object
time	string
unit	string	An enumeration. Enum: `minutes`,`hours`,`days`,`each_day`,`week_day`
value
integer	integer
runtime_config	object
run_once	boolean
is_active	boolean

POST /api/admin/scan-sources/config

Responses

200

Successful Response

No response body

400

Bad request

401

Not authorized

404

Item not found

422

Validation Error

Response

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.

Auth

Request Body

ScanSourcesConfigIds	object
config_ids
string	string

DELETE /api/admin/scan-sources/config

Responses

200

Successful Response

AdminScanSourcesRemoveResponse	object
remove_count	integer

422

Validation Error

Response

Check Scan Source Connection

Verify if scan source credentials are working ok

Auth

Path Params

config_id string

GET /api/admin/scan-sources/{config_id}/check-connection

Responses

200

Successful Response

array array[string]

401

Not authorized

404

Item not found

422

Validation Error

Response

Get Scan Sources Jobs State

Get state of scan sources handlers

Auth

Query String

page

integer

minimum: 1

Default: 1

config string

GET /api/admin/scan-sources/subjobs

Responses

200

Successful Response

AdminScanSourcesSubjobsResponse	object	Customize admin response models
items	array[object]
scan_source_config	object
id	string
provider	string
name	string
source_type	string	An enumeration. Enum: `email:IMAP`,`s3`
config	object	Return job config to user
name	string
trigger	string	All available trigger types Enum: `once`,`date`,`interval`,`cron`,`calendarinterval`
trigger_config	object
runtime_config	object
is_active	boolean
is_editable	boolean
state	object	Return job state to user
name	string
state	string
data	object
updated_date	date-time
public_log	array
has_public_log	boolean
total_count	integer
matched_count	integer

401

Not authorized

422

Validation Error

Response

Get Full Scan Source Subjob State

Obtain full scan source job record data

Auth

Path Params

job_id string

GET /api/admin/scan-sources/subjobs/{job_id}

Responses

200

Successful Response

AdminScanSourceSubjobResponse	object	Customize admin response models
scan_source_config	object
id	string
provider	string
name	string
source_type	string	An enumeration. Enum: `email:IMAP`,`s3`
config	object	Return job config to user
name	string
trigger	string	All available trigger types Enum: `once`,`date`,`interval`,`cron`,`calendarinterval`
trigger_config	object
runtime_config	object
is_active	boolean
is_editable	boolean
state	object	Return job state to user
name	string
state	string
data	object
updated_date	date-time
public_log	array
has_public_log	boolean

400

Bad request

401

Not authorized

404

Item not found

422

Validation Error

Response

Audit-logger

Audit Logger

GET

/api/admin/audit-logs

Get Audit Logs

Obtain saved audit logs

Auth

Query String

logger_type	string	Enum: `admin`,`auth`
log_level_filter		Default: all
page	integer	minimum: 1 Default: 1
filter	string

GET /api/admin/audit-logs

Responses

200

Successful Response

AuditLogsResponse	object	Response model for getting audit logs
items	array[object]
total_count	integer
matched_count	integer

400

Bad request

401

Not authorized

422

Validation Error

Response

Threatintel

Threat Intelligence

POST

/api/threatintel/get-prevalence

POST

/api/threatintel/modify-verdict

GET

/api/threatintel/get-similars

GET

/api/threatintel/similarity

GET

/api/threatintel/feed

GET

/api/threatintel/download-iocs

Get prevalence of IOCs

Get prevalences of IOCs

Auth

Query String

exclude_report_ids array

Request Body

IOCsPrevalenceSearchParams	object	Params for IOCs' prevalence search
domain	array[string]	Default: []
ip	array[string]	Default: []
url	array[string]	Default: []
uuid	array[string]	Default: []
email	array[string]	Default: []
registry_path	array[string]	Default: []
revision_save_id	array[string]	Default: []
sha1	array[string]	Default: []
sha256	array[string]	Default: []
sha512	array[string]	Default: []
md5	array[string]	Default: []
imphash	array[string]	Default: []
ssdeep	array[string]	Default: []
authentihash	array[string]	Default: []
fuzzyfsiohash	array[string]	Default: []
days	integer	Default: -1

POST /api/threatintel/get-prevalence

Responses

200

Successful Response

No response body

400

Bad request

422

Validation Error

Response

Modify verdict for a given report

Auth

Request Body

ModifyVerdictPayload

object

New verdict and report id

verdict

string

An enumeration.

Enum: unknown,benign,informational,no_threat,suspicious,likely_malicious,malicious

report_id string

POST /api/threatintel/modify-verdict

Responses

200

Successful Response

No response body

400

Bad request

422

Validation Error

Response

Get reports with the same special hashes (fuzzyfsio, imphash, ssdeep, authentihash)

Get reports with the same special hashes

Auth

Query String

exclude_report_ids	array
imphash	string
ssdeep	string
fuzzyfsiohash	string
authentihash	string
days	integer	Default: -1

GET /api/threatintel/get-similars

Responses

200

Successful Response

No response body

400

Bad request

422

Validation Error

Response

Get similar reports based on the SHA256 hash, tags, threshold and verdict

Get similar reports

Auth

Query String

hash	string
min_similarity	integer	maximum: 100 minimum: 0 Default: 0
verdict	string	Enum: `unknown`,`benign`,`informational`,`no_threat`,`suspicious`,`likely_malicious`,`malicious`
tags	array

GET /api/threatintel/similarity

Responses

200

Successful Response

SimilaritiesResponse	object
note	string	Optinal notification about demo data
most_similar	array[object]	Default: []
sha256	string
overall_similarity	number
similarities	object
binary_metadata	number
version_info	number
pdb_guid	number
rich_header_compiler_ids	number
sections	number
resources	number
signal_ids	number
extracted	number
imports	number
certifications	number
weighted_numerics	number
threat_indicators	number
certificates	number
details	object
verdict	string	An enumeration. Enum: `unknown`,`benign`,`informational`,`no_threat`,`suspicious`,`likely_malicious`,`malicious`
tags	array[string]
start_date	date-time
is_dotnet	integer
architecture	string
entropy	number
file_size	number
most_recent	array[object]	Default: []
sha256	string
overall_similarity	number
similarities	object
binary_metadata	number
version_info	number
pdb_guid	number
rich_header_compiler_ids	number
sections	number
resources	number
signal_ids	number
extracted	number
imports	number
certifications	number
weighted_numerics	number
threat_indicators	number
certificates	number
details	object
verdict	string	An enumeration. Enum: `unknown`,`benign`,`informational`,`no_threat`,`suspicious`,`likely_malicious`,`malicious`
tags	array[string]
start_date	date-time
is_dotnet	integer
architecture	string
entropy	number
file_size	number

404

Item not found

422

Validation Error

Response

Get feeds with more data

Get advanced feed containing all IOCs and signatures compared to the basic feed

Auth

GET /api/threatintel/feed

Responses

200

Successful Response

No response body

401

Not authorized

Response

Download iocs of reports in csv format

Download iocs of all reports

Auth

Headers

page

integer

minimum: 0

Default: 0

pageSize

integer

minimum: 0

Default: 0

Query String

unique_files	boolean	Default: false
method		Default: and
no_date_limit	boolean	Default: false
query	string
verdict	string
source_type	string	Enum: `url`,`url-to-file`,`file`
filetype	string	Enum: `ace`,`apk`,`bat`,`64bits`,`bmp`,`csv`,`doc`,`docm`,`docx`,`dot`,`dotm`,`dotx`,`elf`,`eml`,`gif`,`hta`,`htm`,`html`,`img`,`iso`,`java`,`java-bytecode`,`javascript`,`jpg`,`lnk`,`mbox`,`mthml`,`msg`,`msi`,`mso`,`ole`,`one`,`pdf`,`pedll`,`peexe`,`png`,`pot`,`potm`,`potx`,`powershell`,`ppt`,`pptm`,`pptx`,`ps`,`pub`,`rar`,`rfc822`,`rtf`,`svg`,`txt`,`vbs`,`wmv`,`wsf`,`xlm`,`xls`,`xlsb`,`xlsm`,`xlsx`,`xlt`,`xltm`,`xltx`,`xsl`,`zip`,`7zip`,`exe`,`mail`,`ms-office`,`script`
tag	string
tags	string
date_from	string
date_to	string
rate_from	integer
rate_to	integer
uuid	string
email	string
registry_path	string
revision_save_id	string
yara_rule	string
retry_count	integer
scan_init_id	string
report_id	string
country	string
filename	string
sha1	string
sha256	string
sha512	string
md5	string
domain	string
ip	string
url	string
media_type	string
imphash	string
ssdeep	string
authentihash	string
fuzzyfsiohash	string
signal_groups	string
mitre_techniques	string
verdict_groups	string
main_task_state		Default: success
exclude	string

GET /api/threatintel/download-iocs

Responses

200

Successful Response

No response body

401

Not authorized

422

Validation Error

Response

Backend

Backend wrapper

GET

/api/backend/reputation

Get Reputation

Wrapper for reputation api

Auth

Query String

sha256	string	SHA256 digest as found in the response of submit or extracted resource in the report.
hashes	array	Array of one or more hashes

GET /api/backend/reputation

Responses

200

Successful Response

No response body

422

Validation Error

Response

Reputation

/api/reputation/{ioc_type}

POST

/api/reputation/{ioc_type}

Get Reputation Hash

Get the reputation for one given hash

Auth

Query String

sha256 string

GET /api/reputation/hash

Responses

200

Successful Response

ReputationResultHash	object
sha256	string
overall_verdict	string	An enumeration. Enum: `unknown`,`benign`,`informational`,`no_threat`,`suspicious`,`likely_malicious`,`malicious`
fuzzyhash	object	Fuzzy hash verdict
hash	string
verdict	string	An enumeration. Enum: `unknown`,`benign`,`informational`,`no_threat`,`suspicious`,`likely_malicious`,`malicious`
mdcloud	object	Result of one multiscan
total_av_engines	integer
detected_av_engines	integer
scan_time	date-time
filescan_reports	array[object]
verdict	string	An enumeration. Enum: `unknown`,`benign`,`informational`,`no_threat`,`suspicious`,`likely_malicious`,`malicious`
report_date	string
report_id	string
flow_id	string

400

Bad request

415

Unsupported media type

422

Validation Error

Response

Get Reputation Hash Bulk

Get the reputation for more hashes

Auth

Request Body

array array[string]

POST /api/reputation/hash

Responses

200

Successful Response

ReputationResultHash	array[object]
sha256	string
overall_verdict	string	An enumeration. Enum: `unknown`,`benign`,`informational`,`no_threat`,`suspicious`,`likely_malicious`,`malicious`
fuzzyhash	object	Fuzzy hash verdict
hash	string
verdict	string	An enumeration. Enum: `unknown`,`benign`,`informational`,`no_threat`,`suspicious`,`likely_malicious`,`malicious`
mdcloud	object	Result of one multiscan
total_av_engines	integer
detected_av_engines	integer
scan_time	date-time
filescan_reports	array[object]
verdict	string	An enumeration. Enum: `unknown`,`benign`,`informational`,`no_threat`,`suspicious`,`likely_malicious`,`malicious`
report_date	string
report_id	string
flow_id	string

400

Bad request

415

Unsupported media type

422

Validation Error

Response

Get Reputation Ioc

Get the reputation for one given IOC

Auth

Path Params

ioc_type

string

Enum: domain,ip,url

Query String

ioc_value string

GET /api/reputation/{ioc_type}

Responses

200

Successful Response

ReputationResultIoc	object
ioc_type	string
ioc_value	string
overall_verdict	string	An enumeration. Enum: `unknown`,`benign`,`informational`,`no_threat`,`suspicious`,`likely_malicious`,`malicious`
mdcloud	object	Result of one lookup for IP, domain or URL
scan_time	date-time
detected	integer
community	object
vote_malicious	integer
vote_benign	integer
filescan_reports	array[object]
verdict	string	An enumeration. Enum: `unknown`,`benign`,`informational`,`no_threat`,`suspicious`,`likely_malicious`,`malicious`
report_date	string
report_id	string
flow_id	string

400

Bad request

415

Unsupported media type

422

Validation Error

Response

Get Reputation Ioc Bulk

Get the reputation for more IOCs

Auth

Path Params

ioc_type

string

Enum: domain,ip,url

Request Body

array array[string]

POST /api/reputation/{ioc_type}

Responses

200

Successful Response

ReputationResultIoc	array[object]
ioc_type	string
ioc_value	string
overall_verdict	string	An enumeration. Enum: `unknown`,`benign`,`informational`,`no_threat`,`suspicious`,`likely_malicious`,`malicious`
mdcloud	object	Result of one lookup for IP, domain or URL
scan_time	date-time
detected	integer
community	object
vote_malicious	integer
vote_benign	integer
filescan_reports	array[object]
verdict	string	An enumeration. Enum: `unknown`,`benign`,`informational`,`no_threat`,`suspicious`,`likely_malicious`,`malicious`
report_date	string
report_id	string
flow_id	string

400

Bad request

415

Unsupported media type

422

Validation Error

Response

Get Votes

Get the number of community votes for a given hash, ip, domain or url

Auth

Query String

sha256	string
ip	string
domain	string
url	string

GET /api/community/votes

Responses

200

Successful Response

No response body

400

Bad request

422

Validation Error

Response

Vote

Vote for a given hash

Auth

Request Body

VotePayload	object
sha256	string
domain	string
ip	string
url	string
vote	string	An enumeration. Enum: `benign`,`malicious`,`neutral`

POST /api/community/vote

Responses

200

Successful Response

No response body

400

Bad request

404

Item not found

422

Validation Error

Response

Docs

API documentation related

Get API Docs

Return API docs UI

Auth

GET /api/docs

Responses

200

Successful Response

No response body

Response

Get OpenAPI Endpoint

Return API json data to be used by docs UI

Auth

GET /openapi.json

Responses

200

Successful Response

No response body

Response

Get API Doc Styles

Return styles for api docs

Auth

GET /api/docs/styles

Responses

200

Successful Response

No response body

Response

Get Sitemap

Get sitemap xml

Auth

GET /api/docs/sitemap

Responses

200

Successful Response

No response body

Response

Get Integration State

Get current state of OCM integration

Auth

GET /api/ocm/state

Responses

200

Successful Response

OcmIntegrationStateResponse	object
server_url	string	Base url of OCM server
registration_code	string	Code used for obtaining API key for interaction with OCM
state	string	An enumeration. Enum: `not_enrolled`,`enrolled`,`unenrolled`
disconnected	boolean	If we failed to establish connection with OCM
last_connection_date	date-time	Last time connection was done to OCM
last_connection_attempt_date	date-time	Last time we tried to edtablish connection with OCM

Response

Enroll

Auth

Request Body

OcmEnrollPayload	object
server_url	string	Base URL of OCM server
registration_code	string	Code to reveice API key to interact with OCM

POST /api/ocm/enroll

Responses

200

Successful Response

No response body

422

Validation Error

Response

Unenroll

Unregister product at OPSWAT Central Management

Auth

POST /api/ocm/unenroll

Responses

200

Successful Response

No response body

Response

filter	array	Report fields that should be fetched.
sorting	array	Sort parameters to be applied to fetched report data
other	array	Extra options to get special data

ScheduleTaskResponse	array[object]
name	string
category	string	Job categories Enum: `statistics`,`scan`,`system`,`reports`,`patches`
description	string
config	object	Return job config to user
name	string
trigger	string	All available trigger types Enum: `once`,`date`,`interval`,`cron`,`calendarinterval`
trigger_config	object
runtime_config	object
is_active	boolean
is_editable	boolean
state	object	Return job state to user
name	string
state	string
data	object
updated_date	date-time
public_log	array
has_public_log	boolean

MetaDefender Sandbox API Reference 2.0

Developer Guide

Authentication

Scan

Scan File

Scan URL

Get All Upload Related Reports

Reports

Get Chat Gpt Summary

Get All Files

Download Export Formats

Get Specific Report

Search Report

Search Report

Get Frequent Tags

Get Most Interesting

Files

Get Single File

Download Archive File

Feed

Get Feed

Get Feed Info

Get Daily Reports Archives

Users

Get Current User

Get Uploads

Get User Uploads

Get Profile

Post Profile

Reset Timezone Locale

Get Avatar Image

Create API Key

Set API key

Remove API Key

Mark notification as viewed by user

Get User Stat

Get User Generic Stat

Get Malicious Ips Stat

Get Ioc Stat

Get Yara Stat

Get Mitre Stat

Get Yara Info

System

Get Default

Get Version

Get Config

Get Terms

Get Signal Groups

Get Mime Types

Get Yara Rules

Get Yara Authors

Get Translations

Get Languages

Get Countries

Get Mitre Data

Log Client Error

Get Logo

Do Healthcheck

Query Healthcheck

Query Healthcheck

Check License Info

Activate License Online

Activate License Offline

Deactivate License

Reputation Check Config

Get News

Admin

Get Report

Save News Item

Remove News Item

Get Access Groups

Save Access Group

Remove Access Group

Get Api Quota

Save Api Quota

Remove Api Quota

Get Settings Group

Save Settings Group

Remove Oauth Service

Save Oauth Services