Skip to main content
POST
/
api
/
v1
/
edge
/
register
Register edge agent
curl --request POST \
  --url https://api.logfleet.io/api/v1/edge/register \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "name": "<string>",
  "hostname": "<string>",
  "version": "<string>",
  "labels": {}
}
'
{
  "agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "registered"
}

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.

Registers a new edge agent with LogFleet. Called once when the agent starts up.
If the agent was previously registered (same name within organization), this updates the existing record rather than creating a duplicate.

Authorizations

​
X-API-Key
string
header
required

API key for edge agents

Body

application/json
​
name
string
required
​
hostname
string
​
version
string
​
labels
object

Response

Agent registered

​
agent_id
string<uuid>
​
status
string
Example:

"registered"