NetAlertX

NetAlertX API

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

GitHub OpenAPI

Operations 69

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 #
POST /sessions/create Create a new session for a device #
DELETE /sessions/delete Delete all sessions for a given MAC #
GET /sessions/list Retrieve sessions optionally filtered by device and date range #
GET /sessions/session-events Retrieve a summary of session events #
GET /sessions/totals Return event and session totals over a given period. #
GET /sse/state GET /sse/state #
GET /sse/stats GET /sse/stats #
GET /sync Fetches data from a node to the hub. #
POST /sync Sends data from nodes to the hub. #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/netalertx/openapi/_ae-authored/netalertx-openapi-generated.yml

Schemas & Data

📊
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

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/netalertx:netalertx-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

netalertx-openapi-generated.yml Raw ↑ 
openapi: 3.1.0
info:
  title: NetAlertX API
  version: '2026-10-28'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-10-28: 69 operation(s) read from 23 public documentation page(s) (each
    operation names its page in x-source). This is not the provider''s published contract; NetAlertX has published no machine-readable contract
    that the pipeline could find. Engine: anthropic.'
  x-evidence-tiers:
    code-example: 11
    documentation: 58
    pages-with-code: 21
    pages-read: 23
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-10-28'
  x-generator: generate-contract-from-docs.py
  x-engine: anthropic
  x-sources:
  - https://docs.netalertx.com/API
  - https://docs.netalertx.com/API_MCP
  - https://docs.netalertx.com/API_OLD
  - https://docs.netalertx.com/API_SSE
  - https://docs.netalertx.com/API_LOGS
  - https://docs.netalertx.com/API_SYNC
  - https://docs.netalertx.com/API_DEVICE
  - https://docs.netalertx.com/API_EVENTS
  - https://docs.netalertx.com/API_DBQUERY
  - https://docs.netalertx.com/API_DEVICES
  - https://docs.netalertx.com/API_GRAPHQL
  - https://docs.netalertx.com/API_METRICS
  - https://docs.netalertx.com/API_NETTOOLS
  - https://docs.netalertx.com/API_SESSIONS
  - https://docs.netalertx.com/API_SETTINGS
  - https://docs.netalertx.com/API_ONLINEHISTORY
  - https://docs.netalertx.com/API_MESSAGING_IN_APP
  - https://docs.netalertx.com/API_DEVICE_FIELD_LOCK
  - https://docs.netalertx.com/HW_INSTALL
  - https://docs.netalertx.com/plugins/_publisher_apprise
  - https://docs.netalertx.com/plugins/ddns_update
  - https://docs.netalertx.com/plugins/dockerdisc


# --- truncated at 32 KB (67 KB total) ---
# Full source: https://artifacts.apis.io/netalertx/openapi/_ae-authored/netalertx-openapi-generated.yml