Skip to main content
POST
/
api
/
v1
/
edge
/
heartbeat
Send heartbeat
curl --request POST \
  --url https://api.logfleet.io/api/v1/edge/heartbeat \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "online",
  "version": "<string>",
  "metrics": {}
}
'
{
  "status": "acknowledged",
  "server_time": "2023-11-07T05:31:56Z"
}

Documentation Index

Fetch the complete documentation index at: https://docs.logfleet.io/llms.txt

Use this file to discover all available pages before exploring further.

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>