Docs

The installed agent works today. Cloud integrations do not exist yet.

1. Create an ingest key

Sign in, open Settings, and create a key. It is shown once. The key scopes every write to your organization and can do nothing else — it cannot read your data, and it cannot reach another tenant.

2. Install the agent

A dependency-free shell script. It needs outbound HTTPS and nothing else — no inbound ports, no daemon.

curl -fsSL https://www.knoxed.ai/agent/knoxed-agent.sh \
  -o /usr/local/bin/knoxed-agent
chmod +x /usr/local/bin/knoxed-agent

3. Run it

KNOXED_KEY=knx_xxx_yyy KNOXED_ROLE=prod knoxed-agent

Then schedule it once a minute:

* * * * * KNOXED_KEY=knx_xxx_yyy KNOXED_ROLE=prod \
  /usr/local/bin/knoxed-agent >/dev/null 2>&1

It reports uptime, load, memory, disk usage, and core count, and marks the host degraded when disk exceeds 90% or load exceeds twice the core count.

Sending events yourself

The agent is a thin wrapper over one endpoint. Post directly if you prefer — from a deploy script, a cron job, or CI.

POST https://www.knoxed.ai/api/ingest
Authorization: Bearer knx_xxx_yyy
Content-Type: application/json

{
  "host":   { "role": "prod", "hostname": "web-1", "status": "online" },
  "events": [ { "kind": "deploy", "status": "ok", "subject": "v1.4.2" } ]
}

Both fields are optional. At most 100 events per request; the body is capped at 256 KB. Any org_id in the body is ignored — the organization comes from the key.

Responses

  • 200{ "ok": true, "events_inserted": 1 }
  • 401 — missing, malformed, revoked, or wrong key
  • 400 — invalid JSON, bad timestamp, or over the event cap
  • 413 — body too large

Cloud integrations

GitHub, Sentry, AWS, and Vercel connectors are being built. They are not available yet, and nothing in the product pretends they are.