MetaDefender Sandbox API Reference 2.4

/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
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
is_private_report	boolean	If the report should not be available for other users
skip_whitelisted	boolean	If file is detected as whitelisted, report is not created
scan_profile	string	Id of scan profile, or name of preset scan profile
scan_engine	string	All possible scan engines that can be used Enum: `internal`,`mdcloud`
rapid_mode	boolean	Disable some scan long-running features
early_termination	boolean	Terminates scan execution once a conclusive verdict is detected
osint	boolean	Enable OSINT (e.g. VirusTotal, ClamAV) lookups
extended_osint	boolean	Enable OSINT lookups on extracted IOCs
extracted_files_osint	boolean	Enable OSINT lookups on extracted files
visualization	boolean	Enable file visualization (e.g. PDF rendering)
files_download	boolean	Enable download of files from extracted URLs
resolve_domains	boolean	Enable resolving domains to IPs (DNS)
input_file_yara	boolean	Enable YARA rule matches on input file
extracted_files_yara	boolean	Enable YARA rule matches on extracted files
whois	boolean	Enable WHOIS record lookups
ips_meta	boolean	Enable meta-data lookups for extracted IPs
images_ocr	boolean	Enable OCR text recognition on extracted images
certificates	boolean	Extract certificates
url_analysis	boolean	Analyse domains and URLs, geolocation
extract_strings	boolean	Enable strings extraction
ocr_qr	boolean	Extract string with OCR and process QR codes
phishing_detection	boolean	Phishing detection for URLs, emails and HTML pages

Expand

POST /api/scan/file

xxxxxxxxxx
 
curl --request POST \ --url 'https://opswat.developerhub.io/api/scan/file' \ --header 'X-Api-Key: {X-Api-Key}' \ --form 'file=@{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

413

Content too large

422

Validation Error

429

Too many requests

Response

xxxxxxxxxx
 
{ "flow_id": "66f1905b318df2831b854ce5", "priority": {  "applied": 100,  "max_possible": 100 }}
Copy

Scan URL

Scan URL resource

Auth

Request Body

Body_scan_file_api_scan_url_post	object
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
is_private_report	boolean	If the report should not be available for other users
skip_whitelisted	boolean	If file is detected as whitelisted, report is not created
scan_profile	string	Id of scan profile, or name of preset scan profile
scan_engine	string	All possible scan engines that can be used Enum: `internal`,`mdcloud`
rapid_mode	boolean	Disable some scan long-running features
early_termination	boolean	Terminates scan execution once a conclusive verdict is detected
osint	boolean	Enable OSINT (e.g. VirusTotal, ClamAV) lookups
extended_osint	boolean	Enable OSINT lookups on extracted IOCs
extracted_files_osint	boolean	Enable OSINT lookups on extracted files
visualization	boolean	Enable file visualization (e.g. PDF rendering)
files_download	boolean	Enable download of files from extracted URLs
resolve_domains	boolean	Enable resolving domains to IPs (DNS)
input_file_yara	boolean	Enable YARA rule matches on input file
extracted_files_yara	boolean	Enable YARA rule matches on extracted files
whois	boolean	Enable WHOIS record lookups
ips_meta	boolean	Enable meta-data lookups for extracted IPs
images_ocr	boolean	Enable OCR text recognition on extracted images
certificates	boolean	Extract certificates
url_analysis	boolean	Analyse domains and URLs, geolocation
extract_strings	boolean	Enable strings extraction
ocr_qr	boolean	Extract string with OCR and process QR codes
phishing_detection	boolean	Phishing detection for URLs, emails and HTML pages

Expand

POST /api/scan/url

xxxxxxxxxx
 
curl --request POST \ --url 'https://opswat.developerhub.io/api/scan/url' \ --header 'X-Api-Key: {X-Api-Key}'
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

xxxxxxxxxx
 
{ "flow_id": "66f1905b318df2831b854ce5", "priority": {  "applied": 100,  "max_possible": 100 }}
Copy

Save Scan Profile

Add/edit scan profile

Auth

Request Body

ScanProfilePayload	object	User provided data to edit scan profile
id	string
name	string
description	string
is_default	boolean
options	object	Options to turn on/off various scan features
rapid_mode	boolean	Disable some scan long-running features
early_termination	boolean	Terminates scan execution once a conclusive verdict is detected
osint	boolean	Enable OSINT (e.g. VirusTotal, ClamAV) lookups
extended_osint	boolean	Enable OSINT lookups on extracted IOCs
extracted_files_osint	boolean	Enable OSINT lookups on extracted files
visualization	boolean	Visualize sample file and render document pages
files_download	boolean	Download and analyze files from embedded URLs
resolve_domains	boolean	Enable resolving domains to IPs (DNS)
input_file_yara	boolean	Enable YARA rule matches on input file
extracted_files_yara	boolean	Enable YARA rule matches on extracted files
whois	boolean	Enable WHOIS record lookups
ips_meta	boolean	Enable meta-data lookups for extracted IPs
images_ocr	boolean	Enable OCR text recognition on extracted images
certificates	boolean	Extract certificates
url_analysis	boolean	Analyse domains and URLs, geolocation
extract_strings	boolean	Enable strings extraction
ocr_qr	boolean	Extract string with OCR and process QR codes
phishing_detection	boolean	Phishing detection for URLs, emails and HTML pages

Expand

POST /api/scan/profiles

xxxxxxxxxx
 
curl --request POST \ --url 'https://opswat.developerhub.io/api/scan/profiles' \ --header 'X-Api-Key: {X-Api-Key}' \ --data '{  "id": "{string}",  "name": "{string}",  "description": "{string}",  "is_default": "{boolean}",  "options": {    "rapid_mode": "{boolean}",    "early_termination": "{boolean}",    "osint": "{boolean}",    "extended_osint": "{boolean}",    "extracted_files_osint": "{boolean}",    "visualization": "{boolean}",    "files_download": "{boolean}",    "resolve_domains": "{boolean}",    "input_file_yara": "{boolean}",    "extracted_files_yara": "{boolean}",    "whois": "{boolean}",    "ips_meta": "{boolean}",    "images_ocr": "{boolean}",    "certificates": "{boolean}",    "url_analysis": "{boolean}",    "extract_strings": "{boolean}",    "ocr_qr": "{boolean}",    "phishing_detection": "{boolean}"  }}'
Copy

Responses

200

Successful Response

No response body

422

Validation Error

Response

xxxxxxxxxx
 
No response
Copy

Remove Scan Profile

Remove scan profile

Auth

Path Params

profile_id string

DELETE /api/scan/profiles/{profile_id}

xxxxxxxxxx
 
curl --request DELETE \ --url 'https://opswat.developerhub.io/api/scan/profiles/%7Bprofile_id%7D' \ --header 'X-Api-Key: {X-Api-Key}'
Copy

Responses

200

Successful Response

No response body

422

Validation Error

Response

xxxxxxxxxx
 
No response
Copy

Get All Upload Related Reports

Obtain all reports for given scan init. By default, if no filter parameter is sent, we only return some basic report data, just to see report is there

Auth

Path Params

flow_id

string

Flow Id from scan-file

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/scan/{flow_id}/report

xxxxxxxxxx
 
curl --get \ --url 'https://opswat.developerhub.io/api/scan/%7Bflow_id%7D/report' \ --header 'X-Api-Key: {X-Api-Key}' \ --data filter=general \ --data sorting=allSignalGroups(description:asc,averageSignalStrength:desc) \ --data other=emulationGraph
Copy

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

Expand

400

Bad request

404

Item not found

422

Validation Error

Response

xxxxxxxxxx
 
{ "flowId": "66e819bd043c09361a3010aa", "allFinished": true, "allFilesDownloadFinished": true, "allAdditionalStepsDone": true, "reportsAmount": 1, "priority": "max", "pollPause": 5, "state": "finished", "scanStartedDate": "09/16/2024, 11:42:55", "fileSize": 13370880, "reports": {  "ac0ce6c9-4c11-4311-966d-0f1ff8821a06": {   "overallState": "success",   "positionInQueue": 0,   "finalVerdict": {    "verdict": "MALICIOUS",    "threatLevel": 1,    "confidence": 1   },   "vtRate": -1,   "file": {    "name": "bad_file.exe",    "hash": "834d1dbfab8330ea5f1844f6e905ed0ac19d1033ee9a9f1122ad2051c56783dc",    "type": "pe"   },   "filesDownloadFinished": true,   "additionalStepsRunning": [],   "additionalStepsDone": true,   "created_date": "09/16/2024, 11:42:56",   "defaultOptionsUsed": true,   "scanOptions": {    "rapid_mode": false,    "osint": true,    "extended_osint": true,    "extracted_files_osint": true,    "visualization": true,    "files_download": true,    "resolve_domains": true,    "input_file_yara": true,    "extracted_files_yara": true,    "whois": true,    "ips_meta": true,    "images_ocr": true   },   "estimatedTime": "13",   "estimated_progress": 1  } }}
Copy

Expand

Reports

Retrieve a variety of report related data

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

/api/reports/{report_id}/files

/api/reports/{report_id}/download/start

/api/reports/{report_id}/download

/api/users/me/downloads

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

/api/files/pe-emulation/{report_id}/{file_name}

/api/reports/advanced-search

/api/me/reports/links

/api/users/get-frequent-tags

/api/users/most-interesting

Get Chat Gpt SummaryDeprecated

Request ChatGPT summary on report

Auth

Path Params

report_id string

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

xxxxxxxxxx
 
curl --get \ --url 'https://opswat.developerhub.io/api/reports/%7Breport_id%7D/chat-gpt' \ --header 'X-Api-Key: {X-Api-Key}'
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

xxxxxxxxxx
 
{ "data_type": "summary", "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.", "created_date": "2024-09-19 15:26:52.842000"}
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

GET /api/reports/{report_id}/files

xxxxxxxxxx
 
curl --get \ --url 'https://opswat.developerhub.io/api/reports/%7Breport_id%7D/files' \ --header 'X-Api-Key: {X-Api-Key}' \ --data type=all \ --data with_content={with_content}
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

xxxxxxxxxx
 
[ {  "id": "6c3e8bf2-dce3-45c4-9ae1-b54b24876334",  "hash": "38cd7b61b24fa1124f13365d74e45f05ac8f1cf99119a3efaaf861e8d935e695",  "size": 2212,  "mediaType": "application/octet-stream",  "type": "extracted" }, {  "id": "19ba4fcd-e9d3-4490-9aea-cbc0b715e7f9",  "hash": "6d02a672cabc9b9b55e7b1b2e54ce34442fa4eb52fc63e8aa713b071a5a1d62f",  "size": 3774,  "mediaType": "image/vnd.microsoft.icon",  "type": "extracted" }, {  "id": "5146938b-cae8-4087-b27e-001b3cbe00bf",  "hash": "c0754b5494997ac938629509cd0e36b831c9bf1d7609a781e7b6a8e696f3419f",  "size": 318,  "mediaType": "image/vnd.microsoft.icon",  "type": "extracted" }]
Copy

Start Report Format Creation

Start creation of HTML or PDF formated report

Auth

Path Params

report_id

string

Report Id

Query String

format

string

Enum: html,pdf

GET /api/reports/{report_id}/download/start

xxxxxxxxxx
 
curl --get \ --url 'https://opswat.developerhub.io/api/reports/%7Breport_id%7D/download/start' \ --header 'X-Api-Key: {X-Api-Key}' \ --data format={format}
Copy

Responses

200

Successful Response

No response body

404

Item not found

422

Validation Error

Response

xxxxxxxxxx
 
