QueryInfectionScanStatusByID

Will retrieve the result of a given scanning session

Syntax

Method ID

#define WAAPI_MID_QUERY_INFECTION_SCAN_STATUS_BY_ID 80005

JSON Input Structure

{
  "input": {
    "method": 80005,
    "infection_scan_id": string
  }
}

Input Properties

Parameter	Type	Description
`infection_scan_id`	string	A session id key representing the scanning session

JSON Output Structure

{
  "result": {
    "method": 80005,
    "code": number,
    "timing": number,
    "timestamp": string,
    "scan_complete": boolean,
    "malware_found": boolean,
    "scanning_type": boolean,
    "details": [
      {
        "status": string,
        "total_source": number,
        "hash": string,
        "scan_time": string,
        "mso_data_id": string,
        "network_address": string,
        "domain_name": string,
        "mac_address": string,
        "explanation": [
          string,
          ...
        ],
        "threats": [
          {
            "threat_name": string,
            "av_name": string,
            "scan_time": string,
            "av_def_time": string,
            "assessment": string,
            "source_name": string,
            "confident": string
          },
          ...
        ],
        "geo_info": {
          "country_name": string,
          "country_code": string,
          "region_name": string,
          "region_code": string,
          "city": string
        }
      },
      ...
    ],
    "files_in_archive": [
      {},
      ...
    ]
  }
}

Output Properties

Property	Type	Description
`result.method`	number	The method ID that generated this result.
`result.code`	number	The result code. See Result Codes.
`result.timing`	number	The measured time for the method call in milliseconds.
`result.timestamp`	string	The timestamp in seconds of when the call was made.
`result.scan_complete`	boolean	True if the given scanning session was completed
`result.malware_found`	boolean	True if there was any malware found
`result.scanning_type`	boolean	Shows the type of the queried scan
`result.details`	array<object>	Will contain a key for each type of scanning object, include process_id, file_path or network_address type. The value varies depending on the type of scanning object
`result.details.status`	string	Indicates the scanning object is clear, dirty or in-progress
`result.details.total_source`	number	Indicates the total number or engines used to scan the object
`result.details.hash`	string	Indicates the hash code of the scanning object if the object is a file or process
`result.details.scan_time`	string	Indicates the scan time of this particular file.
`result.details.mso_data_id`	string	Indicates the data_id on Metadefender of the scanning object if the object is a file or process
`result.details.network_address`	string	Network address of the detected threat
`result.details.domain_name`	string	Domain name of the connection (only for external IP addresses)
`result.details.mac_address`	string	MAC address of the connection (only for internal IP addresses)
`result.details.explanation`	array<string>	An array of reasons which explain the scanning status
`result.details.threats`	array<object>	An array of threats found with details information
`result.details.threats.threat_name`	string	Name of threat found
`result.details.threats.av_name`	string	Name of antivirus engine which found the threat
`result.details.threats.scan_time`	string	Scan time of specific antivirus engine over the threat
`result.details.threats.av_def_time`	string	The definition time of a specific antivirus engine
`result.details.threats.assessment`	string	Type of threat detected
`result.details.threats.source_name`	string	Source of the feed, usually the domain where the feed is from (e.g., example.com)
`result.details.threats.confident`	string	Represents the reliability of the detection based on several factors. The higher the score, the more reliable the result.
`result.details.geo_info`	object	An object represents the geolocation of address
`result.details.geo_info.country_name`	string	Country name of the network address (e.g., Brazil)
`result.details.geo_info.country_code`	string	Country name of the network address (e.g., BR)
`result.details.geo_info.region_name`	string	Region name of the network address (e.g., Rio de Janeiro)
`result.details.geo_info.region_code`	string	Region code of the network address (e.g., 27)
`result.details.geo_info.city`	string	City name of the network address (e.g., Rio de Janeiro)
`result.files_in_archive`	array<object>	(optional) List all file inside an archive file along with its detail information if the archive file is dirty

Result Codes

Code	Name	Description
0	`WAAPI_OK`	The operation completed successfully.

note

Other codes may be returned. See the full Result Codes reference for the complete list.

Remarks

Error Handling

The results of this function are determined by the error code returned by the call. If successful, WAAPI_OK or a special success code will be returned. Always check both the function return value and the result.code field in the output JSON.

Examples

Examples will be added here demonstrating the usage of this method.

Syntax​

Method ID​

JSON Input Structure​

Input Properties​

JSON Output Structure​

Output Properties​

Result Codes​

Remarks​

Error Handling​

Examples​

See Also​