{"openapi":"3.1.0","info":{"title":"Filescan.io","version":"1.0"},"paths":{"/api/scan/file":{"post":{"tags":["scan"],"summary":"Scan File","description":"Perform scan of uploaded file","operationId":"scan_file_api_scan_file_post","requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/Body_scan_file_api_scan_file_post"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScanResponse"},"example":{"flow_id":"66f1905b318df2831b854ce5","priority":{"applied":100,"max_possible":100}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessageModel"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessageModel"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessageModel"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessageModel"}}}},"413":{"description":"Content too large","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessageModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"id":"scan-file","security":[{"apiKey":[]}],"path":"/api/scan/file","method":"post"}},"/api/scan/url":{"post":{"tags":["scan"],"summary":"Scan URL","description":"Scan URL resource","operationId":"scan_file_api_scan_url_post","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/Body_scan_file_api_scan_url_post"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScanResponse"},"example":{"flow_id":"66f1905b318df2831b854ce5","priority":{"applied":100,"max_possible":100}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessageModel"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessageModel"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessageModel"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessageModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"id":"scan-url","security":[{"apiKey":[]}],"path":"/api/scan/url","method":"post"}},"/api/scan/{flow_id}/report":{"get":{"tags":["scan"],"summary":"Get All Upload Related Reports","description":"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","operationId":"get_all_upload_related_reports_api_scan__flow_id__report_get","parameters":[{"name":"flow_id","in":"path","required":true,"schema":{"type":"string","description":"Flow Id from scan-file","title":"Flow Id"},"description":"Flow Id from scan-file"},{"name":"filter","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"},"title":"Report filter","description":"Report fields that should be fetched."},"description":"Report fields that should be fetched.","examples":{"basic":{"summary":"basic example","description":"Fetch only general report data: file name, hash, type of file, report creation date and error status in case there was an error","value":["general"]},"signal_groups":{"summary":"all signal groups","description":"Fetch all signal groups","value":["allSignalGroups"]},"tags":{"summary":"all tags","description":"Fetch all tags","value":["allTags"]},"task_reference":{"summary":"status of main task","description":"Fetch status of the main scan task","value":["taskReference"]},"subtask_references":{"summary":"status of subtasks","description":"Fetch status of scan subtasks","value":["subtaskReferences"]},"final_verdict":{"summary":"final verdict","description":"Final verdict and confidence","value":["finalVerdict"]},"simple_fields":{"summary":"other simple fields","description":"Various simple fields of the report","value":["opcount","positionInQueue","priority","expectedRemainingProcessingTimeInSeconds","processTime"]},"main_task_data":{"summary":"main task result","description":"All data produced by `file` scan task (it's the main scan task)","value":["f:all"]},"file_download":{"summary":"downloaded files","description":"All data produced by `file-download` scan subtask","value":["fd:all"]},"domain_resolve":{"summary":"domain resolve result","description":"All data produced by `domain-resolve` scan subtask","value":["dr:all"]},"visualization":{"summary":"visualization result","description":"Visualization image produced by `visualization` scan subtask","value":["v:visualizedSample.compressedBase64"]},"file_preview":{"summary":"file preview images","description":"File preview images produced by `visualization` scan subtask","value":["v:renderedImages"]},"whois_lookup":{"summary":"whois lookup result","description":"All data produced by `whois-lookup` scan subtask","value":["wi:all"]},"osint":{"summary":"osint result","description":"All data produced by `osint` scan subtasks","value":["o:all"]},"task_subfields":{"summary":"particular information","description":"Get some specific fields from task data (on example of main task data)","value":["f:yaraMatches","f:extractedFiles","f:digests"]},"combination":{"summary":"various combination","description":"Get specific fields of multiple scan tasks","value":["f:all","fd:fileDownloadResults","fd:extractedUrls","o:all"]},"nested_selections":{"summary":"various combination of nested selections","description":"More selective information of any depth","value":["general","subtaskReferences.state","f:yaraMatches","f:extractedFiles.yaraMatches","f:extractedDomains.origin.type","o:results"]}}},{"name":"sorting","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"},"title":"Filter sorting options","description":"Sort parameters to be applied to fetched report data"},"description":"Sort parameters to be applied to fetched report data","examples":{"all_signal_groups":{"summary":"all signal groups","description":"Sort by allSignalGroups description ascending and averageSignalStrength descending","value":["allSignalGroups(description:asc,averageSignalStrength:desc)"]},"all_tags":{"summary":"all tags","description":"Sort by allTags tag name ascending","value":["allTags(tag.name:asc)"]}}},{"name":"other","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"},"title":"Special options","description":"Extra options to get special data"},"description":"Extra options to get special data","examples":{"emulation_graph":{"summary":"emulation graph","description":"Fetch the emulation graph","value":["emulationGraph"]}}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AllUploadRelatedReportsResponse"},"examples":{"Basic response":{"value":{"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.0}}}},"Filtered report":{"value":{"reports":{"66eb5622-1049-43e7-93d6-3087bb100d67":{"finalVerdict":{"verdict":"NO_THREAT","threatLevel":0.1,"confidence":1},"overallState":"success","sanitizedSummary":{"tags":["data","png"],"yaraMatches":[],"fileSize":1293537,"mimeType":"image/png","metaData":{"bitsPerPixel":"24","colorType":"RGB","comments":"0","compressionAlgorithm":"PNG Filter","entropy":7.993209920185224,"format":"PNG","formatDetails":"Png","formatName":"PNG Portable Network Graphics","height":"800","isProgressive":"false","isTransparent":"false","mimeType":"image/png","numberOfImages":"1","physicalHeightDpi":"-1","physicalHeightInch":"-1.0","physicalWidthDpi":"-1","physicalWidthInch":"-1.0","usesPalette":"false","width":"1056"},"fileMagicDescription":"PNG image data, 1056 x 800, 8-bit/color RGB, non-interlaced","behaviorPatterns":[],"avLabels":[]}}}}}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessageModel"}}}},"404":{"description":"Item not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessageModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"id":"get-flow-reports","security":[{"apiKey":[]}],"path":"/api/scan/{flow_id}/report","method":"get"}},"/api/reports/{report_id}/{file_hash}":{"get":{"tags":["reports"],"summary":"Get Specific Report","description":"Obtain a report for given report_id.","operationId":"get_specific_report_api_reports__report_id___file_hash__get","parameters":[{"name":"report_id","in":"path","required":true,"schema":{"type":"string","description":"Report Id","title":"Report Id"},"description":"Report Id"},{"name":"file_hash","in":"path","required":true,"schema":{"type":"string","description":"File hash","title":"File Hash"},"description":"File hash"},{"name":"filter","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"},"title":"Report filter","description":"Report fields that should be fetched"},"description":"Report fields that should be fetched","examples":{"basic":{"summary":"basic example","description":"Fetch only general report data: file name, hash, type of file, report creation date and error status in case there was an error","value":["general"]},"signal_groups":{"summary":"all signal groups","description":"Fetch all signal groups","value":["allSignalGroups"]},"tags":{"summary":"all tags","description":"Fetch all tags","value":["allTags"]},"task_reference":{"summary":"status of main task","description":"Fetch status of the main scan task","value":["taskReference"]},"subtask_references":{"summary":"status of subtasks","description":"Fetch status of scan subtasks","value":["subtaskReferences"]},"final_verdict":{"summary":"final verdict","description":"Final verdict and confidence","value":["finalVerdict"]},"simple_fields":{"summary":"other simple fields","description":"Various simple fields of the report","value":["opcount","positionInQueue","priority","expectedRemainingProcessingTimeInSeconds","processTime"]},"main_task_data":{"summary":"main task result","description":"All data produced by `file` scan task (it's the main scan task)","value":["f:all"]},"file_download":{"summary":"downloaded files","description":"All data produced by `file-download` scan subtask","value":["fd:all"]},"domain_resolve":{"summary":"domain resolve result","description":"All data produced by `domain-resolve` scan subtask","value":["dr:all"]},"visualization":{"summary":"visualization result","description":"Visualization image produced by `visualization` scan subtask","value":["v:visualizedSample.compressedBase64"]},"file_preview":{"summary":"file preview images","description":"File preview images produced by `visualization` scan subtask","value":["v:renderedImages"]},"whois_lookup":{"summary":"whois lookup result","description":"All data produced by `whois-lookup` scan subtask","value":["wi:all"]},"osint":{"summary":"osint result","description":"All data produced by `osint` scan subtasks","value":["o:all"]},"task_subfields":{"summary":"particular information","description":"Get some specific fields from task data (on example of main task data)","value":["f:yaraMatches","f:extractedFiles","f:digests"]},"combination":{"summary":"various combination","description":"Get specific fields of multiple scan tasks","value":["f:all","fd:fileDownloadResults","fd:extractedUrls","o:all"]},"nested_selections":{"summary":"various combination of nested selections","description":"More selective information of any depth","value":["general","subtaskReferences.state","f:yaraMatches","f:extractedFiles.yaraMatches","f:extractedDomains.origin.type","o:results"]}}},{"name":"sorting","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"},"title":"Filter sorting options","description":"Sort parameters to be applied to fetched report data"},"description":"Sort parameters to be applied to fetched report data","examples":{"all_signal_groups":{"summary":"all signal groups","description":"Sort by allSignalGroups description ascending and averageSignalStrength descending","value":["allSignalGroups(description:asc,averageSignalStrength:desc)"]},"all_tags":{"summary":"all tags","description":"Sort by allTags tag name ascending","value":["allTags(tag.name:asc)"]}}},{"name":"other","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"},"title":"Special options","description":"Extra options to get special data"},"description":"Extra options to get special data","examples":{"emulation_graph":{"summary":"emulation graph","description":"Fetch the emulation graph","value":["emulationGraph"]}}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AllUploadRelatedReportsResponse"},"example":{"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.0}}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessageModel"}}}},"404":{"description":"Item not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessageModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"id":"get-report-from-id","security":[{"apiKey":[]}],"path":"/api/reports/{report_id}/{file_hash}","method":"get"}},"/api/files/availability":{"post":{"tags":["files"],"summary":"Check Files Availability","description":"Check files availability by their hashes","operationId":"check_files_availability_api_files_availability_post","requestBody":{"content":{"application/json":{"schema":{"items":{"type":"string"},"type":"array","title":"Hashes"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","title":"Response Check Files Availability Api Files Availability Post"},"example":{"def235db54b8b18f1119d5546979fabfeb3f854406f8f9be4e20d262f1e380a4":true,"def235db54b8b18f1119d5546979fabfeb3f854406f8f9be4e20d262f1e380a5":false}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"id":"check-files-availability","security":[{"apiKey":[]}],"path":"/api/files/availability","method":"post"}},"/api/system/info":{"get":{"tags":["system"],"summary":"Get Default","description":"Return general information about webservice, just to indicate that API is working","operationId":"get_default_api_system_info_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralSystemInfo"}}}}},"id":"api-info","security":[{"apiKey":[]}],"path":"/api/system/info","method":"get"}},"/api/system/version":{"get":{"tags":["system"],"summary":"Get Version","description":"Return the version of the webservice","operationId":"get_version_api_system_version_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"string","title":"Response Get Version Api System Version Get"}}}}},"id":"app-version","security":[{"apiKey":[]}],"path":"/api/system/version","method":"get"}},"/api/system/config":{"get":{"tags":["system"],"summary":"Get Config","description":"Obtain project configuration to use on front-end","operationId":"get_config_api_system_config_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SystemConfig"}}}}},"id":"app-config","security":[{"apiKey":[]}],"path":"/api/system/config","method":"get"}},"/api/system/product-features":{"get":{"tags":["system"],"summary":"Get License Product Features","description":"Get product features","operationId":"get_license_product_features_api_system_product_features_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"Item not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessageModel"}}}}},"id":"get-product-features","security":[{"apiKey":[]}],"path":"/api/system/product-features","method":"get"}},"/api/system/get-terms/{terms_type}":{"get":{"tags":["system"],"summary":"Get Terms","description":"Obtain privacy policy and terms & conditions","operationId":"get_terms_api_system_get_terms__terms_type__get","parameters":[{"name":"terms_type","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TermsType"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"string","title":"Response Get Terms Api System Get Terms  Terms Type  Get"}}}},"404":{"description":"Item not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessageModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"id":"terms","security":[{"apiKey":[]}],"path":"/api/system/get-terms/{terms_type}","method":"get"}},"/api/system/yara":{"get":{"tags":["system"],"summary":"Get Yara Rules","description":"Get extended data of yara rules\n\nIf the `name` parameter is left empty, it returns the list of yara rules that already has a match in the system.\nOtherwise 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.","operationId":"get_yara_rules_api_system_yara_get","parameters":[{"name":"name","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"},"description":"Name of the YARA rule","default":[],"title":"Name"},"description":"Name of the YARA rule"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/YaraRuleResponse"},"title":"Response Get Yara Rules Api System Yara Get"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessageModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"id":"yara-rules","security":[{"apiKey":[]}],"path":"/api/system/yara","method":"get"}},"/api/system/translations/{lang}":{"get":{"tags":["system"],"summary":"Get Translations","description":"Obtain translations for specific language","operationId":"get_translations_api_system_translations__lang__get","parameters":[{"name":"lang","in":"path","required":true,"schema":{"$ref":"#/components/schemas/Language"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":{"type":"string"},"title":"Response Get Translations Api System Translations  Lang  Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"id":"translations","security":[{"apiKey":[]}],"path":"/api/system/translations/{lang}","method":"get"}},"/api/system/languages":{"get":{"tags":["system"],"summary":"Get Languages","description":"Obtain list of all detectable (and probably even more) languages","operationId":"get_languages_api_system_languages_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"additionalProperties":{"$ref":"#/components/schemas/LanguageData"},"type":"object","title":"Response Get Languages Api System Languages Get"}}}},"404":{"description":"Item not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessageModel"}}}}},"id":"langs","security":[{"apiKey":[]}],"path":"/api/system/languages","method":"get"}},"/api/system/countries":{"get":{"tags":["system"],"summary":"Get Countries","description":"Obtain list of all countries","operationId":"get_countries_api_system_countries_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"additionalProperties":{"type":"string"},"type":"object","title":"Response Get Countries Api System Countries Get"}}}},"404":{"description":"Item not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessageModel"}}}}},"id":"countries","security":[{"apiKey":[]}],"path":"/api/system/countries","method":"get"}},"/api/system/mitre":{"get":{"tags":["system"],"summary":"Get Mitre Data","description":"Obtain MITRE tactics and techniques","operationId":"get_mitre_data_api_system_mitre_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"additionalProperties":{"$ref":"#/components/schemas/MitreDataResponse"},"type":"object","title":"Response Get Mitre Data Api System Mitre Get"}}}},"404":{"description":"Item not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessageModel"}}}}},"id":"mitre","security":[{"apiKey":[]}],"path":"/api/system/mitre","method":"get"}},"/api/system/mbc":{"get":{"tags":["system"],"summary":"Get Mbc Data","description":"Obtain MBC objectives and behaviors","operationId":"get_mbc_data_api_system_mbc_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"additionalProperties":{"$ref":"#/components/schemas/MbcDataResponse"},"type":"object","title":"Response Get Mbc Data Api System Mbc Get"}}}},"404":{"description":"Item not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessageModel"}}}}},"id":"mbc","security":[{"apiKey":[]}],"path":"/api/system/mbc","method":"get"}},"/api/system/errors/log":{"post":{"tags":["system"],"summary":"Log Client Error","description":"Log frontend cliend errors","operationId":"log_client_error_api_system_errors_log_post","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessageModel"}}}}},"id":"log-client-error","security":[{"apiKey":[]}],"path":"/api/system/errors/log","method":"post"}},"/api/system/logo":{"get":{"tags":["system"],"summary":"Get Logo","description":"Get logo image","operationId":"get_logo_api_system_logo_get","parameters":[{"name":"type","in":"query","required":false,"schema":{"$ref":"#/components/schemas/SiteLogoType","default":"main"}},{"name":"theme","in":"query","required":false,"schema":{"$ref":"#/components/schemas/SiteTheme","default":"light"}},{"name":"name","in":"query","required":false,"schema":{"type":"string","title":"Name"}}],"responses":{"200":{"description":"Successful Response"},"404":{"description":"Item not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessageModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"id":"get-logo","security":[{"apiKey":[]}],"path":"/api/system/logo","method":"get"}},"/api/system/query-healthcheck":{"get":{"tags":["system"],"summary":"Query Healthcheck","description":"Query sanitized past healthcheck logs","operationId":"query_healthcheck_api_system_query_healthcheck_get","parameters":[{"name":"days","in":"query","required":false,"schema":{"type":"integer","default":90,"title":"Days"}},{"name":"days_from","in":"query","required":false,"schema":{"type":"integer","default":0,"title":"Days From"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SanitizedHealthCheckOutput"},"title":"Response Query Healthcheck Api System Query Healthcheck Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"id":"query-healthcheck","security":[{"apiKey":[]}],"path":"/api/system/query-healthcheck","method":"get"}},"/api/system/reputation/check-config":{"get":{"tags":["system"],"summary":"Reputation Check Config","description":"Check if MD Cloud Reputation is enabled\n\nIf in the /config `opswatReputationAPIKeySource` value `FALLBACK`, it returns `False`.\nIf `opswatReputationAPIKeySource` is `LICENSE` or `USER`, it returns `True`","operationId":"reputation_check_config_api_system_reputation_check_config_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReputationCheckConfigResponse"}}}}},"id":"reputation-check-config","security":[{"apiKey":[]}],"path":"/api/system/reputation/check-config","method":"get"}},"/api/system/news":{"get":{"tags":["system"],"summary":"Get News","description":"Get news","operationId":"get_news_api_system_news_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/NewsItemResponse"},"title":"Response Get News Api System News Get"}}}}},"id":"get-news","security":[{"apiKey":[]}],"path":"/api/system/news","method":"get"},"post":{"tags":["admin","admin"],"summary":"Save News Item","description":"Save news item data","operationId":"save_news_item_api_system_news_post","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminNewsPayload"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{},"example":{}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessageModel"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessageModel"}}}},"404":{"description":"Item not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessageModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"id":"save-news-item","security":[{"apiKey":[]},{}],"path":"/api/system/news","method":"post"},"delete":{"tags":["admin","admin"],"summary":"Remove News Item","description":"Remove news item","operationId":"remove_news_item_api_system_news_delete","parameters":[{"name":"news_id","in":"query","required":true,"schema":{"title":"News Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{},"example":{}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessageModel"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessageModel"}}}},"404":{"description":"Item not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessageModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"id":"remove-news-item","security":[{"apiKey":[]},{}],"path":"/api/system/news","method":"delete"}},"/api/users/{account_id}/avatar":{"get":{"tags":["users"],"summary":"Get Avatar Image","description":"Get use avatar image","operationId":"get_avatar_image_api_users__account_id__avatar_get","parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","title":"Account Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessageModel"}}}},"404":{"description":"Item not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessageModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"id":"avatar","security":[{"apiKey":[]}],"path":"/api/users/{account_id}/avatar","method":"get"}},"/api/reports/search":{"get":{"tags":["reports"],"summary":"Simple Search","description":"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.","operationId":"search_report_api_reports_search_get","parameters":[{"name":"age","in":"query","required":false,"schema":{"type":"integer","description":"Search reports with age of \"age\" days","default":-1,"title":"Age"},"description":"Search reports with age of \"age\" days"},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"description":"Page number starting from 1","default":1,"title":"Page"},"description":"Page number starting from 1"},{"name":"page_size","in":"query","required":false,"schema":{"$ref":"#/components/schemas/REPORTS_SEARCH_PAGE_SIZE_OPTIONS","description":"Page size","default":10},"description":"Page size"},{"name":"method","in":"query","required":false,"schema":{"$ref":"#/components/schemas/ReportSearchMethod","default":"and"}},{"name":"derived_files","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":true,"title":"Derived Files"}},{"name":"no_date_limit","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":false,"title":"No Date Limit"}},{"name":"query","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Query"}},{"name":"verdict","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Verdict"}},{"name":"source_type","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/ReportsSourceType"},{"type":"null"}],"title":"Source Type"}},{"name":"filetype","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/FileType"},{"type":"null"}],"title":"Filetype"}},{"name":"tag","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Tag"}},{"name":"tags","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Tags"}},{"name":"date_from","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Date From"}},{"name":"date_to","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Date To"}},{"name":"rate_from","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Rate From"}},{"name":"rate_to","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Rate To"}},{"name":"uuid","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Uuid"}},{"name":"email","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Email"}},{"name":"registry_path","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Registry Path"}},{"name":"revision_save_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Revision Save Id"}},{"name":"yara_rule","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Yara Rule"}},{"name":"retry_count","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Retry Count"}},{"name":"scan_init_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Scan Init Id"}},{"name":"report_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Report Id"}},{"name":"country","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Country"}},{"name":"filename","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Filename"}},{"name":"sha1","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sha1"}},{"name":"sha256","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sha256"}},{"name":"sha512","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sha512"}},{"name":"md5","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Md5"}},{"name":"domain","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Domain"}},{"name":"ip","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Ip"}},{"name":"url","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Url"}},{"name":"media_type","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Media Type"}},{"name":"imphash","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Imphash"}},{"name":"ssdeep","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Ssdeep"}},{"name":"authentihash","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authentihash"}},{"name":"fuzzyfsiohash","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Fuzzyfsiohash"}},{"name":"signal_groups","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Signal Groups"}},{"name":"mitre_techniques","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Mitre Techniques"}},{"name":"verdict_groups","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Verdict Groups"}},{"name":"main_task_state","in":"query","required":false,"schema":{"$ref":"#/components/schemas/MainTaskSimplifiedState","default":"success"}},{"name":"exclude","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Exclude"}},{"name":"all_dates_algo","in":"query","required":false,"schema":{"const":"default","type":"string","default":"default","title":"All Dates Algo"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReportSearchResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessageModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"id":"search-reports","security":[{"apiKey":[]}],"path":"/api/reports/search","method":"get"}},"/api/reports/search/matches":{"post":{"tags":["reports"],"summary":"Matches for reports, obtained by search","description":"Get matches data for reports, previously obtained by search","operationId":"get_search_matches_api_reports_search_matches_post","parameters":[{"name":"unique_files","in":"query","required":false,"schema":{"type":"boolean","default":false,"title":"Unique Files"}},{"name":"method","in":"query","required":false,"schema":{"$ref":"#/components/schemas/ReportSearchMethod","default":"and"}},{"name":"derived_files","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":true,"title":"Derived Files"}},{"name":"no_date_limit","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":false,"title":"No Date Limit"}},{"name":"query","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Query"}},{"name":"verdict","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Verdict"}},{"name":"source_type","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/ReportsSourceType"},{"type":"null"}],"title":"Source Type"}},{"name":"filetype","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/FileType"},{"type":"null"}],"title":"Filetype"}},{"name":"tag","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Tag"}},{"name":"tags","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Tags"}},{"name":"date_from","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Date From"}},{"name":"date_to","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Date To"}},{"name":"rate_from","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Rate From"}},{"name":"rate_to","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Rate To"}},{"name":"uuid","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Uuid"}},{"name":"email","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Email"}},{"name":"registry_path","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Registry Path"}},{"name":"revision_save_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Revision Save Id"}},{"name":"yara_rule","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Yara Rule"}},{"name":"retry_count","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Retry Count"}},{"name":"scan_init_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Scan Init Id"}},{"name":"report_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Report Id"}},{"name":"country","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Country"}},{"name":"filename","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Filename"}},{"name":"sha1","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sha1"}},{"name":"sha256","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sha256"}},{"name":"sha512","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sha512"}},{"name":"md5","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Md5"}},{"name":"domain","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Domain"}},{"name":"ip","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Ip"}},{"name":"url","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Url"}},{"name":"media_type","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Media Type"}},{"name":"imphash","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Imphash"}},{"name":"ssdeep","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Ssdeep"}},{"name":"authentihash","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authentihash"}},{"name":"fuzzyfsiohash","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Fuzzyfsiohash"}},{"name":"signal_groups","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Signal Groups"}},{"name":"mitre_techniques","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Mitre Techniques"}},{"name":"verdict_groups","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Verdict Groups"}},{"name":"main_task_state","in":"query","required":false,"schema":{"$ref":"#/components/schemas/MainTaskSimplifiedState","default":"success"}},{"name":"exclude","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Exclude"}},{"name":"all_dates_algo","in":"query","required":false,"schema":{"const":"default","type":"string","default":"default","title":"All Dates Algo"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MatchesPayload"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MatchesResponseItem"},"title":"Response Get Search Matches Api Reports Search Matches Post"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessageModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"id":"search-matches","security":[{"apiKey":[]}],"path":"/api/reports/search/matches","method":"post"}},"/api/reports":{"get":{"tags":["reports"],"summary":"Get Public Reports","description":"Get all public reports","operationId":"get_public_reports_api_reports_get","parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"description":"Page number starting from 1","default":1,"title":"Page"},"description":"Page number starting from 1"},{"name":"page_size","in":"query","required":false,"schema":{"$ref":"#/components/schemas/REPORTS_SEARCH_PAGE_SIZE_OPTIONS","description":"Page size","default":10},"description":"Page size"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReportSearchResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessageModel"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessageModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"id":"all-reports","security":[{"apiKey":[]}],"path":"/api/reports","method":"get"}},"/api/threatintel/get-prevalence":{"post":{"tags":["threatintel"],"summary":"Get prevalence of IOCs","description":"Get prevalences of IOCs","operationId":"get_ioc_prevalences_api_threatintel_get_prevalence_post","parameters":[{"name":"exclude_report_ids","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"},"title":"Exclude Report Ids"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IOCsPrevalenceSearchParams"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/IOCsPrevalenceResponse"}},"propertyNames":{"$ref":"#/components/schemas/IOCs"},"title":"Response Get Ioc Prevalences Api Threatintel Get Prevalence Post"},"example":{"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"}}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessageModel"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessageModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"id":"get-prevalence","security":[{"apiKey":[]}],"path":"/api/threatintel/get-prevalence","method":"post"}},"/api/threatintel/get-similars":{"get":{"tags":["threatintel"],"summary":"Get reports with the same special hashes (fuzzyfsio, imphash, ssdeep, authentihash)","description":"Get reports with the same special hashes","operationId":"get_similar_reports_api_threatintel_get_similars_get","parameters":[{"name":"exclude_report_ids","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"},"title":"Exclude Report Ids"}},{"name":"imphash","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Imphash"}},{"name":"ssdeep","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Ssdeep"}},{"name":"fuzzyfsiohash","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Fuzzyfsiohash"}},{"name":"authentihash","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authentihash"}},{"name":"days","in":"query","required":false,"schema":{"type":"integer","default":-1,"title":"Days"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/IOCsPrevalenceResponse"}},"propertyNames":{"$ref":"#/components/schemas/IOCs"},"title":"Response Get Similar Reports Api Threatintel Get Similars Get"},"example":{"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"}}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessageModel"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessageModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"id":"get-similar","security":[{"apiKey":[]}],"path":"/api/threatintel/get-similars","method":"get"}},"/api/similarity-search/similarity":{"get":{"tags":["similarity-search"],"summary":"Get similar reports based on the SHA256 hash, tags, threshold and verdict","description":"Get similar reports","operationId":"similarity_api_similarity_search_similarity_get","deprecated":true,"parameters":[{"name":"hash","in":"query","required":false,"schema":{"type":"string","title":"Hash"}},{"name":"min_similarity","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","maximum":100,"minimum":0},{"type":"null"}],"default":0,"title":"Min Similarity"}},{"name":"verdict","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/ReportVerdict"},{"type":"null"}],"title":"Verdict"}},{"name":"tags","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"title":"Tags"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SimilaritiesResponse"},"example":{"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}}]}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessageModel"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessageModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"id":"similarity","security":[{"apiKey":[]}],"path":"/api/similarity-search/similarity","method":"get"}},"/api/docs":{"get":{"tags":["docs"],"summary":"Get API Docs","description":"Return API docs UI","operationId":"get_api_docs_api_docs_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"string","title":"Response Get Api Docs Api Docs Get"}},"text/plain":{"example":"\n                <!DOCTYPE html>\n                <html>\n                <head>\n                <link type=\"text/css\" rel=\"stylesheet\" href=\"/api/docs/styles\">\n                <link rel=\"shortcut icon\" href=\"\">\n                <title>OPSWAT Filescan - API Documentation</title>\n                </head>\n                <body>\n                <div id=\"swagger-ui\">\n                </div>\n                <script src=\"https://cdn.jsdelivr.net/npm/swagger-ui-dist@5/swagger-ui-bundle.js\"></script>\n                <!-- `SwaggerUIBundle` is now available on the page -->\n                <script>\n                const ui = SwaggerUIBundle({\n                    url: '/openapi.json',\n                \"dom_id\": \"#swagger-ui\",\n            \"layout\": \"BaseLayout\",\n            \"deepLinking\": true,\n            \"showExtensions\": true,\n            \"showCommonExtensions\": true,\n            \n                presets: [\n                    SwaggerUIBundle.presets.apis,\n                    SwaggerUIBundle.SwaggerUIStandalonePreset\n                    ],\n                })\n                </script>\n                </body>\n                </html>\n            "}}}},"id":"api-docs-ui","security":[{"apiKey":[]}],"path":"/api/docs","method":"get"}},"/openapi.json":{"get":{"tags":["docs"],"summary":"Get OpenAPI Endpoint","description":"Return API json data to be used by docs UI","operationId":"get_open_api_endpoint_openapi_json_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetOpenApiJsonResponse"},"example":{"openapi":"3.1.0","info":{"title":"OPSWAT Filescan","version":"1.0"},"paths":{"/api/scan/file":{"post":{"tags":["scan"],"summary":"Scan File","description":"Perform scan of uploaded file","operationId":"scan_file_api_scan_file_post","requestBody":{"content":{"multipart/form-data":{"schema":{"allOf":[{"$ref":"#/components/schemas/Body_scan_file_api_scan_file_post"}],"title":"Body"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScanResponse"},"example":{"flow_id":"66f1905b318df2831b854ce5","priority":{"applied":100,"max_possible":100}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessageModel"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessageModel"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessageModel"}}}},"413":{"description":"Content too large","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessageModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessageModel"}}}}},"id":"scan-file","security":[{"apiKey":[]},{}],"path":"/api/scan/file","method":"post"}}},"components":{"schemas":{"Body_scan_file_api_scan_file_post":{"properties":{"file":{"type":"string","format":"binary","title":"File"},"save_preset":{"type":"boolean","title":"Save Preset","default":false},"description":{"type":"string","title":"Description","description":"Uploaded file/url description"},"tags":{"type":"string","title":"Tags","description":"Tags array to propagate"},"propagate_tags":{"type":"boolean","title":"Propagate Tags","description":"If tags from description should be added to produced report(s)","default":true},"password":{"type":"string","title":"Password","description":"Custom password, in case uploaded archive is protected"},"is_private":{"type":"boolean","title":"Is Private","description":"If file should not be available for download by other users","default":false},"is_private_report":{"type":"boolean","title":"Is Private Report","description":"If the report should not be available for other users","default":false},"skip_whitelisted":{"type":"boolean","title":"Skip Whitelisted","description":"If file is detected as whitelisted, report is not created","default":false},"rapid_mode":{"type":"boolean","title":"Rapid Mode","description":"Disable some scan long-running features","default":false},"osint":{"type":"boolean","title":"Osint","description":"Enable OSINT (e.g. VirusTotal, ClamAV) lookups","default":true},"extended_osint":{"type":"boolean","title":"Extended Osint","description":"Enable OSINT lookups on extracted IOCs","default":true},"extracted_files_osint":{"type":"boolean","title":"Extracted Files Osint","description":"Enable OSINT lookups on extracted files","default":true},"visualization":{"type":"boolean","title":"Visualization","description":"Enable file visualization (e.g. PDF rendering)","default":true},"files_download":{"type":"boolean","title":"Files Download","description":"Enable download of files from extracted URLs","default":true},"resolve_domains":{"type":"boolean","title":"Resolve Domains","description":"Enable resolving domains to IPs (DNS)","default":true},"input_file_yara":{"type":"boolean","title":"Input File Yara","description":"Enable YARA rule matches on input file","default":true},"extracted_files_yara":{"type":"boolean","title":"Extracted Files Yara","description":"Enable YARA rule matches on extracted files","default":true},"whois":{"type":"boolean","title":"Whois","description":"Enable WHOIS record lookups","default":true},"ips_meta":{"type":"boolean","title":"Ips Meta","description":"Enable meta-data lookups for extracted IPs","default":true},"images_ocr":{"type":"boolean","title":"Images Ocr","description":"Enable OCR text recognition on extracted images","default":true}},"type":"object","title":"Body_scan_file_api_scan_file_post","required":["file"]},"ScanResponse":{"properties":{"flow_id":{"type":"string","title":"Flow Id"},"priority":{"$ref":"#/components/schemas/ScanPriorityResponse"}},"type":"object","required":["flow_id","priority"],"title":"ScanResponse","description":"Model for an initiated scan response"},"ErrorMessageModel":{"properties":{"detail":{"anyOf":[{"type":"string"},{"type":"object"}],"title":"Detail"}},"type":"object","required":["detail"],"title":"ErrorMessageModel"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"}},"securitySchemes":{"apiKey":{"type":"apiKey","in":"header","name":"X-Api-Key"}}},"tags":[{"name":"scan","description":"Upload file or URL resource for scan"},{"name":"reports","description":"Retrieve a variety of report related data"},{"name":"files","description":"Get a file by its hash or id in various format"},{"name":"feed","description":"Atom feed"},{"name":"users","description":"Report-related and other functionality used by ordinary users."},{"name":"system","description":"Various helper and system functionality."},{"name":"admin","description":"Functionality for site admins."},{"name":"audit-logger","description":"Audit Logger"},{"name":"threatintel","description":"Threat Intelligence"},{"name":"backend","description":"Backend wrapper"},{"name":"reputation","description":"Reputation"},{"name":"docs","description":"API documentation related"}]}}}}},"id":"api-data","security":[{"apiKey":[]}],"path":"/openapi.json","method":"get"}},"/api/users/stat/iocs":{"get":{"tags":["users"],"summary":"Get Ioc Stat","description":"Get app statistics","operationId":"get_ioc_stat_api_users_stat_iocs_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatForResponse"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessageModel"}}}}},"id":"user-ioc-stat","security":[{"apiKey":[]}],"path":"/api/users/stat/iocs","method":"get"}},"/api/users/get-frequent-tags":{"get":{"tags":["reports"],"summary":"Get Frequent Tags","description":"Get most frequently seen tags recently","operationId":"get_frequent_tags_api_users_get_frequent_tags_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FrequentTagsResponse"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessageModel"}}}}},"id":"frequent-tags","security":[{"apiKey":[]}],"path":"/api/users/get-frequent-tags","method":"get"}},"/api/users/most-interesting":{"get":{"tags":["reports"],"summary":"Get Most Interesting","description":"Get most interesting report recently","operationId":"get_most_interesting_api_users_most_interesting_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MostInterestingResponse"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessageModel"}}}}},"id":"most-interesting","security":[{"apiKey":[]}],"path":"/api/users/most-interesting","method":"get"}},"/api/feed/reports":{"get":{"tags":["feed"],"summary":"Get Reports Feed","description":"Get reports feed.\n\nFor 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.","operationId":"get_reports_feed_api_feed_reports_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessageModel"}}}}},"id":"get-reports-feed","security":[{"apiKey":[]}],"path":"/api/feed/reports","method":"get"}},"/api/feed/reports/info":{"get":{"tags":["feed"],"summary":"Get Reports Feed Info","description":"Get reports feed info","operationId":"get_reports_feed_info_api_feed_reports_info_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FeedInfo"},"example":{"count":38,"length":1161760,"updated":1731932169.007461,"download_allowed":true}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessageModel"}}}}},"id":"get-reports-feed-info","security":[{"apiKey":[]}],"path":"/api/feed/reports/info","method":"get"}},"/api/docs/sitemap":{"get":{"tags":["docs"],"summary":"Get Sitemap","description":"Get sitemap xml","operationId":"get_sitemap_api_docs_sitemap_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}},"id":"get-sitemap","security":[{"apiKey":[]}],"path":"/api/docs/sitemap","method":"get"}},"/api/reputation/hash":{"get":{"tags":["reputation"],"summary":"Get Reputation Hash","description":"Get the reputation for one given hash","operationId":"get_reputation_hash_api_reputation_hash_get","parameters":[{"name":"sha256","in":"query","required":true,"schema":{"type":"string","title":"Sha256"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReputationResultHash"},"example":{"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"}]}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessageModel"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessageModel"}}}},"415":{"description":"Unsupported media type","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessageModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"id":"get-reputation-hash","security":[{"apiKey":[]}],"path":"/api/reputation/hash","method":"get"},"post":{"tags":["reputation"],"summary":"Get Reputation Hash Bulk","description":"Get the reputation for more hashes","operationId":"get_reputation_hash_bulk_api_reputation_hash_post","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"string"},"title":"Payload"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ReputationResultHash"},"title":"Response Get Reputation Hash Bulk Api Reputation Hash Post"},"example":[{"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"}]}]}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessageModel"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessageModel"}}}},"415":{"description":"Unsupported media type","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessageModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"id":"get-reputation-hash-bulk","security":[{"apiKey":[]}],"path":"/api/reputation/hash","method":"post"}},"/api/reputation/{ioc_type}":{"get":{"tags":["reputation"],"summary":"Get Reputation Ioc","description":"Get the reputation for one given IOC","operationId":"get_reputation_ioc_api_reputation__ioc_type__get","parameters":[{"name":"ioc_type","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ReputationIocType"}},{"name":"ioc_value","in":"query","required":true,"schema":{"type":"string","title":"Ioc Value"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReputationResultIoc"},"example":{"ioc_type":"url","ioc_value":"https://netflix.com","overall_verdict":"malicious","mdcloud":{"scan_time":"2025-02-10T13:29:04.035000","detected":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"}]}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessageModel"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessageModel"}}}},"415":{"description":"Unsupported media type","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessageModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"id":"get-reputation-ioc","security":[{"apiKey":[]}],"path":"/api/reputation/{ioc_type}","method":"get"},"post":{"tags":["reputation"],"summary":"Get Reputation Ioc Bulk","description":"Get the reputation for more IOCs","operationId":"get_reputation_ioc_bulk_api_reputation__ioc_type__post","parameters":[{"name":"ioc_type","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ReputationIocType"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"string"},"title":"Payload"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ReputationResultIoc"},"title":"Response Get Reputation Ioc Bulk Api Reputation  Ioc Type  Post"},"example":[{"ioc_type":"url","ioc_value":"https://netflix.com","overall_verdict":"malicious","mdcloud":{"scan_time":"2025-02-10T13:29:04.035000","detected":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},"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"}]}]}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessageModel"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessageModel"}}}},"415":{"description":"Unsupported media type","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorMessageModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"id":"get-reputation-ioc-bulk","security":[{"apiKey":[]}],"path":"/api/reputation/{ioc_type}","method":"post"}}},"components":{"schemas":{"AddUserPayload":{"properties":{"email":{"type":"string","title":"Email"},"password":{"type":"string","title":"Password"},"username":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Username","default":""},"groups":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Groups"}},"type":"object","required":["email","password"],"title":"AddUserPayload","description":"Payload model for creating new user"},"AdminAppErrorNotePayload":{"properties":{"note":{"type":"string","title":"Note"}},"type":"object","required":["note"],"title":"AdminAppErrorNotePayload"},"AdminAppErrorResponse":{"properties":{"id":{"type":"string","title":"Id"},"type":{"$ref":"#/components/schemas/AppErrorType","title":"Error type"},"message":{"type":"string","title":"Exception message"},"url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Page url, where error happened"},"context":{"anyOf":[{"$ref":"#/components/schemas/AppErrorContext"},{"type":"null"}],"title":"Short description of context, in case there's no page url"},"trace":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Exception stack trace"},"first_occurance_date":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Date of first occurance"},"last_occurance_date":{"type":"string","format":"date-time","title":"Date of last occurance"},"occurance_count":{"type":"integer","title":"Occurance Count","description":"How often error was noticed","default":1},"is_signed_in":{"type":"boolean","title":"Is Signed In","description":"If user was signed in during error"},"report_flow_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Id of file upload"},"report_flow_file_sha256":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"SHA256 hash of file uploaded by user for scan"},"report_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Report id"},"report_file_sha256":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"SHA256 hash of file report was created for"},"note":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Note about error"}},"type":"object","required":["id","type","message","last_occurance_date","is_signed_in"],"title":"AdminAppErrorResponse"},"AdminAppErrorsRemovedResponse":{"properties":{"removed_count":{"type":"integer","title":"Removed Count"}},"type":"object","required":["removed_count"],"title":"AdminAppErrorsRemovedResponse"},"AdminAppErrorsResponse":{"properties":{"items":{"items":{"$ref":"#/components/schemas/AdminAppErrorResponse"},"type":"array","title":"Items"},"total_count":{"type":"integer","title":"Total Count"},"matched_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Matched Count"}},"type":"object","required":["items","total_count"],"title":"AdminAppErrorsResponse"},"AdminAppStatType":{"type":"string","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","count_report_feedbacks","count_product_feedbacks"],"title":"AdminAppStatType","description":"AppStatType list for admins"},"AdminConfig":{"properties":{"pageSize":{"type":"integer","title":"Pagesize"}},"type":"object","required":["pageSize"],"title":"AdminConfig","description":"Admin config model for SystemConfig response model"},"AdminDailyAppStatType":{"type":"string","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"],"title":"AdminDailyAppStatType","description":"AppStatType list for admins"},"AdminGenerateInviteLinkResponse":{"properties":{"groups":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Groups"}},"type":"object","title":"AdminGenerateInviteLinkResponse"},"AdminGenericLogNotePayload":{"properties":{"note":{"type":"string","title":"Note"}},"type":"object","required":["note"],"title":"AdminGenericLogNotePayload"},"AdminGenericLogResponse":{"properties":{"id":{"type":"string","title":"Id"},"key":{"type":"string","title":"Some key of logging record to easily search it by"},"key_type":{"$ref":"#/components/schemas/LoggingRecordKeyType","description":"User friendly note on logging record key"},"data":{"anyOf":[{},{"type":"null"}],"title":"Data","description":"Logging data itself"},"note":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Note","description":"Note describing log specifics"},"related_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Related Url","description":"Related site page, if it exists"},"saved_date":{"type":"string","format":"date-time","title":"Saved Date","description":"Date when logging record was created"}},"type":"object","required":["id","key","key_type"],"title":"AdminGenericLogResponse"},"AdminGenericLogsRemovedResponse":{"properties":{"removed_count":{"type":"integer","title":"Removed Count"}},"type":"object","required":["removed_count"],"title":"AdminGenericLogsRemovedResponse"},"AdminGenericLogsResponse":{"properties":{"items":{"items":{"$ref":"#/components/schemas/AdminGenericLogResponse"},"type":"array","title":"Items"},"total_count":{"type":"integer","title":"Total Count"},"matched_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Matched Count"}},"type":"object","required":["items","total_count"],"title":"AdminGenericLogsResponse"},"AdminGroupResponse":{"properties":{"id":{"type":"string","title":"Group ID"},"name":{"type":"string","maxLength":100,"title":"Group name"},"description":{"anyOf":[{"type":"string","maxLength":300},{"type":"null"}],"title":"Group description"},"default":{"type":"boolean","title":"Default","description":"If group is provided by app by default"}},"type":"object","required":["id","name","default"],"title":"AdminGroupResponse"},"AdminLoginPasswordCredentialsResponse":{"properties":{"login":{"type":"string","title":"Login"}},"type":"object","required":["login"],"title":"AdminLoginPasswordCredentialsResponse"},"AdminNewsPayload":{"properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Id"},"link":{"type":"string","title":"Link"},"date":{"type":"string","title":"Date"},"text":{"type":"string","title":"Text"},"images":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Images"},"order":{"type":"integer","title":"Order"},"active":{"type":"boolean","title":"Active"}},"type":"object","required":["link","date","text","order","active"],"title":"AdminNewsPayload"},"AdminRetentionCalculationResponse":{"properties":{"total_number_of_reports":{"type":"integer","title":"Total Number Of Reports"},"affected_number_of_reports":{"additionalProperties":true,"type":"object","title":"Affected Number Of Reports"}},"type":"object","required":["total_number_of_reports","affected_number_of_reports"],"title":"AdminRetentionCalculationResponse"},"AdminScanSourceConfigResponse":{"properties":{"id":{"type":"string","title":"Id"},"provider":{"type":"string","title":"Service provider name"},"name":{"type":"string","title":"Source name"},"source_type":{"$ref":"#/components/schemas/ScanSourceType","title":"Source type"},"host":{"type":"string","title":"Host to connect to"},"port":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Port to connect to"},"connection_security":{"anyOf":[{"$ref":"#/components/schemas/ScanSourceConnectionSecurity"},{"type":"null"}],"title":"Connection security type"},"folders":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Folders to download"},"remove_files_on_source":{"type":"boolean","title":"Remove Files On Source","description":"If we should remove files on source after scanning","default":false},"credentials":{"anyOf":[{"$ref":"#/components/schemas/AdminLoginPasswordCredentialsResponse"},{"$ref":"#/components/schemas/S3Credentials"}],"title":"Connect credentials","description":"Can have various fields depending on scan source"},"is_active":{"type":"boolean","title":"Is Active","description":"If config is activated for usage"},"source_type_specific":{"anyOf":[{"$ref":"#/components/schemas/EmailSourceOptions"},{"type":"null"}],"description":"Source type specific options"},"files_are_private":{"type":"boolean","title":"Files Are Private","description":"If all downloaded files should be scanned as private"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"Description field that should be added to all downloaded files"},"propagate_tags":{"type":"boolean","title":"Propagate Tags","description":"If tags should be extracted from description and added to reports"},"schedule":{"$ref":"#/components/schemas/ScheduleTaskConfigResponse","description":"Schedule to run scan source handlers"}},"type":"object","required":["id","provider","name","source_type","host","credentials","is_active","files_are_private","propagate_tags","schedule"],"title":"AdminScanSourceConfigResponse"},"AdminScanSourceFileConfigResponse":{"properties":{"id":{"type":"string","title":"Id"},"provider":{"type":"string","title":"Provider"},"name":{"type":"string","title":"Name"},"source_type":{"$ref":"#/components/schemas/ScanSourceType"}},"type":"object","required":["id","provider","name","source_type"],"title":"AdminScanSourceFileConfigResponse"},"AdminScanSourceFileDataResponse":{"properties":{"name":{"type":"string","title":"Name"},"hash":{"type":"string","title":"Hash"},"mime_type":{"type":"string","title":"Mime Type"}},"type":"object","required":["name","hash","mime_type"],"title":"AdminScanSourceFileDataResponse"},"AdminScanSourceFileResponse":{"properties":{"config":{"$ref":"#/components/schemas/AdminScanSourceFileConfigResponse","title":"Summary of config of scan source"},"file":{"anyOf":[{"$ref":"#/components/schemas/AdminScanSourceFileDataResponse"},{"type":"null"}],"description":"Some file data"},"state":{"$ref":"#/components/schemas/ScanSourceFileState","title":"File processing state"},"verdict":{"anyOf":[{"$ref":"#/components/schemas/ReportVerdict"},{"type":"null"}],"title":"Related report verdict","description":"Scan service decision about scanned file danger level"},"folder":{"type":"string","title":"Folder","description":"Unique path to file on source"},"id_on_source":{"type":"integer","title":"Id On Source","description":"Unique id of file in its folder on source"},"flow_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Flow Id","description":"Id of scan flow record"},"created_date":{"type":"string","format":"date-time","title":"Created Date","description":"Time of file record creation"},"created_date_on_source":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created Date On Source","description":"Date of file creation on source"},"downloaded_date":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Date/time of downloading"}},"type":"object","required":["config","state","folder","id_on_source","created_date"],"title":"AdminScanSourceFileResponse"},"AdminScanSourceSubjobResponse":{"properties":{"scan_source_config":{"$ref":"#/components/schemas/AdminScanSourceFileConfigResponse"},"config":{"$ref":"#/components/schemas/ScheduleTaskConfigResponse"},"state":{"$ref":"#/components/schemas/ScheduleTaskStateResponse"}},"type":"object","required":["scan_source_config","config","state"],"title":"AdminScanSourceSubjobResponse"},"AdminScanSourcesConfigsResponse":{"properties":{"items":{"items":{"$ref":"#/components/schemas/AdminScanSourceConfigResponse"},"type":"array","title":"Items"},"total_count":{"type":"integer","title":"Total Count"}},"type":"object","required":["items","total_count"],"title":"AdminScanSourcesConfigsResponse"},"AdminScanSourcesFilesResponse":{"properties":{"items":{"items":{"$ref":"#/components/schemas/AdminScanSourceFileResponse"},"type":"array","title":"Items"},"total_count":{"type":"integer","title":"Total Count"},"matched_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Matched Count"}},"type":"object","required":["items","total_count"],"title":"AdminScanSourcesFilesResponse"},"AdminScanSourcesRemoveResponse":{"properties":{"remove_count":{"type":"integer","title":"Remove Count"}},"type":"object","required":["remove_count"],"title":"AdminScanSourcesRemoveResponse"},"AdminScanSourcesSubjobsResponse":{"properties":{"items":{"items":{"$ref":"#/components/schemas/AdminScanSourceSubjobResponse"},"type":"array","title":"Items"},"total_count":{"type":"integer","title":"Total Count"},"matched_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Matched Count"}},"type":"object","required":["items","total_count"],"title":"AdminScanSourcesSubjobsResponse"},"AdminSettingOutput":{"properties":{"id":{"type":"string","title":"Id"},"name":{"type":"string","title":"Setting name"},"group":{"$ref":"#/components/schemas/SettingGroup","title":"Settings group name"},"subgroup":{"type":"string","title":"settings subgroup name"},"value":{"anyOf":[{"type":"integer"},{"type":"boolean"},{"type":"string"},{"items":{},"type":"array"},{"type":"null"}],"title":"Setting value"}},"type":"object","required":["id","name","group","subgroup"],"title":"AdminSettingOutput"},"AdminUserResponse":{"properties":{"id":{"type":"string","title":"User ID"},"account_id":{"type":"string","title":"Account ID","description":"Permanent id to use, say, in urls"},"email":{"type":"string","title":"Email"},"username":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Nick name","description":"User nickname in system"},"groups":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"User groups","description":"Groups user is a member of"},"confirmed":{"type":"boolean","title":"Email confirmed","default":false},"active":{"type":"boolean","title":"Is user active","default":false},"created_date":{"type":"string","format":"date-time","title":"Date of user creation"},"last_login_date":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Last login date"},"count_uploads":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Count Uploads","description":"Amount of user uploads","default":0},"is_service_account":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Service Account","description":"The account is used for automated services","default":false},"mdcloud_user_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Mdcloud User Id","description":"The internal user ID used in MD Cloud"}},"type":"object","required":["id","email"],"title":"AdminUserResponse"},"AdminUsersResponse":{"properties":{"items":{"items":{"$ref":"#/components/schemas/AdminUserResponse"},"type":"array","title":"Items"},"total_count":{"type":"integer","title":"Total Count"},"matched_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Matched Count"}},"type":"object","required":["items","total_count"],"title":"AdminUsersResponse"},"AiReportData":{"properties":{"source_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Source Id","description":"Id of analyzed portion of report. Usually - the `dataUUID` property"},"data_type":{"$ref":"#/components/schemas/AiReportDataType","description":"Type of data we request from AI"},"data":{"anyOf":[{"$ref":"#/components/schemas/AiReportDecompiledData"},{"type":"string"},{"type":"null"}],"title":"Data","description":"Data provided by AI. Not all data, but only portion of it that we need"},"created_date":{"type":"string","format":"date-time","title":"Created Date","description":"Date when AI data was received"}},"type":"object","required":["data_type"],"title":"AiReportData","description":"AI data, provided on some request to analyze some report data"},"AiReportDataType":{"type":"string","enum":["summary","decompiled_disassembly_section"],"title":"AiReportDataType","description":"Type of data we request from AI for report"},"AiReportDecompiledData":{"properties":{"functions":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Functions","description":"Extracted names of decompiled functions"},"summary":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Summary","description":"Generic summary on all functions"},"content":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Content","description":"Either only all functions with comments, or whole response if we failed to parse it"}},"type":"object","title":"AiReportDecompiledData","description":"Parsed data of decompiled disassembly section"},"AllUploadRelatedReportsResponse":{"properties":{"flowId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Flowid"},"allFinished":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Allfinished"},"allFilesDownloadFinished":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Allfilesdownloadfinished"},"allAdditionalStepsDone":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Alladditionalstepsdone"},"reportsAmount":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Reportsamount"},"priority":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Priority"},"pollPause":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Pollpause"},"state":{"anyOf":[{"$ref":"#/components/schemas/ScanState"},{"type":"null"}]},"scanStartedDate":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Scanstarteddate"},"positionInQueue":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Positioninqueue"},"queueSize":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Queuesize"},"fileSize":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Filesize"},"job":{"anyOf":[{"$ref":"#/components/schemas/JobError"},{"type":"null"}]},"fileReadProgressBytes":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Filereadprogressbytes"},"rejected_files":{"anyOf":[{"items":{"$ref":"#/components/schemas/RejectedFiles"},"type":"array"},{"type":"null"}],"title":"Rejected Files"},"sourceArchive":{"anyOf":[{"$ref":"#/components/schemas/SourceArchive"},{"type":"null"}]},"reports":{"additionalProperties":{"additionalProperties":true,"type":"object"},"type":"object","title":"Reports"}},"type":"object","required":["reports"],"title":"AllUploadRelatedReportsResponse","description":"Model for get_all_upload_related_reports() endpoint"},"ApiQuotaSecondsSettings":{"properties":{"seconds_amount":{"type":"integer","exclusiveMinimum":0.0,"title":"Seconds Amount","description":"Seconds period to count requests"},"requests":{"type":"integer","exclusiveMinimum":0.0,"title":"Requests","description":"Requests amount per seconds period"}},"type":"object","required":["seconds_amount","requests"],"title":"ApiQuotaSecondsSettings"},"ApiQuotaSetting":{"properties":{"route_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"API route id"},"groups":{"anyOf":[{"items":{"type":"string","examples":["5f85f36d6dfecacc68428a46","ffffffffffffffffffffffff"],"example":"5f85f36d6dfecacc68428a46"},"type":"array"},{"type":"null"}],"title":"User groups","description":"User groups to apply quota settings to"},"time_settings":{"anyOf":[{"$ref":"#/components/schemas/ApiQuotaTimeSettings"},{"type":"null"}],"description":"Requests limit for various time periods"},"id":{"type":"string","title":"Id","examples":["5f85f36d6dfecacc68428a46","ffffffffffffffffffffffff"],"example":"5f85f36d6dfecacc68428a46"}},"type":"object","title":"ApiQuotaSetting"},"ApiQuotaTimeSettings":{"properties":{"seconds":{"anyOf":[{"$ref":"#/components/schemas/ApiQuotaSecondsSettings"},{"type":"null"}],"title":"Seconds period settings"},"minute":{"anyOf":[{"type":"integer","exclusiveMinimum":0.0},{"type":"null"}],"title":"Minute","description":"Max requests amount per minute"},"hour":{"anyOf":[{"type":"integer","exclusiveMinimum":0.0},{"type":"null"}],"title":"Hour","description":"Max requests amount per hour"},"day":{"anyOf":[{"type":"integer","exclusiveMinimum":0.0},{"type":"null"}],"title":"Day","description":"Max requests amount per day"},"week":{"anyOf":[{"type":"integer","exclusiveMinimum":0.0},{"type":"null"}],"title":"Week","description":"Max requests amount per week"},"month":{"anyOf":[{"type":"integer","exclusiveMinimum":0.0},{"type":"null"}],"title":"Month","description":"Max requests amount per month"}},"type":"object","title":"ApiQuotaTimeSettings"},"AppErrorContext":{"type":"string","enum":["Scanning job","HTML/PDF report job","Scheduled job","Signin using external auth provider"],"title":"AppErrorContext","description":"Short description of error context"},"AppErrorSort":{"type":"string","enum":["date","count","note"],"title":"AppErrorSort","description":"Sort types of application error logs"},"AppErrorType":{"type":"string","enum":["server","client"],"title":"AppErrorType","description":"Type of application error that we can save"},"AppStat":{"properties":{"name":{"type":"string","title":"Statistics type"},"value":{"title":"Gathered statistics"},"period":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Period for which statistics was gathered"},"updated_date":{"type":"string","format":"date-time","title":"Updated Date"},"id":{"type":"string","title":"Id","examples":["5f85f36d6dfecacc68428a46","ffffffffffffffffffffffff"],"example":"5f85f36d6dfecacc68428a46"}},"type":"object","required":["name","value"],"title":"AppStat","description":"Generic statistic record.\n\nCan hold statistics of any type."},"AppStatResponse":{"properties":{"name":{"type":"string","title":"Name"},"value":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"integer"},{"items":{},"type":"array"},{"additionalProperties":true,"type":"object"}],"title":"Value"},"updated_date":{"type":"string","format":"date-time","title":"Updated Date"}},"type":"object","required":["name","value","updated_date"],"title":"AppStatResponse","description":"Return stat data to user"},"AppStatType":{"type":"string","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_c2_items","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","count_ips","count_domains","count_sha256","hourly_all_verdict_date_stats","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_mongodb","delete_reports_arangodb","postprocess_iocs","new_search_fix_search_params","count_initial_scan_jobs_by_date","count_rescan_jobs_by_date","count_mitre_techniques","load_mitre_data","load_mbc_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","mark_failed_reports_for_deletion","engine_database_update","remove_invalid_ips_stat","remove_invalid_tags_stat","remove_noisy_yara_stat","restrict_features_access","count_report_feedbacks","count_product_feedbacks","fix_otel_enabled_type","fix_strings_settings","cleanup_orphan_user_data","remove_weak_threat_indicators_from_stats","frequent_signal_tags","frequent_malware_tags"],"title":"AppStatType","description":"All available types of statistics (and other jobs, this class' name is not really precise)"},"AuditLogLevelFilter":{"type":"string","enum":["all","info","warning","error","fatal"],"title":"AuditLogLevelFilter"},"AuditLoggerType":{"type":"string","enum":["admin","auth"],"title":"AuditLoggerType"},"AuditLogsResponse":{"properties":{"items":{"items":{"additionalProperties":true,"type":"object"},"type":"array","title":"Items"},"total_count":{"type":"integer","title":"Total Count"},"matched_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Matched Count"}},"type":"object","required":["items","total_count"],"title":"AuditLogsResponse","description":"Response model for getting audit logs"},"Body_activate_license_offline_api_system_license_activate_offline_post":{"properties":{"app_server":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"App Server"}},"type":"object","title":"Body_activate_license_offline_api_system_license_activate_offline_post"},"Body_handle_signin_response_saml_api_auth_signin__service__callback_post":{"properties":{"SAMLResponse":{"type":"string","title":"Samlresponse"}},"type":"object","required":["SAMLResponse"],"title":"Body_handle_signin_response_saml_api_auth_signin__service__callback_post"},"Body_post_profile_api_users_profile_post":{"properties":{"email":{"type":"string","title":"Email"},"username":{"type":"string","title":"Username"},"old_password":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Old Password"},"new_password":{"type":"string","title":"New Password"},"password_confirm":{"type":"string","title":"Password Confirm"},"file":{"type":"string","contentMediaType":"application/octet-stream","title":"File"},"first_name":{"type":"string","title":"First Name"},"last_name":{"type":"string","title":"Last Name"},"phone":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Phone"},"company":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Company"},"job":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Job"},"role":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Role"},"department":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Department"},"industry":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Industry"},"subscribe":{"type":"boolean","title":"Subscribe","default":true},"theme":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Theme"},"timezone":{"anyOf":[{"$ref":"#/components/schemas/Timezones"},{"type":"null"}]},"locale":{"anyOf":[{"$ref":"#/components/schemas/Locales"},{"type":"null"}]},"feedback_notification_enabled":{"title":"Feedback Notification Enabled","default":true}},"type":"object","required":["email"],"title":"Body_post_profile_api_users_profile_post"},"Body_run_manual_engine_database_update_api_updates_engine_database_run_manual_post":{"properties":{"app_server":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"App Server"},"descriptor":{"type":"string","contentMediaType":"application/octet-stream","title":"Descriptor"},"database_package":{"type":"string","contentMediaType":"application/octet-stream","title":"Database Package"}},"type":"object","title":"Body_run_manual_engine_database_update_api_updates_engine_database_run_manual_post"},"Body_scan_file_api_scan_file_post":{"properties":{"file":{"anyOf":[{"type":"string","contentMediaType":"application/octet-stream"},{"type":"null"}],"title":"File"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"Uploaded file/url description","examples":["Sample description"],"metadata":[],"repr":true},"tags":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Tags","description":"Tags to propagate, separated by | (e.g. anti-vm|macros)","default":"","examples":["anti-vm|macros"],"metadata":[],"repr":true},"propagate_tags":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Propagate Tags","description":"If tags from description should be added to produced report(s)","default":true,"metadata":[],"repr":true},"password":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Password","description":"Custom password, in case uploaded archive is protected","metadata":[],"repr":true},"is_private":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Private","description":"If file should not be available for download by other users","default":false,"metadata":[],"repr":true},"is_private_report":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Private Report","description":"If the report should not be available for other users","default":false,"metadata":[],"repr":true},"skip_whitelisted":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Skip Whitelisted","description":"If file is detected as whitelisted, report is not created","default":false,"metadata":[],"repr":true},"scan_profile":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Scan Profile","description":"Id of scan profile, or name of preset scan profile (analysis or speed)","examples":["","analysis","speed"],"metadata":[],"repr":true},"scan_engine":{"anyOf":[{"$ref":"#/components/schemas/ScanEngine"},{"type":"null"}],"description":"Scan engine to use","metadata":[],"repr":true}},"type":"object","title":"Body_scan_file_api_scan_file_post","required":["file"]},"Body_scan_file_api_scan_url_post":{"properties":{"url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Url","description":"Url of internet resource to be scanned","metadata":[],"repr":true},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"Uploaded file/url description","examples":["Sample description"],"metadata":[],"repr":true},"tags":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Tags","description":"Tags to propagate, separated by | (e.g. anti-vm|macros)","default":"","examples":["anti-vm|macros"],"metadata":[],"repr":true},"propagate_tags":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Propagate Tags","description":"If tags from description should be added to produced report(s)","default":true,"metadata":[],"repr":true},"password":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Password","description":"Custom password, in case uploaded archive is protected","metadata":[],"repr":true},"is_private":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Private","description":"If file should not be available for download by other users","default":false,"metadata":[],"repr":true},"is_private_report":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Private Report","description":"If the report should not be available for other users","default":false,"metadata":[],"repr":true},"skip_whitelisted":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Skip Whitelisted","description":"If file is detected as whitelisted, report is not created","default":false,"metadata":[],"repr":true},"scan_profile":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Scan Profile","description":"Id of scan profile, or name of preset scan profile (analysis or speed)","examples":["","analysis","speed"],"metadata":[],"repr":true},"scan_engine":{"anyOf":[{"$ref":"#/components/schemas/ScanEngine"},{"type":"null"}],"description":"Scan engine to use","metadata":[],"repr":true}},"type":"object","title":"Body_scan_file_api_scan_url_post","required":["url"]},"Body_select_logo_api_admin_logos_select_post":{"properties":{"file":{"anyOf":[{"type":"string","contentMediaType":"application/octet-stream"},{"type":"null"}],"title":"File"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"type":{"$ref":"#/components/schemas/SiteLogoType"},"theme":{"$ref":"#/components/schemas/SiteTheme"}},"type":"object","required":["type","theme"],"title":"Body_select_logo_api_admin_logos_select_post"},"BuildType":{"type":"string","enum":["default","community","develop","onpremise"],"title":"BuildType"},"CasualPasswordPayload":{"properties":{"content":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}],"title":"Content","description":"Actual content of the password"},"description":{"anyOf":[{"type":"string","maxLength":100},{"type":"null"}],"title":"Description","description":"Describe what this password is used for"}},"type":"object","title":"CasualPasswordPayload","description":"Model for creating and editing a casual password"},"ContentType-Input":{"type":"string","enum":["base64","compressedBase64","raw"],"title":"ContentType"},"ContentType-Output":{"type":"string","enum":["base64","compressedBase64"],"title":"ContentType"},"DailySamplesArchiveResponse":{"properties":{"name":{"type":"string","title":"Name","description":"Archive file name"},"link":{"type":"string","title":"Link","description":"Link to file download"},"reports_date":{"type":"string","title":"Reports Date","description":"Date of reports creation"},"files_count":{"type":"integer","title":"Files Count","description":"Amount of files in archive"},"files_type":{"$ref":"#/components/schemas/DailySamplesArchiveType","description":"Generic type of files inside archive"},"size":{"type":"integer","title":"Size","description":"Archive size in bytes"},"is_public":{"type":"boolean","title":"Is Public","description":"If archive contains only public or only private files"}},"type":"object","required":["name","link","reports_date","files_count","files_type","size","is_public"],"title":"DailySamplesArchiveResponse"},"DailySamplesArchiveType":{"type":"string","enum":["doc","exec"],"title":"DailySamplesArchiveType"},"DailyYaraArchiveResponse":{"properties":{"name":{"type":"string","title":"Name","description":"Archive file name"},"link":{"type":"string","title":"Link","description":"Link to file download"},"reports_date":{"type":"string","title":"Reports Date","description":"Date of reports creation"},"rules_count":{"type":"integer","title":"Rules Count","description":"Amount of rules in archive"},"size":{"type":"integer","title":"Size","description":"Archive size in bytes"}},"type":"object","required":["name","link","reports_date","rules_count","size"],"title":"DailyYaraArchiveResponse"},"DateStatResponse":{"properties":{"date":{"type":"string","title":"Date"},"name":{"type":"string","title":"Name"},"value":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"integer"},{"items":{},"type":"array"},{"additionalProperties":true,"type":"object"}],"title":"Value"},"updated_date":{"type":"string","format":"date-time","title":"Updated Date"}},"type":"object","required":["date","name","value","updated_date"],"title":"DateStatResponse","description":"Return date stat data to user"},"DetailedScanState":{"type":"string","enum":["created","queued","scanning","queued_cancelled","changed_priority","failed","running_timedout"],"title":"DetailedScanState","description":"Extended scan states, used for statistics"},"DetailsResultSimilarity":{"properties":{"start_date":{"type":"string","format":"date-time","title":"Start Date"},"file_size":{"type":"number","title":"File Size"},"tags":{"items":{"type":"string"},"type":"array","title":"Tags"},"verdict":{"$ref":"#/components/schemas/ReportVerdict"},"is_dotnet":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Is Dotnet"},"architecture":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Architecture"},"entropy":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Entropy"}},"type":"object","required":["start_date","file_size","tags","verdict"],"title":"DetailsResultSimilarity"},"DoHealthcheckOutput":{"properties":{"created_date":{"type":"string","format":"date-time","title":"Creation date"},"frontend_health":{"$ref":"#/components/schemas/HealthLogFrontend","title":"Frontend health"},"webservice_health":{"$ref":"#/components/schemas/HealthLogWebservice","title":"Webservice health"},"fstransform_health":{"items":{"$ref":"#/components/schemas/HealthLogFstransform"},"type":"array","title":"Fstransform instances health"},"fsbroker_health":{"$ref":"#/components/schemas/HealthLogFsbroker","title":"Fsbroker health"}},"type":"object","required":["frontend_health","webservice_health","fstransform_health","fsbroker_health"],"title":"DoHealthcheckOutput"},"EditUserRequest":{"properties":{"active":{"type":"boolean","title":"Active"},"confirmed":{"type":"boolean","title":"Confirmed"},"groups":{"items":{"type":"string"},"type":"array","title":"Groups"},"is_service_account":{"type":"boolean","title":"Is Service Account"},"mdcloud_user_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Mdcloud User Id"}},"type":"object","required":["active","confirmed","groups","is_service_account"],"title":"EditUserRequest","description":"Request model to edit user"},"EmailFirstFetchMode":{"type":"string","enum":["all","recent","unseen"],"title":"EmailFirstFetchMode","description":"What emails to fetch on first time accessing account"},"EmailHistoryResponse":{"properties":{"items":{"items":{"$ref":"#/components/schemas/EmailQueueResponse"},"type":"array","title":"Items"},"total_count":{"type":"integer","title":"Total Count"}},"type":"object","required":["items","total_count"],"title":"EmailHistoryResponse"},"EmailQueueRequest":{"properties":{"recipient_type":{"$ref":"#/components/schemas/EmailRecipientType"},"recipient_emails":{"anyOf":[{"type":"string"},{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Recipient Emails"},"subject":{"type":"string","title":"Subject"},"content":{"type":"string","title":"Content"}},"type":"object","required":["recipient_type","subject","content"],"title":"EmailQueueRequest","description":"Email queue input model"},"EmailQueueResponse":{"properties":{"id":{"type":"string","title":"Id"},"recipient_type":{"$ref":"#/components/schemas/EmailRecipientType"},"recipient_emails":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Recipient Emails"},"subject":{"type":"string","title":"Subject"},"content":{"type":"string","title":"Content"},"state":{"$ref":"#/components/schemas/EmailSendingState"},"created_date":{"type":"string","format":"date-time","title":"Created Date"},"completed_date":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Completed Date"},"count_emails_sent":{"type":"integer","title":"Count Emails Sent"},"error":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Error"}},"type":"object","required":["id","recipient_type","subject","content","state","created_date","count_emails_sent"],"title":"EmailQueueResponse","description":"Data of email queue item that are shown to admins"},"EmailRecipientType":{"type":"string","enum":["all_users","admins","selected_users"],"title":"EmailRecipientType","description":"Recipient types of mass email sending"},"EmailSendingState":{"type":"string","enum":["created","queued","sending","succeeded","failed"],"title":"EmailSendingState","description":"State of email queue item processing"},"EmailSourceConfigRequest":{"properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Id"},"provider":{"type":"string","title":"Provider"},"name":{"type":"string","title":"Name"},"source_type":{"$ref":"#/components/schemas/ScanSourceType"},"host":{"type":"string","title":"Host"},"port":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Port"},"connection_security":{"anyOf":[{"$ref":"#/components/schemas/ScanSourceConnectionSecurity"},{"type":"null"}]},"folders":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Folders"},"remove_files_on_source":{"type":"boolean","title":"Remove Files On Source"},"credentials":{"anyOf":[{"$ref":"#/components/schemas/LoginPasswordCredentials"},{"$ref":"#/components/schemas/S3Credentials"}],"title":"Credentials"},"is_active":{"type":"boolean","title":"Is Active"},"source_type_specific":{"anyOf":[{"$ref":"#/components/schemas/EmailSourceOptions"},{"type":"null"}]},"files_are_private":{"type":"boolean","title":"Files Are Private"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"propagate_tags":{"type":"boolean","title":"Propagate Tags"},"schedule":{"$ref":"#/components/schemas/ScheduleTaskConfigClientside"}},"type":"object","required":["provider","name","source_type","host","remove_files_on_source","credentials","is_active","files_are_private","propagate_tags","schedule"],"title":"EmailSourceConfigRequest"},"EmailSourceOptions":{"properties":{"mark_as_seen":{"type":"boolean","title":"Mark As Seen","description":"If we should mark downloaded emails as seen on email service","default":false},"append_scanned_flag":{"type":"boolean","title":"Append Scanned Flag","description":"If we should add flag with scan result to email on service","default":false},"first_fetch_mode":{"$ref":"#/components/schemas/EmailFirstFetchMode","description":"Fetching mode to use when acccessing given email account for the first time"}},"type":"object","required":["first_fetch_mode"],"title":"EmailSourceOptions","description":"Options specific to email sources"},"EmailTemplatesResponse":{"properties":{"terms_change":{"anyOf":[{"type":"string"},{"type":"string","contentMediaType":"application/octet-stream"}],"title":"Terms Change"}},"type":"object","required":["terms_change"],"title":"EmailTemplatesResponse"},"EngineDatabaseUpdateInfo":{"properties":{"app_server":{"type":"string","title":"The name of the app server"},"status":{"$ref":"#/components/schemas/EngineDatabaseUpdateStatus","title":"The status of the engine instance","default":"active"},"error":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Any error messages from the last update attempt"},"active_package_version":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"The currently active database package version"},"is_fallback_active":{"type":"boolean","title":"If the engine is using the fallback package","default":false},"active_database_api_version":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"The currently active database API version"},"available_package_version":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"The latest available database package version"},"update_available":{"type":"boolean","title":"If an update is available","default":false},"last_update":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"The date of the last update attempt"},"modified_date":{"type":"string","format":"date-time","title":"The date of the last record modification"},"id":{"type":"string","title":"Id","examples":["5f85f36d6dfecacc68428a46","ffffffffffffffffffffffff"],"example":"5f85f36d6dfecacc68428a46"}},"type":"object","required":["app_server"],"title":"EngineDatabaseUpdateInfo","description":"Engine database update information"},"EngineDatabaseUpdateStatus":{"type":"string","enum":["active","in_progress","reverting"],"title":"EngineDatabaseUpdateStatus","description":"Status of the engine database update"},"ErrorMessageModel":{"properties":{"detail":{"anyOf":[{"type":"string"},{"additionalProperties":true,"type":"object"}],"title":"Detail"}},"type":"object","required":["detail"],"title":"ErrorMessageModel"},"ExternalAuthGroupsMapPayload":{"properties":{"local_group_id":{"type":"string","title":"Local Group Id"},"external_groups":{"items":{"type":"string"},"type":"array","title":"External Groups"}},"type":"object","required":["local_group_id","external_groups"],"title":"ExternalAuthGroupsMapPayload","description":"Map between local user groups and external groups"},"ExternalAuthType":{"type":"string","enum":["oauth","saml"],"title":"ExternalAuthType"},"ExternalServiceApiType":{"type":"string","enum":["microsoft_graph"],"title":"ExternalServiceApiType","description":"Supported APIs for OAuth providers"},"ExtraButtonConfig":{"properties":{"text":{"type":"string","title":"Text"},"link":{"type":"string","title":"Link"},"active":{"type":"boolean","title":"Active"}},"type":"object","required":["text","link","active"],"title":"ExtraButtonConfig","description":"ExtraButton config model for SystemConfig response model"},"FeedInfo":{"properties":{"count":{"type":"integer","title":"Count"},"length":{"type":"integer","title":"Length"},"updated":{"type":"number","title":"Updated"},"download_allowed":{"type":"boolean","title":"Download Allowed"}},"type":"object","required":["count","length","updated","download_allowed"],"title":"FeedInfo","description":"Response model for get_feed_info endpoint"},"Feedback":{"properties":{"type":{"$ref":"#/components/schemas/FeedbackType","description":"Type of feedback (report/product)"},"report":{"anyOf":[{"$ref":"#/components/schemas/FeedbackReport"},{"type":"null"}],"description":"Report information containing flow_id and report_id (in case of report feedback)"},"is_useful":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Useful","description":"Indicates if the feedback is positive or negative (in case of report feedback)"},"score":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Score","description":"Score given by the user (1-10) (in case of product feedback)"},"user_email":{"type":"string","title":"User Email","description":"Email of the user who submitted the feedback"},"created_date":{"type":"string","format":"date-time","title":"Created Date","description":"Time of feedback submission"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"Additional description provided by the user"},"versions":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Versions","description":"Versions of different components at the time of feedback submission"},"id":{"type":"string","title":"Id","examples":["5f85f36d6dfecacc68428a46","ffffffffffffffffffffffff"],"example":"5f85f36d6dfecacc68428a46"}},"type":"object","required":["type","user_email"],"title":"Feedback","description":"Feedbacks from users either about the product or specific reports "},"FeedbackListResponse":{"properties":{"items":{"items":{"$ref":"#/components/schemas/FeedbackResponse"},"type":"array","title":"Items","description":"List of feedback items"},"total_count":{"type":"integer","title":"Total Count","description":"Total number of feedbacks in database"},"matched_count":{"type":"integer","title":"Matched Count","description":"Number of feedbacks matching the query"}},"type":"object","required":["items","total_count","matched_count"],"title":"FeedbackListResponse","description":"Response model for paginated feedback list"},"FeedbackNotificationConfig":{"properties":{"frequency":{"type":"integer","title":"Frequency"},"minimumVerdict":{"$ref":"#/components/schemas/ReportVerdict"}},"type":"object","required":["frequency","minimumVerdict"],"title":"FeedbackNotificationConfig"},"FeedbackPayload":{"properties":{"type":{"$ref":"#/components/schemas/FeedbackType","description":"Type of feedback (report/product)"},"report":{"anyOf":[{"$ref":"#/components/schemas/FeedbackReport"},{"type":"null"}],"description":"Report information containing flow_id and report_id (in case of report feedback)"},"is_useful":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Useful","description":"Indicates if the feedback is positive or negative (in case of report feedback)"},"score":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Score","description":"Score given by the user (1-10) (in case of product feedback)"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"Additional description provided by the user"}},"type":"object","required":["type"],"title":"FeedbackPayload","description":"Payload for creating feedback (user input only)"},"FeedbackReport":{"properties":{"flow_id":{"type":"string","title":"Flow Id","description":"Flow ID of the report"},"report_id":{"type":"string","title":"Report Id","description":"Report ID of the report"}},"type":"object","required":["flow_id","report_id"],"title":"FeedbackReport","description":"Report information for report feedback"},"FeedbackResponse":{"properties":{"id":{"type":"string","title":"Id","description":"Feedback ID"},"type":{"type":"string","title":"Type","description":"Type of feedback (report/product)"},"report":{"anyOf":[{"$ref":"#/components/schemas/FeedbackReport"},{"type":"null"}],"description":"Report information containing flow_id and report_id (in case of report feedback)"},"is_useful":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Useful","description":"Indicates if the feedback is positive or negative (in case of report feedback)"},"score":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Score","description":"Score given by the user (1-10) (in case of product feedback)"},"user_email":{"type":"string","title":"User Email","description":"Email of the user who submitted the feedback"},"created_date":{"type":"string","format":"date-time","title":"Created Date","description":"Time of feedback submission"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"Additional description provided by the user"},"versions":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Versions","description":"Versions of different components at submission time"}},"type":"object","required":["id","type","user_email","created_date"],"title":"FeedbackResponse","description":"Response model for a single feedback"},"FeedbackType":{"type":"string","enum":["report","product"],"title":"FeedbackType"},"FileType":{"type":"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"],"title":"FileType","description":"All file types we support.\n\nThis list is used in reports' search form."},"FrequentTagsResponse":{"properties":{"tags":{"anyOf":[{"items":{"additionalProperties":true,"type":"object"},"type":"array"},{"type":"null"}],"title":"Tags"},"updated":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated"}},"type":"object","title":"FrequentTagsResponse"},"FuzzyhashVerdict":{"properties":{"hash":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Hash"},"verdict":{"$ref":"#/components/schemas/ReportVerdict"}},"type":"object","required":["verdict"],"title":"FuzzyhashVerdict","description":"Fuzzy hash verdict"},"GeneralSystemInfo":{"properties":{"title":{"type":"string","title":"Title"},"description":{"type":"string","title":"Description"},"api_version":{"type":"string","title":"Api Version"},"release_version":{"type":"string","title":"Release Version"},"release_date":{"type":"string","format":"date-time","title":"Release Date"}},"type":"object","required":["title","description","api_version","release_version","release_date"],"title":"GeneralSystemInfo","description":"Response model for /api/system/info endpoint"},"GenerateInviteTokenResponse":{"properties":{"token":{"type":"string","title":"Token"}},"type":"object","required":["token"],"title":"GenerateInviteTokenResponse"},"GenericLogSort":{"type":"string","enum":["date","note"],"title":"GenericLogSort","description":"Sort types of generic logs"},"GetCurrentUserResponse":{"properties":{"accountId":{"type":"string","title":"Accountid"},"userId":{"type":"string","title":"Userid"},"username":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Username"},"email":{"type":"string","title":"Email"},"avatarLastModified":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Avatarlastmodified"},"allowedFeatures":{"items":{},"type":"array","title":"Allowedfeatures"},"scanProfiles":{"items":{},"type":"array","title":"Scanprofiles"},"reportExportProfiles":{"items":{},"type":"array","title":"Reportexportprofiles"},"isAdmin":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Isadmin"},"isAuditor":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Isauditor"},"isPasswordEmpty":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Ispasswordempty"},"theme":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Theme"},"timezone":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Timezone"},"locale":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Locale"},"externalAuth":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Externalauth"},"notifications":{"anyOf":[{"items":{},"type":"array"},{"type":"null"}],"title":"Notifications"},"casualPasswords":{"anyOf":[{"items":{},"type":"array"},{"type":"null"}],"title":"Casualpasswords"},"feedbackNotificationEnabled":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Feedbacknotificationenabled"}},"type":"object","required":["accountId","userId","email","allowedFeatures","scanProfiles","reportExportProfiles"],"title":"GetCurrentUserResponse"},"GetOpenApiJsonResponse":{"properties":{"openapi":{"type":"string","title":"Openapi"},"info":{"$ref":"#/components/schemas/OpenApiInfo"},"paths":{"additionalProperties":{"additionalProperties":true,"type":"object"},"type":"object","title":"Paths"},"components":{"$ref":"#/components/schemas/OpenApiComponents"},"tags":{"items":{"$ref":"#/components/schemas/OpenApiTags"},"type":"array","title":"Tags"}},"type":"object","required":["openapi","info","paths","components","tags"],"title":"GetOpenApiJsonResponse","description":"Response model for get_open_api_endpoint()"},"GetSingleFileResponse":{"properties":{"type":{"$ref":"#/components/schemas/ContentType-Output"},"content":{"type":"string","title":"Content"}},"type":"object","required":["type","content"],"title":"GetSingleFileResponse","description":"Model for get_single_file() endpoint"},"GroupOut":{"properties":{"name":{"type":"string","title":"Name"}},"type":"object","required":["name"],"title":"GroupOut","description":"Users' group for out"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"HealthLogFrontend":{"properties":{"http_info":{"$ref":"#/components/schemas/HealthLogHttp","title":"HTTP check info"},"calculated_health":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Shows the calculated health","default":false}},"type":"object","required":["http_info"],"title":"HealthLogFrontend","description":"Frontent health log"},"HealthLogFsbroker":{"properties":{"http_info":{"$ref":"#/components/schemas/HealthLogHttp","title":"HTTP check info"},"response":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Response from system info"},"calculated_health":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Shows the calculated health","default":false}},"type":"object","required":["http_info"],"title":"HealthLogFsbroker","description":"Fsbroker health log"},"HealthLogFstransform":{"properties":{"response":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Response from system info"},"instance_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Fstranfsform instance ID"},"calculated_health":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Shows the calculated health","default":false}},"type":"object","title":"HealthLogFstransform","description":"Fstransform health log"},"HealthLogHttp":{"properties":{"response_time_ms":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Response time in ms"},"response_code_http":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"HTTP response code"},"request_success":{"type":"boolean","title":"Request was successfully made or not"}},"type":"object","required":["request_success"],"title":"HealthLogHttp","description":"HTTP health log"},"HealthLogWebservice":{"properties":{"http_info_direct":{"$ref":"#/components/schemas/HealthLogHttp","title":"Direct HTTP check info"},"response_direct":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Response from direct healthcheck"},"http_info_nginx":{"$ref":"#/components/schemas/HealthLogHttp","title":"NGINX HTTP check info"},"response_nginx":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Response from nginx healthcheck"},"number_of_all_users":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Number of all users in the system"},"number_of_active_users":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Number of active users in the system, who logged in in the last 2 weeks"},"tasks_queues":{"anyOf":[{"$ref":"#/components/schemas/TasksQueueHealthVerdictAll"},{"type":"null"}],"description":"Health result of scan tasks queues"},"calculated_health":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Shows the calculated health","default":false}},"type":"object","required":["http_info_direct","http_info_nginx"],"title":"HealthLogWebservice","description":"Webservice health log"},"IOCPrevalenceReport":{"properties":{"flow_id":{"type":"string","title":"Flow Id"},"report_id":{"type":"string","title":"Report Id"},"file":{"anyOf":[{"$ref":"#/components/schemas/IOCPrevalenceReportFile"},{"type":"null"}]},"verdict":{"$ref":"#/components/schemas/ReportVerdict"},"created_date":{"type":"string","format":"date-time","title":"Created Date"}},"type":"object","required":["flow_id","report_id","verdict","created_date"],"title":"IOCPrevalenceReport","description":"Report item in prevalence response"},"IOCPrevalenceReportFile":{"properties":{"name":{"type":"string","title":"Name"},"sha256":{"type":"string","title":"Sha256"}},"type":"object","required":["name","sha256"],"title":"IOCPrevalenceReportFile","description":"File name and hash"},"IOCs":{"type":"string","enum":["domain","ip","url","uuid","email","registry_path","revision_save_id","sha1","sha256","sha512","md5","imphash","ssdeep","authentihash","fuzzyfsiohash","unc_path"],"title":"IOCs","description":"List of possible IOCs for prevalence"},"IOCsConfig":{"properties":{"prevalenceExceptWhitelists":{"type":"boolean","title":"Prevalenceexceptwhitelists"},"genQueryExceptWhitelists":{"type":"boolean","title":"Genqueryexceptwhitelists"},"prevalenceDayOptions":{"items":{"$ref":"#/components/schemas/THREATINTEL_PREVALENCE_DAY_OPTIONS"},"type":"array","title":"Prevalencedayoptions"}},"type":"object","required":["prevalenceExceptWhitelists","genQueryExceptWhitelists","prevalenceDayOptions"],"title":"IOCsConfig","description":"IOCs config model for SystemConfig response model"},"IOCsPrevalenceResponse":{"properties":{"counts":{"additionalProperties":{"type":"integer"},"propertyNames":{"$ref":"#/components/schemas/ReportVerdict"},"type":"object","title":"Counts"},"reports":{"items":{"$ref":"#/components/schemas/IOCPrevalenceReport"},"type":"array","title":"Reports"},"verdict":{"$ref":"#/components/schemas/ReportVerdict"}},"type":"object","required":["counts","reports","verdict"],"title":"IOCsPrevalenceResponse","description":"Prevalence response model"},"IOCsPrevalenceSearchParams":{"properties":{"domain":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Domain","default":[]},"ip":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Ip","default":[]},"url":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Url","default":[]},"uuid":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Uuid","default":[]},"email":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Email","default":[]},"registry_path":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Registry Path","default":[]},"revision_save_id":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Revision Save Id","default":[]},"sha1":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Sha1","default":[]},"sha256":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Sha256","default":[]},"sha512":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Sha512","default":[]},"md5":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Md5","default":[]},"imphash":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Imphash","default":[]},"ssdeep":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Ssdeep","default":[]},"authentihash":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Authentihash","default":[]},"fuzzyfsiohash":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Fuzzyfsiohash","default":[]},"unc_path":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Unc Path","default":[]},"days":{"type":"integer","maximum":30.0,"exclusiveMinimum":0.0,"title":"Days","default":30}},"type":"object","title":"IOCsPrevalenceSearchParams","description":"Params for IOCs' prevalence search"},"IocDatesCount":{"properties":{"date":{"type":"string","title":"Date"},"value":{"type":"integer","title":"Value"}},"type":"object","required":["date","value"],"title":"IocDatesCount"},"IocsDatesCountForStatType":{"properties":{"name":{"type":"string","title":"Name"},"stat":{"items":{"$ref":"#/components/schemas/IocDatesCount"},"type":"array","title":"Stat"}},"type":"object","required":["name","stat"],"title":"IocsDatesCountForStatType"},"IocsDatesCountResponse":{"properties":{"stat_name":{"anyOf":[{"$ref":"#/components/schemas/VerdictDateGenericStatName"},{"$ref":"#/components/schemas/VerdictDateStandaloneStatName"}],"title":"Stat Name"},"items":{"items":{"$ref":"#/components/schemas/IocsDatesCountForStatType"},"type":"array","title":"Items"}},"type":"object","required":["stat_name","items"],"title":"IocsDatesCountResponse","description":"Return result of getting count of IOCs per dates"},"IocsOfStatType":{"properties":{"items":{"items":{"type":"string"},"type":"array","title":"Items"},"stat_name":{"anyOf":[{"$ref":"#/components/schemas/VerdictDateGenericStatName"},{"$ref":"#/components/schemas/VerdictDateStandaloneStatName"}],"title":"Stat Name"}},"type":"object","required":["items","stat_name"],"title":"IocsOfStatType"},"IocsStatPayload":{"properties":{"data":{"items":{"$ref":"#/components/schemas/IocsOfStatType"},"type":"array","title":"Data"}},"type":"object","required":["data"],"title":"IocsStatPayload"},"IocsVerdictsResponse":{"properties":{"stat_name":{"anyOf":[{"$ref":"#/components/schemas/VerdictDateGenericStatName"},{"$ref":"#/components/schemas/VerdictDateStandaloneStatName"}],"title":"Stat Name"},"items":{"additionalProperties":{"$ref":"#/components/schemas/ReportVerdict"},"type":"object","title":"Items"}},"type":"object","required":["stat_name","items"],"title":"IocsVerdictsResponse","description":"Return verdicts for provided IOCs"},"ItemsOrder":{"type":"string","enum":["asc","desc"],"title":"ItemsOrder","description":"In case user needs to specify the order of requested items"},"JobError":{"properties":{"error":{"type":"boolean","title":"Error"},"reason":{"type":"string","title":"Reason"}},"type":"object","required":["error","reason"],"title":"JobError","description":"Model for job field in AllUploadRelatedReportsResponse"},"JobsConfig":{"properties":{"memoryLimit":{"type":"integer","title":"Memorylimit"},"chartControlTime":{"type":"integer","title":"Chartcontroltime"},"memoryUsageTop":{"type":"integer","title":"Memoryusagetop"}},"type":"object","required":["memoryLimit","chartControlTime","memoryUsageTop"],"title":"JobsConfig","description":"Jobs config model for SystemConfig response model"},"Language":{"type":"string","enum":["en","de","zh","es","hi","ar","pt","bn","ru","ja","ko","fr","te","mr","tr","ta","vi","ur"],"title":"Language"},"LanguageData":{"properties":{"name":{"type":"string","title":"Language name"},"country_code":{"type":"string","title":"ISO 3166-1 alpha-2 country code"}},"type":"object","required":["name","country_code"],"title":"LanguageData","description":"Language data model with name and country code"},"LanguagesConfig":{"properties":{"language":{"type":"string","title":"Language"},"code":{"type":"string","title":"Code"}},"type":"object","required":["language","code"],"title":"LanguagesConfig","description":"Languages config model for SystemConfig response model"},"LicenseActivateOnlinePayload":{"properties":{"app_server":{"type":"string","title":"App Server"},"license_key":{"type":"string","title":"License Key"}},"type":"object","required":["app_server","license_key"],"title":"LicenseActivateOnlinePayload"},"LicenseInfoFstransformDict":{"properties":{"application_servers":{"additionalProperties":{"$ref":"#/components/schemas/ScanEngineServerInfo"},"type":"object","title":"Fstransform instances license info","default":{}},"aggregated_license_info":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Shows aggregated license info, false if any of the instances is not validated","default":false},"license_expiration":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"License expiration time in days","default":0},"expiration_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"License expiration date","default":""},"aggregated_health":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Shows the aggregated health","default":false},"activation_method":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Activation method","default":""}},"type":"object","title":"LicenseInfoFstransformDict","description":"Aggregated Fstransform license info"},"LicenseResponse":{"properties":{"http_info":{"$ref":"#/components/schemas/HealthLogHttp","title":"HTTP check info"},"response":{"anyOf":[{"additionalProperties":true,"type":"object"},{"$ref":"#/components/schemas/LicenseInfoFstransformDict"},{"type":"null"}],"title":"License info response"},"message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Response message"},"calculated_health":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Shows the calculated health","default":false}},"type":"object","required":["http_info"],"title":"LicenseResponse","description":"Fsbroker health log"},"Locales":{"type":"string","enum":["de","en","hu","it","nl","sv"],"title":"Locales"},"LoggingRecordKeyType":{"type":"string","enum":["scan_init_id","new_search"],"title":"LoggingRecordKeyType","description":"Type of key attribute for logging record"},"LoginPasswordCredentials":{"properties":{"login":{"type":"string","title":"Login"},"password":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Password"}},"type":"object","required":["login"],"title":"LoginPasswordCredentials","description":"Standard credentials with login/password"},"LogoSelectedTimeConfig":{"properties":{"light":{"$ref":"#/components/schemas/LogoTypeSelectedTimeConfig"},"dark":{"$ref":"#/components/schemas/LogoTypeSelectedTimeConfig"}},"type":"object","required":["light","dark"],"title":"LogoSelectedTimeConfig","description":"LogoSelectedTime config model for SystemConfig response model"},"LogoTypeSelectedTimeConfig":{"properties":{"main":{"type":"integer","title":"Main"},"top_menu":{"type":"integer","title":"Top Menu"},"footer":{"type":"integer","title":"Footer"}},"type":"object","required":["main","top_menu","footer"],"title":"LogoTypeSelectedTimeConfig","description":"LogoTypeSelectedTime config model for LogoSelectedTimeConfig model"},"MainTaskSimplifiedState":{"type":"string","enum":["success","failed","in_progress"],"title":"MainTaskSimplifiedState"},"MaintenanceConfig":{"properties":{"blockScan":{"type":"boolean","title":"Blockscan"},"blockScanNotification":{"type":"string","title":"Blockscannotification"},"blockSearch":{"type":"boolean","title":"Blocksearch"},"blockSearchNotification":{"type":"string","title":"Blocksearchnotification"}},"type":"object","required":["blockScan","blockScanNotification","blockSearch","blockSearchNotification"],"title":"MaintenanceConfig","description":"Maintenance config model for SystemConfig response model"},"MatchesOrigin":{"properties":{"origin":{"$ref":"#/components/schemas/MatchesOriginData"},"matches":{"additionalProperties":true,"type":"object","title":"Matches"}},"type":"object","required":["origin","matches"],"title":"MatchesOrigin","description":"Model of single origin match for matches API response"},"MatchesOriginData":{"properties":{"sha256":{"type":"string","title":"Sha256"},"filetype":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Filetype"},"mime_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Mime Type"},"relation":{"type":"string","title":"Relation"}},"type":"object","required":["sha256","relation"],"title":"MatchesOriginData","description":"Model of single origin match for matches API response"},"MatchesPayload":{"properties":{"reports_ids":{"items":{"type":"string"},"type":"array","title":"Reports Ids"}},"type":"object","required":["reports_ids"],"title":"MatchesPayload"},"MatchesResponseItem":{"properties":{"report_id":{"type":"string","title":"Report Id"},"matches":{"items":{"$ref":"#/components/schemas/MatchesOrigin"},"type":"array","title":"Matches"}},"type":"object","required":["report_id","matches"],"title":"MatchesResponseItem","description":"Response from search's matches API endpoint"},"MbcBehaviorResponse":{"properties":{"id":{"type":"string","title":"Id"},"name":{"type":"string","title":"Name"},"description":{"type":"string","title":"Description"}},"type":"object","required":["id","name","description"],"title":"MbcBehaviorResponse","description":"Response data for MBC behavior"},"MbcDataResponse":{"properties":{"behaviors":{"additionalProperties":{"$ref":"#/components/schemas/MbcBehaviorResponse"},"type":"object","title":"Behaviors"},"id":{"type":"string","title":"Id"},"name":{"type":"string","title":"Name"},"description":{"type":"string","title":"Description"}},"type":"object","required":["behaviors","id","name","description"],"title":"MbcDataResponse","description":"Response model for getting MBC data"},"MitreDataResponse":{"properties":{"techniques":{"additionalProperties":{"$ref":"#/components/schemas/MitreTechnique"},"type":"object","title":"Techniques"},"id":{"type":"string","title":"Id"},"name":{"type":"string","title":"Name"},"description":{"type":"string","title":"Description"}},"type":"object","required":["techniques","id","name","description"],"title":"MitreDataResponse","description":"Response model for /api/system/mitre endpoint"},"MitreTechnique":{"properties":{"id":{"type":"string","title":"Id"},"name":{"type":"string","title":"Name"},"description":{"type":"string","title":"Description"}},"type":"object","required":["id","name","description"],"title":"MitreTechnique","description":"MitreTechnique model for MitreDataResponse model"},"ModifyVerdictPayload":{"properties":{"verdict":{"$ref":"#/components/schemas/ReportVerdict"},"report_id":{"type":"string","title":"Report Id"}},"type":"object","required":["verdict","report_id"],"title":"ModifyVerdictPayload","description":"New verdict and report id"},"MostInterestingResponse":{"properties":{"report":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Report"},"updated":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated"}},"type":"object","title":"MostInterestingResponse"},"NewsItemResponse":{"properties":{"id":{"type":"string","title":"Id"},"link":{"type":"string","title":"News URL"},"date":{"type":"string","title":"Date","description":"Represenation of news date, is shown as is"},"text":{"type":"string","title":"News text"},"images":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Images","description":"Comma separated list of images URLs"},"order":{"type":"integer","title":"Order","description":"In what order news should be shown"},"active":{"type":"boolean","title":"Active","description":"If this news item should be shown"}},"type":"object","required":["id","link","date","text","order","active"],"title":"NewsItemResponse"},"OCMConfig":{"properties":{"clientUrl":{"type":"string","title":"Clienturl"}},"type":"object","required":["clientUrl"],"title":"OCMConfig","description":"OCM config model for SystemConfig response model"},"OcmEnrollPayload":{"properties":{"ocm_version":{"$ref":"#/components/schemas/OcmMajorVersion","description":"OCM version user wants to enroll to"},"server_url":{"type":"string","title":"Server Url","description":"Base URL of OCM server"},"registration_code":{"type":"string","title":"Registration Code","description":"Code to reveice API key to interact with OCM"}},"type":"object","required":["ocm_version","server_url","registration_code"],"title":"OcmEnrollPayload"},"OcmIntegrationStateName":{"type":"string","enum":["not_enrolled","enrolled","unenrolled"],"title":"OcmIntegrationStateName"},"OcmIntegrationStateResponse":{"properties":{"ocm_version":{"$ref":"#/components/schemas/OcmMajorVersion","description":"Current version of OCM instance is enrolled to"},"server_url":{"type":"string","title":"Server Url","description":"Base url of OCM server"},"registration_code":{"type":"string","title":"Registration Code","description":"Code used for obtaining API key for interaction with OCM"},"state":{"$ref":"#/components/schemas/OcmIntegrationStateName","description":"Current enrollment state"},"disconnected":{"type":"boolean","title":"Disconnected","description":"If we failed to establish connection with OCM"},"last_connection_date":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Last Connection Date","description":"Last time connection was done to OCM"},"last_connection_attempt_date":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Last Connection Attempt Date","description":"Last time we tried to edtablish connection with OCM"},"app_server":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"App Server","description":"Application server's name for which license was activated"},"last_config_sync_date":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Last Config Sync Date","description":"Last time we synced config with OCM"},"config_synced":{"type":"boolean","title":"Config Synced","description":"If config has been synced with OCM successfully"}},"type":"object","required":["ocm_version","server_url","registration_code","state","disconnected","config_synced"],"title":"OcmIntegrationStateResponse"},"OcmMajorVersion":{"type":"integer","enum":[8,10],"title":"OcmMajorVersion"},"OcmUnenrollPayload":{"properties":{"force":{"type":"boolean","title":"Force","description":"Clear local enrollment data","default":false}},"type":"object","title":"OcmUnenrollPayload"},"OpenApiComponents":{"properties":{"schemas":{"additionalProperties":{"additionalProperties":true,"type":"object"},"type":"object","title":"Schemas"},"securitySchemes":{"$ref":"#/components/schemas/OpenApiComponentsSecuritySchemes"}},"type":"object","required":["schemas","securitySchemes"],"title":"OpenApiComponents"},"OpenApiComponentsSecuritySchemes":{"properties":{"apiKey":{"$ref":"#/components/schemas/OpenApiSecuritySchemesApiKey"}},"type":"object","required":["apiKey"],"title":"OpenApiComponentsSecuritySchemes"},"OpenApiInfo":{"properties":{"title":{"type":"string","title":"Title"},"version":{"type":"string","title":"Version"}},"type":"object","required":["title","version"],"title":"OpenApiInfo"},"OpenApiSecuritySchemesApiKey":{"properties":{"type":{"type":"string","title":"Type"},"in":{"type":"string","title":"In"},"name":{"type":"string","title":"Name"}},"type":"object","required":["type","in","name"],"title":"OpenApiSecuritySchemesApiKey"},"OpenApiTags":{"properties":{"name":{"type":"string","title":"Name"},"description":{"type":"string","title":"Description"}},"type":"object","required":["name","description"],"title":"OpenApiTags"},"PEEmulationFile":{"type":"string","enum":["symbols.json","api_log.json"],"title":"PEEmulationFile","description":"PE emulation file names"},"PasswordConfig":{"properties":{"alpha_numeric":{"type":"boolean","title":"Alpha Numeric"},"minimum_length":{"type":"integer","title":"Minimum Length"},"mixed_case":{"type":"boolean","title":"Mixed Case"},"special_characters":{"type":"boolean","title":"Special Characters"}},"type":"object","required":["alpha_numeric","minimum_length","mixed_case","special_characters"],"title":"PasswordConfig","description":"Password config model for SystemConfig response model"},"ProfileResponse":{"properties":{"first_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"First Name"},"last_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Last Name"},"phone":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Phone"},"company":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Company"},"job":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Job"},"role":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Role"},"department":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Department"},"industry":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Industry"},"subscribe":{"type":"boolean","title":"Subscribe"}},"type":"object","required":["subscribe"],"title":"ProfileResponse"},"PublicityType":{"type":"string","enum":["public","private"],"title":"PublicityType"},"QueryIntervalConfig":{"properties":{"initial":{"type":"integer","title":"Initial"},"withData":{"type":"integer","title":"Withdata"}},"type":"object","required":["initial","withData"],"title":"QueryIntervalConfig","description":"QueryInterval config model for ReportsConfig model"},"REPORTS_SEARCH_PAGE_SIZE_OPTIONS":{"type":"integer","enum":[5,10,20],"title":"REPORTS_SEARCH_PAGE_SIZE_OPTIONS"},"RawReportResponse":{"properties":{"scan_init":{"additionalProperties":true,"type":"object","title":"Scan Init"},"reports":{"items":{"additionalProperties":true,"type":"object"},"type":"array","title":"Reports"}},"type":"object","required":["scan_init","reports"],"title":"RawReportResponse","description":"Model for report raw format"},"RefreshTokenPayload":{"properties":{"token":{"type":"string","title":"Token"}},"type":"object","required":["token"],"title":"RefreshTokenPayload"},"RejectedFiles":{"properties":{"name":{"type":"string","title":"Name"},"rejected_reason":{"type":"string","title":"Rejected Reason"}},"type":"object","required":["name","rejected_reason"],"title":"RejectedFiles","description":"Model for rejected_files field in AllUploadRelatedReportsResponse"},"RepoInfo":{"properties":{"revision":{"type":"string","title":"Revision"},"url":{"type":"string","title":"Url"}},"type":"object","required":["revision","url"],"title":"RepoInfo"},"ReportAllFilesResponse":{"properties":{"id":{"type":"string","title":"Id"},"hash":{"type":"string","title":"Hash"},"size":{"type":"integer","title":"Size"},"mediaType":{"type":"string","title":"Mediatype"},"type":{"$ref":"#/components/schemas/ReportFileTypeInput"}},"type":"object","required":["id","hash","size","mediaType","type"],"title":"ReportAllFilesResponse","description":"Model for get_all_files() endpoint"},"ReportExportProfilePayload":{"properties":{"name":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}],"title":"Name","description":"Export profile's name"},"description":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}],"title":"Description","description":"Description about the profile"},"is_default":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Default","description":"Is the profile used as default"},"options":{"anyOf":[{"$ref":"#/components/schemas/ReportFormatSettings"},{"type":"null"}],"description":"Format options on export"}},"type":"object","title":"ReportExportProfilePayload","description":"User provided data to edit scan profile"},"ReportFileTypeInput":{"type":"string","enum":["all","extracted","downloaded"],"title":"ReportFileTypeInput","description":"Smaller set of ReportFileType for the get_all_files() endpoint"},"ReportForReputationCalculation":{"properties":{"verdict":{"$ref":"#/components/schemas/ReportVerdict"},"report_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Report Date"},"report_id":{"type":"string","title":"Report Id"},"flow_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Flow Id"}},"type":"object","required":["verdict","report_id"],"title":"ReportForReputationCalculation","description":"Report with verdict date and ID"},"ReportFormat":{"type":"string","enum":["misp","stix","html","pdf"],"title":"ReportFormat"},"ReportFormatItemResponse":{"properties":{"id":{"type":"string","title":"Id"},"flow_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Flow Id"},"file_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"File Name"},"file_sha256":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"File Sha256"},"verdict":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Verdict"},"report_id":{"type":"string","title":"Report Id"},"format":{"$ref":"#/components/schemas/ReportFormatSlow"},"state":{"$ref":"#/components/schemas/ReportFormatState"},"created_date":{"type":"string","format":"date-time","title":"Created Date"},"started_date":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Started Date"},"finished_date":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Finished Date"},"settings":{"$ref":"#/components/schemas/ReportFormatSettings"}},"type":"object","required":["id","report_id","format","state","created_date","settings"],"title":"ReportFormatItemResponse","description":"Report format record data, returned to user"},"ReportFormatResponse":{"properties":{"items":{"items":{"$ref":"#/components/schemas/ReportFormatItemResponse"},"type":"array","title":"Items"},"count":{"type":"integer","title":"Count"}},"type":"object","required":["items","count"],"title":"ReportFormatResponse"},"ReportFormatSettings":{"properties":{"all_pages":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"All Pages","description":"Include all pages in the report"},"pages":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Pages","description":"Specify which pages to include in the report"},"strings_limit":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Strings Limit","description":"Limit for report format strings"},"strings_mode":{"anyOf":[{"$ref":"#/components/schemas/ReportFormatStringsMode"},{"type":"null"}],"description":"Mode for report format strings"}},"type":"object","title":"ReportFormatSettings","description":"Options to configure report export profile"},"ReportFormatSlow":{"type":"string","enum":["html","pdf"],"title":"ReportFormatSlow","description":"Formats that can take a lot of time to be generated"},"ReportFormatState":{"type":"string","enum":["created","queued","in_progress","failed","success"],"title":"ReportFormatState","description":"State of report generation"},"ReportFormatStringsMode":{"type":"string","enum":["all","interesting","prefer_interesting"],"title":"ReportFormatStringsMode"},"ReportSearchMethod":{"type":"string","enum":["or","and"],"title":"ReportSearchMethod"},"ReportSearchResponse":{"properties":{"items":{"items":{},"type":"array","title":"Items"},"count":{"type":"integer","title":"Count"},"count_search_params":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Count Search Params"},"earliest_dates_covered":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Earliest Dates Covered"},"method":{"type":"string","title":"Method"},"dbs_sync":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Dbs Sync"}},"type":"object","required":["items","count","method"],"title":"ReportSearchResponse","description":"Search response returned to user"},"ReportVerdict":{"type":"string","enum":["unknown","benign","informational","no_threat","suspicious","likely_malicious","malicious"],"title":"ReportVerdict"},"ReportsConfig":{"properties":{"queryInterval":{"$ref":"#/components/schemas/QueryIntervalConfig"},"signalTypeUpperLimit":{"$ref":"#/components/schemas/SignalTypeUpperLimitConfig"},"search":{"$ref":"#/components/schemas/SearchConfig"},"maxRetryCount":{"type":"integer","title":"Maxretrycount"},"viewFileContentSizeLimit":{"type":"integer","title":"Viewfilecontentsizelimit"},"keepJobResultSeconds":{"type":"integer","title":"Keepjobresultseconds"}},"type":"object","required":["queryInterval","signalTypeUpperLimit","search","maxRetryCount","viewFileContentSizeLimit","keepJobResultSeconds"],"title":"ReportsConfig","description":"Reports config model for SystemConfig response model"},"ReportsSourceType":{"type":"string","enum":["url","url-to-file","file"],"title":"ReportsSourceType","description":"Defines the way the scan was initiated."},"ReputationCheckConfigResponse":{"properties":{"reputation_enabled":{"type":"boolean","title":"Reputation Enabled"}},"type":"object","required":["reputation_enabled"],"title":"ReputationCheckConfigResponse"},"ReputationIocType":{"type":"string","enum":["domain","ip","url"],"title":"ReputationIocType"},"ReputationResultHash":{"properties":{"sha256":{"type":"string","title":"The SHA256 hash"},"overall_verdict":{"$ref":"#/components/schemas/ReportVerdict","title":"Overall verdict"},"fuzzyhash":{"anyOf":[{"$ref":"#/components/schemas/FuzzyhashVerdict"},{"type":"null"}],"title":"Fuzzyhash verdict along with fuzzyhash"},"mdcloud":{"anyOf":[{"$ref":"#/components/schemas/ResultMultiscan"},{"type":"null"}],"title":"MDCloud reputation"},"filescan_reports":{"items":{"$ref":"#/components/schemas/ReportForReputationCalculation"},"type":"array","title":"Filescan reports"}},"type":"object","required":["sha256","overall_verdict","filescan_reports"],"title":"ReputationResultHash"},"ReputationResultIoc":{"properties":{"ioc_type":{"type":"string","title":"Type of the IOC: domain, url or ip"},"ioc_value":{"type":"string","title":"IP address, domain or URL on which the reputation lookup was performed"},"overall_verdict":{"$ref":"#/components/schemas/ReportVerdict","title":"Overall verdict"},"mdcloud":{"anyOf":[{"$ref":"#/components/schemas/ResultLookup"},{"type":"null"}],"title":"MDCloud reputation"},"filescan_reports":{"items":{"$ref":"#/components/schemas/ReportForReputationCalculation"},"type":"array","title":"Filescan reports"}},"type":"object","required":["ioc_type","ioc_value","overall_verdict","filescan_reports"],"title":"ReputationResultIoc"},"RequestPasswordResetPayload":{"properties":{"email":{"type":"string","title":"Email"}},"type":"object","required":["email"],"title":"RequestPasswordResetPayload"},"ResetPasswordPayload":{"properties":{"token":{"type":"string","title":"Token"},"password":{"type":"string","title":"Password"},"password_confirm":{"type":"string","title":"Password Confirm"}},"type":"object","required":["token","password","password_confirm"],"title":"ResetPasswordPayload"},"ResultLookup":{"properties":{"scan_time":{"type":"string","format":"date-time","title":"Scan Time"},"detected":{"type":"integer","title":"Detected"}},"type":"object","required":["scan_time","detected"],"title":"ResultLookup","description":"Result of one lookup for IP, domain or URL"},"ResultMultiscan":{"properties":{"total_av_engines":{"type":"integer","title":"Total Av Engines"},"detected_av_engines":{"type":"integer","title":"Detected Av Engines"},"scan_time":{"type":"string","format":"date-time","title":"Scan Time"}},"type":"object","required":["total_av_engines","detected_av_engines","scan_time"],"title":"ResultMultiscan","description":"Result of one multiscan"},"ResultSimilarity":{"properties":{"sha256":{"type":"string","title":"Sha256"},"overall_similarity":{"type":"number","title":"Overall Similarity"},"similarities":{"$ref":"#/components/schemas/SimilaritiesResultSimilarity"},"details":{"$ref":"#/components/schemas/DetailsResultSimilarity"}},"type":"object","required":["sha256","overall_similarity","similarities","details"],"title":"ResultSimilarity","description":"Result of one similarity entry"},"S3Credentials":{"properties":{"bucket":{"type":"string","title":"Bucket name"},"key_id":{"type":"string","title":"Access key ID"},"secret_key":{"type":"string","title":"Secret key"},"region":{"type":"string","title":"Region"}},"type":"object","required":["bucket","key_id","secret_key","region"],"title":"S3Credentials","description":"AWS S3 credentials"},"STAT_PAGE_SIZES":{"type":"integer","enum":[20,100,1000],"title":"STAT_PAGE_SIZES"},"SanitizedHealthCheckOutput":{"properties":{"created_date":{"type":"string","format":"date-time","title":"Creation date"},"frontend_health":{"additionalProperties":true,"type":"object","title":"Frontend health"},"webservice_health":{"additionalProperties":true,"type":"object","title":"Webservice health"},"fstransform_health":{"items":{"additionalProperties":true,"type":"object"},"type":"array","title":"Fstransform instances health"},"fsbroker_health":{"additionalProperties":true,"type":"object","title":"Fsbroker health"}},"type":"object","required":["created_date","frontend_health","webservice_health","fstransform_health","fsbroker_health"],"title":"SanitizedHealthCheckOutput"},"SaveAccessGroupRequest":{"properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Id"},"name":{"type":"string","title":"Name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"}},"type":"object","required":["name"],"title":"SaveAccessGroupRequest","description":"Request model to save access groups"},"SaveApiQuotaSettingRequest":{"properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Id"},"route_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Route Id"},"groups":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Groups"},"time_settings":{"anyOf":[{"$ref":"#/components/schemas/ApiQuotaTimeSettings"},{"type":"null"}]}},"type":"object","title":"SaveApiQuotaSettingRequest","description":"Request model to save api quota setting"},"SaveOAuthServicePayload":{"properties":{"active":{"type":"boolean","title":"Active"},"client_id":{"type":"string","title":"Client Id"},"discovery_base_url":{"type":"string","title":"Discovery Base Url"},"discovery_path":{"type":"string","title":"Discovery Path"},"home_page":{"type":"string","title":"Home Page"},"key":{"type":"string","title":"Key"},"name":{"type":"string","title":"Name"},"order":{"type":"integer","title":"Order"},"secret":{"type":"string","title":"Secret"},"auth_type":{"type":"string","const":"oauth","title":"Auth Type"},"use_state":{"type":"boolean","title":"Use State"},"api_base_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Api Base Url"},"api_type":{"anyOf":[{"$ref":"#/components/schemas/ExternalServiceApiType"},{"type":"null"}]},"should_map_groups":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Should Map Groups"},"groups_map":{"anyOf":[{"items":{"$ref":"#/components/schemas/ExternalAuthGroupsMapPayload"},"type":"array"},{"type":"null"}],"title":"Groups Map"}},"type":"object","required":["active","client_id","discovery_base_url","discovery_path","home_page","key","name","order","secret","auth_type","use_state"],"title":"SaveOAuthServicePayload","description":"Request model to save OAuth service"},"SaveSamlServicePayload":{"properties":{"active":{"type":"boolean","title":"Active"},"key":{"type":"string","title":"Key"},"name":{"type":"string","title":"Name"},"order":{"type":"integer","title":"Order"},"entity_id":{"type":"string","title":"Entity Id"},"signin_url":{"type":"string","title":"Signin Url"},"certificate":{"type":"string","title":"Certificate"},"auth_type":{"type":"string","const":"saml","title":"Auth Type"}},"type":"object","required":["active","key","name","order","entity_id","signin_url","certificate","auth_type"],"title":"SaveSamlServicePayload","description":"Request model to save SAML service"},"ScanEngine":{"type":"string","enum":["internal","mdcloud"],"title":"ScanEngine","description":"All possible scan engines that can be used"},"ScanEngineServerInfo":{"properties":{"version_info":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Fstransform version info","default":{}},"license_data":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Fstranfsform license info","default":{}},"is_healthy":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Fstransform instance health","default":false}},"type":"object","title":"ScanEngineServerInfo","description":"Server general info, including license data"},"ScanHealthResponse":{"properties":{"date":{"type":"string","format":"date-time","title":"Date"},"value":{"type":"integer","title":"Value"}},"type":"object","required":["date","value"],"title":"ScanHealthResponse"},"ScanPriorityResponse":{"properties":{"applied":{"type":"integer","title":"Applied"},"max_posibble":{"type":"integer","title":"Max Posibble"},"note":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Note"}},"type":"object","required":["applied","max_posibble"],"title":"ScanPriorityResponse","description":"Priority part of the scan respoms model"},"ScanProfilePayload":{"properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Id"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"is_default":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Default"},"options":{"anyOf":[{"$ref":"#/components/schemas/ScanTransformOptions"},{"type":"null"}]}},"type":"object","title":"ScanProfilePayload","description":"User provided data to edit scan profile"},"ScanResponse":{"properties":{"flow_id":{"type":"string","title":"Flow Id"},"priority":{"$ref":"#/components/schemas/ScanPriorityResponse"}},"type":"object","required":["flow_id","priority"],"title":"ScanResponse","description":"Model for an initiated scan response"},"ScanSourceConnectionSecurity":{"type":"string","enum":["ssl_tls","start_tls"],"title":"ScanSourceConnectionSecurity"},"ScanSourceFileState":{"type":"string","enum":["queued_for_download","downloading","queued_for_scan","scanning","scan_completed","scan_failed"],"title":"ScanSourceFileState","description":"All possible states of processing of file from remote scan source"},"ScanSourceType":{"type":"string","enum":["email:IMAP","s3"],"title":"ScanSourceType"},"ScanSourcesConfigIds":{"properties":{"config_ids":{"anyOf":[{"type":"string"},{"items":{"type":"string"},"type":"array"}],"title":"Config Ids"}},"type":"object","required":["config_ids"],"title":"ScanSourcesConfigIds"},"ScanState":{"type":"string","enum":["created","queued","scanning","finished"],"title":"ScanState","description":"Scan state of ScanInit instance"},"ScanStateStatResponse":{"properties":{"count_created":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Count Created"},"count_queued":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Count Queued"},"count_scanning":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Count Scanning"},"count_failed":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Count Failed"},"count_queued_cancelled":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Count Queued Cancelled"},"count_changed_priority":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Count Changed Priority"},"count_running_timedout":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Count Running Timedout"},"date":{"type":"string","format":"date-time","title":"Date"}},"type":"object","required":["date"],"title":"ScanStateStatResponse"},"ScanTransformOptions":{"properties":{"rapid_mode":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Rapid Mode","description":"Disable some scan long-running features"},"early_termination":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Early Termination","description":"Terminates scan execution once a conclusive verdict is detected"},"osint":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Osint","description":"Enable OSINT (e.g. VirusTotal, ClamAV) lookups"},"extended_osint":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Extended Osint","description":"Enable OSINT lookups on extracted IOCs"},"extracted_files_osint":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Extracted Files Osint","description":"Enable OSINT lookups on extracted files"},"visualization":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Visualization","description":"Visualize sample file and render document pages"},"files_download":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Files Download","description":"Download and analyze files from embedded URLs"},"resolve_domains":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Resolve Domains","description":"Enable resolving domains to IPs (DNS)"},"input_file_yara":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Input File Yara","description":"Enable YARA rule matches on input file"},"extracted_files_yara":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Extracted Files Yara","description":"Enable YARA rule matches on extracted files"},"whois":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Whois","description":"Enable WHOIS record lookups"},"ips_meta":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Ips Meta","description":"Enable meta-data lookups for extracted IPs"},"images_ocr":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Images Ocr","description":"Enable OCR text recognition on extracted images"},"certificates":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Certificates","description":"Extract certificates"},"url_analysis":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Url Analysis","description":"Analyse domains and URLs, geolocation"},"extract_strings":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Extract Strings","description":"Enable strings extraction"},"ocr_qr":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Ocr Qr","description":"Extract string with OCR and process QR codes"},"phishing_detection":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Phishing Detection","description":"Phishing detection for URLs, emails and HTML pages"}},"type":"object","title":"ScanTransformOptions","description":"Options to turn on/off various scan features"},"ScheduleTaskCategory":{"type":"string","enum":["trends","statistics","scan","system","reports","patches"],"title":"ScheduleTaskCategory","description":"Job categories"},"ScheduleTaskConfig":{"properties":{"name":{"type":"string","title":"Job name"},"trigger":{"$ref":"#/components/schemas/ScheduleTaskTrigger","title":"Job trigger type"},"trigger_config":{"additionalProperties":true,"type":"object","title":"Trigger options"},"runtime_config":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Job logic options"},"is_subprocess":{"type":"boolean","title":"Is Subprocess","description":"Field to differ real scheduled jobs from custom ones","default":false},"is_active":{"type":"boolean","title":"Is Active","description":"If job is available for running","default":true},"is_editable":{"type":"boolean","title":"Is Editable","description":"If user is allowed to edit this settings","default":true},"updated_date":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated Date","description":"Last time when schedual was updated by user"},"update_applied_date":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Update Applied Date","description":"Last date when updated schedual was applied to job"},"id":{"type":"string","title":"Id","examples":["5f85f36d6dfecacc68428a46","ffffffffffffffffffffffff"],"example":"5f85f36d6dfecacc68428a46"}},"type":"object","required":["name","trigger","trigger_config"],"title":"ScheduleTaskConfig","description":"Config to run scheduled tasks, like statistics jobs"},"ScheduleTaskConfigClientside":{"properties":{"trigger":{"$ref":"#/components/schemas/ScheduleTaskTriggerClientside"},"trigger_config":{"anyOf":[{"$ref":"#/components/schemas/ScheduleTaskTriggerConfig"},{"type":"null"}]},"runtime_config":{"anyOf":[{"$ref":"#/components/schemas/ScheduleTaskRuntimeConfig"},{"type":"null"}]},"is_active":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Active"}},"type":"object","required":["trigger"],"title":"ScheduleTaskConfigClientside"},"ScheduleTaskConfigEdit":{"properties":{"trigger":{"$ref":"#/components/schemas/ScheduleTaskTrigger"},"trigger_config":{"additionalProperties":true,"type":"object","title":"Trigger Config"},"runtime_config":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Runtime Config"},"is_active":{"type":"boolean","title":"Is Active"}},"type":"object","required":["trigger","trigger_config","is_active"],"title":"ScheduleTaskConfigEdit","description":"Job edit input model"},"ScheduleTaskConfigResponse":{"properties":{"name":{"type":"string","title":"Name"},"trigger":{"$ref":"#/components/schemas/ScheduleTaskTrigger"},"trigger_config":{"additionalProperties":true,"type":"object","title":"Trigger Config"},"runtime_config":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Runtime Config"},"is_active":{"type":"boolean","title":"Is Active"},"is_editable":{"type":"boolean","title":"Is Editable"}},"type":"object","required":["name","trigger","trigger_config","is_active","is_editable"],"title":"ScheduleTaskConfigResponse","description":"Return job config to user"},"ScheduleTaskLogResponse":{"properties":{"state":{"$ref":"#/components/schemas/ScheduledTaskStateName"},"log":{"anyOf":[{"items":{},"type":"array"},{"type":"null"}],"title":"Log"}},"type":"object","required":["state"],"title":"ScheduleTaskLogResponse","description":"Job log response"},"ScheduleTaskMemoryResponse":{"properties":{"name":{"type":"string","title":"Name"},"resident_memory":{"type":"number","title":"Resident Memory"},"date":{"type":"string","format":"date-time","title":"Date"},"is_killed":{"type":"boolean","title":"Is Killed"}},"type":"object","required":["name","resident_memory","date","is_killed"],"title":"ScheduleTaskMemoryResponse"},"ScheduleTaskPeakMemoryResponse":{"properties":{"name":{"type":"string","title":"Name"},"description":{"type":"string","title":"Description"},"memory":{"type":"number","title":"Memory"},"is_killed":{"type":"boolean","title":"Is Killed"},"is_unresponsive":{"type":"boolean","title":"Is Unresponsive"}},"type":"object","required":["name","description","memory","is_killed","is_unresponsive"],"title":"ScheduleTaskPeakMemoryResponse"},"ScheduleTaskResponse":{"properties":{"name":{"type":"string","title":"Name"},"category":{"$ref":"#/components/schemas/ScheduleTaskCategory"},"description":{"type":"string","title":"Description"},"config":{"anyOf":[{"$ref":"#/components/schemas/ScheduleTaskConfigResponse"},{"type":"null"}]},"state":{"anyOf":[{"$ref":"#/components/schemas/ScheduleTaskStateResponse"},{"type":"null"}]}},"type":"object","required":["name","category","description"],"title":"ScheduleTaskResponse","description":"Jobs response model"},"ScheduleTaskRuntimeConfig":{"properties":{"run_once":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Run Once"}},"type":"object","title":"ScheduleTaskRuntimeConfig"},"ScheduleTaskStateResponse":{"properties":{"name":{"type":"string","title":"Name"},"state":{"type":"string","title":"State"},"data":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Data"},"updated_date":{"type":"string","format":"date-time","title":"Updated Date"},"public_log":{"anyOf":[{"items":{},"type":"array"},{"type":"null"}],"title":"Public Log"},"has_public_log":{"type":"boolean","title":"Has Public Log"}},"type":"object","required":["name","state","updated_date","has_public_log"],"title":"ScheduleTaskStateResponse","description":"Return job state to user"},"ScheduleTaskTrigger":{"type":"string","enum":["once","date","interval","cron","calendarinterval"],"title":"ScheduleTaskTrigger","description":"All available trigger types"},"ScheduleTaskTriggerClientside":{"type":"string","enum":["once","interval","cron"],"title":"ScheduleTaskTriggerClientside","description":"Available tirgger types when adding scan source from clientside"},"ScheduleTaskTriggerConfig":{"properties":{"time":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Time"},"unit":{"anyOf":[{"$ref":"#/components/schemas/ScheduleTaskTriggerUnit"},{"type":"null"}]},"value":{"anyOf":[{"type":"integer"},{"type":"string"},{"type":"null"}],"title":"Value"}},"type":"object","title":"ScheduleTaskTriggerConfig"},"ScheduleTaskTriggerUnit":{"type":"string","enum":["minutes","hours","days","each_day","week_day"],"title":"ScheduleTaskTriggerUnit"},"ScheduledTaskStateName":{"type":"string","enum":["succeeded","succeeded_with_errors","failed","running"],"title":"ScheduledTaskStateName","description":"Name of job state"},"SearchConfig":{"properties":{"page_size":{"type":"integer","title":"Page Size"},"page_size_options":{"items":{"type":"integer"},"type":"array","title":"Page Size Options"},"reportsLimit":{"type":"integer","title":"Reportslimit"},"monthsLimit":{"type":"integer","title":"Monthslimit"}},"type":"object","required":["page_size","page_size_options","reportsLimit","monthsLimit"],"title":"SearchConfig","description":"Search config model for ReportsConfig model"},"ServiceStatQueues":{"properties":{"scan":{"additionalProperties":true,"type":"object","title":"Scan"}},"type":"object","required":["scan"],"title":"ServiceStatQueues","description":"Service Stat Response nested model"},"ServiceStatRedis":{"properties":{"info":{"additionalProperties":true,"type":"object","title":"Info"}},"type":"object","required":["info"],"title":"ServiceStatRedis","description":"Service Stat Response nested model"},"ServicesStatResponse":{"properties":{"queues":{"$ref":"#/components/schemas/ServiceStatQueues"},"redis":{"$ref":"#/components/schemas/ServiceStatRedis"}},"type":"object","required":["queues","redis"],"title":"ServicesStatResponse"},"SettingGroup":{"type":"string","enum":["access","auth","environment"],"title":"SettingGroup"},"SignalGroup":{"properties":{"id":{"type":"string","title":"Id"},"description":{"type":"string","title":"Description"},"mime_type":{"type":"string","title":"Mime Type"},"mitre_technique_ids":{"type":"string","title":"Mitre Technique Ids"},"strength":{"type":"string","title":"Strength"}},"type":"object","required":["id","description","mime_type","mitre_technique_ids","strength"],"title":"SignalGroup","description":"SignalGroup model for groups field in SignalGroupsResponse model"},"SignalGroupsResponse":{"properties":{"type":{"type":"string","title":"Type"},"name":{"type":"string","title":"Name"},"category":{"type":"string","title":"Category"},"groups":{"items":{"$ref":"#/components/schemas/SignalGroup"},"type":"array","title":"Groups"}},"type":"object","required":["type","name","category","groups"],"title":"SignalGroupsResponse","description":"Response model for /api/system/signal-groups endpoint"},"SignalTypeUpperLimitConfig":{"properties":{"informational":{"type":"number","title":"Informational"},"suspicious":{"type":"number","title":"Suspicious"}},"type":"object","required":["informational","suspicious"],"title":"SignalTypeUpperLimitConfig","description":"SignalTypeUpperLimit config model for ReportsConfig model"},"SigninExternalPayload":{"properties":{"payload":{"type":"string","title":"Payload"},"state":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"State"}},"type":"object","required":["payload"],"title":"SigninExternalPayload"},"SigninPayload":{"properties":{"email":{"type":"string","title":"Email"},"password":{"type":"string","title":"Password"}},"type":"object","required":["email","password"],"title":"SigninPayload"},"SignupPayload":{"properties":{"username":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Username","default":""},"email":{"type":"string","title":"Email"},"email_confirm":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Email Confirm"},"password":{"type":"string","title":"Password"},"password_confirm":{"type":"string","title":"Password Confirm"},"invite_token":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Invite Token"},"policy_accepted":{"type":"boolean","title":"Policy Accepted"}},"type":"object","required":["email","password","password_confirm","policy_accepted"],"title":"SignupPayload"},"SimilaritiesResponse":{"properties":{"note":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Note","description":"Optinal notification about demo data"},"most_similar":{"items":{"$ref":"#/components/schemas/ResultSimilarity"},"type":"array","title":"TOP 10 most similar findings","default":[]},"most_recent":{"items":{"$ref":"#/components/schemas/ResultSimilarity"},"type":"array","title":"TOP 10 most recent findings","default":[]}},"type":"object","title":"SimilaritiesResponse"},"SimilaritiesResultSimilarity":{"properties":{"extracted":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Extracted"},"threat_indicators":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Threat Indicators"},"sections":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Sections"},"mitre_techniques":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Mitre Techniques"},"binary_metadata":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Binary Metadata"},"certificates":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Certificates"},"characteristic":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Characteristic"},"disassembly_sections":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Disassembly Sections"},"dotnet_info":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Dotnet Info"},"header_info":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Header Info"},"imports":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Imports"},"pdb_guid":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Pdb Guid"},"resources":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Resources"},"rich_header_compiler_ids":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Rich Header Compiler Ids"},"strings":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Strings"},"version_info":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Version Info"},"apk":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Apk"},"biffopcodes":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Biffopcodes"},"emulation":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Emulation"},"extendeddata":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Extendeddata"},"metadata":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Metadata"},"segments":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Segments"},"content_parse":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Content Parse"},"image_ocr":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Image Ocr"},"binary_internal":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Binary Internal"},"strings_input_file":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Strings Input File"},"triggeredconsumerids":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Triggeredconsumerids"},"vba_emulation":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Vba Emulation"},"yara":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Yara"},"signal_ids":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Signal Ids"},"certifications":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Certifications"},"weighted_numerics":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Weighted Numerics"}},"type":"object","title":"SimilaritiesResultSimilarity"},"SiteLogoType":{"type":"string","enum":["main","top_menu","footer"],"title":"SiteLogoType","description":"Type of logo, representing it's usecase"},"SiteTheme":{"type":"string","enum":["light","dark"],"title":"SiteTheme","description":"All available themes"},"SourceArchive":{"properties":{"scan_task_id":{"type":"string","title":"Scan Task Id"},"name":{"type":"string","title":"Name"},"mimeType":{"type":"string","title":"Mimetype"},"sha256":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sha256"},"private":{"type":"boolean","title":"Private"},"is_link_upload":{"type":"boolean","title":"Is Link Upload"},"sha1":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sha1"},"sha512":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sha512"},"md5":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Md5"},"tags":{"anyOf":[{"$ref":"#/components/schemas/TagsResponse"},{"type":"null"}]},"verdict":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Verdict"}},"type":"object","required":["scan_task_id","name","mimeType","private","is_link_upload"],"title":"SourceArchive","description":"Model for sourceArchive field in AllUploadRelatedReportsResponse"},"StatChangeResponse":{"properties":{"stat_name":{"anyOf":[{"$ref":"#/components/schemas/VerdictDateGenericStatName"},{"$ref":"#/components/schemas/VerdictDateStandaloneStatName"}],"title":"Stat Name"},"items":{"items":{"$ref":"#/components/schemas/StatItemsChangeResponse"},"type":"array","title":"Items"}},"type":"object","required":["stat_name","items"],"title":"StatChangeResponse","description":"Return result of comparing statistics between periods"},"StatForResponse":{"properties":{"count":{"anyOf":[{"type":"integer"},{"additionalProperties":true,"type":"object"}],"title":"Count"},"updated":{"type":"string","format":"date-time","title":"Updated"}},"type":"object","required":["count","updated"],"title":"StatForResponse"},"StatForYaraResponse":{"properties":{"count":{"anyOf":[{"type":"integer"},{"additionalProperties":true,"type":"object"}],"title":"Count"},"updated":{"type":"string","format":"date-time","title":"Updated"}},"type":"object","required":["count","updated"],"title":"StatForYaraResponse"},"StatItemsChangeResponse":{"properties":{"name":{"type":"string","title":"Name"},"change":{"type":"number","title":"Change"},"value":{"type":"number","title":"Value"},"compare_value":{"type":"number","title":"Compare Value"}},"type":"object","required":["name","change","value","compare_value"],"title":"StatItemsChangeResponse"},"StatOverviewConfig":{"properties":{"timelineMonths":{"items":{"type":"string"},"type":"array","title":"Timelinemonths"},"topItemsLimit":{"type":"integer","title":"Topitemslimit"},"leaderboardItemsLimit":{"type":"integer","title":"Leaderboarditemslimit"}},"type":"object","required":["timelineMonths","topItemsLimit","leaderboardItemsLimit"],"title":"StatOverviewConfig","description":"StatOverview config model for SystemConfig response model"},"SystemConfig":{"properties":{"baseUrl":{"type":"string","title":"Baseurl"},"allowAnonymousUsers":{"type":"boolean","title":"Allowanonymoususers"},"appTitle":{"type":"string","title":"Apptitle"},"appDescription":{"type":"string","title":"Appdescription"},"adFrequency":{"type":"integer","title":"Adfrequency"},"feedbackNotification":{"$ref":"#/components/schemas/FeedbackNotificationConfig"},"buildType":{"$ref":"#/components/schemas/BuildType"},"maxUploadSize":{"type":"integer","title":"Maxuploadsize"},"maxUploadSizeLimit":{"type":"integer","title":"Maxuploadsizelimit"},"username":{"$ref":"#/components/schemas/UsernameConfig"},"password":{"$ref":"#/components/schemas/PasswordConfig"},"tokenExpire":{"$ref":"#/components/schemas/TokenExpireConfig"},"reports":{"$ref":"#/components/schemas/ReportsConfig"},"queueJobTimeout":{"type":"integer","title":"Queuejobtimeout"},"languages":{"$ref":"#/components/schemas/LanguagesConfig"},"scanFilesPerUpload":{"type":"integer","title":"Scanfilesperupload"},"googleTagManagerID":{"type":"string","title":"Googletagmanagerid"},"supportedTypes":{"items":{"$ref":"#/components/schemas/FileType"},"type":"array","title":"Supportedtypes"},"fileCategories":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","title":"Filecategories"},"fileGeneralTypes":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object","title":"Filegeneraltypes"},"constantStrings":{"items":{"type":"string"},"type":"array","title":"Constantstrings"},"defaultTheme":{"type":"string","title":"Defaulttheme"},"iocs":{"$ref":"#/components/schemas/IOCsConfig"},"admin":{"$ref":"#/components/schemas/AdminConfig"},"logoSelectedTime":{"$ref":"#/components/schemas/LogoSelectedTimeConfig"},"askTermsConsent":{"type":"boolean","title":"Asktermsconsent"},"scanBigFileSize":{"type":"integer","title":"Scanbigfilesize"},"statOverview":{"$ref":"#/components/schemas/StatOverviewConfig"},"jobs":{"$ref":"#/components/schemas/JobsConfig"},"similaritySearchEnabled":{"type":"boolean","title":"Similaritysearchenabled"},"reportSimilarityVerdictThreshold":{"type":"number","title":"Reportsimilarityverdictthreshold"},"TLDTypes":{"items":{"$ref":"#/components/schemas/TLDTypes"},"type":"array","title":"Tldtypes"},"showFooter":{"type":"boolean","title":"Showfooter"},"maintenance":{"$ref":"#/components/schemas/MaintenanceConfig"},"allowedFeatures":{"items":{"type":"string"},"type":"array","title":"Allowedfeatures"},"ocm":{"$ref":"#/components/schemas/OCMConfig"},"extraButton":{"$ref":"#/components/schemas/ExtraButtonConfig"},"newsLimit":{"type":"integer","title":"Newslimit"},"automaticReportFilesDownload":{"type":"boolean","title":"Automaticreportfilesdownload"}},"type":"object","required":["baseUrl","allowAnonymousUsers","appTitle","appDescription","adFrequency","feedbackNotification","buildType","maxUploadSize","maxUploadSizeLimit","username","password","tokenExpire","reports","queueJobTimeout","languages","scanFilesPerUpload","googleTagManagerID","supportedTypes","fileCategories","fileGeneralTypes","constantStrings","defaultTheme","iocs","admin","logoSelectedTime","askTermsConsent","scanBigFileSize","statOverview","jobs","similaritySearchEnabled","reportSimilarityVerdictThreshold","TLDTypes","showFooter","maintenance","allowedFeatures","ocm","extraButton","newsLimit","automaticReportFilesDownload"],"title":"SystemConfig","description":"Response model for /api/system/config endpoint"},"THREATINTEL_PREVALENCE_DAY_OPTIONS":{"type":"integer","enum":[7,14,30],"title":"THREATINTEL_PREVALENCE_DAY_OPTIONS"},"TLDTypes":{"type":"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"],"title":"TLDTypes"},"TagResponse":{"properties":{"name":{"type":"string","title":"Name"}},"type":"object","required":["name"],"title":"TagResponse","description":"Model for tag field in TagsResponse"},"TagsResponse":{"properties":{"source":{"type":"string","title":"Source"},"tag":{"$ref":"#/components/schemas/TagResponse"}},"type":"object","required":["source","tag"],"title":"TagsResponse","description":"Model for tags field in AllUploadRelatedReportsResponse"},"TasksQueueHealthCheckType":{"type":"string","enum":["long_run","new_run"],"title":"TasksQueueHealthCheckType","description":"Type of health check that can be performed on tasks queue"},"TasksQueueHealthVerdict":{"properties":{"queue_name":{"type":"string","title":"Queue Name","description":"Name of tasks queue"},"check_type":{"$ref":"#/components/schemas/TasksQueueHealthVerdictCheckType","description":"Type of check that was performed","default":"all"},"healthy":{"type":"boolean","title":"Healthy","description":"Health verdict"},"last_date_healthy":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Last Date Healthy","description":"Last time queue was reported as working"},"data":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Data","description":"Arbitrary data we can save as health state"}},"type":"object","required":["queue_name","healthy"],"title":"TasksQueueHealthVerdict","description":"Data that we return about tasks queue final health verdict"},"TasksQueueHealthVerdictAll":{"properties":{"total_healthy":{"type":"boolean","title":"Total Healthy","description":"Health verdict"},"queues":{"items":{"$ref":"#/components/schemas/TasksQueueHealthVerdict"},"type":"array","title":"Queues","description":"Details about each queue health verdict"}},"type":"object","required":["total_healthy","queues"],"title":"TasksQueueHealthVerdictAll"},"TasksQueueHealthVerdictCheckType":{"type":"string","enum":["long_run","new_run","all"],"title":"TasksQueueHealthVerdictCheckType","description":"Type of health check we have verdict for"},"TermsType":{"type":"string","enum":["privacy-policy","terms-condition","cookie-policy"],"title":"TermsType"},"Timezones":{"type":"string","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"],"title":"Timezones"},"TokenExpireConfig":{"properties":{"signupConfirm":{"type":"integer","title":"Signupconfirm"},"passwordReset":{"type":"integer","title":"Passwordreset"},"invite":{"type":"integer","title":"Invite"}},"type":"object","required":["signupConfirm","passwordReset","invite"],"title":"TokenExpireConfig","description":"TokenExpire config model for SystemConfig response model"},"TokensPair":{"properties":{"access_token":{"type":"string","title":"Access Token"},"refresh_token":{"type":"string","title":"Refresh Token"}},"type":"object","required":["access_token","refresh_token"],"title":"TokensPair","description":"Used as a response model"},"UserApiKey":{"properties":{"api_key":{"type":"string","title":"Api Key"}},"type":"object","required":["api_key"],"title":"UserApiKey","description":"Model for user API key create and set"},"UserAppStatType":{"type":"string","enum":["count_malicious_ips_by_user","count_verdicts_by_user","count_reports_by_user","count_uploads_by_user"],"title":"UserAppStatType","description":"AppStatType list for users"},"UserNotification":{"type":"string","enum":["dark_theme"],"title":"UserNotification","description":"All notifications available for users"},"UserResetPasswordResponse":{"properties":{"token":{"type":"string","title":"Token"}},"type":"object","required":["token"],"title":"UserResetPasswordResponse"},"UserResponse":{"properties":{"account_id":{"type":"string","title":"Account Id"},"email":{"type":"string","title":"Email"},"username":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Username"},"pseudoname":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Pseudoname"},"groups":{"anyOf":[{"items":{"$ref":"#/components/schemas/GroupOut"},"type":"array"},{"type":"null"}],"title":"Groups"},"has_avatar":{"type":"boolean","title":"Has Avatar"},"profile":{"anyOf":[{"$ref":"#/components/schemas/ProfileResponse"},{"type":"null"}]},"api_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Api Key"},"theme":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Theme"},"timezone":{"anyOf":[{"$ref":"#/components/schemas/Timezones"},{"type":"null"}]},"locale":{"anyOf":[{"$ref":"#/components/schemas/Locales"},{"type":"null"}]},"feedback_notification_enabled":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Feedback Notification Enabled"}},"type":"object","required":["account_id","email","has_avatar"],"title":"UserResponse","description":"System user for out"},"UserStat":{"properties":{"user":{"type":"string","title":"Reference to user","examples":["5f85f36d6dfecacc68428a46","ffffffffffffffffffffffff"],"example":"5f85f36d6dfecacc68428a46"},"name":{"type":"string","title":"Statistics type"},"period":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Period for which statistics was gathered"},"value":{"title":"Gathered statistics"},"updated_date":{"type":"string","format":"date-time","title":"Updated Date"},"id":{"type":"string","title":"Id","examples":["5f85f36d6dfecacc68428a46","ffffffffffffffffffffffff"],"example":"5f85f36d6dfecacc68428a46"}},"type":"object","required":["user","name","value"],"title":"UserStat","description":"Statistics record in case when we need to save stat per user"},"UserStatResponse":{"properties":{"user":{"anyOf":[{"$ref":"#/components/schemas/UserStatResponseUserData"},{"type":"null"}]},"name":{"type":"string","title":"Name"},"value":{"title":"Value"},"updated_date":{"type":"string","format":"date-time","title":"Updated Date"}},"type":"object","required":["name","updated_date"],"title":"UserStatResponse","description":"Return user stat data to user"},"UserStatResponseUserData":{"properties":{"account_id":{"type":"string","title":"Account Id"},"username":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Username"},"pseudoname":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Pseudoname"}},"type":"object","required":["account_id"],"title":"UserStatResponseUserData"},"UserUploadsResponse":{"properties":{"items":{"items":{"additionalProperties":true,"type":"object"},"type":"array","title":"Items"},"count":{"type":"integer","title":"Count"},"timing":{"items":{"additionalProperties":true,"type":"object"},"type":"array","title":"Timing"},"method":{"$ref":"#/components/schemas/ReportSearchMethod"},"count_search_params":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Count Search Params"}},"type":"object","required":["items","count","timing","method"],"title":"UserUploadsResponse"},"UsernameConfig":{"properties":{"maximum_length":{"type":"integer","title":"Maximum Length"},"regex":{"type":"string","title":"Regex"}},"type":"object","required":["maximum_length","regex"],"title":"UsernameConfig","description":"Username config model for SystemConfig response model"},"UsersDailyAppStatType":{"type":"string","enum":["count_verdicts_by_date","count_reports_by_date","count_uploads_by_date"],"title":"UsersDailyAppStatType","description":"Limited AppStatType list for ordinary users"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"VerdictAmountItemResponse":{"properties":{"item":{"type":"string","title":"Item"},"verdicts":{"additionalProperties":{"type":"integer"},"propertyNames":{"$ref":"#/components/schemas/ReportVerdict"},"type":"object","title":"Verdicts"}},"type":"object","required":["item","verdicts"],"title":"VerdictAmountItemResponse"},"VerdictAmountResponse":{"properties":{"stat_name":{"anyOf":[{"$ref":"#/components/schemas/VerdictDateGenericStatName"},{"$ref":"#/components/schemas/VerdictDateStandaloneStatName"}],"title":"Stat Name"},"items":{"items":{"$ref":"#/components/schemas/VerdictAmountItemResponse"},"type":"array","title":"Items"}},"type":"object","required":["stat_name","items"],"title":"VerdictAmountResponse","description":"Return amount of different reports verdicts for IOCs"},"VerdictDateGenericStatName":{"type":"string","enum":["count_malicious_signal_groups","count_mitre_techniques_by_period","frequent_yara_tags","frequent_malware_tags","count_yaras_per_period","count_malicious_reports_by_extension","count_api_calls","count_top_level_domains","count_malicious_reports_by_language","count_phishing_brands","count_malicious_reports_by_country","count_malicious_ips","count_malicious_ips_ratio","count_iocs_per_period","average_scan_time","count_verdicts_by_date","count_c2_items"],"title":"VerdictDateGenericStatName","description":"Name of statistics types that should be stored together in a single collection"},"VerdictDateStandaloneStatName":{"type":"string","enum":["count_ips","count_domains","count_sha256"],"title":"VerdictDateStandaloneStatName","description":"Verdict/date stat types, that are stored in dedicated collections"},"VerdictDateStatResponse":{"properties":{"stat_name":{"anyOf":[{"$ref":"#/components/schemas/VerdictDateGenericStatName"},{"$ref":"#/components/schemas/VerdictDateStandaloneStatName"}],"title":"Stat Name"},"items":{"items":{"$ref":"#/components/schemas/VerdictDateStatResponseItem"},"type":"array","title":"Items"},"order":{"$ref":"#/components/schemas/ItemsOrder"}},"type":"object","required":["stat_name","items","order"],"title":"VerdictDateStatResponse","description":"Return reports verdict/date stat to user"},"VerdictDateStatResponseItem":{"properties":{"name":{"type":"string","title":"Name"},"value":{"type":"number","title":"Value"},"country_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Country Name"}},"type":"object","required":["name","value"],"title":"VerdictDateStatResponseItem","description":"Return reports verdict/date stat to user"},"VerdictDateTimelineResponse":{"properties":{"date":{"type":"string","title":"Date"},"value":{"additionalProperties":{"type":"integer"},"propertyNames":{"$ref":"#/components/schemas/ReportVerdict"},"type":"object","title":"Value"}},"type":"object","required":["date","value"],"title":"VerdictDateTimelineResponse","description":"Return total verdicts-dates timeline"},"VerdictDatesItemResponse":{"properties":{"item":{"type":"string","title":"Item"},"verdicts":{"additionalProperties":{"additionalProperties":{"type":"integer"},"propertyNames":{"$ref":"#/components/schemas/ReportVerdict"},"type":"object"},"type":"object","title":"Verdicts"}},"type":"object","required":["item","verdicts"],"title":"VerdictDatesItemResponse"},"VerdictDatesResponse":{"properties":{"stat_name":{"anyOf":[{"$ref":"#/components/schemas/VerdictDateGenericStatName"},{"$ref":"#/components/schemas/VerdictDateStandaloneStatName"}],"title":"Stat Name"},"items":{"items":{"$ref":"#/components/schemas/VerdictDatesItemResponse"},"type":"array","title":"Items"}},"type":"object","required":["stat_name","items"],"title":"VerdictDatesResponse","description":"Return reports verdicts per dates for IOCs"},"VerdictsAmountPayload":{"properties":{"data":{"items":{"$ref":"#/components/schemas/IocsOfStatType"},"type":"array","title":"Data"}},"type":"object","required":["data"],"title":"VerdictsAmountPayload"},"YaraInfoResponse":{"properties":{"info":{"items":{"$ref":"#/components/schemas/RepoInfo"},"type":"array","title":"Info"}},"type":"object","required":["info"],"title":"YaraInfoResponse"},"YaraRuleResponse":{"properties":{"name":{"type":"string","title":"Rule name"},"author":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Rule author reference"},"strength":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Rule threat strength"},"created_date":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Date of rule creation"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Rule description"},"other_data":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Other rule meta data"},"content":{"type":"string","title":"Full rule content"}},"type":"object","required":["name","content"],"title":"YaraRuleResponse"}},"securitySchemes":{"apiKey":{"type":"apiKey","in":"header","name":"X-Api-Key"}}},"tags":[{"name":"scan","description":"Upload file or URL resource for scan"},{"name":"reports","description":"Retrieve a variety of report related data"},{"name":"files","description":"Get a file by its hash or id in various format"},{"name":"feed","description":"Atom feed"},{"name":"users","description":"Report-related and other functionality used by ordinary users."},{"name":"system","description":"Various helper and system functionality."},{"name":"admin","description":"Functionality for site admins."},{"name":"threatintel","description":"Threat Intelligence"},{"name":"similarity-search","description":"Similarity Search"},{"name":"reputation","description":"Reputation"},{"name":"docs","description":"API documentation related"}]}