API Surface

Current API routes used by onboarding, telemetry ingestion, policy checks, and docs-safe integration examples.

Last updated

2026-07-20 · Audience: Engineers

Onboarding Mechanics Notification Mechanics Telemetry Model API Surface Rust Agent Runtime

Core system routes

POST /api/v1/agent/invite
POST /api/v1/agent
GET  /api/v1/agent
GET  /api/v1/system/notification-checks
POST /api/v1/system/notification-checks
GET  /api/v1/system/snmp-targets
POST /api/v1/system/snmp-targets

User-facing routes

GET  /api/user/invitations
GET  /api/user/servers
POST /api/user/servers
  GET  /api/user/servers/[identifier]/notifications
  PATCH /api/user/servers/[identifier]/notifications
GET  /api/v1/notifications/profiles
POST /api/v1/notifications/profiles

Hostname compatibility window

Hostname-based server URLs remain temporarily supported for compatibility, but canonical server URLs now use routeKey. Hostname URL compatibility will be removed after 2026-10-31T00:00:00.000Z.

Integration note

For external automation, prefer stable API contracts above and avoid scraping UI internals. Keep provider credentials in secret-vault references.