Skip to content

api-evangelist/nagios

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Nagios (nagios)

Nagios is a family of open-source and commercial IT infrastructure monitoring tools, including Nagios Core (the original open-source monitoring engine), Nagios XI (the commercial enterprise distribution), Nagios Fusion, Nagios Log Server, and Nagios Network Analyzer, used to monitor hosts, services, networks, applications, and metrics with alerting and reporting. Nagios Core itself has no central HTTP API; Nagios XI ships a built-in REST API (typically reached at https://{nagios-xi-host}/nagiosxi/api/v1/) for reading, writing, deleting, and updating monitoring configuration and status. The Nagios XI API is authenticated via a per-user API key passed as a query parameter or header. Passive check results can also be submitted via NRDP (HTTP, JSON/XML) or NSCA (encrypted TCP, port 5667), and the NCPA cross-platform agent exposes a hierarchical REST API on port 5693.

APIs.json: https://raw.githubusercontent.com/api-evangelist/nagios/refs/heads/main/apis.yml

Scope

  • Type: Index

Tags

  • Monitoring
  • Infrastructure Monitoring
  • Network Monitoring
  • Open Source
  • IT Operations
  • Alerting
  • Observability
  • Nagios XI
  • Nagios Core
  • NCPA
  • NRPE
  • NSCA
  • NRDP

Timestamps

  • Created: 2026-05-11
  • Modified: 2026-05-23

APIs

Nagios XI REST API

Built-in REST API for Nagios XI. Split into three sections: Objects (read-only backend for hosts, services, host groups, contacts, downtime, history), Config (admin-only writes for hosts and services), and System (admin-only commands such as apply configuration, scheduled downtime, status). Responses are returned as JSON. Authentication uses a per-user Nagios XI API key passed via the apikey query parameter (or header). Custom endpoints can be added by creating a Nagios XI Component.

Tags

  • Monitoring
  • REST
  • Nagios XI
  • IT Operations

Properties

NCPA (Nagios Cross-Platform Agent) API

REST API exposed by the Nagios Cross-Platform Agent (NCPA), a cross-platform monitoring agent that runs on Linux, Windows, and macOS. Uses a hierarchical URL structure /api/{module}/{node1}/{node2} for CPU, memory, disk, interface, process, service, and plugin metrics. Both active polling and passive Nagios-style check results (check=1 + thresholds) are supported. Authenticated via a token query parameter matching the community_string in the agent config. Default TLS port 5693.

Tags

  • Monitoring
  • Agent
  • REST
  • NCPA

Properties

NRDP (Nagios Remote Data Processor) API

PHP-based HTTP collector that accepts passive check results and external commands. Two commands are supported: submitcheck (host/service check results) and submitcmd (Nagios external command). Payloads can be sent as XML (XMLDATA) or JSON (JSONDATA) in a POST form. Authenticated by a token configured in config.inc.php with optional per-command deny mappings.

Tags

  • Monitoring
  • Passive Check
  • REST
  • NRDP

Properties

NSCA (Nagios Service Check Acceptor)

Encrypted binary TCP daemon (default port 5667) that accepts passive service/host check results from remote machines. Not REST — clients send tab-delimited records over a shared-secret-encrypted socket. Use NRDP for an HTTP/JSON equivalent.

Tags

  • Monitoring
  • Passive Check
  • Binary Protocol
  • NSCA

Properties

NRPE (Nagios Remote Plugin Executor)

Daemon that runs Nagios plugins on a remote Linux/Unix host on TCP port 5666, returning the plugin's exit code and output to the Nagios server. Binary protocol, not REST.

Tags

  • Monitoring
  • Active Check
  • Binary Protocol
  • NRPE

Properties

Common Properties

Maintainers

FN: Kin Lane Email: kin@apievangelist.com

Releases

No releases published

Packages

 
 
 

Contributors