{ "export_id": "66a22c48d970b67320c8a280"}
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`
export_id	string	ID of export record

GET /api/reports/{report_id}/download

xxxxxxxxxx
 
curl --get \ --url 'https://opswat.developerhub.io/api/reports/%7Breport_id%7D/download' \ --header 'X-Api-Key: {X-Api-Key}' \ --data format={format} \ --data export_id={export_id}
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

xxxxxxxxxx
 
{"xmlns": "http://www.misp-project.org/", "Event": {"uuid": "e0e8d7e1-6e40-444e-a6ba-2833b9a4761f", "published": False, "publish_timestamp": 0, "date": "2024-09-19", "timestamp": 1726761610, "info": "FilescanIO report generated for file "eicar.txt"", "distribution": 2, "analysis": 2, "threat_level_id": 1, "Attribute": [{"category": "External analysis", "type": "link", "value": "https://staging.filescan.io/reports/275a021bbfb6489e54d471899f7db9d1663fc695ec2fe2a2c4538aabf651fd0f/e0e8d7e1-6e40-444e-a6ba-2833b9a4761f", "distribution": 3, "timestamp": 1726761626, "deleted": False, "sharing_group_id": 0}, {"category": "Internal reference", "type": "other", "value": "wscript", "distribution": 1, "timestamp": 1726761626, "deleted": False, "sharing_group_id": 0, "comment": "Emulation Process"}], "Tag": [{"name": "vbs"}, {"name": "virus"}]}}
Copy

Get Downloads List

Get list of all reports downloads by current user

Auth

Query String

page	integer	Default: 1
page_size	integer	Default: 10

GET /api/users/me/downloads

xxxxxxxxxx
 
curl --get \ --url 'https://opswat.developerhub.io/api/users/me/downloads' \ --header 'X-Api-Key: {X-Api-Key}' \ --data page=1 \ --data page_size=10
Copy

Responses

200

Successful Response

ReportFormatResponse	object
items	array[object]
id	string
flow_id	string
file_name	string
file_sha256	string
verdict	string
report_id	string
format	string	Formats that can take a lot of time to be generated Enum: `html`,`pdf`
state	string	State of report generation Enum: `created`,`queued`,`in_progress`,`failed`,`success`
created_date	date-time
started_date	date-time
finished_date	date-time
settings	object	Settings used for exporting report
strings_limit	integer
strings_mode	string	An enumeration. Enum: `all`,`interesting`,`prefer_interesting`
count	integer

422

Validation Error

500

Internal server error

Response

xxxxxxxxxx
 
{ "items": [  {   "id": "67582a23d385590c8e6c706e",   "flow_id": "674a0f1392f3eefed863e1ac",   "file_name": "2d229a302ecfdb8e3424b4ea3447586e2e3084e17b5874ebb93a5d41286ed812.bin",   "file_sha256": "2d229a302ecfdb8e3424b4ea3447586e2e3084e17b5874ebb93a5d41286ed812",   "report_id": "95f46868-9d07-47be-be9e-058ede219440",   "verdict": "malicious",   "format": "pdf",   "state": "in_progress",   "created_date": "2024-12-10T11:46:43.345000",   "started_date": "2024-12-10T11:46:43.535000",   "settings": {    "strings_limit": 100,    "strings_mode": "prefer_interesting"   }  } ], "count": 1}
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}

xxxxxxxxxx
 
curl --get \ --url 'https://opswat.developerhub.io/api/reports/%7Breport_id%7D/%7Bfile_hash%7D' \ --header 'X-Api-Key: {X-Api-Key}' \ --data filter=general \ --data sorting=allSignalGroups(description:asc,averageSignalStrength:desc) \ --data other=emulationGraph
Copy

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

Expand

400

Bad request

404

Item not found

422

Validation Error

Response

xxxxxxxxxx
 
{ "flowId": "66ec42875612760457943ad5", "allFinished": true, "allFilesDownloadFinished": true, "allAdditionalStepsDone": true, "reportsAmount": 1, "priority": "max", "pollPause": 5, "state": "finished", "scanStartedDate": "09/19/2024, 15:26:01", "fileSize": 13370880, "fileReadProgressBytes": 13370880, "reports": {  "c1a06fb4-c035-443e-b9d8-efb5a94e1aa2": {   "overallState": "success",   "positionInQueue": -1,   "finalVerdict": {    "verdict": "MALICIOUS",    "threatLevel": 1,    "confidence": 1   },   "interestingScore": 0,   "vtRate": -1,   "file": {    "name": "bad_file.exe",    "hash": "834d1dbfab8330ea5f1844f6e905ed0ac19d1033ee9a9f1122ad2051c56783dc",    "type": "pe"   },   "filesDownloadFinished": true,   "additionalStepsRunning": [],   "additionalStepsDone": true,   "created_date": "09/19/2024, 15:26:02",   "defaultOptionsUsed": true,   "scanOptions": {    "rapid_mode": false,    "osint": true,    "extended_osint": true,    "extracted_files_osint": true,    "visualization": true,    "files_download": true,    "resolve_domains": true,    "input_file_yara": true,    "extracted_files_yara": true,    "whois": true,    "ips_meta": true,    "images_ocr": true   },   "chatGptSummary": {    "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.\n  \n- Temporary File Creation: It can create temporary files, a common technique used to hide malicious processes or data from detection.\n  \n- Installation Framework Usage: This malware operates using an established software installation framework, allowing it to efficiently deploy itself and possibly other unwanted software onto infected systems.\n  \n- Anti-Debugging Techniques: It employs methods to prevent security software from analyzing its behavior, making it harder for analysts to understand its full capabilities.\n  \n- Command Execution: The malware can take command-line arguments, which means it can receive instructions that dictate its behavior, potentially allowing it to act upon specific targets or functions within a system.",    "created_date": "2024-09-19 15:26:52.842000"   },   "estimatedTime": "30",   "estimated_progress": 1  } }}
Copy

Expand

Get Pe Emulation File

Get PE emulation files

Auth

Path Params

report_id	string	Report Id
file_name		PE emulation file name

GET /api/files/pe-emulation/{report_id}/{file_name}

xxxxxxxxxx
 
curl --get \ --url 'https://opswat.developerhub.io/api/files/pe-emulation/%7Breport_id%7D/%7Bfile_name%7D' \ --header 'X-Api-Key: {X-Api-Key}'
Copy

Responses

200

Successful Response

No response body

404

Item not found

422

Validation Error

Response

xxxxxxxxxx
 
No response
Copy

Advanced Search

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

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
method		Default: and
derived_files	boolean	Default: true
no_date_limit	boolean
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`,`iso`,`java`,`java-bytecode`,`javascript`,`jpg`,`lnk`,`mbox`,`mhtml`,`msg`,`msi`,`mso`,`odp`,`ods`,`odt`,`odg`,`odf`,`odc`,`odb`,`odi`,`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`,`xml`,`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

Expand

GET /api/reports/advanced-search

xxxxxxxxxx
 
curl --get \ --url 'https://opswat.developerhub.io/api/reports/advanced-search' \ --header 'X-Api-Key: {X-Api-Key}' \ --data age=-1 \ --data page=1 \ --data page_size=10 \ --data unique_files={unique_files} \ --data method=and \ --data derived_files=true \ --data no_date_limit={no_date_limit} \ --data query={query} \ --data verdict={verdict} \ --data source_type={source_type} \ --data filetype={filetype} \ --data tag={tag} \ --data tags={tags} \ --data date_from={date_from} \ --data date_to={date_to} \ --data rate_from={rate_from} \ --data rate_to={rate_to} \ --data uuid={uuid} \ --data email={email} \ --data registry_path={registry_path} \ --data revision_save_id={revision_save_id} \ --data yara_rule={yara_rule} \ --data retry_count={retry_count} \ --data scan_init_id={scan_init_id} \ --data report_id={report_id} \ --data country={country} \ --data filename={filename} \ --data sha1={sha1} \ --data sha256={sha256} \ --data sha512={sha512} \ --data md5={md5} \ --data domain={domain} \ --data ip={ip} \ --data url={url} \ --data media_type={media_type} \ --data imphash={imphash} \ --data ssdeep={ssdeep} \ --data authentihash={authentihash} \ --data fuzzyfsiohash={fuzzyfsiohash} \ --data signal_groups={signal_groups} \ --data mitre_techniques={mitre_techniques} \ --data verdict_groups={verdict_groups} \ --data main_task_state=success \ --data exclude={exclude}
Copy

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

xxxxxxxxxx
 
{ "items": [  "{array...}" ], "count": "{integer}", "count_search_params": "{integer}", "method": "{string}", "dbs_sync": "{boolean}"}
Copy

Simple Search

Search for reports and uploaded files by various tokens, like hash, filename, verdict, IOCs etc. Simple search only uses the query param (and some other defaults), other params are ignored.

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
derived_files	boolean	Default: true
no_date_limit	boolean
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`,`iso`,`java`,`java-bytecode`,`javascript`,`jpg`,`lnk`,`mbox`,`mhtml`,`msg`,`msi`,`mso`,`odp`,`ods`,`odt`,`odg`,`odf`,`odc`,`odb`,`odi`,`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`,`xml`,`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

Expand

GET /api/reports/search

xxxxxxxxxx
 
curl --get \ --url 'https://opswat.developerhub.io/api/reports/search' \ --header 'X-Api-Key: {X-Api-Key}' \ --data age=-1 \ --data page=1 \ --data page_size=10 \ --data method=and \ --data derived_files=true \ --data no_date_limit={no_date_limit} \ --data query={query} \ --data verdict={verdict} \ --data source_type={source_type} \ --data filetype={filetype} \ --data tag={tag} \ --data tags={tags} \ --data date_from={date_from} \ --data date_to={date_to} \ --data rate_from={rate_from} \ --data rate_to={rate_to} \ --data uuid={uuid} \ --data email={email} \ --data registry_path={registry_path} \ --data revision_save_id={revision_save_id} \ --data yara_rule={yara_rule} \ --data retry_count={retry_count} \ --data scan_init_id={scan_init_id} \ --data report_id={report_id} \ --data country={country} \ --data filename={filename} \ --data sha1={sha1} \ --data sha256={sha256} \ --data sha512={sha512} \ --data md5={md5} \ --data domain={domain} \ --data ip={ip} \ --data url={url} \ --data media_type={media_type} \ --data imphash={imphash} \ --data ssdeep={ssdeep} \ --data authentihash={authentihash} \ --data fuzzyfsiohash={fuzzyfsiohash} \ --data signal_groups={signal_groups} \ --data mitre_techniques={mitre_techniques} \ --data verdict_groups={verdict_groups} \ --data main_task_state=success \ --data exclude={exclude}
Copy

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

xxxxxxxxxx
 
{ "items": [  "{array...}" ], "count": "{integer}", "count_search_params": "{integer}", "method": "{string}", "dbs_sync": "{boolean}"}
Copy

Get Public Reports

Get all public reports

Auth

Query String

page

integer

Page number starting from 1

minimum: 1

Default: 1

page_size

Page size

Default: 10

GET /api/reports

xxxxxxxxxx
 
curl --get \ --url 'https://opswat.developerhub.io/api/reports' \ --header 'X-Api-Key: {X-Api-Key}' \ --data page=1 \ --data page_size=10
Copy

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

401

Not authorized

422

Validation Error

Response

xxxxxxxxxx
 
{ "items": [  "{array...}" ], "count": "{integer}", "count_search_params": "{integer}", "method": "{string}", "dbs_sync": "{boolean}"}
Copy

Get User Reports

Get reports of 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	Results newer then this date (format YYYY-MM-DD)
verdict	string	Enum: `unknown`,`benign`,`informational`,`no_threat`,`suspicious`,`likely_malicious`,`malicious`

GET /api/me/reports

xxxxxxxxxx
 
curl --get \ --url 'https://opswat.developerhub.io/api/me/reports' \ --header 'X-Api-Key: {X-Api-Key}' \ --data page=1 \ --data page_size=10 \ --data date_from={date_from} \ --data verdict={verdict}
Copy

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

401

Not authorized

422

Validation Error

Response

xxxxxxxxxx
 
{ "items": [  "{array...}" ], "count": "{integer}", "count_search_params": "{integer}", "method": "{string}", "dbs_sync": "{boolean}"}
Copy

Get User Reports Links

Get links of all user's reports as a .CSV file.

In case of no reports for selected time frame empty response is returned.

Auth

Query String

date_from	string	Results newer then this date (format YYYY-MM-DD)
date_to	string	Results older then this date (format YYYY-MM-DD)

GET /api/me/reports/links

xxxxxxxxxx
 
curl --get \ --url 'https://opswat.developerhub.io/api/me/reports/links' \ --header 'X-Api-Key: {X-Api-Key}' \ --data date_from={date_from} \ --data date_to={date_to}
Copy

Responses

200

Successful Response

No response body

400

Bad request

401

Not authorized

422

Validation Error

Response

xxxxxxxxxx
 
No response
Copy

Get Frequent Tags

Get most frequently seen tags recently

Auth

GET /api/users/get-frequent-tags

xxxxxxxxxx
 
curl --get \ --url 'https://opswat.developerhub.io/api/users/get-frequent-tags' \ --header 'X-Api-Key: {X-Api-Key}'
Copy

Responses

200

Successful Response

FrequentTagsResponse	object
tags	array[object]
updated	date-time

401

Not authorized

Response

xxxxxxxxxx
 
{ "tags": [  {} ], "updated": "{date-time}"}
Copy

Get Most Interesting

Get most interesting report recently

Auth

GET /api/users/most-interesting

xxxxxxxxxx
 
curl --get \ --url 'https://opswat.developerhub.io/api/users/most-interesting' \ --header 'X-Api-Key: {X-Api-Key}'
Copy

Responses

200

Successful Response

MostInterestingResponse	object
report	object
updated	date-time

401

Not authorized

Response

xxxxxxxxxx
 
{ "report": {}, "updated": "{date-time}"}
Copy

Files

Get a file by its hash or id in various format

/api/files/{hash}

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

/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)
password	string	Password to be used on compression (only used if `type` is raw)

GET /api/files/{hash}

xxxxxxxxxx
 
curl --get \ --url 'https://opswat.developerhub.io/api/files/%7Bhash%7D' \ --header 'X-Api-Key: {X-Api-Key}' \ --data report_id={report_id} \ --data type=base64 \ --data original_name={original_name} \ --data password={password}
Copy

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

xxxxxxxxxx
 
{ "type": "base64", "content": "WDVPIVAlQEFQWzRcUFpYNTQoUF4pN0NDKTd9JEVJQ0FSLVNUQU5EQVJELUFOVElWSVJVUy1URVNULUZJTEUhJEgrSCo="}
Copy

Download Samples Archive

Download an archive file

Auth

Path Params

publicity	string	Enum: `public`,`private`
type	string	Enum: `doc`,`exec`
date	string	pattern: `(\d{4})\-(0[1-9]\|1[012])\-(0[1-9]\|[12][0-9]\|3[01])`

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

xxxxxxxxxx
 
curl --get \ --url 'https://opswat.developerhub.io/api/archives/samples/%7Bpublicity%7D/%7Btype%7D/%7Bdate%7D' \ --header 'X-Api-Key: {X-Api-Key}'
Copy

Responses

200

Successful Response

No response body

401

Not authorized

403

Forbidden

404

Item not found

422

Validation Error

Response

xxxxxxxxxx
 
No response
Copy

Download Samples ArchiveDeprecated

Download an archive file

Auth

Path Params

publicity	string	Enum: `public`,`private`
type	string	Enum: `doc`,`exec`
date	string	pattern: `(\d{4})\-(0[1-9]\|1[012])\-(0[1-9]\|[12][0-9]\|3[01])`

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

xxxxxxxxxx
 
curl --get \ --url 'https://opswat.developerhub.io/api/feed/archives/%7Bpublicity%7D/%7Btype%7D/%7Bdate%7D' \ --header 'X-Api-Key: {X-Api-Key}'
Copy

Responses

200

Successful Response

No response body

401

Not authorized

403

Forbidden

404

Item not found

422

Validation Error

Response

xxxxxxxxxx
 
No response
Copy

Feed

Atom feed

/api/feed/reports/info

/api/feed/info

/api/archives/yara/{date}

/api/archives/samples

Get Reports Feed

Get reports feed.

For API documentation page we show smaller amount of reports. To get full feed, query feed endpoint directly from browser address bar or from any suitable app.

Auth

GET /api/feed/reports

xxxxxxxxxx
 
curl --get \ --url 'https://opswat.developerhub.io/api/feed/reports' \ --header 'X-Api-Key: {X-Api-Key}'
Copy

Responses

200

Successful Response

No response body

401

Not authorized

Response

xxxxxxxxxx
 
No response
Copy

Get Reports FeedDeprecated

Get reports feed.

For API documentation page we show smaller amount of reports. To get full feed, query feed endpoint directly from browser address bar or from any suitable app.

Auth

GET /api/feed/atom

xxxxxxxxxx
 
curl --get \ --url 'https://opswat.developerhub.io/api/feed/atom' \ --header 'X-Api-Key: {X-Api-Key}'
Copy

Responses

200

Successful Response

No response body

401

Not authorized

Response

xxxxxxxxxx
 
No response
Copy

Get Reports Feed Info

Get reports feed info

Auth

GET /api/feed/reports/info

xxxxxxxxxx
 
curl --get \ --url 'https://opswat.developerhub.io/api/feed/reports/info' \ --header 'X-Api-Key: {X-Api-Key}'
Copy

Responses

200

Successful Response

FeedInfo	object	Response model for get_feed_info endpoint
count	integer
length	integer
updated	number
download_allowed	boolean

401

Not authorized

Response

xxxxxxxxxx
 
{ "count": 38, "length": 1161760, "updated": 1731932169.007461, "download_allowed": true}
Copy

Get Reports Feed InfoDeprecated

Get reports feed info

Auth

GET /api/feed/info

xxxxxxxxxx
 
curl --get \ --url 'https://opswat.developerhub.io/api/feed/info' \ --header 'X-Api-Key: {X-Api-Key}'
Copy

Responses

200

Successful Response

FeedInfo	object	Response model for get_feed_info endpoint
count	integer
length	integer
updated	number
download_allowed	boolean

401

Not authorized

Response

xxxxxxxxxx
 
{ "count": 38, "length": 1161760, "updated": 1731932169.007461, "download_allowed": true}
Copy

Get Daily Samples Archives

Get daily samples

Auth

GET /api/archives/samples

xxxxxxxxxx
 
curl --get \ --url 'https://opswat.developerhub.io/api/archives/samples' \ --header 'X-Api-Key: {X-Api-Key}'
Copy

Responses

200

Successful Response

DailySamplesArchiveResponse	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

401

Not authorized

Response

xxxxxxxxxx
 
[ {  "name": "2024-11-11.zip",  "link": "http://localhost:4200/api/archives/samples/public/exec/2024-11-11",  "reports_date": "2024-11-11",  "files_count": 2,  "files_type": "exec",  "size": 2534700,  "is_public": true }, {  "name": "2024-11-06.zip",  "link": "http://localhost:4200/api/archives/samples/public/exec/2024-11-06",  "reports_date": "2024-11-06",  "files_count": 1,  "files_type": "exec",  "size": 21185,  "is_public": true }, {  "name": "2024-11-05.zip",  "link": "http://localhost:4200/api/archives/samples/private/exec/2024-11-05",  "reports_date": "2024-11-05",  "files_count": 1,  "files_type": "exec",  "size": 2158455,  "is_public": false }]
Copy

Get Daily Samples ArchivesDeprecated

Get daily samples

Auth

GET /api/feed/archives

xxxxxxxxxx
 
curl --get \ --url 'https://opswat.developerhub.io/api/feed/archives' \ --header 'X-Api-Key: {X-Api-Key}'
Copy

Responses

200

Successful Response

DailySamplesArchiveResponse	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

401

Not authorized

Response

xxxxxxxxxx
 
[ {  "name": "2024-11-11.zip",  "link": "http://localhost:4200/api/archives/samples/public/exec/2024-11-11",  "reports_date": "2024-11-11",  "files_count": 2,  "files_type": "exec",  "size": 2534700,  "is_public": true }, {  "name": "2024-11-06.zip",  "link": "http://localhost:4200/api/archives/samples/public/exec/2024-11-06",  "reports_date": "2024-11-06",  "files_count": 1,  "files_type": "exec",  "size": 21185,  "is_public": true }, {  "name": "2024-11-05.zip",  "link": "http://localhost:4200/api/archives/samples/private/exec/2024-11-05",  "reports_date": "2024-11-05",  "files_count": 1,  "files_type": "exec",  "size": 2158455,  "is_public": false }]
Copy

Get Yara Feed

Get YARA rules feed

Auth

GET /api/feed/yara

xxxxxxxxxx
 
curl --get \ --url 'https://opswat.developerhub.io/api/feed/yara' \ --header 'X-Api-Key: {X-Api-Key}'
Copy

Responses

200

Successful Response

No response body

401

Not authorized

Response

xxxxxxxxxx
 
No response
Copy

Get Yara Feed Info

Get YARA rules feed info

Auth

GET /api/feed/yara/info

xxxxxxxxxx
 
curl --get \ --url 'https://opswat.developerhub.io/api/feed/yara/info' \ --header 'X-Api-Key: {X-Api-Key}'
Copy

Responses

200

Successful Response

No response body

401

Not authorized

Response

xxxxxxxxxx
 
No response
Copy

Get Daily Yara Archives

Get daily YARA rules, generated for malicious reports

Auth

GET /api/archives/yara

xxxxxxxxxx
 
curl --get \ --url 'https://opswat.developerhub.io/api/archives/yara' \ --header 'X-Api-Key: {X-Api-Key}'
Copy

Responses

200

Successful Response

DailyYaraArchiveResponse	array[object]
name	string	Archive file name
link	string	Link to file download
reports_date	string	Date of reports creation
rules_count	integer	Amount of rules in archive
size	integer	Archive size in bytes

401

Not authorized

Response

xxxxxxxxxx
 
[ {  "name": "2024-11-11.zip",  "link": "http://localhost:4200/api/archives/yara/2024-11-11",  "reports_date": "2024-11-11",  "rules_count": 2,  "size": 2534700 }, {  "name": "2024-11-06.zip",  "link": "http://localhost:4200/api/archives/yara/2024-11-06",  "reports_date": "2024-11-06",  "rules_count": 1,  "size": 21185 }, {  "name": "2024-11-05.zip",  "link": "http://localhost:4200/api/archives/yara/2024-11-05",  "reports_date": "2024-11-05",  "rules_count": 1,  "size": 2158455 }]
Copy

Download Yara Archive

Get daily YARA rules archive

Auth

Path Params

date string

GET /api/archives/yara/{date}

xxxxxxxxxx
 
curl --get \ --url 'https://opswat.developerhub.io/api/archives/yara/%7Bdate%7D' \ --header 'X-Api-Key: {X-Api-Key}'
Copy

Responses

200

Successful Response

No response body

401

Not authorized

403

Forbidden

404

Item not found

422

Validation Error

Response

xxxxxxxxxx
 
No response
Copy

Users

Report-related and other functionality used by ordinary users.

/api/users/reset-timezone-locale

/api/users/{account_id}/avatar

/api/users/api-key/create

/api/users/api-key/set

/api/users/api-key/remove

/api/users/notifications/{notification}

/api/users/reports/{report_id}

/api/users/uploads

/api/users/me/uploads

/api/users/stat

/api/users/stat/generic

/api/users/stat/malicious-ips

/api/users/stat/mitre

/api/admin/reports/{report_id}

/api/users/info/yara

Get Current User

Get user model of currently authenticated user

Auth

GET /api/users/me

xxxxxxxxxx
 
curl --get \ --url 'https://opswat.developerhub.io/api/users/me' \ --header 'X-Api-Key: {X-Api-Key}'
Copy

Responses

200

Successful Response

GetCurrentUserResponse	object
accountId	string
userId	string
username	string
email	string
avatarLastModified	date-time
allowedFeatures	array
scanProfiles	array
isAdmin	boolean
isAuditor	boolean
isPasswordEmpty	boolean
theme	string
timezone	string
locale	string
externalAuth	object
notifications	array

Response

xxxxxxxxxx
 
{ "accountId": "{string}", "userId": "{string}", "username": "{string}", "email": "{string}", "avatarLastModified": "{date-time}", "allowedFeatures": [  "{array...}" ], "scanProfiles": [  "{array...}" ], "isAdmin": "{boolean}", "isAuditor": "{boolean}", "isPasswordEmpty": "{boolean}", "theme": "{string}", "timezone": "{string}", "locale": "{string}", "externalAuth": {}, "notifications": [  "{array...}" ]}
Copy

Get Profile

Get user profile data

Auth

GET /api/users/profile

xxxxxxxxxx
 
curl --get \ --url 'https://opswat.developerhub.io/api/users/profile' \ --header 'X-Api-Key: {X-Api-Key}'
Copy

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`

Expand

401

Not authorized

Response

xxxxxxxxxx
 
