Skip to main content
POST
Send heartbeat
Sends a heartbeat signal indicating the agent is alive and healthy. Called every 30 seconds. The platform uses heartbeats to:
  • Track agent online/offline status
  • Monitor agent health
  • Detect connectivity issues

Authorizations

X-API-Key
string
header
required

API key for edge agents

Body

application/json
agent_id
string<uuid>
required
status
enum<string>
required
Available options:
online,
offline,
error
version
string
metrics
object

System metrics (CPU, memory, disk)

Response

Heartbeat acknowledged

status
string
Example:

"acknowledged"

server_time
string<date-time>