Heartbeat

This URL provides McAfee Advanced Threat Defense availability information to the user.

Resource URL

GET https://<MATD_IP>/php/heartbeat.php

Input parameters

The following HTTP headers should be specified in the resource URL request:

  • Accept: application/vnd.ve.v1.0+json
  • Content-Type: application/json
  • VE-SDK-API: Base64 encoded "session:user id" string

Input parameters are only the following mandatory header parameters that you must supply in all calls (except File Submission, Bulk sample status, and verify blacklisted and whitelisted hash values). Going forward, this document does not mention these two parameters.

Input parameter Description Data type
session Logged on session id. String
userId Logged on user id. String
Important: All other URL resources in the ATD RESTful API are required to pass these credentials for validation and authorization in VE-SDK-API custom header.

Output parameters

Output parameter Description Data type
session Logged on session id. String
userId Logged on user id. String
heartBeat The time in seconds when the response was returned. Numeric

Example

Input

In the HTTP header: 

"Accept: application/vnd.ve.v1.0+json"
"Content-Type: application/json"
"VE-SDK-API:" + base64 encoded "u5hiesvp9nmv9ti44vnpoi27b5:1" string

Output 

{"success": true, "results": {"session": "u5hiesvp9nmv9ti44vnpoi27b5","userId": "1","heartBeat": 
"1362247723"} }