{ "account_id": "{string}", "email": "{string}", "username": "{string}", "pseudoname": "{string}", "groups": [  {   "name": "{string}"  } ], "has_avatar": "{boolean}", "profile": {  "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}", "locale": "{string}"}
Copy

Post Profile

Update user profile data

Auth

Request Body

Body_post_profile_api_users_profile_post	object
email	string
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`

Expand

POST /api/users/profile

xxxxxxxxxx
 
curl --request POST \ --url 'https://opswat.developerhub.io/api/users/profile' \ --header 'X-Api-Key: {X-Api-Key}' \ --form 'file=@{file}'
Copy

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`

Expand

400

Bad request

401

Not authorized

415

Unsupported media type

422

Validation Error

500

Internal server error

Response

xxxxxxxxxx
 
{ "account_id": "{string}", "email": "{string}", "username": "{string}", "pseudoname": "{string}", "groups": [  {   "name": "{string}"  } ], "has_avatar": "{boolean}", "profile": {  "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}", "locale": "{string}"}
Copy

Reset Timezone Locale

Reset user timezone and locale settings

Auth

DELETE /api/users/reset-timezone-locale

xxxxxxxxxx
 
curl --request DELETE \ --url 'https://opswat.developerhub.io/api/users/reset-timezone-locale' \ --header 'X-Api-Key: {X-Api-Key}'
Copy

Responses

200

Successful Response

No response body

401

Not authorized

Response

xxxxxxxxxx
 
No response
Copy

Get Avatar Image

Get use avatar image

Auth

Path Params

account_id string

GET /api/users/{account_id}/avatar

xxxxxxxxxx
 
curl --get \ --url 'https://opswat.developerhub.io/api/users/%7Baccount_id%7D/avatar' \ --header 'X-Api-Key: {X-Api-Key}'
Copy

Responses

200

Successful Response

No response body

401

Not authorized

404

Item not found

422

Validation Error

Response

xxxxxxxxxx
 
No response
Copy

Create API Key

Create API key for current user

Auth

POST /api/users/api-key/create

xxxxxxxxxx
 
curl --request POST \ --url 'https://opswat.developerhub.io/api/users/api-key/create' \ --header 'X-Api-Key: {X-Api-Key}'
Copy

Responses

200

Successful Response

UserApiKey	object	Model for user API key create and set
api_key	string

400

Bad request

401

Not authorized

Response

xxxxxxxxxx
 
{ "api_key": "{string}"}
Copy

Set API key

Set API key for current user

Auth

Request Body

UserApiKey	object	Model for user API key create and set
api_key	string

POST /api/users/api-key/set

xxxxxxxxxx
 
curl --request POST \ --url 'https://opswat.developerhub.io/api/users/api-key/set' \ --header 'X-Api-Key: {X-Api-Key}' \ --data '{  "api_key": "{string}"}'
Copy

Responses

200

Successful Response

No response body

400

Bad request

401

Not authorized

422

Validation Error

Response

xxxxxxxxxx
 
No response
Copy

Remove API Key

Remove user's API key

Auth

POST /api/users/api-key/remove

xxxxxxxxxx
 
curl --request POST \ --url 'https://opswat.developerhub.io/api/users/api-key/remove' \ --header 'X-Api-Key: {X-Api-Key}'
Copy

Responses

200

Successful Response

No response body

401

Not authorized

404

Item not found

Response

xxxxxxxxxx
 
No response
Copy

Mark notification as viewed by user

Auth

Path Params

notification

string

Enum: dark_theme

POST /api/users/notifications/{notification}

xxxxxxxxxx
 
curl --request POST \ --url 'https://opswat.developerhub.io/api/users/notifications/%7Bnotification%7D' \ --header 'X-Api-Key: {X-Api-Key}'
Copy

Responses

200

Successful Response

No response body

401

Not authorized

422

Validation Error

Response

xxxxxxxxxx
 
No response
Copy

Delete Report

Delete a report

Users can only delete their own reports

Auth

Path Params

report_id string

DELETE /api/users/reports/{report_id}

xxxxxxxxxx
 
curl --request DELETE \ --url 'https://opswat.developerhub.io/api/users/reports/%7Breport_id%7D' \ --header 'X-Api-Key: {X-Api-Key}'
Copy

Responses

200

Successful Response

No response body

401

Not authorized

403

Forbidden

404

Item not found

422

Validation Error

Response

xxxxxxxxxx
 
No response
Copy

Get Public ReportsDeprecated

Get all public reports

Auth

Query String

page

integer

Page number starting from 1

minimum: 1

Default: 1

page_size

Page size

Default: 10

GET /api/users/uploads

xxxxxxxxxx
 
curl --get \ --url 'https://opswat.developerhub.io/api/users/uploads' \ --header 'X-Api-Key: {X-Api-Key}' \ --data page=1 \ --data page_size=10
Copy

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

401

Not authorized

422

Validation Error

Response

xxxxxxxxxx
 
{ "items": [  "{array...}" ], "count": "{integer}", "count_search_params": "{integer}", "method": "{string}", "dbs_sync": "{boolean}"}
Copy

Get User ReportsDeprecated

Get reports of 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	Results newer then this date (format YYYY-MM-DD)
verdict	string	Enum: `unknown`,`benign`,`informational`,`no_threat`,`suspicious`,`likely_malicious`,`malicious`

GET /api/users/me/uploads

xxxxxxxxxx
 
curl --get \ --url 'https://opswat.developerhub.io/api/users/me/uploads' \ --header 'X-Api-Key: {X-Api-Key}' \ --data page=1 \ --data page_size=10 \ --data date_from={date_from} \ --data verdict={verdict}
Copy

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

401

Not authorized

422

Validation Error

Response

xxxxxxxxxx
 
{ "items": [  "{array...}" ], "count": "{integer}", "count_search_params": "{integer}", "method": "{string}", "dbs_sync": "{boolean}"}
Copy

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
period	string

GET /api/users/stat

xxxxxxxxxx
 
curl --get \ --url 'https://opswat.developerhub.io/api/users/stat' \ --header 'X-Api-Key: {X-Api-Key}' \ --data types={types} \ --data all_users={all_users} \ --data period={period}
Copy

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

xxxxxxxxxx
 
[ {  "user": {   "account_id": "{string}",   "username": "{string}",   "pseudoname": "{string}"  },  "name": "{string}",  "value": "{}",  "updated_date": "{date-time}" }]
Copy

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_iocs_per_period`,`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`,`count_malicious_signal_groups`,`count_mitre_techniques_by_period`,`count_yaras_per_period`,`count_top_level_domains`,`count_phishing_brands`,`count_api_calls`,`average_scan_time`,`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`,`collect_daily_yara`,`fix_link_mime_type`,`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`,`fix_origins_relations`,`old_errors_cleanup`,`cleanup_report_format_history`,`calculate_storage`,`check_license_scan_limit`,`generate_yara_xml_feed`,`send_report_summary`,`remove_failed_reports`,`frequent_signal_tags`,`frequent_malware_tags`
period	string

GET /api/users/stat/generic

xxxxxxxxxx
 
curl --get \ --url 'https://opswat.developerhub.io/api/users/stat/generic' \ --header 'X-Api-Key: {X-Api-Key}' \ --data types={types} \ --data period={period}
Copy

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

xxxxxxxxxx
 
[ {  "name": "{string}",  "value": "{boolean}",  "updated_date": "{date-time}" }]
Copy

Get Malicious Ips Stat

Get statistics on malicious IPs

Auth

Query String

period	string
target	string

GET /api/users/stat/malicious-ips

xxxxxxxxxx
 
curl --get \ --url 'https://opswat.developerhub.io/api/users/stat/malicious-ips' \ --header 'X-Api-Key: {X-Api-Key}' \ --data period={period} \ --data target={target}
Copy

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

xxxxxxxxxx
 
{ "name": "{string}", "value": "{}", "period": "{string}", "updated_date": "2025-07-30T13:27:51.963553", "id": "5f85f36d6dfecacc68428a46"}
Copy

Get Ioc Stat

Get app statistics

Auth

GET /api/users/stat/iocs

xxxxxxxxxx
 
curl --get \ --url 'https://opswat.developerhub.io/api/users/stat/iocs' \ --header 'X-Api-Key: {X-Api-Key}'
Copy

Responses

200

Successful Response

StatForResponse	object
count
integer	integer
updated	date-time

401

Not authorized

Response

xxxxxxxxxx
 
{ "count": "{integer}", "updated": "{date-time}"}
Copy

Get Yara Stat

Get yara statistics

Auth

GET /api/users/stat/yara

xxxxxxxxxx
 
curl --get \ --url 'https://opswat.developerhub.io/api/users/stat/yara' \ --header 'X-Api-Key: {X-Api-Key}'
Copy

Responses

200

Successful Response

StatForYaraResponse	object
count
integer	integer
updated	date-time

401

Not authorized

Response

xxxxxxxxxx
 
{ "count": "{integer}", "updated": "{date-time}"}
Copy

Get Mitre Stat

Get statistics on MITRE techniques used in reports

Auth

GET /api/users/stat/mitre

xxxxxxxxxx
 
curl --get \ --url 'https://opswat.developerhub.io/api/users/stat/mitre' \ --header 'X-Api-Key: {X-Api-Key}'
Copy

Responses

200

Successful Response

StatForResponse	object
count
integer	integer
updated	date-time

401

Not authorized

Response

xxxxxxxxxx
 
{ "count": "{integer}", "updated": "{date-time}"}
Copy

Get Yara Info

Get yara repo info

Auth

GET /api/users/info/yara

xxxxxxxxxx
 
curl --get \ --url 'https://opswat.developerhub.io/api/users/info/yara' \ --header 'X-Api-Key: {X-Api-Key}'
Copy

Responses

200

Successful Response

YaraInfoResponse	object
info	array[object]
revision	string
url	string

401

Not authorized

Response

xxxxxxxxxx
 
{ "info": [  {   "revision": "{string}",   "url": "{string}"  } ]}
Copy

Get Default

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

Auth

GET /api/system/info

xxxxxxxxxx
 
curl --get \ --url 'https://opswat.developerhub.io/api/system/info' \ --header 'X-Api-Key: {X-Api-Key}'
Copy

Responses

200

Successful Response

GeneralSystemInfo	object	Response model for /api/system/info endpoint
title	string
description	string
api_version	string
release_version	string
release_date	date-time

Response

xxxxxxxxxx
 
{ "title": "{string}", "description": "{string}", "api_version": "{string}", "release_version": "{string}", "release_date": "{date-time}"}
Copy

Get Version

Return the version of the webservice

Auth

GET /api/system/version

xxxxxxxxxx
 
curl --get \ --url 'https://opswat.developerhub.io/api/system/version' \ --header 'X-Api-Key: {X-Api-Key}'
Copy

Responses

200

Successful Response

Response Get Version Api System Version Get string

Response

xxxxxxxxxx
 
{ "schema": "{string}"}
Copy

Get Config

Obtain project configuration to use on front-end

Auth

GET /api/system/config

xxxxxxxxxx
 
curl --get \ --url 'https://opswat.developerhub.io/api/system/config' \ --header 'X-Api-Key: {X-Api-Key}'
Copy

Responses

200

Successful Response

SystemConfig	object	Response model for /api/system/config endpoint
baseUrl	string
allowAnonymousUsers	boolean
appTitle	string
appDescription	string
adFrequency	integer
buildType	string	An enumeration. Enum: `default`,`community`,`develop`
maxUploadSize	integer
maxUploadSizeLimit	integer
username	object	Username config model for SystemConfig response model
maximum_length	integer
regex	string
password	object	Password config model for SystemConfig response model
alpha_numeric	boolean
minimum_length	integer
mixed_case	boolean
special_characters	boolean
tokenExpire	object	TokenExpire config model for SystemConfig response model
signupConfirm	integer
passwordReset	integer
invite	integer
reports	object	Reports config model for SystemConfig response model
queryInterval	object	QueryInterval config model for ReportsConfig model
initial	integer
withData	integer
signalTypeUpperLimit	object	SignalTypeUpperLimit config model for ReportsConfig model
informational	number
suspicious	number
search	object	Search config model for ReportsConfig model
page_size	integer
page_size_options	array[integer]
reportsLimit	integer
monthsLimit	integer
maxRetryCount	integer
viewFileContentSizeLimit	integer
keepJobResultSeconds	integer
queueJobTimeout	integer
languages	object	Languages config model for SystemConfig response model
language	string
code	string
scanFilesPerUpload	integer
googleAnalyticsID	string
googleAnalyticsUA	string
matomoContainerPath	string
supportedTypes	array[string]	Enum: `ace`,`apk`,`bat`,`64bits`,`bmp`,`csv`,`doc`,`docm`,`docx`,`dot`,`dotm`,`dotx`,`elf`,`eml`,`gif`,`hta`,`htm`,`html`,`iso`,`java`,`java-bytecode`,`javascript`,`jpg`,`lnk`,`mbox`,`mhtml`,`msg`,`msi`,`mso`,`odp`,`ods`,`odt`,`odg`,`odf`,`odc`,`odb`,`odi`,`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`,`xml`,`xsl`,`zip`,`7zip`,`exe`,`mail`,`ms-office`,`script`
fileCategories	object
*	array[string]
fileGeneralTypes	object
*	array[string]
constantStrings	array[string]
defaultTheme	string
iocs	object	IOCs config model for SystemConfig response model
prevalenceExceptWhitelists	boolean
genQueryExceptWhitelists	boolean
prevalenceDayOptions	array[integer]	Enum: `7`,`14`,`30`,`-1`
admin	object	Admin config model for SystemConfig response model
pageSize	integer
logoSelectedTime	object	LogoSelectedTime config model for SystemConfig response model
light	object	LogoTypeSelectedTime config model for LogoSelectedTimeConfig model
main	integer
top_menu	integer
footer	integer
dark	object	LogoTypeSelectedTime config model for LogoSelectedTimeConfig model
main	integer
top_menu	integer
footer	integer
askTermsConsent	boolean
scanBigFileSize	integer
statOverview	object	StatOverview config model for SystemConfig response model
timelineMonths	array[string]
topItemsLimit	integer
leaderboardItemsLimit	integer
jobs	object	Jobs config model for SystemConfig response model
memoryLimit	integer
chartControlTime	integer
memoryUsageTop	integer
similaritySearchEnabled	boolean
TLDTypes	array[string]	Enum: `com`,`org`,`edu`,`gov`,`uk`,`net`,`ca`,`de`,`jp`,`fr`,`au`,`us`,`ru`,`ch`,`it`,`nl`,`se`,`no`,`es`,`mil`,`aero`,`biz`,`coop`,`info`,`museum`,`name`,`pro`,`ac`,`ad`,`ae`,`af`,`ag`,`al`,`ai`,`am`,`ao`,`aq`,`ar`,`as`,`at`,`az`,`ba`,`bb`,`be`,`bf`,`bg`,`bh`,`bm`,`bn`,`bo`,`br`,`bt`,`bw`,`by`,`bz`,`cc`,`cd`,`cg`,`cl`,`cm`,`co`,`cr`,`cu`,`cx`,`cy`,`cz`,`dj`,`dk`,`do`,`dz`,`ec`,`ee`,`eg`,`et`,`fi`,`fj`,`fm`,`fo`,`ga`,`ge`,`gg`,`gh`,`gi`,`gl`,`gr`,`gs`,`gt`,`hk`,`hm`,`hn`,`hr`,`hu`,`id`,`ie`,`il`,`im`,`io`,`ir`,`je`,`jm`,`jo`,`ke`,`kg`,`kh`,`ki`,`kr`,`kw`,`ky`,`kz`,`la`,`lb`,`li`,`lk`,`lt`,`lu`,`lv`,`ly`,`ma`,`mc`,`md`,`mg`,`mk`,`mm`,`mn`,`mo`,`mp`,`mr`,`ms`,`mt`,`mu`,`mv`,`mx`,`my`,`mz`,`na`,`nc`,`ne`,`ng`,`ni`,`np`,`nr`,`nu`,`nz`,`om`,`pa`,`pe`,`pf`,`pg`,`ph`,`pk`,`pl`,`pr`,`pt`,`pw`,`qa`,`re`,`ro`,`rw`,`sa`,`sc`,`sg`,`sh`,`si`,`sk`,`sm`,`sn`,`sr`,`st`,`sv`,`sy`,`tc`,`tf`,`th`,`tj`,`tk`,`tm`,`tn`,`to`,`tp`,`tr`,`tt`,`tv`,`tw`,`tz`,`ua`,`ug`,`uy`,`uz`,`va`,`vc`,`ve`,`vg`,`vi`,`vn`,`vu`,`ws`,`ye`,`yu`,`za`,`zm`,`zw`
showFooter	boolean
maintenance	object	Maintenance config model for SystemConfig response model
blockScan	boolean
blockScanNotification	string
blockSearch	boolean
blockSearchNotification	string
allowedFeatures	array[string]
ocm	object	OCM config model for SystemConfig response model
clientUrl	string
extraButton	object	ExtraButton config model for SystemConfig response model
text	string
link	string
active	boolean
newsLimit	integer
automaticReportFilesDownload	boolean

Expand

Response

xxxxxxxxxx
 
{
 "baseUrl": "{string}", "allowAnonymousUsers": "{boolean}", "appTitle": "{string}", "appDescription": "{string}", "adFrequency": "{integer}", "buildType": "{string}", "maxUploadSize": "{integer}", "maxUploadSizeLimit": "{integer}", "username": {...},
 "password": {...},
 "tokenExpire": {...},
 "reports": {...},
 "queueJobTimeout": "{integer}", "languages": {...},
 "scanFilesPerUpload": "{integer}", "googleAnalyticsID": "{string}", "googleAnalyticsUA": "{string}", "matomoContainerPath": "{string}", "supportedTypes": [...],
 "fileCategories": {}, "fileGeneralTypes": {}, "constantStrings": [...],
 "defaultTheme": "{string}", "iocs": {...},
 "admin": {...},
 "logoSelectedTime": {...},
 "askTermsConsent": "{boolean}", "scanBigFileSize": "{integer}", "statOverview": {...},
 "jobs": {...},
 "similaritySearchEnabled": "{boolean}", "TLDTypes": [...],
 "showFooter": "{boolean}", "maintenance": {...},
 "allowedFeatures": [...],
 "ocm": {...},
 "extraButton": {...},
 "newsLimit": "{integer}", "automaticReportFilesDownload": "{boolean}"}
Copy

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}

xxxxxxxxxx
 
curl --get \ --url 'https://opswat.developerhub.io/api/system/get-terms/%7Bterms_type%7D' \ --header 'X-Api-Key: {X-Api-Key}'
Copy

Responses

200

Successful Response

Response Get Terms Api System Get Terms Terms Type Get string

404

Item not found

422

Validation Error

Response

xxxxxxxxxx
 
{ "schema": "{string}"}
Copy

Get Signal Groups

Obtain signal groups list

Auth

GET /api/system/signal-groups

xxxxxxxxxx
 
curl --get \ --url 'https://opswat.developerhub.io/api/system/signal-groups' \ --header 'X-Api-Key: {X-Api-Key}'
Copy

Responses

200

Successful Response

SignalGroupsResponse	array[object]
type	string
name	string
category	string
groups	array[object]
id	string
description	string
mime_type	string
mitre_technique_ids	string
strength	string

401

Not authorized

Response

xxxxxxxxxx
 
[ {  "type": "{string}",  "name": "{string}",  "category": "{string}",  "groups": [   {    "id": "{string}",    "description": "{string}",    "mime_type": "{string}",    "mitre_technique_ids": "{string}",    "strength": "{string}"   }  ] }]
Copy

Get Mime Types

Obtain mime type list

Auth

GET /api/system/mime-types

xxxxxxxxxx
 
curl --get \ --url 'https://opswat.developerhub.io/api/system/mime-types' \ --header 'X-Api-Key: {X-Api-Key}'
Copy

Responses

200

Successful Response

array array[string]

401

Not authorized

Response

xxxxxxxxxx
 
[ "{array[string]...}"]
Copy

Get Yara Rules

Get extended data of yara rules

If the name parameter is left empty, it returns the list of yara rules that already has a match in the system. Otherwise it will return a list of yara rules where the yara rule name matches the name parameter even if the yara rule has no match in the system.

Auth

Query String

name

array

Name of the YARA rule

Default: []

GET /api/system/yara

xxxxxxxxxx
 
curl --get \ --url 'https://opswat.developerhub.io/api/system/yara' \ --header 'X-Api-Key: {X-Api-Key}' \ --data name=
Copy

Responses

200

Successful Response

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

401

Not authorized

422

Validation Error

Response

xxxxxxxxxx
 
[ {  "name": "{string}",  "author": "{string}",  "strength": "{number}",  "created_date": "2025-07-30T13:27:51.963949",  "description": "{string}",  "other_data": {},  "content": "{string}" }]
Copy

Get Yara Authors

Get yara rules authors

If the name parameter is left empty, it returns the list of yara rule authors that already has a match in the system. Otherwise it will return a list of yara rule authors where the yara rule name matches the name parameter even if the yara rule has no match in the system.

Auth

Query String

name

array

Name of the YARA rule

Default: []

GET /api/system/yara-authors

xxxxxxxxxx
 
curl --get \ --url 'https://opswat.developerhub.io/api/system/yara-authors' \ --header 'X-Api-Key: {X-Api-Key}' \ --data name=
Copy

Responses

200

Successful Response

array array[string]

401

Not authorized

422

Validation Error

Response

xxxxxxxxxx
 
[ "{array[string]...}"]
Copy

Get Translations

Obtain translations for specific language

Auth

Path Params

lang

string

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

GET /api/system/translations/{lang}

xxxxxxxxxx
 
curl --get \ --url 'https://opswat.developerhub.io/api/system/translations/%7Blang%7D' \ --header 'X-Api-Key: {X-Api-Key}'
Copy

Responses

200

Successful Response

Response Get Translations Api System Translations Lang Get	object
*	string

422

Validation Error

Response

xxxxxxxxxx
 
{}
Copy

Get Languages

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

Auth

GET /api/system/languages

xxxxxxxxxx
 
curl --get \ --url 'https://opswat.developerhub.io/api/system/languages' \ --header 'X-Api-Key: {X-Api-Key}'
Copy

Responses

200

Successful Response

Response Get Languages Api System Languages Get	object
*	string

404

Item not found

Response

xxxxxxxxxx
 
{}
Copy

Get Countries

Obtain list of all countries

Auth

GET /api/system/countries

xxxxxxxxxx
 
curl --get \ --url 'https://opswat.developerhub.io/api/system/countries' \ --header 'X-Api-Key: {X-Api-Key}'
Copy

Responses

200

Successful Response

Response Get Countries Api System Countries Get	object
*	string

404

Item not found

Response

xxxxxxxxxx
 
{}
Copy

Get Mitre Data

Obtain MITRE tactics and techniques

Auth

GET /api/system/mitre

xxxxxxxxxx
 
curl --get \ --url 'https://opswat.developerhub.io/api/system/mitre' \ --header 'X-Api-Key: {X-Api-Key}'
Copy

Responses

200

Successful Response

Response Get Mitre Data Api System Mitre Get	object
*	object	Response model for /api/system/mitre endpoint
techniques	object
*	object	MitreTechnique model for MitreDataResponse model
id	string
name	string
description	string
id	string
name	string
description	string

404

Item not found

Response

xxxxxxxxxx
 
{}
Copy

Log Client Error

Log frontend cliend errors

Auth

POST /api/system/errors/log

xxxxxxxxxx
 
curl --request POST \ --url 'https://opswat.developerhub.io/api/system/errors/log' \ --header 'X-Api-Key: {X-Api-Key}'
Copy

Responses

200

Successful Response

No response body

400

Bad request

Response

xxxxxxxxxx
 
No response
Copy

Get Logo

Get logo image

Auth

Query String

type		Default: main
theme		Default: light
name	string

GET /api/system/logo

xxxxxxxxxx
 
curl --get \ --url 'https://opswat.developerhub.io/api/system/logo' \ --header 'X-Api-Key: {X-Api-Key}' \ --data type=main \ --data theme=light \ --data name={name}
Copy

Responses

200

Successful Response

No response body

404

Item not found

422

Validation Error

Response

xxxxxxxxxx
 
No response
Copy

Do Healthcheck

Do an immediate healthcheck and return the state

Auth

GET /api/system/do-healthcheck

xxxxxxxxxx
 
curl --get \ --url 'https://opswat.developerhub.io/api/system/do-healthcheck' \ --header 'X-Api-Key: {X-Api-Key}'
Copy

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
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
fstransform_health	array[object]
response	object
instance_id	string
calculated_health	boolean
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

Expand

401

Not authorized

Response

xxxxxxxxxx
 
{ "created_date": "{date-time}", "frontend_health": {  "http_info": {   "response_time_ms": "{integer}",   "response_code_http": "{integer}",   "request_success": "{boolean}"  },  "calculated_health": "{boolean}" }, "webservice_health": {  "http_info_direct": {   "response_time_ms": "{integer}",   "response_code_http": "{integer}",   "request_success": "{boolean}"  },  "response_direct": {},  "http_info_nginx": {   "response_time_ms": "{integer}",   "response_code_http": "{integer}",   "request_success": "{boolean}"  },  "response_nginx": {},  "number_of_all_users": "{integer}",  "number_of_active_users": "{integer}",  "tasks_queues": {   "total_healthy": "{boolean}",   "queues": [    {     "queue_name": "{string}",     "check_type": "{string}",     "healthy": "{boolean}",     "last_date_healthy": "{date-time}",     "data": {}    }   ]  },  "calculated_health": "{boolean}" }, "fstransform_health": [  {   "response": {},   "instance_id": "{string}",   "calculated_health": "{boolean}"  } ], "fsbroker_health": {  "http_info": {   "response_time_ms": "{integer}",   "response_code_http": "{integer}",   "request_success": "{boolean}"  },  "response": {},  "calculated_health": "{boolean}" }}
Copy

Expand

Query Healthcheck

Query past healthcheck logs

Auth

Query String

days	integer	Default: 90
days_from	integer

GET /api/system/query-full-healthcheck

xxxxxxxxxx
 
curl --get \ --url 'https://opswat.developerhub.io/api/system/query-full-healthcheck' \ --header 'X-Api-Key: {X-Api-Key}' \ --data days=90 \ --data days_from={days_from}
Copy

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
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
fstransform_health	array[object]
response	object
instance_id	string
calculated_health	boolean
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

Expand

401

Not authorized

422

Validation Error

Response

xxxxxxxxxx
 
[ {  "created_date": "{date-time}",  "frontend_health": {   "http_info": {    "response_time_ms": "{integer}",    "response_code_http": "{integer}",    "request_success": "{boolean}"   },   "calculated_health": "{boolean}"  },  "webservice_health": {   "http_info_direct": {    "response_time_ms": "{integer}",    "response_code_http": "{integer}",    "request_success": "{boolean}"   },   "response_direct": {},   "http_info_nginx": {    "response_time_ms": "{integer}",    "response_code_http": "{integer}",    "request_success": "{boolean}"   },   "response_nginx": {},   "number_of_all_users": "{integer}",   "number_of_active_users": "{integer}",   "tasks_queues": {    "total_healthy": "{boolean}",    "queues": [     {      "queue_name": "{string}",      "check_type": "{string}",      "healthy": "{boolean}",      "last_date_healthy": "{date-time}",      "data": {}     }    ]   },   "calculated_health": "{boolean}"  },  "fstransform_health": [   {    "response": {},    "instance_id": "{string}",    "calculated_health": "{boolean}"   }  ],  "fsbroker_health": {   "http_info": {    "response_time_ms": "{integer}",    "response_code_http": "{integer}",    "request_success": "{boolean}"   },   "response": {},   "calculated_health": "{boolean}"  } }]
Copy

Expand

Query Healthcheck

Query sanitized past healthcheck logs

Auth

Query String

days	integer	Default: 90
days_from	integer

GET /api/system/query-healthcheck

xxxxxxxxxx
 
curl --get \ --url 'https://opswat.developerhub.io/api/system/query-healthcheck' \ --header 'X-Api-Key: {X-Api-Key}' \ --data days=90 \ --data days_from={days_from}
Copy

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

xxxxxxxxxx
 
[ {  "created_date": "{date-time}",  "frontend_health": {},  "webservice_health": {},  "fstransform_health": [   {}  ],  "fsbroker_health": {} }]
Copy

Check License Info

Get license information

Auth

GET /api/system/license

xxxxxxxxxx
 
curl --get \ --url 'https://opswat.developerhub.io/api/system/license' \ --header 'X-Api-Key: {X-Api-Key}'
Copy

Responses

200

Successful Response

LicenseResponse	object	Fsbroker health log
http_info	object	HTTP health log
response_time_ms	integer
response_code_http	integer
request_success	boolean
response
object	object
message	string
calculated_health	boolean

401

Not authorized

Response

xxxxxxxxxx
 
{ "http_info": {  "response_time_ms": "{integer}",  "response_code_http": "{integer}",  "request_success": "{boolean}" }, "response": {}, "message": "{string}", "calculated_health": "{boolean}"}
Copy

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

xxxxxxxxxx
 
curl --request POST \ --url 'https://opswat.developerhub.io/api/system/license/activate/online' \ --header 'X-Api-Key: {X-Api-Key}' \ --data '{  "app_server": "{string}",  "license_key": "{string}"}'
Copy

Responses

200

Successful Response

LicenseResponse	object	Fsbroker health log
http_info	object	HTTP health log
response_time_ms	integer
response_code_http	integer
request_success	boolean
response
object	object
message	string
calculated_health	boolean

400

Bad request

401

Not authorized

422

Validation Error

Response

xxxxxxxxxx
 
{ "http_info": {  "response_time_ms": "{integer}",  "response_code_http": "{integer}",  "request_success": "{boolean}" }, "response": {}, "message": "{string}", "calculated_health": "{boolean}"}
Copy

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

xxxxxxxxxx
 
curl --request POST \ --url 'https://opswat.developerhub.io/api/system/license/activate/offline' \ --header 'X-Api-Key: {X-Api-Key}'
Copy

Responses

200

Successful Response

LicenseResponse	object	Fsbroker health log
http_info	object	HTTP health log
response_time_ms	integer
response_code_http	integer
request_success	boolean
response
object	object
message	string
calculated_health	boolean

400

Bad request

401

Not authorized

422

Validation Error

Response

xxxxxxxxxx
 
{ "http_info": {  "response_time_ms": "{integer}",  "response_code_http": "{integer}",  "request_success": "{boolean}" }, "response": {}, "message": "{string}", "calculated_health": "{boolean}"}
Copy

Deactivate License

Deactivate license

Auth

Query String

app_server string

DELETE /api/system/license/deactivate

xxxxxxxxxx
 
curl --request DELETE \ --url 'https://opswat.developerhub.io/api/system/license/deactivate' \ --header 'X-Api-Key: {X-Api-Key}' \ --data app_server={app_server}
Copy

Responses

200

Successful Response

LicenseResponse	object	Fsbroker health log
http_info	object	HTTP health log
response_time_ms	integer
response_code_http	integer
request_success	boolean
response
object	object
message	string
calculated_health	boolean

401

Not authorized

404

Item not found

422

Validation Error

500

Internal server error

Response

xxxxxxxxxx
 
{ "http_info": {  "response_time_ms": "{integer}",  "response_code_http": "{integer}",  "request_success": "{boolean}" }, "response": {}, "message": "{string}", "calculated_health": "{boolean}"}
Copy

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

xxxxxxxxxx
 
curl --get \ --url 'https://opswat.developerhub.io/api/system/reputation/check-config' \ --header 'X-Api-Key: {X-Api-Key}'
Copy

Responses

200

Successful Response

ReputationCheckConfigResponse	object
reputation_enabled	boolean

Response

xxxxxxxxxx
 
{ "reputation_enabled": "{boolean}"}
Copy

Get News

Get news

Auth

GET /api/system/news

xxxxxxxxxx
 
curl --get \ --url 'https://opswat.developerhub.io/api/system/news' \ --header 'X-Api-Key: {X-Api-Key}'
Copy

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

xxxxxxxxxx
 
[ {  "id": "{string}",  "link": "{string}",  "date": "{string}",  "text": "{string}",  "images": "{string}",  "order": "{integer}",  "active": "{boolean}" }]
Copy

Admin

Functionality for site admins.

/api/admin/access-groups

/api/admin/access-groups

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

/api/admin/settings/api-quota

/api/admin/settings/api-quota

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

/api/admin/settings/{group}

/api/admin/settings/{group}

/api/admin/auth-services

/api/admin/auth-services

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

/api/admin/users

/api/admin/users/import

/api/admin/users/{user_id}

/api/admin/users/{user_id}

/api/admin/users/{user_id}

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

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

/api/admin/app-config

/api/admin/stat/services

/api/admin/invite

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

/api/admin/errors/{error_id}

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

/api/admin/retention-calculation

/api/admin/errors/export

/api/admin/logs/{log_id}

/api/admin/logs/{log_id}

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

/api/admin/logos

/api/admin/logos/select

/api/admin/stat

/api/admin/stat/daily

/api/admin/jobs

/api/admin/jobs/config

/api/admin/jobs/memory/peaks

/api/admin/jobs/memory

/api/admin/jobs/{job_name}

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

/api/admin/jobs/stop/all

/api/admin/jobs/enable/all

/api/admin/stat/scan/health

/api/admin/stat/scan/states

/api/admin/emails/templates

/api/users/stat/daily

/api/admin/scan-sources/files

/api/admin/scan-sources/config

/api/admin/scan-sources/config

/api/admin/scan-sources/config

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

/api/admin/scan-sources/subjobs

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

Get Report

Get reports in raw format

Auth

Query String

scan_init_id	string
report_id	string

GET /api/debug/reports

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

Responses

200

Successful Response

RawReportResponse	object	Model for report raw format
scan_init	object
reports	array[object]

400

Bad request

404

Item not found

422

Validation Error

Response

xxxxxxxxxx
 
{
 "scan_init": {...},
 "reports": {...}
}
Copy

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

xxxxxxxxxx
 
curl --request POST \ --url 'https://opswat.developerhub.io/api/system/news' \ --header 'X-Api-Key: {X-Api-Key}' \ --data '{  "id": "{string}",  "link": "{string}",  "date": "{string}",  "text": "{string}",  "images": "{string}",  "order": "{integer}",  "active": "{boolean}"}'
Copy

Responses

200

Successful Response

No response body

400

Bad request

401

Not authorized

404

Item not found

422

Validation Error

Response

xxxxxxxxxx
 
No response
Copy

Remove News Item

Remove news item

Auth

Query String

news_id

DELETE /api/system/news

xxxxxxxxxx
 
curl --request DELETE \ --url 'https://opswat.developerhub.io/api/system/news' \ --header 'X-Api-Key: {X-Api-Key}' \ --data news_id={news_id}
Copy

Responses

200

Successful Response

No response body

400

Bad request

401

Not authorized

404

Item not found

422

Validation Error

Response

xxxxxxxxxx
 
No response
Copy

Delete ReportDeprecated

Delete a report

Users can only delete their own reports

Auth

Path Params

report_id string

DELETE /api/admin/reports/{report_id}

xxxxxxxxxx
 
curl --request DELETE \ --url 'https://opswat.developerhub.io/api/admin/reports/%7Breport_id%7D' \ --header 'X-Api-Key: {X-Api-Key}'
Copy

Responses

200

Successful Response

No response body

401

Not authorized

403

Forbidden

404

Item not found

422

Validation Error

Response

xxxxxxxxxx
 
No response
Copy

Get Access Groups

Get a list of all access groups

Auth

GET /api/admin/access-groups

xxxxxxxxxx
 
curl --get \ --url 'https://opswat.developerhub.io/api/admin/access-groups' \ --header 'X-Api-Key: {X-Api-Key}'
Copy

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

xxxxxxxxxx
 
[ {  "id": "60d70628b5194714b89be271",  "name": "admin",  "description": "User with access to admin panel",  "default": true }, {  "id": "65aee34a680efc464d0a1bc5",  "name": "auditor",  "description": "User with read-only access to admin panel",  "default": true }, {  "id": "60d704ddb5194714b89be20f",  "name": "guest",  "description": "Not authenticated user",  "default": true }, {  "id": "60d704ddb5194714b89be24c",  "name": "intel",  "description": "User with access to advanced threat-intel features",  "default": true }, {  "id": "6049f060a86b087d7e916f3f",  "name": "user",  "description": "Ordinary authenticated user",  "default": true }]
Copy

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

xxxxxxxxxx
 
curl --request POST \ --url 'https://opswat.developerhub.io/api/admin/access-groups' \ --header 'X-Api-Key: {X-Api-Key}' \ --data '{  "id": "{string}",  "name": "{string}",  "description": "{string}"}'
Copy

Responses

200

Successful Response

No response body

400

Bad request

401

Not authorized

404

Item not found

422

Validation Error

Response

xxxxxxxxxx
 
No response
Copy

Remove Access Group

Remove group

Auth

Path Params

group_id string

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

xxxxxxxxxx
 
curl --request POST \ --url 'https://opswat.developerhub.io/api/admin/access-groups/%7Bgroup_id%7D/remove' \ --header 'X-Api-Key: {X-Api-Key}'
Copy

Responses

200

Successful Response

No response body

400

Bad request

401

Not authorized

404

Item not found

422

Validation Error

Response

xxxxxxxxxx
 
No response
Copy

Get Api Quota

Get all api quota settings

Auth

GET /api/admin/settings/api-quota

xxxxxxxxxx
 
curl --get \ --url 'https://opswat.developerhub.io/api/admin/settings/api-quota' \ --header 'X-Api-Key: {X-Api-Key}'
Copy

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

xxxxxxxxxx
 
[ {  "route_id": "scan-file",  "groups": [   "60d704ddb5194714b89be20f"  ],  "time_settings": {   "seconds": {    "seconds_amount": 10,    "requests": 5   },   "hour": 20,   "day": 50  },  "id": "66f2a40f318df2831b854f85" }]
Copy

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

xxxxxxxxxx
 
curl --request POST \ --url 'https://opswat.developerhub.io/api/admin/settings/api-quota' \ --header 'X-Api-Key: {X-Api-Key}' \ --data '{  "route_id": "{string}",  "groups": [    "{array[string]...}"  ],  "time_settings": {    "seconds": {      "seconds_amount": "{integer}",      "requests": "{integer}"    },    "minute": "{integer}",    "hour": "{integer}",    "day": "{integer}",    "week": "{integer}",    "month": "{integer}"  },  "credits_settings": {    "request_cost": "{integer}",    "total_credits": "{integer}"  }}'
Copy

Responses

200

Successful Response

No response body

400

Bad request

401

Not authorized

422

Validation Error

Response

xxxxxxxxxx
 
No response
Copy

Remove Api Quota

Remove single api quota setting

Auth

Path Params

quota_id string

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

xxxxxxxxxx
 
curl --request POST \ --url 'https://opswat.developerhub.io/api/admin/settings/api-quota/%7Bquota_id%7D/remove' \ --header 'X-Api-Key: {X-Api-Key}'
Copy

Responses

200

Successful Response

No response body

400

Bad request

401

Not authorized

404

Item not found

422

Validation Error

Response

xxxxxxxxxx
 
No response
Copy

Get Settings Group

Get a group of admin settings

Auth

Path Params

group

string

Enum: access,auth,environment

GET /api/admin/settings/{group}

xxxxxxxxxx
 
curl --get \ --url 'https://opswat.developerhub.io/api/admin/settings/%7Bgroup%7D' \ --header 'X-Api-Key: {X-Api-Key}'
Copy

Responses

200

Successful Response

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

401

Not authorized

422

Validation Error

Response

xxxxxxxxxx
 
[ {  "id": "635ec3f6e279f644a5083b65",  "name": "all_reports",  "group": "access",  "subgroup": "groups",  "value": [   "60d70628b5194714b89be271",   "6049f060a86b087d7e916f3f",   "65aee34a680efc464d0a1bc5"  ] }, {  "id": "64c8cd1f562d2384c3466880",  "name": "chat_gpt",  "group": "access",  "subgroup": "groups",  "value": [   "60d70628b5194714b89be271",   "65aee34a680efc464d0a1bc5"  ] }]
Copy

Save Settings Group

Update group of admin settings

Auth

Path Params

group

string

Enum: access,auth,environment

Request Body

Data	object
*	object

POST /api/admin/settings/{group}

xxxxxxxxxx
 
curl --request POST \ --url 'https://opswat.developerhub.io/api/admin/settings/%7Bgroup%7D' \ --header 'X-Api-Key: {X-Api-Key}' \ --data '{}'
Copy

Responses

200

Successful Response

No response body

400

Bad request

401

Not authorized

422

Validation Error

Response

xxxxxxxxxx
 
No response
Copy

Get Auth Services

Get all external auth services settings

Auth

GET /api/admin/auth-services

xxxxxxxxxx
 
curl --get \ --url 'https://opswat.developerhub.io/api/admin/auth-services' \ --header 'X-Api-Key: {X-Api-Key}'
Copy

Responses

200

Successful Response

No response body

401

Not authorized

Response

xxxxxxxxxx
 
No response
Copy

Save Auth Service

Update settings of external auth service

Auth

Request Body

SaveOAuthServicePayload	object	Request model to save OAuth service
active	boolean
client_id	string
discovery_base_url	string
discovery_path	string
home_page	string
key	string
name	string
order	string
secret	string
auth_type	string	An enumeration. Enum: `oauth`,`saml`
use_state	boolean
api_base_url	string
api_type	string	Supported APIs for OAuth providers Enum: `microsoft_graph`
should_map_groups	boolean
groups_map	array[object]
local_group_id	string
external_groups	array[string]

POST /api/admin/auth-services

xxxxxxxxxx
 
curl --request POST \ --url 'https://opswat.developerhub.io/api/admin/auth-services' \ --header 'X-Api-Key: {X-Api-Key}' \ --data '{  "active": "{boolean}",  "client_id": "{string}",  "discovery_base_url": "{string}",  "discovery_path": "{string}",  "home_page": "{string}",  "key": "{string}",  "name": "{string}",  "order": "{string}",  "secret": "{string}",  "auth_type": "{string}",  "use_state": "{boolean}",  "api_base_url": "{string}",  "api_type": "{string}",  "should_map_groups": "{boolean}",  "groups_map": [    {      "local_group_id": "{string}",      "external_groups": [        "{array[string]...}"      ]    }  ]}'
Copy

Responses

200

Successful Response

No response body

400

Bad request

401

Not authorized

422

Validation Error

Response

xxxxxxxxxx
 
No response
Copy

Remove Auth Service

Remove external auth service settings

Auth

Path Params

service string

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

xxxxxxxxxx
 
curl --request POST \ --url 'https://opswat.developerhub.io/api/admin/auth-services/%7Bservice%7D/remove' \ --header 'X-Api-Key: {X-Api-Key}'
Copy

Responses

200

Successful Response

No response body

401

Not authorized

422

Validation Error

Response

xxxxxxxxxx
 
No response
Copy

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

xxxxxxxxxx
 
curl --get \ --url 'https://opswat.developerhub.io/api/admin/users' \ --header 'X-Api-Key: {X-Api-Key}' \ --data page=1 \ --data ids={ids} \ --data filter={filter}
Copy

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
active	boolean
created_date	date-time
last_login_date	date-time
count_uploads	integer	Amount of user uploads
is_service_account	boolean	The account is used for automated services
total_count	integer
matched_count	integer

401

Not authorized

422

Validation Error

Response

xxxxxxxxxx
 
{ "items": [  {   "id": "66bdc33ec28618a5b322140e",   "account_id": "abc123",   "email": "mr.smith@testemail.com",   "username": "admin",   "groups": [    "6049f060a86b087d7e916f3f"   ],   "confirmed": true,   "active": true,   "created_date": "2024-08-15T09:22:04.991000",   "last_login_date": "2024-09-26T11:22:17.829000",   "count_uploads": 34  },  {   "id": "668cdc756b5080fe6a28f35d",   "account_id": "def456",   "email": "test_admin@email.com",   "username": "test_admin",   "groups": [    "60d70628b5194714b89be271",    "6049f060a86b087d7e916f3f",    "65aee34a680efc464d0a1bc5"   ],   "confirmed": true,   "active": true,   "created_date": "2024-07-09T06:46:08.354000",   "last_login_date": "2024-07-09T06:46:08.358000",   "count_uploads": 15  } ], "total_count": 2}
Copy

Get Users Overview

Download basic users info as csv file

Auth

GET /api/admin/users/import

xxxxxxxxxx
 
curl --get \ --url 'https://opswat.developerhub.io/api/admin/users/import' \ --header 'X-Api-Key: {X-Api-Key}'
Copy

Responses

200

Successful Response

No response body

401

Not authorized

Response

xxxxxxxxxx
 
No response
Copy

Get User

Get user by user id

Auth

Path Params

user_id string

GET /api/admin/users/{user_id}

xxxxxxxxxx
 
curl --get \ --url 'https://opswat.developerhub.io/api/admin/users/%7Buser_id%7D' \ --header 'X-Api-Key: {X-Api-Key}'
Copy

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
active	boolean
created_date	date-time
last_login_date	date-time
count_uploads	integer	Amount of user uploads
is_service_account	boolean	The account is used for automated services

400

Bad request

401

Not authorized

404

Item not found

422

Validation Error

Response

xxxxxxxxxx
 
{ "id": "668cdc756b5080fe6a28f35d", "account_id": "1234", "email": "test_admin@testemail.com", "username": "test_admin", "groups": [  "60d70628b5194714b89be271",  "6049f060a86b087d7e916f3f",  "65aee34a680efc464d0a1bc5" ], "confirmed": true, "active": true, "created_date": "2024-07-09T06:46:08.354000", "last_login_date": "2024-07-09T06:46:08.358000", "count_uploads": 0}
Copy

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]
is_service_account	boolean

POST /api/admin/users/{user_id}

xxxxxxxxxx
 
curl --request POST \ --url 'https://opswat.developerhub.io/api/admin/users/%7Buser_id%7D' \ --header 'X-Api-Key: {X-Api-Key}' \ --data '{  "active": "{boolean}",  "confirmed": "{boolean}",  "groups": [    "{array[string]...}"  ],  "is_service_account": "{boolean}"}'
Copy

Responses

200

Successful Response

No response body

400

Bad request

401

Not authorized

404

Item not found

422

Validation Error

Response

xxxxxxxxxx
 
No response
Copy

Delete User

Delete a user

Auth

Path Params

user_id string

DELETE /api/admin/users/{user_id}

xxxxxxxxxx
 
curl --request DELETE \ --url 'https://opswat.developerhub.io/api/admin/users/%7Buser_id%7D' \ --header 'X-Api-Key: {X-Api-Key}'
Copy

Responses

200

Successful Response

No response body

401

Not authorized

404

Item not found

422

Validation Error

Response

xxxxxxxxxx
 
No response
Copy

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

xxxxxxxxxx
 
curl --get \ --url 'https://opswat.developerhub.io/api/admin/users/%7Buser_id%7D/uploads' \ --header 'X-Api-Key: {X-Api-Key}' \ --data page=1 \ --data page_size=10
Copy

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

xxxxxxxxxx
 
{ "items": [  {   "id": "c9b9da03-e6a7-4fc3-821d-e767f94fd673",   "file": {    "name": "newfile.txt",    "mime_type": "text/plain",    "short_type": "txt",    "sha256": "18ffd9682c5535a2b2798ca51b13e9490df326f185a83fe6e059f8ff47d92105"   },   "scan_init": {    "id": "66ec5128fa50bda8b6670153"   },   "state": "success",   "verdict": "no_threat",   "tags": [    {     "source": "MEDIA_TYPE",     "sourceIdentifier": "18ffd9682c5535a2b2798ca51b13e9490df326f185a83fe6e059f8ff47d92105",     "isRootTag": true,     "tag": {      "name": "txt",      "synonyms": [],      "descriptions": [],      "verdict": {       "verdict": "NO_THREAT",       "threatLevel": 0.1,       "confidence": 1      }     }    }   ],   "date": "2024-09-19T16:28:24.981000",   "updated_date": "09/19/2024, 16:28:31",   "score": 0  } ], "count": 1, "timing": [  {   "lookup reports ids": "0:00:00.007331"  },  {   "finish fetching reports": "0:00:00.000034"  },  {   "lookup matches": "0:00:00.001337"  },  {   "total": 0.008702  } ], "method": "and", "count_search_params": 0}
Copy

Expand

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

xxxxxxxxxx
 
curl --get \ --url 'https://opswat.developerhub.io/api/admin/users/%7Buser_id%7D/reset-password' \ --header 'X-Api-Key: {X-Api-Key}'
Copy

Responses

200

Successful Response

UserResetPasswordResponse	object
token	string

401

Not authorized

422

Validation Error

Response

xxxxxxxxxx
 
{ "token": "https://my.filescan.io/auth/reset-password?token=12345678abcdefgh"}
Copy

Get App Config

Get app basic config values

Auth

GET /api/admin/app-config

xxxxxxxxxx
 
curl --get \ --url 'https://opswat.developerhub.io/api/admin/app-config' \ --header 'X-Api-Key: {X-Api-Key}'
Copy

Responses

200

Successful Response

Response Get App Config Api Admin App Config Get object

401

Not authorized

Response

xxxxxxxxxx
 
{
 "BASE_DIR": "/app/src", "DEBUG": false, "APP_TITLE": "MetaDefender Sandbox", "APP_DESC": "Next-Gen Malware Analysis Platform", "AD_FREQUENCY": 25, "API_VERSION": "1.0", "SCAN_FILES_PER_UPLOAD": 5, "MAX_UPLOAD_SIZE": 150, "SHOW_FOOTER": true, "REPORT_CACHE_TTL_MINUTES": 3, "AUTOMATIC_REPORT_FILES_DOWNLOAD": true, "OFFLINE_MODE": false, "TRUSTED_NETWORK_MODE": false, "DB_CONN_URL": "mongodb://db:12345", "GRAPH_DB_CONN_URL": "http://graphdb:1234", "REDIS_CONN_URL": "redis://redis", "ENGINE_SCHEMA": "https", "ENGINE_HOST": "broker", "ENGINE_PORT": 23001, "ENGINE_SECRET": "1234567890abcdefgh", "DEFAULT_FILE_MANAGER": "s3", "STORAGE_CLEAN_AGE_IN_HOURS": 24, "S3_ACCESS_KEY_ID": "ABCD12345", "S3_SECRET_ACCESS_KEY": "abcdef123456/1a/xy", "S3_REGION": "eu-central-1", "S3_BUCKET_NAME": "sandbox-bucket", "EMAIL_SENDER_ADDRESS": "noreply@sandbox.io", "USE_SMTP": true, "SMTP_HOST": "smtp.eu.mailgun.org", "SMTP_PORT": 587, "SMTP_USER": "postmaster@mg.sandbox.io", "SMTP_PASS": "12345abcd-123454-abcde", "SMTP_SECURITY": "tls", "TERMLY_ACCOUNT_ID": "abcd-efgh-1234-5678-abcd", "TERMLY_PRIVACY_POLICY_ID": "1234-123-12-1234-1234", "TERMLY_TERMS_ID": "123-1234-1234-1234-123x", "TERMLY_COOKIE_POLICY_ID": "1234-123-1234-1234-1234", "TERMS_LOCAL_SOURCE": true, "ASK_TERMS_CONSENT": false, "GOOGLE_ANALYTICS_ID": "G-ABCDEF123", "GOOGLE_ANALYTICS_ID_V3": "", "PING_GOOGLE_SITEMAP_HOSTNAME": "", "MATOMO_CONTAINER_PATH": "container_abcd.js", "RETENTION_ENABLED": false, "RETENTION_DELETE_REPORT": false, "RETENTION_FREE_SPACE_WARNING_THRESHOLD": 5000, "RETENTION_PERIOD_MALICIOUS": 0, "RETENTION_PERIOD_SUSPICIOUS": 360, "RETENTION_PERIOD_INFORMATIONAL": 180, "RETENTION_PERIOD_UNKNOWN": 180, "RETENTION_PERIOD_BENIGN": 0, "HCS_PERIOD_MIN": 15, "HCS_RETENTION_DAYS": 90, "HCS_PROXY_HOST": "reverse_proxy", "HCS_FSIO_URI": "http://fsio:8000", "SCAN_QUEUE_LONG_CHECK_TIME_INTERVAL": 11, "SCAN_QUEUE_QUICK_CHECK_STEPS_INTERVAL": 3, "SCAN_QUEUE_ALLOWED_CHECKS_MISSED": 3, "EXTERNAL_TOKENS_SECRET_KEY": "abcdefgh-1234=", "INTERNAL_TOKENS_SECRET_KEY": "abcdefghij", "JOBS_PARALLEL_DB_QUERIES_LIMIT": 3, "JOB_MEMORY_LIMIT": 2000, "JOBS_QUERIES_INTERVAL": 0.5, "MIN_SYSTEM_AVAILABLE_MEMORY_THRESHOLD": 5000, "SCAN_MAX_PRIORITY_JOBS_LIMIT": 50, "SCAN_MEDIUM_PRIORITY_JOBS_LIMIT": 100, "SCAN_LOW_PRIORITY_JOBS_LIMIT": 150, "SCAN_LEAST_PRIORITY_JOBS_LIMIT": 200, "SCAN_BROKER_STUCK_RETRY_WAIT_1": 20, "SCAN_BROKER_STUCK_RETRY_WAIT_2": 60, "SCAN_BROKER_STUCK_RETRY_WAIT_3": 300, "SCAN_BROKER_STUCK_RETRY_MAX_UPLOAD_SIZE": 1, "SCAN_REQUEST_FAILED_RETRY_WAIT": 10, "QUEUED_SCAN_CHANGE_PRIORITY_TIMEOUT": 10, "QUEUED_SCAN_CANCEL_TIMEOUT": 60, "TASKS_QUEUE_JOB_TIMEOUT": 600, "CREATE_SCANS_ABOVE_LIMIT_FACTOR": 0.3, "MOVE_SCAN_KEEP_FREE_RATIO": 0.25, "RESCAN_QUOTA_FACTOR": 0.02, "RESCAN_MAX_COUNT": 0, "RESCAN_MIN_AGE_HOURS": 24, "QUICK_RETRY_MAX_COUNT": 2, "REPORT_INTERRUPT_TIMEOUT": 180, "OLD_ERRORS_CLEANUP_AGE": 60, "SCAN_REPORTS_S3_ACCESS_KEY_ID": "ABCD1234", "SCAN_REPORTS_S3_SECRET_ACCESS_KEY": "Aaa/abcdefghABCD", "SCAN_REPORTS_S3_REGION": "us-west-2", "SCAN_REPORTS_S3_BUCKET_NAME": "inputs-s3-prod", "SCAN_REPORTS_S3_PREFIX": "filescan", "IOC_FEED_S3_ACCESS_KEY_ID": "", "IOC_FEED_S3_SECRET_ACCESS_KEY": "", "IOC_FEED_S3_REGION": "", "IOC_FEED_S3_BUCKET_NAME": "", "IOC_FEED_S3_PREFIX": "", "MDCLOUD_API_URL": "https://api.metadefender.com/", "MDCLOUD_API_KEY": "abcdefgh1234", "MDCLOUD_TTL_HOURS": 720, "MDCLOUD_REPUTATION_ENABLED": true, "MDCLOUD_SIMILARITY_SEARCH_ENABLED": true, "REPUTATION_MDCLOUD_THRESHOLD_MALICIOUS": 0.3, "REPUTATION_MDCLOUD_THRESHOLD_LIKELY_MALICIOUS": 0.2, "REPUTATION_MDCLOUD_THRESHOLD_SUSPICIOUS": 0.1, "REPUTATION_MDCLOUD_THRESHOLD_DAYS_OLD": 7, "REPUTATION_COMMUNITY_THRESHOLD_MALICIOUS": 0.3, "REPUTATION_COMMUNITY_THRESHOLD_LIKELY_MALICIOUS": 0.2, "REPUTATION_COMMUNITY_THRESHOLD_SUSPICIOUS": 0.1, "REPUTATION_COMMUNITY_THRESHOLD_VOTENUMBER": 100, "REPUTATION_BULK_LIMIT": 100, "IOC_REPORTS_REPUTATION_REPORTS_LIMIT": 10, "IOC_REPORTS_REPUTATION_DAYS_LIMIT": 90, "REPORT_FIELDS_TO_REMOVE_PYDANTIC": "", "REPORT_FIELDS_TO_REMOVE_RESOURCES": "strings,staticEvents,visualizedSample,fileVisualization,fileDownloadResults,disassemblySections,compressedBase64", "REPORT_SIMILARITY_VERDICT_OVERWRITE": true, "REPORT_SIMILARITY_VERDICT_THRESHOLD": 0.95, "REPORT_SIMILARITY_VERDICT_FILTER": "suspicious", "REPORT_SIMILARITY_MALICIOUS_MATCH": 0.5, "REPORT_SIMILARITY_LIKELY_MALICIOUS_MATCH": 0.5, "REPORT_SIMILARITY_SUSPICIOUS_MATCH": 0.5, "SEARCH_REPORTS_LIMIT": 1000, "SEARCH_REPORTS_LIMIT_PREVALENCE": 3, "SEARCH_MONTHS_LIMIT_GUEST": 3, "SEARCH_MONTHS_LIMIT_USER": 3, "SEARCH_MONTHS_LIMIT_ADMIN": 3, "SEARCH_MONTHS_LIMIT_INTEL": 3, "SEARCH_MONTHS_LIMIT_PREVALENCE": 0, "BLOCK_SCAN": false, "BLOCK_SCAN_NOTIFICATION": "Scanning is temporary unavailable due to maintenance", "BLOCK_SEARCH": false, "BLOCK_SEARCH_NOTIFICATION": "Search is temporary unavailable due to maintenance", "CHAT_GPT_API_URL": "https://api.openai.com/v1/chat/completions", "CHAT_GPT_API_SECRET": "ab-abcdefgh1234", "CHAT_GPT_PAYLOAD_MODEL_NAME": "gpt-4o-mini", "CHAT_GPT_PROMPT_REPORT_OVERVIEW": "You need to summarize the malware described in the following JSON", "CHAT_GPT_PAYLOAD_USER_CONTENT": "JSON:", "CHAT_GPT_IS_AZURE_API": false, "OCM_DISCONNECTED_TIMEOUT": 15, "OCM_CLIENT_URL": "https://my.opswat.com/product-management/", "IFRAME_LOGOUT_URL": "https://my.opswat.com", "EXTRA_BUTTON_TEXT": "Test", "EXTRA_BUTTON_LINK": "https://getbootstrap.com/docs/5.3/utilities/text/", "EXTRA_BUTTON_ACTIVE": false, "MISP_API_KEY": "1234abcd", "MISP_API_URL": "https://192.168.0.0/events/add", "MISP_TIMEOUT": 15, "MISP_ENABLED": false, "ADMIN_AUDIT_LOGGER_ENABLED": true, "ADMIN_AUDIT_LOGGER_TTL": 180, "AUTH_AUDIT_LOGGER_ENABLED": true, "AUTH_AUDIT_LOGGER_TTL": 180}
Copy

Expand

Get Services Stat

Get statistics of various running services

Auth

GET /api/admin/stat/services

xxxxxxxxxx
 
curl --get \ --url 'https://opswat.developerhub.io/api/admin/stat/services' \ --header 'X-Api-Key: {X-Api-Key}'
Copy

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

xxxxxxxxxx
 
{
 "queues": {...},
 "redis": {...}
}
Copy

Generate Invite Token

Generate invitation token for user

Auth

Request Body

AdminGenerateInviteLinkResponse	object
groups	array[string]

POST /api/admin/invite

xxxxxxxxxx
 
curl --request POST \ --url 'https://opswat.developerhub.io/api/admin/invite' \ --header 'X-Api-Key: {X-Api-Key}' \ --data '{  "groups": [    "{array[string]...}"  ]}'
Copy

Responses

200

Successful Response

GenerateInviteTokenResponse	object
token	string

401

Not authorized

422

Validation Error

Response

xxxxxxxxxx
 
{ "token": "abcd1234.efghijkl.0123456789"}
Copy

Generate External Tokens Secret

Generate secret key to encript external auth tokens

Auth

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

xxxxxxxxxx
 
curl --get \ --url 'https://opswat.developerhub.io/api/admin/generate-external-tokens-secret' \ --header 'X-Api-Key: {X-Api-Key}'
Copy

Responses

200

Successful Response

No response body

401

Not authorized

Response

xxxxxxxxxx
 
No response
Copy

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

xxxxxxxxxx
 
curl --get \ --url 'https://opswat.developerhub.io/api/admin/errors' \ --header 'X-Api-Key: {X-Api-Key}' \ --data type=client \ --data page=1 \ --data filter={filter} \ --data sort={sort}
Copy

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`,`Signin using external auth provider`
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

xxxxxxxxxx
 
{ "items": [  {   "id": "1234",   "type": "client",   "message": "TypeError: Cannot read properties of undefined (reading 'detail')",   "url": "/uploads/1234/reports/1234absc/details",   "trace": "TypeError: Cannot read properties of undefined (reading 'detail')\n    at c (https://my.filescan.io/main.2b0f2e6d38331320.js:291:629132)\n    at async https://my.filescan.io/main.2b0f2e6d38331320.js:291:525370\n    at async b (https://my.filescan.io/main.2b0f2e6d38331320.js:291:525254)",   "first_occurance_date": "2024-09-23T17:16:05.625000",   "last_occurance_date": "2024-09-23T17:16:05.625000",   "occurance_count": 1,   "is_signed_in": true,   "report_flow_id": "1234",   "report_id": "1234abcd"  } ], "total_count": 1}
Copy

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

xxxxxxxxxx
 
curl --request DELETE \ --url 'https://opswat.developerhub.io/api/admin/errors' \ --header 'X-Api-Key: {X-Api-Key}' \ --data type=client \ --data filter={filter}
Copy

Responses

200

Successful Response

AdminAppErrorsRemovedResponse	object
removed_count	integer

400

Bad request

401

Not authorized

422

Validation Error

Response

xxxxxxxxxx
 
{ "removed_count": 10}
Copy

App Error

Remove single saved error

Auth

Path Params

error_id string

DELETE /api/admin/errors/{error_id}

xxxxxxxxxx
 
curl --request DELETE \ --url 'https://opswat.developerhub.io/api/admin/errors/%7Berror_id%7D' \ --header 'X-Api-Key: {X-Api-Key}'
Copy

Responses

200

Successful Response

No response body

400

Bad request

401

Not authorized

422

Validation Error

Response

xxxxxxxxxx
 
No response
Copy

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

xxxxxxxxxx
 
curl --request POST \ --url 'https://opswat.developerhub.io/api/admin/errors/%7Berror_id%7D/note' \ --header 'X-Api-Key: {X-Api-Key}' \ --data '{  "note": "{string}"}'
Copy

Responses

200

Successful Response

No response body

400

Bad request

401

Not authorized

422

Validation Error

Response

xxxxxxxxxx
 
No response
Copy

Export Errors

Export application errors in a .csv format

Auth

GET /api/admin/errors/export

xxxxxxxxxx
 
curl --get \ --url 'https://opswat.developerhub.io/api/admin/errors/export' \ --header 'X-Api-Key: {X-Api-Key}'
Copy

Responses

200

Successful Response

No response body

401

Not authorized

Response

xxxxxxxxxx
 
No response
Copy

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

xxxxxxxxxx
 
curl --get \ --url 'https://opswat.developerhub.io/api/admin/logs' \ --header 'X-Api-Key: {X-Api-Key}' \ --data page=1 \ --data filter={filter} \ --data sort={sort}
Copy

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

xxxxxxxxxx
 
{ "items": [  {   "id": "1234",   "key": "1234567",   "key_type": "scan_init_id",   "note": "Debug issue with missing scan file",   "saved_date": "2024-03-21T02:53:06.631000"  } ], "total_count": 1}
Copy

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

xxxxxxxxxx
 
curl --request DELETE \ --url 'https://opswat.developerhub.io/api/admin/logs' \ --header 'X-Api-Key: {X-Api-Key}' \ --data filter={filter}
Copy

Responses

200

Successful Response

AdminGenericLogsRemovedResponse	object
removed_count	integer

400

Bad request

401

Not authorized

422

Validation Error

Response

xxxxxxxxxx
 
{ "removed_count": 3}
Copy

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

xxxxxxxxxx
 
curl --get \ --url 'https://opswat.developerhub.io/api/admin/retention-calculation' \ --header 'X-Api-Key: {X-Api-Key}' \ --data retention_period_malicious={retention_period_malicious} \ --data retention_period_suspicious={retention_period_suspicious} \ --data retention_period_informational={retention_period_informational} \ --data retention_period_unknown={retention_period_unknown} \ --data retention_period_benign={retention_period_benign}
Copy

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

xxxxxxxxxx
 
{ "total_number_of_reports": 10, "affected_number_of_reports": {}}
Copy

Get Full Generic Log

Obtain full log record data

Auth

Path Params

log_id string

GET /api/admin/logs/{log_id}

xxxxxxxxxx
 
curl --get \ --url 'https://opswat.developerhub.io/api/admin/logs/%7Blog_id%7D' \ --header 'X-Api-Key: {X-Api-Key}'
Copy

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

xxxxxxxxxx
 
{ "id": "1234", "key": "1234abcd", "key_type": "scan_init_id", "data": {  "scan_init": {   "file": {    "name": "test.pdf",    "hash": "0123456789abcdefghijklmnopqrstuvwxyz0123456789abcdefghijklmnopqr",    "size": 521948,    "is_private": false   },   "state": "scanning",   "created_date": "2024-02-23T00:23:39.381000",   "queue_assigned_date": "2024-02-29T12:06:32.067000",   "queued_date": "2024-03-14T13:02:49.323000",   "scan_started_date": "2024-03-14T13:02:49.430000",   "data": {    "processTime": 10,    "acceptedFiles": [     {      "ID": "01234567-89ab-cdef-ghij-klmnopqrstuv",      "submitName": "test.pdf",      "submitTime": 1708647822984,      "sha256": "0123456789abcdefghijklmnopqrstuvwxyz0123456789abcdefghijklmnopqr",      "mediaType": {       "string": "application/pdf",       "slash": 11,       "semicolon": 15,       "parameters": {}      },      "priority": 10,      "positionInQueue": 0,      "isSourceFile": true     }    ],    "rejectedFiles": [],    "submitWarnings": [],    "submitComposition": {     "mediaTypes": {      "application/pdf": 1     }    },    "acceptedComposition": {     "mediaTypes": {      "application/pdf": 1     }    },    "rejectedComposition": {     "mediaTypes": {}    }   },   "user": "123abc",   "tags": [],   "propagate_tags": true,   "client": {    "ip_addr": "192.168.0.0",    "user_agent": "Python/3.10 aiohttp/3.8.4"   },   "priority": 0,   "skip_whitelisted": false,   "transform_options": {    "rapid_mode": false,    "osint": true,    "extended_osint": true,    "extracted_files_osint": true,    "visualization": true,    "files_download": true,    "resolve_domains": true,    "input_file_yara": true,    "extracted_files_yara": true,    "whois": true,    "ips_meta": true,    "images_ocr": true   },   "default_options_used": true,   "broker_retry_count": 0,   "scans_count": 4,   "use_queued_limits": true,   "id": "12345abcdef"  },  "exception": "Traceback (most recent call last):\n  Lorem ipsum",  "file_path": "/app/src/storage/temp/1234/1234abcdef",  "file_exists": false }, "note": "Debug issue with missing scan file", "saved_date": "2024-03-14T13:03:10.637000"}
Copy

Expand

Remove Generic Log

Remove single log record

Auth

Path Params

log_id string

DELETE /api/admin/logs/{log_id}

xxxxxxxxxx
 
curl --request DELETE \ --url 'https://opswat.developerhub.io/api/admin/logs/%7Blog_id%7D' \ --header 'X-Api-Key: {X-Api-Key}'
Copy

Responses

200

Successful Response

No response body

400

Bad request

401

Not authorized

422

Validation Error

Response

xxxxxxxxxx
 
No response
Copy

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

xxxxxxxxxx
 
curl --request POST \ --url 'https://opswat.developerhub.io/api/admin/logs/%7Blog_id%7D/note' \ --header 'X-Api-Key: {X-Api-Key}' \ --data '{  "note": "{string}"}'
Copy

Responses

200

Successful Response

No response body

400

Bad request

401

Not authorized

422

Validation Error

Response

xxxxxxxxxx
 
No response
Copy

Get Logos List

Get list of all available logos

Auth

GET /api/admin/logos

xxxxxxxxxx
 
curl --get \ --url 'https://opswat.developerhub.io/api/admin/logos' \ --header 'X-Api-Key: {X-Api-Key}'
Copy

Responses

200

Successful Response

array array[string]

401

Not authorized

Response

xxxxxxxxxx
 
[ "footer.svg", "header.svg", "fsio-main-light.svg", "fsio-main-dark.svg", "opswat.svg", "opswat-white.svg", "fsio-owl-blue-transparent.png", "fsio-owl-white-transparent.png"]
Copy

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

xxxxxxxxxx
 
curl --request POST \ --url 'https://opswat.developerhub.io/api/admin/logos/select' \ --header 'X-Api-Key: {X-Api-Key}'
Copy

Responses

200

Successful Response

No response body

401

Not authorized

422

Validation Error

Response

xxxxxxxxxx
 
No response
Copy

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

xxxxxxxxxx
 
curl --get \ --url 'https://opswat.developerhub.io/api/admin/stat' \ --header 'X-Api-Key: {X-Api-Key}' \ --data types={types}
Copy

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

xxxxxxxxxx
 
[ {  "name": "{string}",  "value": "{boolean}",  "updated_date": "{date-time}" }]
Copy

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

xxxxxxxxxx
 
curl --get \ --url 'https://opswat.developerhub.io/api/admin/stat/daily' \ --header 'X-Api-Key: {X-Api-Key}' \ --data types={types} \ --data date_from={date_from} \ --data date_to={date_to}
Copy

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

xxxxxxxxxx
 
[ {  "date": "{string}",  "name": "{string}",  "value": "{boolean}",  "updated_date": "{date-time}" }]
Copy

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

xxxxxxxxxx
 
curl --get \ --url 'https://opswat.developerhub.io/api/admin/jobs/config' \ --header 'X-Api-Key: {X-Api-Key}' \ --data jobs={jobs}
Copy

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

xxxxxxxxxx
 
[ {  "name": "{string}",  "trigger": "{string}",  "trigger_config": {},  "runtime_config": {},  "is_subprocess": "{boolean}",  "is_active": "{boolean}",  "is_editable": "{boolean}",  "updated_date": "2025-07-30T13:27:51.965531",  "update_applied_date": "2025-07-30T13:27:51.965538",  "id": "5f85f36d6dfecacc68428a46" }]
Copy

Get Jobs Memory Peaks

Get peak jobs memory usage

Auth

GET /api/admin/jobs/memory/peaks

xxxxxxxxxx
 
curl --get \ --url 'https://opswat.developerhub.io/api/admin/jobs/memory/peaks' \ --header 'X-Api-Key: {X-Api-Key}'
Copy

Responses

200

Successful Response

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

401

Not authorized

Response

xxxxxxxxxx
 
[ {  "name": "{string}",  "description": "{string}",  "memory": "{number}",  "is_killed": "{boolean}",  "is_unresponsive": "{boolean}" }]
Copy

Get Job Memory Details

Get job memory usage details

Auth

Query String

job_name string

GET /api/admin/jobs/memory

xxxxxxxxxx
 
curl --get \ --url 'https://opswat.developerhub.io/api/admin/jobs/memory' \ --header 'X-Api-Key: {X-Api-Key}' \ --data job_name={job_name}
Copy

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

xxxxxxxxxx
 
[ {  "name": "{string}",  "resident_memory": "{number}",  "date": "{date-time}",  "is_killed": "{boolean}" }]
Copy

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}

xxxxxxxxxx
 
curl --request POST \ --url 'https://opswat.developerhub.io/api/admin/jobs/%7Bjob_name%7D' \ --header 'X-Api-Key: {X-Api-Key}' \ --data '{  "trigger": "{string}",  "trigger_config": {},  "runtime_config": {},  "is_active": "{boolean}"}'
Copy

Responses

200

Successful Response

No response body

400

Bad request

401

Not authorized

403

Forbidden

404

Item not found

422

Validation Error

Response

xxxxxxxxxx
 
No response
Copy

Get Job Log

Get job public log

Auth

Path Params

job_name string

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

xxxxxxxxxx
 
curl --get \ --url 'https://opswat.developerhub.io/api/admin/jobs/%7Bjob_name%7D/log' \ --header 'X-Api-Key: {X-Api-Key}'
Copy

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

xxxxxxxxxx
 
{ "state": "{string}", "log": [  "{array...}" ]}
Copy

Stop All Jobs

Stop all existing jobs

Auth

POST /api/admin/jobs/stop/all

xxxxxxxxxx
 
curl --request POST \ --url 'https://opswat.developerhub.io/api/admin/jobs/stop/all' \ --header 'X-Api-Key: {X-Api-Key}'
Copy

Responses

200

Successful Response

No response body

401

Not authorized

Response

xxxxxxxxxx
 
No response
Copy

Enable All Jobs

Enable all existing jobs

Auth

POST /api/admin/jobs/enable/all

xxxxxxxxxx
 
curl --request POST \ --url 'https://opswat.developerhub.io/api/admin/jobs/enable/all' \ --header 'X-Api-Key: {X-Api-Key}'
Copy

Responses

200

Successful Response

No response body

401

Not authorized

Response

xxxxxxxxxx
 
No response
Copy

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

xxxxxxxxxx
 
curl --get \ --url 'https://opswat.developerhub.io/api/admin/stat/scan/health' \ --header 'X-Api-Key: {X-Api-Key}' \ --data queue_name={queue_name} \ --data check_type={check_type} \ --data date_from={date_from}
Copy

Responses

200

Successful Response

ScanHealthResponse	array[object]
date	date-time
value	integer

401

Not authorized

422

Validation Error

Response

xxxxxxxxxx
 
[ {  "date": "{date-time}",  "value": "{integer}" }]
Copy

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

xxxxxxxxxx
 
curl --get \ --url 'https://opswat.developerhub.io/api/admin/stat/scan/states' \ --header 'X-Api-Key: {X-Api-Key}' \ --data queue_name={queue_name} \ --data state={state} \ --data date_from={date_from}
Copy

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

xxxxxxxxxx
 
[ {  "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}" }]
Copy

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

xxxxxxxxxx
 
curl --get \ --url 'https://opswat.developerhub.io/api/users/stat/daily' \ --header 'X-Api-Key: {X-Api-Key}' \ --data types={types} \ --data date_from={date_from} \ --data date_to={date_to}
Copy

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

xxxxxxxxxx
 
[ {  "date": "{string}",  "name": "{string}",  "value": "{boolean}",  "updated_date": "{date-time}" }]
Copy

Get Emails History

Get history of sending mass emails

Auth

Query String

page

integer

minimum: 1

Default: 1

GET /api/admin/emails

xxxxxxxxxx
 
curl --get \ --url 'https://opswat.developerhub.io/api/admin/emails' \ --header 'X-Api-Key: {X-Api-Key}' \ --data page=1
Copy

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

xxxxxxxxxx
 
{ "items": [  {   "id": "{string}",   "recipient_type": "{string}",   "recipient_emails": [    "{array[string]...}"   ],   "subject": "{string}",   "content": "{string}",   "state": "{string}",   "created_date": "{date-time}",   "completed_date": "2025-07-30T13:27:51.968062",   "count_emails_sent": "{integer}",   "error": {}  } ], "total_count": "{integer}"}
Copy

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

xxxxxxxxxx
 
curl --request POST \ --url 'https://opswat.developerhub.io/api/admin/emails' \ --header 'X-Api-Key: {X-Api-Key}' \ --data '{  "recipient_type": "{string}",  "recipient_emails": [    "{array[string]...}"  ],  "subject": "{string}",  "content": "{string}"}'
Copy

Responses

200

Successful Response

No response body

401

Not authorized

422

Validation Error

Response

xxxxxxxxxx
 
No response
Copy

Get Emails Templates

Get predefined email templates

Auth

GET /api/admin/emails/templates

xxxxxxxxxx
 
curl --get \ --url 'https://opswat.developerhub.io/api/admin/emails/templates' \ --header 'X-Api-Key: {X-Api-Key}'
Copy

Responses

200

Successful Response

EmailTemplatesResponse	object
terms_change
string	string

401

Not authorized

Response

xxxxxxxxxx
 
{ "terms_change": "{string}"}
Copy

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

xxxxxxxxxx
 
curl --get \ --url 'https://opswat.developerhub.io/api/admin/scan-sources/files' \ --header 'X-Api-Key: {X-Api-Key}' \ --data page=1 \ --data config={config} \ --data state={state} \ --data verdict={verdict}
Copy

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

xxxxxxxxxx
 
{ "items": [  {   "config": {    "id": "{string}",    "provider": "{string}",    "name": "{string}",    "source_type": "{string}"   },   "file": {    "name": "{string}",    "hash": "{string}",    "mime_type": "{string}"   },   "state": "{string}",   "verdict": "{string}",   "folder": "{string}",   "id_on_source": "{integer}",   "flow_id": "{string}",   "created_date": "{date-time}",   "created_date_on_source": "{date-time}",   "downloaded_date": "{date-time}"  } ], "total_count": "{integer}", "matched_count": "{integer}"}
Copy

Get Scan Sources Configs

Obtain scan sources config records

Auth

Query String

page

integer

minimum: 1

Default: 1

GET /api/admin/scan-sources/config

xxxxxxxxxx
 
curl --get \ --url 'https://opswat.developerhub.io/api/admin/scan-sources/config' \ --header 'X-Api-Key: {X-Api-Key}' \ --data page=1
Copy

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
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
append_scanned_flag	boolean	If we should add flag with scan result to email on service
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

Expand

401

Not authorized

422

Validation Error

Response

xxxxxxxxxx
 
{ "items": [  {   "id": "{string}",   "provider": "{string}",   "name": "{string}",   "source_type": "{string}",   "host": "{string}",   "port": "{string}",   "connection_security": "{string}",   "folders": [    "{array[string]...}"   ],   "remove_files_on_source": "{boolean}",   "credentials": {    "login": "{string}"   },   "is_active": "{boolean}",   "source_type_specific": {    "mark_as_seen": "{boolean}",    "append_scanned_flag": "{boolean}",    "first_fetch_mode": "{string}"   },   "files_are_private": "{boolean}",   "description": "{string}",   "propagate_tags": "{boolean}",   "schedule": {    "name": "{string}",    "trigger": "{string}",    "trigger_config": {},    "runtime_config": {},    "is_active": "{boolean}",    "is_editable": "{boolean}"   }  } ], "total_count": "{integer}"}
Copy

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
append_scanned_flag	boolean	If we should add flag with scan result to email on service
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

Expand

POST /api/admin/scan-sources/config

xxxxxxxxxx
 
curl --request POST \ --url 'https://opswat.developerhub.io/api/admin/scan-sources/config' \ --header 'X-Api-Key: {X-Api-Key}' \ --data '{  "id": "{string}",  "provider": "{string}",  "name": "{string}",  "source_type": "{string}",  "host": "{string}",  "port": "{string}",  "connection_security": "{string}",  "folders": [    "{array[string]...}"  ],  "remove_files_on_source": "{boolean}",  "credentials": {    "login": "{string}",    "password": "{string}"  },  "is_active": "{boolean}",  "source_type_specific": {    "mark_as_seen": "{boolean}",    "append_scanned_flag": "{boolean}",    "first_fetch_mode": "{string}"  },  "files_are_private": "{boolean}",  "description": "{string}",  "propagate_tags": "{boolean}",  "schedule": {    "trigger": "{string}",    "trigger_config": {      "time": "{string}",      "unit": "{string}",      "value": "{integer}"    },    "runtime_config": {      "run_once": "{boolean}"    },    "is_active": "{boolean}"  }}'
Copy

Responses

200

Successful Response

No response body

400

Bad request

401

Not authorized

404

Item not found

422

Validation Error

Response

xxxxxxxxxx
 
No response
Copy

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

xxxxxxxxxx
 
curl --request DELETE \ --url 'https://opswat.developerhub.io/api/admin/scan-sources/config' \ --header 'X-Api-Key: {X-Api-Key}' \ --data '{  "config_ids": "{string}"}'
Copy

Responses

200

Successful Response

AdminScanSourcesRemoveResponse	object
remove_count	integer

422

Validation Error

Response

xxxxxxxxxx
 
{ "remove_count": "{integer}"}
Copy

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

xxxxxxxxxx
 
curl --get \ --url 'https://opswat.developerhub.io/api/admin/scan-sources/%7Bconfig_id%7D/check-connection' \ --header 'X-Api-Key: {X-Api-Key}'
Copy

Responses

200

Successful Response

array array[string]

401

Not authorized

404

Item not found

422

Validation Error

Response

xxxxxxxxxx
 
[ "{array[string]...}"]
Copy

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

xxxxxxxxxx
 
curl --get \ --url 'https://opswat.developerhub.io/api/admin/scan-sources/subjobs' \ --header 'X-Api-Key: {X-Api-Key}' \ --data page=1 \ --data config={config}
Copy

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

xxxxxxxxxx
 
{ "items": [  {   "scan_source_config": {    "id": "{string}",    "provider": "{string}",    "name": "{string}",    "source_type": "{string}"   },   "config": {    "name": "{string}",    "trigger": "{string}",    "trigger_config": {},    "runtime_config": {},    "is_active": "{boolean}",    "is_editable": "{boolean}"   },   "state": {    "name": "{string}",    "state": "{string}",    "data": {},    "updated_date": "{date-time}",    "public_log": [     "{array...}"    ],    "has_public_log": "{boolean}"   }  } ], "total_count": "{integer}", "matched_count": "{integer}"}
Copy

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}

