a1aa4cdbda
The routes used are the same that are used when issuing commands on multiple objects (bulk actions). So the filter that's used in the examples can be any other filter as well. Input data must be provided as `multipart/form-data`. They respond with the JSON format provided by Icinga Web and are only accessible for non-XHR clients. ## Examples ### Adding a comment ``` curl -H "Accept: application/json" -u icingaadmin:icinga "http://localhost/icingaweb2/icingadb/hosts/add-comment?host.name=docker-master" -F "comment=kaput" -F "expire_time=2023-09-05T20:00:00" -F "expire=y" -v * Trying 127.0.0.1:80... * Connected to localhost (127.0.0.1) port 80 (#0) * Server auth using Basic with user 'icingaadmin' > POST /icingaweb2/icingadb/api/v1/hosts/add-comment?host.name=docker-master HTTP/1.1 > Host: localhost > Authorization: Basic aWNpbmdhYWRtaW46aWNpbmdh > User-Agent: curl/7.81.0 > Accept: application/json > Content-Length: 362 > Content-Type: multipart/form-data; boundary=------------------------da76739ff7328fd9 > * We are completely uploaded and fine * Mark bundle as not supporting multiuse < HTTP/1.1 200 OK < Server: nginx/1.23.4 < Date: Tue, 05 Sep 2023 07:44:56 GMT < Content-Type: application/json < Transfer-Encoding: chunked < Connection: keep-alive < X-Powered-By: PHP/8.2.3 < X-Xdebug-Profile-Filename: /tmp/cachegrind.out.128.gz < * Connection #0 to host localhost left intact {"status":"success","data":[{"type":"success","message":"Added comment successfully"}]} ``` #### In case there's an error ``` curl -H "Accept: application/json" -u icingaadmin:icinga "http://localhost/icingaweb2/icingadb/hosts/add-comment?host.name=docker-master" -F "comment=kaput" -F "expire_time=2023-08-05T20:00:00" -F "expire=y" -v * Trying 127.0.0.1:80... * Connected to localhost (127.0.0.1) port 80 (#0) * Server auth using Basic with user 'icingaadmin' > POST /icingaweb2/icingadb/api/v1/hosts/add-comment?host.name=docker-master HTTP/1.1 > Host: localhost > Authorization: Basic aWNpbmdhYWRtaW46aWNpbmdh > User-Agent: curl/7.81.0 > Accept: application/json > Content-Length: 362 > Content-Type: multipart/form-data; boundary=------------------------53cd05bc746f90be > * We are completely uploaded and fine * Mark bundle as not supporting multiuse < HTTP/1.1 422 < Server: nginx/1.23.4 < Date: Tue, 05 Sep 2023 07:45:31 GMT < Content-Type: application/json < Transfer-Encoding: chunked < Connection: keep-alive < X-Powered-By: PHP/8.2.3 < X-Xdebug-Profile-Filename: /tmp/cachegrind.out.129.gz < * Connection #0 to host localhost left intact {"status":"fail","data":{"comment":[],"expire":[],"expire_time":["The expire time must not be in the past"]}} ``` ### Scheduling a downtime ``` curl -H "Accept: application/json" -u icingaadmin:icinga "http://localhost/icingaweb2/icingadb/hosts/schedule-downtime?host.name=docker-master" -F "comment=kaput" -F "start=2023-09-05T20:00:00" -F "end=2023-09-05T22:00:00" -F "flexible=y" -F "hours=1" -F "minutes=0" -F "all_services=n" -F "child_options=0" -v * Trying 127.0.0.1:80... * Connected to localhost (127.0.0.1) port 80 (#0) * Server auth using Basic with user 'icingaadmin' > POST /icingaweb2/icingadb/api/v1/hosts/schedule-downtime?host.name=docker-master HTTP/1.1 > Host: localhost > Authorization: Basic aWNpbmdhYWRtaW46aWNpbmdh > User-Agent: curl/7.81.0 > Accept: application/json > Content-Length: 866 > Content-Type: multipart/form-data; boundary=------------------------2222dcc7ed0e5442 > * We are completely uploaded and fine * Mark bundle as not supporting multiuse < HTTP/1.1 200 OK < Server: nginx/1.23.4 < Date: Tue, 05 Sep 2023 07:47:10 GMT < Content-Type: application/json < Transfer-Encoding: chunked < Connection: keep-alive < X-Powered-By: PHP/8.2.3 < X-Xdebug-Profile-Filename: /tmp/cachegrind.out.129.gz < * Connection #0 to host localhost left intact {"status":"success","data":[{"type":"success","message":"Scheduled downtime successfully"}]} ``` |
||
|---|---|---|
| .github | ||
| application | ||
| doc | ||
| library/Icingadb | ||
| public | ||
| test/php | ||
| .gitattributes | ||
| .gitignore | ||
| .mailmap | ||
| .phpcs.xml | ||
| AUTHORS | ||
| CHANGELOG.md | ||
| configuration.php | ||
| CONTRIBUTING.md | ||
| LICENSE | ||
| module.info | ||
| phpstan-baseline.neon | ||
| phpstan.neon | ||
| phpunit.xml | ||
| README.md | ||
| run.php | ||
| SECURITY.md | ||
Icinga DB Web
Icinga DB is a set of components for publishing, synchronizing and visualizing monitoring data in the Icinga ecosystem, consisting of:
- Icinga DB Web which connects to both a Redis server and a database to view and work with most up-to-date monitoring data
- Icinga 2 with its Icinga DB feature enabled, responsible for publishing the data to the Redis server, i.e. configuration and its runtime updates, check results, state changes, downtimes, acknowledgements, notifications, and other events such as flapping
- And the Icinga DB daemon, which synchronizes the data between the Redis server and the database
Documentation
Icinga DB Web documentation is available at icinga.com/docs.
Features
Icinga DB Web offers a modern and streamlined design to provide a clear and concise view of your monitoring environment, also with dark and light mode support.
Various List Layouts
The view switcher allows to control the level of detail displayed in host and service list views:
Search with Autocomplete
The search bar in list views can be used for everything from simple searches to creating complex filters. It allows full keyboard control and also supports contextual auto-completion. In addition, there is an editor for easier filter creation.
Clean Detail Views
Host and service detail views are structured to make best use of available space. Related information is grouped and important information is at the top for instant access without having to scroll down.
Modal Dialogs
Any interaction that requires user input, such as acknowledging problems, scheduling downtimes, etc., shows a modal dialog over the current view to preserve context and focus on interaction.
Bulk Operations
Bulk interactions such as scheduling downtimes for multiple objects, acknowledging multiple problems, etc.
are easily accomplished with the Continue With control that operates on filtered lists.
License
Icinga DB Web and the Icinga DB Web documentation are licensed under the terms of the GNU General Public License Version 2.