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
Section titled “Built-in alert integrations”Set these up under Configure → Notification Endpoints, then point your detections’ notifications at them.
| Integration | Use it for |
|---|---|
| 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
Section titled “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)
Section titled “The REST API (for admins)”Everything you can do in the GridNMS web app is backed by a REST API, so you can script bulk operations or integrate with your own systems.
- Base path: the API lives under
/apion your GridNMS instance (for example,https://your-instance/api). - Authentication: the API uses your authenticated session — sign in to GridNMS, and your session authorizes API calls. Access is governed by the same roles and permissions as the UI.
Common resource areas:
| Area | What it covers |
|---|---|
| Devices | Inventory: list, create, update, search, status |
| Events | Live events and historical event search |
| Interfaces | Per-interface data, bandwidth metrics, thresholds |
| Topology & neighbors | The device map and discovered links |
| Discovery | Run network scans and bulk-add results |
| Detections & endpoints | Your alert rules and routing |
| Reports | Inventory and event summaries |
| Users, roles & groups | Access management |
Single sign-on & identity
Section titled “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.