xxxxxxxxxx
 
curl --get \ --url 'https://opswat.developerhub.io/api/admin/scan-sources/subjobs/%7Bjob_id%7D' \ --header 'X-Api-Key: {X-Api-Key}'
Copy

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

xxxxxxxxxx
 
{ "scan_source_config": {  "id": "{string}",  "provider": "{string}",  "name": "{string}",  "source_type": "{string}" }, "config": {  "name": "{string}",  "trigger": "{string}",  "trigger_config": {},  "runtime_config": {},  "is_active": "{boolean}",  "is_editable": "{boolean}" }, "state": {  "name": "{string}",  "state": "{string}",  "data": {},  "updated_date": "{date-time}",  "public_log": [   "{array...}"  ],  "has_public_log": "{boolean}" }}
Copy

Audit-logger

Audit Logger

/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

xxxxxxxxxx
 
curl --get \ --url 'https://opswat.developerhub.io/api/admin/audit-logs' \ --header 'X-Api-Key: {X-Api-Key}' \ --data logger_type={logger_type} \ --data log_level_filter=all \ --data page=1 \ --data filter={filter}
Copy

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

xxxxxxxxxx
 
{ "items": [  {} ], "total_count": "{integer}", "matched_count": "{integer}"}
Copy

Threatintel

