# NetAlertX API

**Canonical:** https://apis.io/apis/netalertx/netalertx-api/  
**Provider:** NetAlertX — https://apis.io/providers/netalertx/  
**Documentation:** https://docs.netalertx.com/API

NetAlertX API is one of 2 APIs that [NetAlertX](https://apis.io/providers/netalertx/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. This API exposes 6 JSON Schema definitions. The published artifact set on APIs.io includes an OpenAPI specification and 6 JSON Schemas.

NetAlertX API as documented publicly: 69 operations. Contract generated from the documentation by API Evangelist (2026-10-28); not the provider's own document.

## Operations (60 of 69)

| Method | Path | Summary |
|---|---|---|
| DELETE | `/` | DELETE / |
| GET | `/` | GET / |
| POST | `/` | POST / |
| POST | `/api/device/AA{BB}{CC}{DD}{EE}{FF}/field/lock` | POST /api/device/AA:BB:CC:DD:EE:FF/field/lock |
| POST | `/dbquery/delete` | Delete rows in a table by columnName + id. |
| POST | `/dbquery/read` | Execute a read-only SQL query (e.g., SELECT). |
| POST | `/dbquery/update` | Update rows in a table by columnName + id (parameterized to reduce SQL injection risk). |
| POST | `/dbquery/write` | Execute a write query (INSERT, UPDATE, DELETE). |
| GET | `/device/AA{BB}{CC}{DD}{EE}{FF}` | Fetch all details for a single device, including computed status, session and event counts, presence hours, and children devices. |
| POST | `/device/AA{BB}{CC}{DD}{EE}{FF}` | Create or update a device record with full-replace semantics. |
| DELETE | `/device/AA{BB}{CC}{DD}{EE}{FF}/delete` | Deletes the device with the given MAC. |
| POST | `/device/AA{BB}{CC}{DD}{EE}{FF}/set-alias` | Convenience wrapper to update the device display name (devName). |
| POST | `/device/AA{BB}{CC}{DD}{EE}{FF}/update-column` | Update exactly one field for a device without touching any other fields. |
| POST | `/device/copy` | Copy all data from one device to another. |
| POST | `/device/{mac}/field/lock` | Lock or Unlock a Field |
| DELETE | `/devices` | Deletes devices by MAC address. |
| GET | `/devices` | Retrieves all devices from the database. |
| GET | `/devices/by-status` | Returns devices filtered by status. |
| DELETE | `/devices/empty-macs` | Removes all devices where MAC address is null or empty. |
| GET | `/devices/export` | Exports all devices in CSV (default) or JSON format. |
| POST | `/devices/fields/unlock` | Unlock fields (clear LOCKED / USER sources) for one device, a list of devices, or all devices. |
| GET | `/devices/history/filters` | To populate dynamic filter dropdowns, fetch available changedBy and changedColumn values. |
| POST | `/devices/import` | Imports devices from an uploaded CSV or base64-encoded CSV content. |
| GET | `/devices/latest` | Get the most recently connected device. |
| GET | `/devices/network/topology` | Get network topology showing device relationships. |
| POST | `/devices/search` | Search devices by MAC, name, or IP. |
| GET | `/devices/totals` | Returns counts of devices by various categories. |
| DELETE | `/devices/unknown` | Deletes devices with names marked as (unknown) or (name not found). |
| DELETE | `/events` | Delete all events. |
| GET | `/events` | Retrieve all events, optionally filtered by MAC address. |
| GET | `/events/last` | Get the 10 most recent events. |
| GET | `/events/recent` | Get events from the last 24 hours. |
| GET | `/graphql` | Advanced queries and filtering for Devices, Settings and Language Strings |
| POST | `/graphql` | POST /graphql |
| GET | `/health` | Exposes live process_cpu_pct and process_rss_mb fields for external monitoring. |
| DELETE | `/history` | Remove all records from the online history table (Online_History). |
| GET | `/info` | Read the daemon's hostname for host MAC auto-detection. |
| GET | `/jokob-sk/NetAlertX/main/install/debian12/install.debian12.sh` | GET /jokob-sk/NetAlertX/main/install/debian12/install.debian12.sh |
| GET | `/jokob-sk/NetAlertX/main/install/ubuntu24/install.sh` | GET /jokob-sk/NetAlertX/main/install/ubuntu24/install.sh |
| DELETE | `/logs` | Purge the contents of an allowed log file. |
| POST | `/logs/add-to-execution-queue` | Add a system action to the execution queue. |
| GET | `/mcp/sse/openapi.json` | Returns the OpenAPI specification for all available MCP tools, describing the parameters and schemas for each tool. |
| DELETE | `/messaging/in-app/delete` | Remove all notifications from the system. |
| POST | `/messaging/in-app/read/all` | Mark all notifications as read. |
| GET | `/messaging/in-app/unread` | Retrieve all unread notifications. |
| POST | `/messaging/in-app/write` | Create a new in-app notification. |
| GET | `/metrics` | API Endpoint: Prometheus Exporter |
| GET | `/nettools/interfaces` | Fetches the list of network interfaces on the system, including IPv4/IPv6 addresses, MAC, MTU, state (up/down), and RX/TX byte counters. |
| GET | `/nettools/internetinfo` | Fetches public internet connection information using ipinfo.io. |
| POST | `/nettools/nmap` | Runs an nmap scan on a target IP address or range. |
| POST | `/nettools/nslookup` | Resolves an IP address or hostname using nslookup. |
| GET | `/nettools/speedtest` | Runs an internet speed test using speedtest-cli. |
| POST | `/nettools/traceroute` | Performs a traceroute to a specified IP address. |
| POST | `/nettools/wakeonlan` | Sends a Wake-on-LAN packet to wake a device. |
| GET | `/networks` | Look up network driver information for containers. |
| GET | `/nic/update` | GET /nic/update |
| POST | `/notify` | POST /notify |
| GET | `/notify/` | Test apprise notification endpoint for sending notifications to configured services. |
| GET | `/sessions/AA{BB}{CC}{DD}{EE}{FF}` | Retrieve sessions for a specific device |
| GET | `/sessions/calendar` | View sessions in calendar format |

…and 9 more operations. They are listed in full on the page.

## Machine-readable artifacts (7)

- **OpenAPI** — https://artifacts.apis.io/netalertx/openapi/_ae-authored/netalertx-openapi-generated.yml
- **JSONSchema** — https://artifacts.apis.io/netalertx/json-schema/netalertx-post-sync-request-schema.json
- **JSONSchema** — https://artifacts.apis.io/netalertx/json-schema/netalertx-post-device-aa-bb-cc-dd-ee-ff-update-column-request-schema.json
- **JSONSchema** — https://artifacts.apis.io/netalertx/json-schema/netalertx-get-device-aa-bb-cc-dd-ee-ff-response-schema.json
- **JSONSchema** — https://artifacts.apis.io/netalertx/json-schema/netalertx-get-sync-response-schema.json
- **JSONSchema** — https://artifacts.apis.io/netalertx/json-schema/netalertx-get-devices-history-filters-response-schema.json
- **JSONSchema** — https://artifacts.apis.io/netalertx/json-schema/netalertx-get-metrics-response-schema.json

## Other NetAlertX APIs (1)

- [NetAlertX API](https://apis.io/apis/netalertx/netalertx-api-2/)

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/netalertx/netalertx-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/netalertx/.