API Endpoints

Overview

Complete endpoint reference for all ACS Monitor application API resources. All endpoints require Bearer token authentication unless noted otherwise. Endpoints are prefixed with /api/v1.

Authentication

Method Path Description Permission
POST/auth/loginAuthenticate and receive a bearer tokenPublic
POST/auth/logoutRevoke the current tokenAuthenticated
GET/auth/meGet current user info, roles, and permissionsAuthenticated

SNMP Devices

Method Path Description Permission
GET/devicesList all devices (filterable, paginated)devices.view
POST/devicesCreate a new SNMP devicedevices.create
GET/devices/{id}Get device details with OIDsdevices.view
PUT/devices/{id}Update a devicedevices.edit
DELETE/devices/{id}Delete a devicedevices.delete
POST/devices/{id}/pollTrigger an immediate SNMP polldevices.edit
POST/devices/{id}/walkPerform an SNMP walk to discover OIDsdevices.edit
GET/devices/{id}/metricsGet time-series metricsdevices.view

Device Groups

Method Path Description Permission
GET/device-groupsList all device groupsdevices.view
POST/device-groupsCreate a device groupdevices.create
GET/device-groups/{id}Get a device groupdevices.view
PUT/device-groups/{id}Update a device groupdevices.edit
DELETE/device-groups/{id}Delete a device groupdevices.delete

OIDs

Method Path Description Permission
GET/devices/{device}/oidsList OIDs for a devicedevices.view
POST/devices/{device}/oidsCreate an OID on a devicedevices.edit
GET/oids/{id}Get OID detailsdevices.view
PUT/oids/{id}Update an OIDdevices.edit
DELETE/oids/{id}Delete an OIDdevices.delete
POST/oids/{id}/toggle-monitorToggle monitoring on/off for an OIDdevices.edit

Device Webhooks

Method Path Description Permission
GET/devices/{device}/webhooksList webhooks for a devicedevices.view
POST/devices/{device}/webhooksCreate a webhook on a devicedevices.create
GET/devices/{device}/webhooks/{webhook}Get webhook detailsdevices.view
PUT/devices/{device}/webhooks/{webhook}Update a webhookdevices.edit
DELETE/devices/{device}/webhooks/{webhook}Delete a webhookdevices.delete
POST/devices/{device}/webhooks/{webhook}/toggleToggle webhook active/inactivedevices.edit
GET/devices/{device}/webhooks/{webhook}/eventsList webhook ingest events (paginated)devices.view

Webhook Alert Rules

Method Path Description Permission
GET/devices/{device}/webhooks/{webhook}/alert-rulesList alert rules for a webhookalerts.view
POST/devices/{device}/webhooks/{webhook}/alert-rulesCreate a webhook alert rulealerts.create
PUT/devices/{device}/webhooks/{webhook}/alert-rules/{rule}Update a webhook alert rulealerts.edit
DELETE/devices/{device}/webhooks/{webhook}/alert-rules/{rule}Delete a webhook alert rulealerts.delete

SNMP Traps

Method Path Description Permission
GET/snmp-trapsList SNMP traps (filter by status, severity, device, search)devices.view
GET/snmp-traps/{id}Get trap details with varbindsdevices.view
POST/snmp-traps/{id}/acknowledgeAcknowledge a trapalerts.acknowledge
DELETE/snmp-traps/{id}Delete a trapdevices.delete

Service Monitors

Method Path Description Permission
GET/monitorsList monitors (filter by status, type, group, search)monitors.view
POST/monitorsCreate a new service monitormonitors.create
GET/monitors/{id}Get monitor details with group and recent resultsmonitors.view
PUT/monitors/{id}Update a monitormonitors.edit
DELETE/monitors/{id}Delete a monitormonitors.delete
POST/monitors/{id}/checkTrigger an immediate manual checkmonitors.edit
GET/monitors/{id}/resultsGet recent check resultsmonitors.view
GET/monitors/{id}/uptimeGet uptime statistics (7d, 30d)monitors.view

Monitor Groups

Method Path Description Permission
GET/monitor-groupsList all monitor groupsmonitors.view
POST/monitor-groupsCreate a monitor groupmonitors.create
GET/monitor-groups/{id}Get a monitor groupmonitors.view
PUT/monitor-groups/{id}Update a monitor groupmonitors.edit
DELETE/monitor-groups/{id}Delete a monitor groupmonitors.delete

SNMP Alert Rules

Method Path Description Permission
GET/alert-rulesList SNMP alert rules (filter by device, severity, active)alerts.view
POST/alert-rulesCreate an SNMP alert rule with channelsalerts.create
GET/alert-rules/{id}Get rule with device, OID, channels, recent eventsalerts.view
PUT/alert-rules/{id}Update rule and sync channelsalerts.edit
DELETE/alert-rules/{id}Delete rule and detach channelsalerts.delete

