General - Session Heartbeat.adoc

General - Session Heartbeat

A session can be extended with a HTTP GET to /api/edge/heartbeat.json.

The web UI includes an ignored t querystring parameter to prevent a browser or network device cache from preventing the remote connection from reaching the remote device. The URL format the web UI uses is /api/edge/heartbeat.json?t=epoch where epoch is the current time in Unix epoch notation (such as 1591537772865).

Table of Contents

• Response
  • Root
• Examples
  • Successful Ping Request Response

Response

Root

Name	Type	Values	Description
SESSION	Boolean	true or false	Whether the user has a valid session.
PING	Boolean	true or false	Whether the ping heartbeat extension was successful.

Examples

Successful Ping Request Response

POST /api/edge/heartbeat.json?t=1591537772865 Response

{"SESSION": true, "PING": true}