API Reference

All endpoints require a Bearer token obtained from your Clerk session:

curl 'https://api.layer8systems.ca/v1/assets' \
  -H "Authorization: Bearer <your_token>"

Generate a token in Settings → API Keys.

https://api.layer8systems.ca

All endpoints enforce per-user rate limits. Responses include 429 Too Many Requests with a Retry-After: 60 header when a limit is exceeded.

Layer8 is a cloud service — it has no network path into your private infrastructure, so live device status has to come from something running inside your own network. The @layer8systems/agent package is that something: it polls GET /v1/maps/{id}/nodes, checks each node that has an IP or hostname for reachability, and reports back via PATCH /v1/nodes/{id}/status.

Run it anywhere with line-of-sight to your mapped devices — a spare server, a Raspberry Pi, a container:

LAYER8_API_KEY=<your_key> LAYER8_MAP_ID=<your-map-id> npx @layer8systems/agent

It polls every 60 seconds, checking reachability with a TCP connect on port 443 (falling back to 80). Nodes without an IP or hostname are skipped, not marked unreachable. It's a thin wrapper around the two endpoints above — anything it does, your own monitoring can do too by calling them directly.