Threat Intelligence

/api/threatintel/get-prevalence

/api/threatintel/modify-verdict

/api/threatintel/get-similars

/api/threatintel/feed

/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: []
unc_path	array[string]	Default: []
days	integer	Default: -1

POST /api/threatintel/get-prevalence

xxxxxxxxxx
 
curl --request POST \ --url 'https://opswat.developerhub.io/api/threatintel/get-prevalence' \ --header 'X-Api-Key: {X-Api-Key}' \ --data exclude_report_ids={exclude_report_ids} \ --data '{  "domain": [    "{array[string]...}"  ],  "ip": [    "{array[string]...}"  ],  "url": [    "{array[string]...}"  ],  "uuid": [    "{array[string]...}"  ],  "email": [    "{array[string]...}"  ],  "registry_path": [    "{array[string]...}"  ],  "revision_save_id": [    "{array[string]...}"  ],  "sha1": [    "{array[string]...}"  ],  "sha256": [    "{array[string]...}"  ],  "sha512": [    "{array[string]...}"  ],  "md5": [    "{array[string]...}"  ],  "imphash": [    "{array[string]...}"  ],  "ssdeep": [    "{array[string]...}"  ],  "authentihash": [    "{array[string]...}"  ],  "fuzzyfsiohash": [    "{array[string]...}"  ],  "unc_path": [    "{array[string]...}"  ],  "days": "{integer}"}'
Copy

