Integrations & API

GridNMS fits into the tools you already use. Most teams never need the API — built-in integrations cover the common cases. This page is a quick reference for admins.

Built-in alert integrations

Set these up under Configure → Logs and Events → Notification Endpoints, then point your detections’ notifications at them.

Integration	Use it for
Email	Send alerts to people or distribution lists.
Slack	Post alerts into a channel via an incoming webhook URL.
Webhook	POST alert data to any HTTP endpoint (your own automation, a ticketing system, etc.).
PagerDuty	Trigger incidents using a PagerDuty integration (routing) key.

See Notifications for step-by-step setup and a worked example.

Webhook payloads

A webhook endpoint receives an HTTP POST with a JSON body describing the event (device, severity, message, tags, timestamps, and status). You can add custom headers on the endpoint — for example, an authorization token your receiver expects. Use this to drive your own automation or to bridge into a system GridNMS doesn’t integrate with directly.

The REST API (for admins)

A stable, documented subset of the GridNMS REST API is available for scripting and integrating with your own systems.

• Base path: /api/v1 on your GridNMS instance (for example, https://your-instance/api/v1); the unversioned /api prefix is a permanent alias for the same endpoints.
• Authentication: create a personal API token under Profile → API Tokens and send it as Authorization: Bearer gnms_…. A token acts as your user — its access is your own permissions and sites, optionally narrowed to a smaller scope (read-only, specific resources, specific sites) at creation time. (Your browser session also authorizes API calls while you’re signed in.)

See the REST API Reference for authentication and scoping details, the response envelope, per-endpoint parameters, curl examples, and a link to the machine-readable OpenAPI spec.

The documented, stable resource areas:

Area	What it covers
Devices	Inventory: list and get devices
Events	Live and historical event search
Cases	Investigation cases and their linked events
Interfaces	Per-device interface listing
Tokens	Manage your own API tokens and their scope

Note

This is a curated, stable subset — not every internal route the app itself calls. The exact request and response shapes evolve with each release, and the running instance is the source of truth. If you’re building a substantial integration, contact support@gridnms.io — we’re happy to help.

Single sign-on & identity

Planning SSO or directory integration for your team? Reach out to support@gridnms.io to discuss the options available for your plan.