Skip to main content

DefinitionsSourceCheck

Will query source feeds for information on whether Antimalware definitions are up to date. Generally for metrics, 1+ indicates up to date, -1 indicates old

Syntax​

Method ID​

#define WAAPI_MID_DEFINITIONS_SOURCE_CHECK 50501

JSON Input Structure​

{
"input": {
"method": 50501,
"signature": number,
"tolerance": number
}
}

Input Properties​

ParameterTypeDescription
tolerancenumber(optional) A tolerance factor that can be used to loosen the 'is_current' metric. The default tolerance value is '1'.

JSON Output Structure​

{
"result": {
"method": 50501,
"code": number,
"timing": number,
"timestamp": string,
"is_current": boolean,
"details": {
"feed_id": number,
"count_behind": number,
"def_date": string,
"def_version": string,
"engine_version": string,
"def_signature": string,
"metrics": {
"basic": number,
"strict": number,
"engine_latest": number,
"date_latest": number,
"version_latest": number,
"version_age": number
}
}
}
}

Output Properties​

PropertyTypeDescription
result.methodnumberThe method ID that generated this result.
result.codenumberThe result code. See Result Codes.
result.timingnumberThe measured time for the method call in milliseconds.
result.timestampstringThe timestamp in seconds of when the call was made.
result.is_currentbooleanTrue if this product's antimalware defintions are current.
result.details.feed_idnumberThe remote feed ID used to determine definition currency.
result.details.count_behindnumberThe number of definitions behind of the installed antimalware based on definition version. Possible values are: 0+: '0' Indicates the latest version, '1' indicates 1 version behind, etc. -1: Indicates that the definition version is old and the count behind cannot be determined. -2: Indicates invalid or absent information given in the input. -3: Indicates internal error. -4: Indicates absent information in database.
result.details.def_datestringThe current definition date in the remote feed.
result.details.def_versionstringThe current definition version in the remote feed.
result.details.engine_versionstringThe current engine version in the remote feed.
result.details.def_signaturestringThe current definition signature in the remote feed.
result.details.metrics.basicnumberA simple metric for determining if definition is up to date based on definition date (within 36 hours) and definition version. Possible values are: 1: Indicates definition is up to date, which means that the definition version is up to date or the definition date is up to date within 12-hour window. 0: Indicates that metric does not apply or insufficient information to determine metric. -1: Indicates that the definition is old. -2: Indicates invalid or absent information given in the input. -3: Indicates internal error.
result.details.metrics.strictnumberA strict metric for determining if definition is up to date based on definition date and definition version the same way as 'basic' metric but no window for definition date is used. Possible values are: 1: Indicates definition is up to date. 0: Indicates that metric does not apply or insufficient information to determine metric. -1: Indicates that the definition is old. -2: Indicates invalid or absent information given in the input. -3: Indicates internal error.
result.details.metrics.engine_latestnumberIndicates whether the engine is the latest version. Possible values are: 1+: Indicates that the engine version is up to date. 0: Not supported / Engine version missing from feed. -1: Indicate that the engine version is old. -2: Indicates invalid or absent information given in the input. -3: Indicates internal error.
result.details.metrics.date_latestnumberIndicates whether definition date is the latest. Possible values are: 1+: Indicates that the definition date is up to date. 0: Indicates that metric does not apply or insufficient information to determine metric. -1: Indicate that the definition date is old. -2: Indicates invalid or absent information given in the input. -3: Indicates internal error.
result.details.metrics.version_latestnumberIndicates whether the definition version is the latest. Possible values are: 1+: Indicates that the definition version is up to date. 0: Indicates that metric does not apply or insufficient information to determine metric. -1: Indicates that the definition version is old. -2: Indicates invalid or absent information given in the input. -3: Indicates internal error.
result.details.metrics.version_agenumberIndicates if the definition version is recent in relation with definition date. This metric is useful for dealing with products which update with a high degree of frequency. Possible values are: 3: Indicates that the definition version is current to latest definition date. 2: Indicates that the definition version is current to the latest definition date within 12-hour window. 1: Indicates that the definition version is current to the latest definition date within 36-hour window. 0: Indicates that metric does not apply or insufficient information to determine metric. -1: Indicates that the definition version is older than 36 hours compared to the latest definition date. -2: Indicates invalid or absent information given in the input. -3: Indicates internal error.

Result Codes​

CodeNameDescription
0WAAPI_OKThe 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.

See Also​


Last updated: 2026-10-01