ConsumeOfflineVmodDatabase

Consumes an offline vmod database and any compatible databases residing in the same directory.

Syntax

Method ID

#define WAAPI_MID_CONSUME_OFFLINE_VMOD_DATABASE 50520

JSON Input Structure

{
  "input": {
    "method": 50520,
    "dat_input_source_file": string,
    "use_delta_flow": number
  }
}

Input Properties

Parameter	Type	Description
`dat_input_source_file`	string	Input database if to be consumed from a file location.
`use_delta_flow`	number	(optional) (Linux System Vulnerability only) Enable the Delta Update mechanism on the endpoint. Accepted values are: • `0`: the SDK loads the Standard database. • `1`: the SDK attempts to load the Baseline database and the corresponding Delta database. If the Baseline database is not available, it falls back to load the Standard database. • `2`: the SDK attempts to load the Baseline database and the corresponding Delta database without any fallback to load the Standard database.Default value of this field is `0`.

JSON Output Structure

{
  "result": {
    "method": 50520,
    "code": number,
    "timing": number,
    "timestamp": string,
    "version": string,
    "schema_version": string,
    "published_epoch": string,
    "details": {
      "number_of_cves": number,
      "number_of_msbs": number,
      "number_of_kbs": number
    },
    "loaded_files": [
      {
        "file_name": string,
        "file_path": string,
        "type": string,
        "version": string,
        "published_epoch": string
      },
      ...
    ]
  }
}

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.version`	string	Version of the database.
`result.schema_version`	string	Schema version of the database.
`result.published_epoch`	string	The timestamp the database was published.
`result.details`	object	Details of the database.
`result.details.number_of_cves`	number	Number of CVE feeds in the database.
`result.details.number_of_msbs`	number	Number of MSB feeds in the database.
`result.details.number_of_kbs`	number	Number of KB feeds in the database.
`result.loaded_files`	array<object>	(optional) List of database files has been loaded. This field typically appears when Delta Update technology or smart loading feature is used.
`result.loaded_files.file_name`	string	Filename of the loaded dataset.
`result.loaded_files.file_path`	string	Path to the loaded dataset.
`result.loaded_files.type`	string	Type of the loaded dataset. Possible values: 'standard', 'extra', 'baseline' or 'delta'.
`result.loaded_files.version`	string	Format version of the loaded dataset.
`result.loaded_files.published_epoch`	string	The epoch timestamp when the loaded dataset was published.

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​