heartbeat¶
-
POST
/heartbeat
¶ Sends a heartbeat to the server to reset session timeout.
Example Request
POST /heartbeat HTTP/1.1 Content-Type: application/json Accept: application/json { "apikey": "E14D8D73-0C78-4583-897A-EE9C1B10E10A", "sessionid": "48F2E9A0-ABD6-4C80-B8DA-61D0DDE4A43B" }
Example Response
HTTP/1.1 200 OK Content-Type: application/json { "data": null, "message": "Heartbeat received.", "success": true }
Request JSON Object: - apikey (string) – User API key
- sessionid (string) – User session ID
Response JSON Object: - data – Response data
- message – Response message
- success – Returns
true
if heartbeat is successful,false
otherwise