Expand

Responses

200

Successful Response

Response Get Ioc Prevalences Api Threatintel Get Prevalence Post	object
*	object
*	object	Prevalence response model
counts	object
*	integer
reports	array[object]
flow_id	string
report_id	string
file	object	File name and hash
name	string
sha256	string
verdict	string	An enumeration. Enum: `unknown`,`benign`,`informational`,`no_threat`,`suspicious`,`likely_malicious`,`malicious`
created_date	date-time
verdict	string	An enumeration. Enum: `unknown`,`benign`,`informational`,`no_threat`,`suspicious`,`likely_malicious`,`malicious`

400

Bad request

401

Not authorized

422

Validation Error

Response

xxxxxxxxxx
 
{ "ip": {  "13.107.246.44": {   "counts": {    "malicious": 2,    "no_threat": 1,    "benign": 1   },   "reports": [    {     "flow_id": "679cc1ff68da9e0fca82cca3",     "report_id": "833700c1-86ed-4bc6-bef5-dcda16e7ed11",     "verdict": "malicious",     "created_date": "2025-01-31T12:28:49.689000"    },    {     "flow_id": "6798a1b69d385c630bd11594",     "report_id": "a18cfa47-2a60-4457-9c86-2d7f58565b0d",     "verdict": "no_threat",     "created_date": "2025-01-28T09:21:58.715000"    },    {     "flow_id": "6798b02209ca8ddccaa4767f",     "report_id": "b05cf8e2-66a7-4827-8b9e-5443892c09e9",     "verdict": "benign",     "created_date": "2025-01-28T10:23:32.711000"    },    {     "flow_id": "679cc24f68da9e0fca82ccbe",     "report_id": "fb50c1ae-0fd8-4b93-831f-f78b349f9a4e",     "verdict": "malicious",     "created_date": "2025-01-31T12:30:10.982000"    }   ],   "verdict": "malicious"  } }, "registry_path": {  "Software\\Microsoft\\Windows\\CurrentVersion\\Policies\\Comdlg32": {   "counts": {    "malicious": 2   },   "reports": [    {     "flow_id": "679cc1ff68da9e0fca82cca3",     "report_id": "833700c1-86ed-4bc6-bef5-dcda16e7ed11",     "verdict": "malicious",     "created_date": "2025-01-31T12:28:49.689000"    },    {     "flow_id": "679cc24f68da9e0fca82ccbe",     "report_id": "fb50c1ae-0fd8-4b93-831f-f78b349f9a4e",     "verdict": "malicious",     "created_date": "2025-01-31T12:30:10.982000"    }   ],   "verdict": "malicious"  } }, "url": {  "http://SecurityXploded.com/remotedll.php": {   "counts": {    "malicious": 2   },   "reports": [    {     "flow_id": "679cc1ff68da9e0fca82cca3",     "report_id": "833700c1-86ed-4bc6-bef5-dcda16e7ed11",     "verdict": "malicious",     "created_date": "2025-01-31T12:28:49.689000"    },    {     "flow_id": "679cc24f68da9e0fca82ccbe",     "report_id": "fb50c1ae-0fd8-4b93-831f-f78b349f9a4e",     "verdict": "malicious",     "created_date": "2025-01-31T12:30:10.982000"    }   ],   "verdict": "malicious"  } }}
Copy

