Commit Graph

57 Commits

Author SHA1 Message Date
Michael Friedrich 4296622f52 REST API Docs: Add Golang client code example 2019-03-26 09:46:36 +01:00
Michael Insel 081d88436f Unify documentation code formatting
This unifies the documentation code formatting to use only backticks.
2019-03-26 09:11:03 +01:00
Luiz Amaral ae2de7b423
Fix incorrect title in API docs
The API docs had the title "List Configuration Packages and their Stages" written twice.
2019-03-20 11:34:59 +01:00
Michael Insel 0042b54298 Escape pipe symbol in api documentation
This escapes the pipe symbol in the api documentation.

refs #6955
2019-02-18 16:22:34 +01:00
Michael Friedrich ba8d79f3c5 API Event Streams: Add 'command' for Notification events
fixes #6824
2018-12-07 09:37:03 +01:00
Michael Friedrich 3cb2c1d143 icinga.com: Update everything else 2018-10-18 09:50:53 +02:00
Michael Friedrich 2372abb49a Add upgrading docs for API schedule-downtime 'child_options' 2018-08-24 14:56:04 +02:00
Noah Hilverling 01fea22c77 Add child_options to ScheduledDowntime
refs #3935
2018-08-24 14:29:39 +02:00
Michael Friedrich 2fd6709952 Remove ApiUser password_hash functionality
This affects and fixes

- Windows reload
- Config validation
- RHEL 7.5 OpenSSL memory corruption
- Hash algorithm, requested changes

refs #6378
refs #6279
refs #6278
2018-06-19 11:32:03 +02:00
Michael Friedrich 447dad91c0 Increase header size to 8KB for HTTP requests
This is the default for Tomcat and Apache too
and avoids problems with cookies and long URLs.

fixes #6355
2018-06-06 20:25:36 +02:00
Leah Oswald 1f681e195d clarify the permision system of the api in the docs
Clarify that the permission system used by the api isn't equivalent
with the system used by the Icinga Web 2 frontend. And that its rather based
on the url scheme of the API endpoints.
2018-06-05 16:20:09 +02:00
Michael Friedrich c58caf3550 Add global API parameters to the docs; Add API troubleshooting section 2018-04-12 19:44:58 +02:00
Michael Friedrich 5e8321f3a4 Add verbose parameter to the docs 2018-04-06 13:03:08 +02:00
Michael Insel 7d165d39c2 Doc: Fix typo in API user creation example
This fixes a typo in the API user creation example inside the documentation.
2018-03-22 20:47:15 +01:00
Gunnar Beutner 39e303a03b Fix incorrect parameter name in the API documentation
fixes #6140
2018-03-05 08:43:13 +01:00
Gunnar Beutner 45c2803f3e Fix incorrect HTTP content length limits 2018-02-28 12:28:02 +01:00
Jean Flach 6bb2ed4258 Merge branch 'feature/security-features' 2018-02-21 16:19:54 +01:00
Jean Flach 85f45d9b94 Minor codestyle and doc changes 2018-02-21 14:52:44 +01:00
Jean Flach fae7f172db Update docs 2018-02-21 14:40:22 +01:00
Noah Hilverling 2823ebb831 Limit HTTP body size 2018-02-20 13:32:04 +01:00
Jean Flach 92e2faaa08 Hash API password and comparison
fixes #4920
2018-02-15 13:09:22 +01:00
Michael Friedrich 407a2d052b
Merge pull request #6080 from Icinga/feature/docs-api-ignore-on-error
Document the 'ignore_on_error' attribute for object creation
2018-02-06 18:10:12 +01:00
Michael Friedrich e3b6a89422 Document the 'ignore_on_error' attribute for object creation
fixes #5797
2018-02-06 18:03:36 +01:00
Michael Friedrich 12471bf259 Allow to pass raw performance data in 'process-check-result' API action
This is how data is coming from Icinga Web 2 and still a valid input
type.

fixes #4786
2018-02-06 15:25:55 +01:00
Gunnar Beutner e8b3faec91 Remove Icinga Studio 2018-02-02 07:22:50 +01:00
Michael Friedrich 211a07f49a Add 'ttl' support for check result freshness via REST API
The `process-check-result` action can now optionally set the
`ttl` parameter. This overrules the configured freshness
check (check_interval).

The main idea behind this is to allow the external sender
to specify when the next check result is coming in.

For example, a backup script which should be run every
24h can specify the exact expected next check result.

The addition to the CheckResult class is necessary to
forward the check result throughout the cluster and
calculate the `next_check` value on each node. This
allows us to send in a check result on a satellite,
and the master determines the freshness and possible
notifications/state changes for Icinga Web 2.
2018-01-15 13:54:11 +01:00
Michael Friedrich d073a807b0 API: Add 'pretty' parameter for beautified JSON response bodies
fixes #5877
2018-01-08 20:55:36 +01:00
Jean Flach f4a1747e14
Merge pull request #5732 from Icinga/fix/flapping
Fix flapping calculation and events

