GetRunningState

Will check if the given product is running on the endpoint. The running state of the product does not refer to the products capabilities (such as an antivirus product's real-time protection). The running state simply refers to whether the product's process is running or active on the endpoint.

Syntax

Method ID

#define WAAPI_MID_GET_RUNNING_STATE 101

JSON Input Structure

{
  "input": {
    "method": 101,
    "signature": number,
    "instance_id": string
  }
}

Input Properties

Parameter	Type	Description
`instance_id`	string	(optional) (macOS only) (macOS only) The current instance id of the product

JSON Output Structure

{
  "result": {
    "method": 101,
    "code": number,
    "timing": number,
    "timestamp": string,
    "running": boolean
  }
}

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.running`	boolean	Will return true if the product is running and false if the product is not running.

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​