Expand

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

xxxxxxxxxx
 
curl --request POST \ --url 'https://opswat.developerhub.io/api/threatintel/modify-verdict' \ --header 'X-Api-Key: {X-Api-Key}' \ --data '{  "verdict": "{string}",  "report_id": "{string}"}'
Copy

Responses

200

Successful Response

No response body

401

Not authorized

404

Item not found

422

Validation Error

Response

xxxxxxxxxx
 
No response
Copy

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

xxxxxxxxxx
 
curl --get \ --url 'https://opswat.developerhub.io/api/threatintel/get-similars' \ --header 'X-Api-Key: {X-Api-Key}' \ --data exclude_report_ids={exclude_report_ids} \ --data imphash={imphash} \ --data ssdeep={ssdeep} \ --data fuzzyfsiohash={fuzzyfsiohash} \ --data authentihash={authentihash} \ --data days=-1
Copy

Responses

200

Successful Response

Response Get Similar Reports Api Threatintel Get Similars Get	object
*	object
*	object	Prevalence response model
counts	object
*	integer
reports	array[object]
flow_id	string
report_id	string
file	object	File name and hash
name	string
sha256	string
verdict	string	An enumeration. Enum: `unknown`,`benign`,`informational`,`no_threat`,`suspicious`,`likely_malicious`,`malicious`
created_date	date-time
verdict	string	An enumeration. Enum: `unknown`,`benign`,`informational`,`no_threat`,`suspicious`,`likely_malicious`,`malicious`

400

Bad request

401

Not authorized

422

Validation Error

Response

xxxxxxxxxx
 
{ "fuzzyfsiohash": {  "a2fb1904b8646448f703538db539925908559ed6762da77703833bd3621ff0c3": {   "counts": {    "malicious": 2   },   "reports": [    {     "flow_id": "679cc1ff68da9e0fca82cca3",     "report_id": "833700c1-86ed-4bc6-bef5-dcda16e7ed11",     "verdict": "malicious",     "file": {      "name": "RemoteDll32.clean.exe",      "sha256": "4bc95fdcf1fd2b2cfddf7312c570fb9c109b8b01e760be99797833741798fbea"     },     "created_date": "2025-01-31T12:28:49.689000"    },    {     "flow_id": "679cc24f68da9e0fca82ccbe",     "report_id": "fb50c1ae-0fd8-4b93-831f-f78b349f9a4e",     "verdict": "malicious",     "file": {      "name": "RemoteDll32.modded_2.exe",      "sha256": "90d6d2c1cbe82edc795ca8b2f09f8018902211b15e40a5b46a3673c2bb1db4de"     },     "created_date": "2025-01-31T12:30:10.982000"    }   ],   "verdict": "malicious"  } }, "imphash": {  "f446e030cec8cd0ecafb11faaaaf5acf": {   "counts": {    "malicious": 2   },   "reports": [    {     "flow_id": "679cc1ff68da9e0fca82cca3",     "report_id": "833700c1-86ed-4bc6-bef5-dcda16e7ed11",     "verdict": "malicious",     "file": {      "name": "RemoteDll32.clean.exe",      "sha256": "4bc95fdcf1fd2b2cfddf7312c570fb9c109b8b01e760be99797833741798fbea"     },     "created_date": "2025-01-31T12:28:49.689000"    },    {     "flow_id": "679cc24f68da9e0fca82ccbe",     "report_id": "fb50c1ae-0fd8-4b93-831f-f78b349f9a4e",     "verdict": "malicious",     "file": {      "name": "RemoteDll32.modded_2.exe",      "sha256": "90d6d2c1cbe82edc795ca8b2f09f8018902211b15e40a5b46a3673c2bb1db4de"     },     "created_date": "2025-01-31T12:30:10.982000"    }   ],   "verdict": "malicious"  } }}
Copy

Expand

Get feeds with more data

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

Auth

GET /api/threatintel/feed

xxxxxxxxxx
 
curl --get \ --url 'https://opswat.developerhub.io/api/threatintel/feed' \ --header 'X-Api-Key: {X-Api-Key}'
Copy

Responses

200

Successful Response

No response body

401

Not authorized

Response

xxxxxxxxxx
 
No response
Copy

Download iocs of reports in csv format

Download iocs of all reports

Auth

Headers

page	integer	minimum: 0
pageSize	integer	minimum: 0

Query String

unique_files	boolean
method		Default: and
derived_files	boolean	Default: true
no_date_limit	boolean
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`,`iso`,`java`,`java-bytecode`,`javascript`,`jpg`,`lnk`,`mbox`,`mhtml`,`msg`,`msi`,`mso`,`odp`,`ods`,`odt`,`odg`,`odf`,`odc`,`odb`,`odi`,`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`,`xml`,`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

Expand

GET /api/threatintel/download-iocs

xxxxxxxxxx
 
