These examples for the Icinga 2 API
should help you get started with your own projects.
Please read the API documentation thoroughly before looking
into the scripting details.
These examples remain generally unsupported, you should not put them in
production without your own review and knowledge.
Discuss your questions on the community channels.
If any tool or script is missing, please send a patch/PR :)
Name |
Language |
Description |
python-icinga2-api |
Python |
Python bindings for Icinga 2 interaction |
go-icinga2 |
Golang |
Golang functions and type definitions |
Name |
Language |
Description |
Dashing |
Ruby, HTML |
Dashboard for Dashing querying the REST API for current host/service/global status |
icinga2bot |
Python |
Errbot plugin to fetch status and event stream information and forward to XMPP, IRC, etc. |
IcingaBusyLightAgent |
C# |
Notification Agent in Systray |
BitBar for OSX |
Python |
macOS tray app for highlighting the host/service status |
Icinga 2 Multistatus |
- |
Chrome Extension |
Clippy.js |
PHP, JS |
Funny demo for presenting alerts in your browser |
Name |
Language |
Description |
Icinga Director |
PHP, JS |
Icinga 2 configuration interface integrated into Icinga Web 2 |
AWS/EC2 |
Ruby |
Example script for creating and deleting AWS instances in Icinga 2 |
Foreman Smart Proxy Monitoring |
Ruby |
Smart Proxy extension for Foreman creating and deleting hosts and services in Icinga 2 |
Terraform Provider |
Golang |
Register hosts from Terraform in Icinga 2 |
Name |
Language |
Description |
mqttwarn |
Python |
Forward check results from mqttwarn to Icinga 2 |
Lita handler |
Ruby |
List, recheck and acknowledge through a #chatops bot called Lita |
Sakuli forwarder |
Java |
Forward check results from tests from Sakuli to Icinga 2 |
OpsGenie actions |
Golang, Java |
Integrate Icinga 2 into OpsGenie |
Several Scripts.
Name |
Language |
Description |
go-icinga2-events |
Golang |
Connect to the event stream and output state changes |
console |
- |
Examples for using the icinga2 console CLI command |
events |
- |
Examples for event streams |
objects |
PHP, Python |
Examples for fetching status and managing objects |