Copyright © 2010-2025
Nagios Enterprises, LLC. All rights reserved.
This document describes how to configure Nagios® XI™ to run global event handler scripts in order to process host and service state changes, alerts, and notification information. Global event handlers allow admins to run custom-developed scripts with Nagios XI in order to create custom automation processes.
This document is intended for use by Nagios XI Administrators who have a good understanding of scripts and want to automate their monitoring environment based on host or service state changes.
Nagios XI 2024 has a built-in API that can be used to read, write, delete, and update data in the system through commands authenticated via your Nagios XI API key. Responses are returned as JSON. While this guide will provide basic information, comprehensive details on usage and endpoints can be found in the Nagios XI interface by navigating to the Help > API Docs section.
Important: This feature is now deprecated. Please use the new REST API, which was introduced in Nagios XI 5. To view the REST API documentation in Nagios XI navigate to Help > API Docs.
Nagios XI includes a backend API that allows developers to pull current status information and more in XML format for use by external systems. This simple API makes it easy to integrate Nagios information into third-party applications and external websites. This document describes how to access to backend API and query information.
Accessing The XI Backend API (Legacy)
Important: This feature is now deprecated. Please use the new REST API, which was introduced in Nagios XI 5. To view the REST API documentation in Nagios XI navigate to Help > API Docs.
If you'd like to integrate host/status information from Nagios XI into a public portal or display of some kind, you'll likely be interested in our example backend API access code. The ZIP file below contains some sample code for accessing the backend API. You can modify as needed. The access credentials are invisible to the public, and the information to be displayed can be customized (if you don't mind diving into some PHP).
This document describes how to write custom configuration wizards in Nagios® XI™. This document will cover how to create a new wizard using a custom plugin and also cover how to utilize some of the programming tools within the Nagios XI framework.
This document is intended for use by Nagios XI Administrators and Developers wanting to create custom configuration wizards, and is intended for an audience that has some familiarity with programming and HTML.
This document describes how to use the Nagios XI Framework to access data and build a successful component. Components are developed to extend the functionality of your Nagios XI installation.
This document is intended for use by Nagios XI Administrators and Developers looking to customize their installation by creating their own components.
The following is a guide on how to create a autoIT script which captures URL's load time from a remote Windows machine, pushes it up through NRPE to a Nagios XI Plugin, and returns the data to a nagios service.
Integrating autoIT With Nagios XI 2024
Integrating autoIT With Nagios XI v5 (Legacy)
The example autoIT Timer plugin can be found here
This document describes how to combine your autoIT scripted windows sequences (.au3 file) with batch files to create a NRPE check for Nagios.
This document is intended for use by Nagios XI Administrators interested in creating NRPE checks which run a automation script on a windows system.
Using autoIT scripts with NRPE checks in the Nagios Environment
The following is a guide on how to create a autoIT script which captures a program's load time from a remote Windows machine, pushes it up through NRPE to a Nagios XI Plugin, and returns the data to a nagios service.
Checking Program Loadtime With autoIT - XI 2024
Checking Program Loadtime With autoIT - XI v5 (Legacy)
The example autoIT Timer plugin can be found here.
This document describes how to configure the XI Actions Component. This includes the the custom url, linux shell/script, macro, and php code evaluation portions of the component.
This document is intended for use by Nagios XI Administrators familiar with Linux shell scripting and argument passing who want to create "quick actions" for objects in XI.
This document describes how to begin contributing translations to the following Nagios products:
As Nagios continues to expand with different languages, we appreciate help from our community to improve the translation files. If you are interested in submitting updates to the translation files for the listed applications, this document will outline the steps to contribute your translations.