curl --get \ --url 'https://opswat.developerhub.io/api/threatintel/download-iocs' \ --header 'page: {page}' \ --header 'pageSize: {pageSize}' \ --header 'X-Api-Key: {X-Api-Key}' \ --data unique_files={unique_files} \ --data method=and \ --data derived_files=true \ --data no_date_limit={no_date_limit} \ --data query={query} \ --data verdict={verdict} \ --data source_type={source_type} \ --data filetype={filetype} \ --data tag={tag} \ --data tags={tags} \ --data date_from={date_from} \ --data date_to={date_to} \ --data rate_from={rate_from} \ --data rate_to={rate_to} \ --data uuid={uuid} \ --data email={email} \ --data registry_path={registry_path} \ --data revision_save_id={revision_save_id} \ --data yara_rule={yara_rule} \ --data retry_count={retry_count} \ --data scan_init_id={scan_init_id} \ --data report_id={report_id} \ --data country={country} \ --data filename={filename} \ --data sha1={sha1} \ --data sha256={sha256} \ --data sha512={sha512} \ --data md5={md5} \ --data domain={domain} \ --data ip={ip} \ --data url={url} \ --data media_type={media_type} \ --data imphash={imphash} \ --data ssdeep={ssdeep} \ --data authentihash={authentihash} \ --data fuzzyfsiohash={fuzzyfsiohash} \ --data signal_groups={signal_groups} \ --data mitre_techniques={mitre_techniques} \ --data verdict_groups={verdict_groups} \ --data main_task_state=success \ --data exclude={exclude}
Copy

Responses

200

Successful Response

No response body

401

Not authorized

422

Validation Error

Response

xxxxxxxxxx
 
IOC_type, IOC_Value, report_SHA256, report_URLurls, http://yahoo.com.au, adcab2f65197289526992e593243d1d3edc73516c94fa2e64fa81f1c48478c47, http://localhost:4200/uploads/672a09b750270725e3077e2b/reports/40a875a4-ed9e-4fc4-b157-1b332f61605f/iocdomains, yahoo.com.au, adcab2f65197289526992e593243d1d3edc73516c94fa2e64fa81f1c48478c47, http://localhost:4200/uploads/672a09b750270725e3077e2b/reports/40a875a4-ed9e-4fc4-b157-1b332f61605f/iocemails, jadoxa@yahoo.com.au, adcab2f65197289526992e593243d1d3edc73516c94fa2e64fa81f1c48478c47, http://localhost:4200/uploads/672a09b750270725e3077e2b/reports/40a875a4-ed9e-4fc4-b157-1b332f61605f/iocmd5, 63fad30e8b00c42bf48d38dd11d3e48a, adcab2f65197289526992e593243d1d3edc73516c94fa2e64fa81f1c48478c47, http://localhost:4200/uploads/672a09b750270725e3077e2b/reports/40a875a4-ed9e-4fc4-b157-1b332f61605f/iocsha1, 5a34ed5cf2d9d3d332717b210c12d4232dfe443f, adcab2f65197289526992e593243d1d3edc73516c94fa2e64fa81f1c48478c47, http://localhost:4200/uploads/672a09b750270725e3077e2b/reports/40a875a4-ed9e-4fc4-b157-1b332f61605f/iocsha256, 5df6994146d086b0cff5ff3e6fd15811fb913a46acffb3a182a66ff09ffd75cf, adcab2f65197289526992e593243d1d3edc73516c94fa2e64fa81f1c48478c47, http://localhost:4200/uploads/672a09b750270725e3077e2b/reports/40a875a4-ed9e-4fc4-b157-1b332f61605f/iocsha512, 2e5692bfc4eb2c8bd3a5c9441103d5dd63245e52d15465e441eeea43a263b38a4197bef474adf055627c526ed279f0399904240c17ffc3188db6b8256cf0b4f2, adcab2f65197289526992e593243d1d3edc73516c94fa2e64fa81f1c48478c47, http://localhost:4200/uploads/672a09b750270725e3077e2b/reports/40a875a4-ed9e-4fc4-b157-1b332f61605f/ioc            
Copy

Similarity-search

Similarity Search

/api/similarity-search/similarity

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
verdict	string	Enum: `unknown`,`benign`,`informational`,`no_threat`,`suspicious`,`likely_malicious`,`malicious`
tags	array

GET /api/similarity-search/similarity

xxxxxxxxxx
 
curl --get \ --url 'https://opswat.developerhub.io/api/similarity-search/similarity' \ --header 'X-Api-Key: {X-Api-Key}' \ --data hash={hash} \ --data min_similarity={min_similarity} \ --data verdict={verdict} \ --data tags={tags}
Copy

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
extracted	number
threat_indicators	number
sections	number
mitre_techniques	number
binary_metadata	number
certificates	number
characteristic	number
disassembly_sections	number
dotnet_info	number
header_info	number
imports	number
pdb_guid	number
resources	number
rich_header_compiler_ids	number
strings	number
version_info	number
apk	number
biffopcodes	number
emulation	number
extendeddata	number
metadata	number
segments	number
content_parse	number
image_ocr	number
binary_internal	number
strings_input_file	number
triggeredconsumerids	number
vba_emulation	number
yara	number
signal_ids	number
certifications	number
weighted_numerics	number
details	object
start_date	date-time
file_size	number
tags	array[string]
verdict	string	An enumeration. Enum: `unknown`,`benign`,`informational`,`no_threat`,`suspicious`,`likely_malicious`,`malicious`
is_dotnet	integer
architecture	string
entropy	number
most_recent	array[object]	Default: []
sha256	string
overall_similarity	number
similarities	object
extracted	number
threat_indicators	number
sections	number
mitre_techniques	number
binary_metadata	number
certificates	number
characteristic	number
disassembly_sections	number
dotnet_info	number
header_info	number
imports	number
pdb_guid	number
resources	number
rich_header_compiler_ids	number
strings	number
version_info	number
apk	number
biffopcodes	number
emulation	number
extendeddata	number
metadata	number
segments	number
content_parse	number
image_ocr	number
binary_internal	number
strings_input_file	number
triggeredconsumerids	number
vba_emulation	number
yara	number
signal_ids	number
certifications	number
weighted_numerics	number
details	object
start_date	date-time
file_size	number
tags	array[string]
verdict	string	An enumeration. Enum: `unknown`,`benign`,`informational`,`no_threat`,`suspicious`,`likely_malicious`,`malicious`
is_dotnet	integer
architecture	string
entropy	number

Expand

400

Bad request

401

Not authorized

422

Validation Error

Response

xxxxxxxxxx
 
{ "most_similar": [  {   "sha256": "4bc95fdcf1fd2b2cfddf7312c570fb9c109b8b01e760be99797833741798fbea",   "overall_similarity": 1,   "similarities": {    "extracted": 1,    "threat_indicators": 1,    "sections": 0.9999,    "mitre_techniques": 1,    "binary_metadata": 1,    "characteristic": 1,    "disassembly_sections": 1,    "dotnet_info": 1,    "header_info": 1,    "imports": 1,    "resources": 1,    "rich_header_compiler_ids": 1,    "strings": 1,    "version_info": 1   },   "details": {    "start_date": "2025-01-31T09:42:38.174000+00:00",    "file_size": 3590144,    "tags": [     "peexe",     "txt",     "evasive",     "keylogger",     "hacktool",     "explorer",     "fingerprint",     "lolbin",     "remote",     "microsoft_visual_cc"    ],    "verdict": "malicious",    "is_dotnet": 0,    "architecture": "32 Bits binary",    "entropy": 6.697518394880351   }  } ], "most_recent": [  {   "sha256": "4bc95fdcf1fd2b2cfddf7312c570fb9c109b8b01e760be99797833741798fbea",   "overall_similarity": 1,   "similarities": {    "extracted": 1,    "threat_indicators": 1,    "sections": 0.9999,    "mitre_techniques": 1,    "binary_metadata": 1,    "characteristic": 1,    "disassembly_sections": 1,    "dotnet_info": 1,    "header_info": 1,    "imports": 1,    "resources": 1,    "rich_header_compiler_ids": 1,    "strings": 1,    "version_info": 1   },   "details": {    "start_date": "2025-01-31T09:42:38.174000+00:00",    "file_size": 3590144,    "tags": [     "peexe",     "txt",     "evasive",     "keylogger",     "hacktool",     "explorer",     "fingerprint",     "lolbin",     "remote",     "microsoft_visual_cc"    ],    "verdict": "malicious",    "is_dotnet": 0,    "architecture": "32 Bits binary",    "entropy": 6.697518394880351   }  } ]}
Copy

Expand

Backend

Backend wrapper

/api/reputation/{ioc_type}

/api/backend/reputation

Get ReputationDeprecated

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

xxxxxxxxxx
 
curl --get \ --url 'https://opswat.developerhub.io/api/backend/reputation' \ --header 'X-Api-Key: {X-Api-Key}' \ --data sha256={sha256} \ --data hashes={hashes}
Copy

Responses

200

Successful Response

ReputationResponse	object	Response model for get_reputation()
processTime	integer
reputationResults	object	Model for reputationResults field
INTERNAL	object	Model for INTERNAL field
processTime	integer
whitelistedHashes	array
invalidHashes	array

422

Validation Error

500

Internal server error

Response

xxxxxxxxxx
 
{ "processTime": "{integer}", "reputationResults": {  "INTERNAL": {   "processTime": "{integer}",   "whitelistedHashes": [    "{array...}"   ],   "invalidHashes": [    "{array...}"   ]  } }}
Copy

Reputation

/api/reputation/{ioc_type}

Get Reputation Hash

Get the reputation for one given hash

Auth

Query String

sha256 string

GET /api/reputation/hash

xxxxxxxxxx
 
curl --get \ --url 'https://opswat.developerhub.io/api/reputation/hash' \ --header 'X-Api-Key: {X-Api-Key}' \ --data sha256={sha256}
Copy

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

401

Not authorized

415

Unsupported media type

422

Validation Error

Response

xxxxxxxxxx
 
{ "sha256": "cd75828da7199ec27875ebb93c9bb848fe5c58baea4de185af37dc3731cb9ffc", "overall_verdict": "malicious", "fuzzyhash": {  "hash": "dfccbab156d3685c12ce4c9250850ef20b09f4f9c16a343cbee8b7314ea314a0",  "verdict": "unknown" }, "mdcloud": {  "total_av_engines": 19,  "detected_av_engines": 0,  "scan_time": "2023-02-01T19:01:17.707000" }, "filescan_reports": [  {   "verdict": "malicious",   "report_date": "01/28/2025, 10:24:45",   "report_id": "d2e899de-eb9a-4135-9f4f-80cc692a6c53",   "flow_id": "6798b06a09ca8ddccaa476ca"  } ]}
Copy

Get Reputation Hash Bulk

Get the reputation for more hashes

Auth

Request Body

array array[string]

POST /api/reputation/hash

xxxxxxxxxx
 
curl --request POST \ --url 'https://opswat.developerhub.io/api/reputation/hash' \ --header 'X-Api-Key: {X-Api-Key}' \ --data '[  "{array[string]...}"]'
Copy

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

401

Not authorized

415

Unsupported media type

422

Validation Error

Response

xxxxxxxxxx
 
[ {  "sha256": "a21e7b25ffe1aa4c4b30d538f71dac5fabfeda74740cb0814569fbcc1e8d9b82",  "overall_verdict": "malicious",  "fuzzyhash": {   "verdict": "unknown"  },  "mdcloud": {   "total_av_engines": 19,   "detected_av_engines": 3,   "scan_time": "2024-09-27T15:44:17.884000"  },  "filescan_reports": [   {    "verdict": "malicious",    "report_date": "01/30/2025, 08:24:49",    "report_id": "cc034b35-24c0-4b01-a75d-84a9c7630001",    "flow_id": "678f168e20b60a22331c0001"   }  ] }, {  "sha256": "cd75828da7199ec27875ebb93c9bb848fe5c58baea4de185af37dc3731cb9ffc",  "overall_verdict": "malicious",  "fuzzyhash": {   "hash": "dfccbab156d3685c12ce4c9250850ef20b09f4f9c16a343cbee8b7314ea314a0",   "verdict": "unknown"  },  "mdcloud": {   "total_av_engines": 19,   "detected_av_engines": 0,   "scan_time": "2023-02-01T19:01:17.707000"  },  "filescan_reports": [   {    "verdict": "malicious",    "report_date": "01/28/2025, 10:24:45",    "report_id": "d2e899de-eb9a-4135-9f4f-80cc692a6c53",    "flow_id": "6798b06a09ca8ddccaa476ca"   }  ] }]
Copy

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}

xxxxxxxxxx
 
curl --get \ --url 'https://opswat.developerhub.io/api/reputation/%7Bioc_type%7D' \ --header 'X-Api-Key: {X-Api-Key}' \ --data ioc_value={ioc_value}
Copy

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

401

Not authorized

415

Unsupported media type

422

Validation Error

Response

xxxxxxxxxx
 
{ "ioc_type": "url", "ioc_value": "https://netflix.com", "overall_verdict": "malicious", "mdcloud": {  "scan_time": "2025-02-10T13:29:04.035000",  "detected": 0 }, "community": {  "vote_malicious": 0,  "vote_benign": 0 }, "filescan_reports": [  {   "verdict": "malicious",   "report_date": "01/28/2025, 10:24:45",   "report_id": "d2e899de-eb9a-4135-9f4f-80cc692a6c53",   "flow_id": "6798b06a09ca8ddccaa476ca"  },  {   "verdict": "malicious",   "report_date": "01/28/2025, 10:24:45",   "report_id": "d2e899de-eb9a-4135-9f4f-80cc692a6c53",   "flow_id": "6798b06a09ca8ddccaa476ca"  } ]}
Copy

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}

xxxxxxxxxx
 
curl --request POST \ --url 'https://opswat.developerhub.io/api/reputation/%7Bioc_type%7D' \ --header 'X-Api-Key: {X-Api-Key}' \ --data '[  "{array[string]...}"]'
Copy

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

401

Not authorized

415

Unsupported media type

422

Validation Error

Response

xxxxxxxxxx
 
[ {  "ioc_type": "url",  "ioc_value": "https://netflix.com",  "overall_verdict": "malicious",  "mdcloud": {   "scan_time": "2025-02-10T13:29:04.035000",   "detected": 0  },  "community": {   "vote_malicious": 0,   "vote_benign": 0  },  "filescan_reports": [   {    "verdict": "malicious",    "report_date": "01/28/2025, 10:24:45",    "report_id": "d2e899de-eb9a-4135-9f4f-80cc692a6c53",    "flow_id": "6798b06a09ca8ddccaa476ca"   },   {    "verdict": "malicious",    "report_date": "01/28/2025, 10:24:45",    "report_id": "d2e899de-eb9a-4135-9f4f-80cc692a6c53",    "flow_id": "6798b06a09ca8ddccaa476ca"   }  ] }, {  "ioc_type": "url",  "ioc_value": "https://linkedin.com",  "overall_verdict": "no_threat",  "mdcloud": {   "scan_time": "2025-02-10T13:36:56.704000",   "detected": 0  },  "community": {   "vote_malicious": 0,   "vote_benign": 0  },  "filescan_reports": [   {    "verdict": "no_threat",    "report_date": "01/28/2025, 09:21:58",    "report_id": "a18cfa47-2a60-4457-9c86-2d7f58565b0d",    "flow_id": "6798a1b69d385c630bd11594"   },   {    "verdict": "no_threat",    "report_date": "01/28/2025, 09:21:58",    "report_id": "a18cfa47-2a60-4457-9c86-2d7f58565b0d",    "flow_id": "6798a1b69d385c630bd11594"   }  ] }]
Copy

Expand

Docs

API documentation related

Get API Docs

Return API docs UI

Auth

GET /api/docs

xxxxxxxxxx
 
curl --get \ --url 'https://opswat.developerhub.io/api/docs' \ --header 'X-Api-Key: {X-Api-Key}'
Copy

Responses

200

Successful Response

Response Get Api Docs Api Docs Get string

Response

xxxxxxxxxx
 
{ "schema": "{string}"}
Copy

Get OpenAPI Endpoint

Return API json data to be used by docs UI

Auth

GET /openapi.json

xxxxxxxxxx
 
curl --get \ --url 'https://opswat.developerhub.io/openapi.json' \ --header 'X-Api-Key: {X-Api-Key}'
Copy

Responses

200

Successful Response

GetOpenApiJsonResponse	object	Response model for get_open_api_endpoint()
openapi	string
info	object
title	string
version	string
paths	object
*	object
components	object
schemas	object
*	object
securitySchemes	object
apiKey	object
type	string
in	string
name	string
tags	array[object]
name	string
description	string

Response

xxxxxxxxxx
 
{
 "openapi": "3.1.0", "info": {...},
 "paths": {...},
 "components": {...},
 "tags": [...]
}
Copy

Get API Doc Styles

Return styles for api docs

Auth

GET /api/docs/styles

xxxxxxxxxx
 
curl --get \ --url 'https://opswat.developerhub.io/api/docs/styles' \ --header 'X-Api-Key: {X-Api-Key}'
Copy

Responses

200

Successful Response

Response Get Api Docs Styles Api Docs Styles Get string

Response

xxxxxxxxxx
 
{ "schema": "{string}"}
Copy

Get Sitemap

Get sitemap xml

Auth

GET /api/docs/sitemap

xxxxxxxxxx
 
curl --get \ --url 'https://opswat.developerhub.io/api/docs/sitemap' \ --header 'X-Api-Key: {X-Api-Key}'
Copy

Responses

200

Successful Response

No response body

Response

xxxxxxxxxx
 
No response
Copy

Ocm

OPSWAT Central Management (OCM)

Get Integration State

Get current state of OCM integration

Auth

GET /api/ocm/state

xxxxxxxxxx
 
curl --get \ --url 'https://opswat.developerhub.io/api/ocm/state' \ --header 'X-Api-Key: {X-Api-Key}'
Copy

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

401

Not authorized

404

Item not found

Response

xxxxxxxxxx
 
{ "server_url": "{string}", "registration_code": "{string}", "state": "{string}", "disconnected": "{boolean}", "last_connection_date": "2025-07-30T13:27:51.962612", "last_connection_attempt_date": "2025-07-30T13:27:51.962620"}
Copy

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

xxxxxxxxxx
 
curl --request POST \ --url 'https://opswat.developerhub.io/api/ocm/enroll' \ --header 'X-Api-Key: {X-Api-Key}' \ --data '{  "server_url": "{string}",  "registration_code": "{string}"}'
Copy

Responses

200

Successful Response

No response body

400

Bad request

401

Not authorized

422

Validation Error

Response

xxxxxxxxxx
 
No response
Copy

Unenroll

Unregister product at OPSWAT Central Management

Auth

Request Body

OcmUnenrollPayload	object
force	boolean	Clear local enrollment data

POST /api/ocm/unenroll

xxxxxxxxxx
 
curl --request POST \ --url 'https://opswat.developerhub.io/api/ocm/unenroll' \ --header 'X-Api-Key: {X-Api-Key}' \ --data '{  "force": "{boolean}"}'
Copy

Responses

200

Successful Response

No response body

401

Not authorized

422

Validation Error

Response

xxxxxxxxxx
 
No response
Copy

Ai

AI powered actions

/api/ai/report/summary