SNMP Alert Events

Method Path Description Permission
GET/alert-eventsList SNMP alert events (paginated)alerts.view
GET/alert-events/{id}Get alert event detailsalerts.view
POST/alert-events/{id}/acknowledgeAcknowledge an open alertalerts.acknowledge
POST/alert-events/{id}/resolveManually resolve an alertalerts.acknowledge

Monitor Alert Rules

Method Path Description Permission
GET/monitor-alert-rulesList monitor alert rulesalerts.view
POST/monitor-alert-rulesCreate a monitor alert rulealerts.create
GET/monitor-alert-rules/{id}Get monitor alert rule detailsalerts.view
PUT/monitor-alert-rules/{id}Update a monitor alert rulealerts.edit
DELETE/monitor-alert-rules/{id}Delete a monitor alert rulealerts.delete

Monitor Events

Method Path Description Permission
GET/monitor-eventsList monitor alert eventsalerts.view
GET/monitor-events/{id}Get monitor event detailsalerts.view
POST/monitor-events/{id}/acknowledgeAcknowledge a monitor eventalerts.acknowledge
POST/monitor-events/{id}/resolveResolve a monitor eventalerts.acknowledge

Alert Channels

Method Path Description Permission
GET/alert-channelsList notification channelschannels.view
POST/alert-channelsCreate a channel (email, sms, webhook, slack)channels.create
GET/alert-channels/{id}Get channel detailschannels.view
PUT/alert-channels/{id}Update a channelchannels.edit
DELETE/alert-channels/{id}Delete a channelchannels.delete
POST/alert-channels/{id}/testSend a test notificationchannels.edit

MIBs

Method Path Description Permission
GET/mibsList uploaded MIBsmibs.view
POST/mibsUpload a MIB file (multipart)mibs.upload
GET/mibs/{id}Get MIB details and parsed OIDsmibs.view
DELETE/mibs/{id}Delete a MIBmibs.delete

Discovery

Method Path Description Permission
GET/discoveryList discovery jobsdiscovery.view
POST/discoveryCreate a discovery job (subnet CIDR)discovery.create
GET/discovery/{id}Get job details with resultsdiscovery.view
DELETE/discovery/{id}Delete a discovery jobdiscovery.create
POST/discovery/{id}/runTrigger a discovery scandiscovery.run
POST/discovery-results/{id}/importImport a discovered devicediscovery.create

Dashboards & Widgets

Method Path Description Permission
GET/dashboardsList user dashboardsdashboards.view
POST/dashboardsCreate a dashboarddashboards.create
GET/dashboards/{id}Get dashboard with widgetsdashboards.view
PUT/dashboards/{id}Update dashboard settingsdashboards.edit
DELETE/dashboards/{id}Delete dashboard and all widgetsdashboards.delete
GET/dashboards/{id}/widgetsList widgets on a dashboarddashboards.view
POST/dashboards/{id}/widgetsAdd a widget to a dashboarddashboards.edit
PUT/widgets/{id}Update a widget's configdashboards.edit
DELETE/widgets/{id}Remove a widgetdashboards.edit
POST/widgets/positionsBatch update widget positionsdashboards.edit

Users & Roles

Method Path Description Permission
GET/usersList all usersusers.view
POST/usersCreate a userusers.create
GET/users/{id}Get user detailsusers.view
PUT/users/{id}Update a userusers.edit
DELETE/users/{id}Delete a userusers.delete
GET/rolesList all roles with permissionsroles.manage
GET/roles/{id}Get role detailsroles.manage
PUT/roles/{id}Update role permissionsroles.manage

Network Tools

Method Path Description Permission
POST/tools/pingRun a ping test (host, count)monitors.run_tools
POST/tools/tracerouteRun a traceroute (host, max_hops)monitors.run_tools
POST/tools/port-scanScan TCP port range (host, port_start, port_end)monitors.run_tools
POST/tools/ssl-checkCheck SSL certificate (host, port)monitors.run_tools
POST/tools/http-headersInspect HTTP headers (url, follow_redirects)monitors.run_tools
POST/tools/dns-lookupDNS query (host, record_type, resolver)monitors.run_tools
POST/tools/whoisWHOIS lookup (query)monitors.run_tools

Webhook Ingest

Method Path Description Permission
GET|POST/webhook-ingest/{token}Receive webhook data (no auth, token-based)Public

Notes:

  • Accepts any JSON body — stored as the webhook event payload
  • Query parameters are also captured
  • Token is generated when creating a webhook on a device
  • Source IP is logged for each ingest event

System

Method Path Description Permission
GET/system/healthSystem health metrics (services, queues, DB)settings.view
GET/system/statsApplication statistics (device/monitor counts)settings.view

We use essential cookies only to keep you logged in and remember your preferences. Cookie Policy