fixes #5720
2017-11-08 15:10:55 +01:00
Michael Friedrich 026f6d6f2e Add documentation for new attributes in `Flapping` API event stream type 2017-11-08 10:17:05 +01:00
Irina Kaprizkina 4dad601fb6 Add documentation for multi-line plugin output for API actions
Signed-off-by: Michael Friedrich <michael.friedrich@icinga.com>
2017-11-02 15:58:39 +01:00
Michael Friedrich 2d8607d6b0 Enhance documentation with more details on value types for object attributes
Main focus: Object attributes and their value types. Originates from the
API Event Streams patch to document their value types. Now applied to
the entire configuration objects chapter.

The API chapter and their value types has been changed to capitalized
type identifiers.

Value types are now explicitly told about inside monitoring basics. This
has been adopted into the Icinga 2 training material a long time ago
and finds its way into the docs too.

The CheckResult and PerfdataValue value types have been moved into the
advanced topics chapter. mkdocs doesn't like multiple `#` headings in one file
and did just hide it.

Also moved the Influxdb details into the features documentation where it
belongs.

Many small references and URLs to other chapters added.
E.g. dedicated chapters for object accessor examples, to better link against
time dependent thresholds.

Can serve as patch basis and reference for ITL documentation where the
value types are missing too.

This commit also fixes the non-requirement of "legacy-timeperiod" which
also is a default template import since 2.6.

This also fixes the state mapping issue.

fixes #4015
2017-10-10 17:52:49 +02:00
ryanohnemus 1cb39994a5 API: Add optional reload parameter to config stage upload
You can now specify a boolean `reload` attribute that
will allow you to skip the icinga2 reload after config
validation. By default this is set to true.

The response text has been updated to show if icinga2
will reload or if it was requested to be skipped.

fixes #4769
2017-09-20 14:16:55 +02:00
Michael Friedrich e88b97079c API: Add execution_{start,end} attribute to 'process-check-result' action
fixes #5002
2017-08-21 17:20:56 +02:00
Michael Friedrich c1784bbb13 Merge pull request #5425 from Icinga/fix/doc-api
Fix formatting in API docs
2017-07-20 10:47:11 +02:00
Glauco Vinicius 41fe01dbc3 Fix formatting in API docs
Indent curl command to get the appropriated code highlight.
2017-07-20 10:41:17 +02:00
Blerim Sheqa eb88217e2d Update docs for better compatibility with mkdocs
* Rename files to allow easy ordering
* Update links inside markdown according to new file names
* Move HTML links (<a>...</a>) to the end of the header lines
  * This is necessary to allow mkdocs to parse headers correctly and display them in the TOC
  * Following sed command was used: sed -i .bu 's/\(<a.*a>\) \(.*\)/\2 \1/g' $filename
2017-07-12 20:46:12 +02:00
Michael Friedrich a64ff362e6 Docs: Add API query example for acknowledgements w/o expire time 2017-05-22 17:48:31 +02:00
Rune Darrud 273ca6a2cc Fix persistent comments for Acknowledgements
fixes #4818

Signed-off-by: Michael Friedrich <michael.friedrich@icinga.com>
2017-05-10 17:10:22 +02:00
Andreas Scherbaum 98256ca0c7 Change http:// links to https:// links where a website exists
fixes #5149

Signed-off-by: Michael Friedrich <michael.friedrich@icinga.com>
2017-04-20 11:33:28 +02:00
Michael Friedrich e4ae789a7c Set zone attribute to no_user_modify for API POST requests
fixes #5166
2017-04-12 09:25:28 +02:00
Michael Friedrich 1c816ac9ad Update documentation (troubleshooting, monitor Icinga 2, configs, integrations, etc.)
fixes #5137
fixes #5140
fixes #1880
fixes #5142
fixes #5144
2017-04-05 20:13:32 +02:00
Michael Friedrich 46900cea3c Fix duration attribute requirement for schedule-downtime API action
fixes #5111
2017-03-31 10:34:07 +02:00
Michael Friedrich 60f334df52 Fix notify/sticky parameter handling in 'acknowledge-problem' API action
refs #13939
2017-02-23 12:30:28 +01:00
Michael Friedrich 0ddea54860 Add an example for /v1/actions/process-check-result which uses filter/type
fixes #4954
2017-02-07 13:42:22 +01:00
Michael Friedrich 3e12cb301c Update README.md and correct project URLs
fixes #13491
2016-12-08 17:38:41 +01:00
Michael Friedrich cda29b070f Docs: Add troubleshooting examples for fetching the executed command line
fixes #13455
2016-12-07 14:23:41 +01:00
Michael Friedrich be935d0239 Docs: Fix missing request headers for X-HTTP-Method-Override
fixes #13411
2016-12-06 10:46:47 +01:00
Michael Friedrich 6c975dab5f Docs: Update API and Library Reference chapters
New sub chapters for global functions linked everywhere.
New API examples and clarifications.

fixes #13327
fixes #12449
2016-11-25 15:31:10 +01:00
Gunnar Beutner 23e30ccb67 Revert "Implement the 'evaluate-macros' API action"
This reverts commit 851135d3a1.

fixes #13091
2016-11-17 10:39:27 +01:00
Michael Friedrich 1bfb91f065 Ensure that DowntimeStart notifications are not immediately sent
fixes #12549
2016-11-11 19:36:19 +01:00