Zwall
Talk to an Engineer
Talk to an Engineer
Documentation
Docs Home › API › API Overview

API Overview

SharedStatus: SUPPORTED — customer API is /api/v1Audience: integration/API engineer, Manager administrator

Facts

  • Operator API: https://MANAGER/api/v1/... (example listen 8443 with TLS).
  • Admin auth: JWT Authorization: Bearer and/or HttpOnly session cookie for browsers. Login JSON does not return session_token.
  • Agent-facing enroll/heartbeat/sync APIs exist for Agents. They are not documented as unauthenticated website cookbooks.
  • There is no generated OpenAPI. Grouped public API pages in this book are the public reference.
  • Envelopes: AUTH_ERR, V1ERR, V1OK, License 403, Community agent-limit 403 — Errors.
  • v2 exists behind //go:build v2api and is not mounted in default binaries. If enabled, code mounts /v2, not /api/v2. NOT_SUPPORTED as a GA customer contract.
  • No GraphQL API. No OIDC/LDAP/SSO customer API.

How to use this book

Each operator page documents method, path, purpose, authentication, parameters, request, example, response, example where the source supports one, errors, edition, and security notes.

When a handler returns gin.H, []map[string]interface{}, or an untyped interface{} without a stable struct, the page marks API_SCHEMA_DOCUMENTATION_BLOCKED and still records method, path, purpose, auth, edition, and known status codes.

Primary groups (public API book)

Scroll sideways to see the full table. Use the arrow keys when focused.

GroupDocument
Conventions and envelopesConventions, Errors
Health / PrometheusHealth
Administrator login, 2FA, usersAuth
Agent enrollment (operator)Agent enrollment
Firewall / DNS / CIDR rulesRules
Blocks and blocklistsBlocks
Security logs and detection familiesSecurity
GeoIPGeoIP
Dashboard, traffic, sanityDashboard
Virtualization inventoryVirtualization
Notifications and email templatesNotifications
Logs / log-monitor / parsersLogs
Traffic viewsTraffic
SettingsSettings
AI Preview (advisory)AI Preview API

Enterprise-only API groups

These HTTP groups exist on Enterprise Manager and are not Community. Detailed operator/customer API books for them are provided separately to Enterprise customers (not linked from this public overview):

  • License status / activate / import
  • Hosting Agent status / events
  • Cloudflare IP sync
  • Unblock portal / messenger
  • Certificates / CA
  • Isolation objects
  • Maintenance backup helper (not a dump) and related internals
  • Agent-facing register / heartbeat / sync

Cloudflare, messenger/unblock, license HTTP groups, and Hosting status/events are Enterprise-only in the Main V1 router. Do not document them as Community.

Intentionally excluded from customer cookbooks

Scroll sideways to see the full table. Use the arrow keys when focused.

ClassTopic
Not customer endpointsInternal AI development endpoints (not AI Preview)
Not a public HA / updater productManager cluster as HA; in-product updater campaigns and signing-key control plane (except CLI existence notes)
Build-tagged/v2
Not shippingGraphQL, OIDC/LDAP/SSO, Terraform providers

Internal AI development endpoints are not AI Preview customer endpoints.

Canonical public pages for authentication, security logs, envelopes, and administration: Auth, Security, Conventions, and Administration.

Example request (login) 

curl -sS -X POST https://manager.example.com:8443/api/v1/auth/login \
  -H 'Content-Type: application/json' \
  -d '{"username":"admin","password":"YOUR_PASSWORD"}'

Success body keys: token, expires_at, username, role. Then:

curl -sS https://manager.example.com:8443/api/v1/agents \
  -H "Authorization: Bearer TOKEN"

Use RFC 5737 documentation addresses (203.0.113.10) in examples. Do not paste live JWTs, bootstrap tokens, or license keys.