1 # <a id="icinga2-api"></a> Icinga 2 API
3 ## <a id="icinga2-api-setup"></a> Setting up the API
5 You can run the CLI command `icinga2 api setup` to enable the
6 `api` [feature](11-cli-commands.md#enable-features) and set up
7 certificates as well as a new API user `root` with an auto-generated password in the
8 `/etc/icinga2/conf.d/api-users.conf` configuration file:
12 Make sure to restart Icinga 2 to enable the changes you just made:
14 # service icinga2 restart
16 If you prefer to set up the API manually, you will have to perform the following steps:
18 * Set up X.509 certificates for Icinga 2
19 * Enable the `api` feature (`icinga2 feature enable api`)
20 * Create an `ApiUser` object for authentication
22 The next chapter provides a quick overview of how you can use the API.
24 ## <a id="icinga2-api-introduction"></a> Introduction
26 The Icinga 2 API allows you to manage configuration objects
27 and resources in a simple, programmatic way using HTTP requests.
29 The URL endpoints are logically separated allowing you to easily
32 * query, create, modify and delete [config objects](12-icinga2-api.md#icinga2-api-config-objects)
33 * perform [actions](12-icinga2-api.md#icinga2-api-actions) (reschedule checks, etc.)
34 * subscribe to [event streams](12-icinga2-api.md#icinga2-api-event-streams)
35 * [manage configuration packages](12-icinga2-api.md#icinga2-api-config-management)
36 * evaluate [script expressions](12-icinga2-api.md#icinga2-api-console)
38 ### <a id="icinga2-api-requests"></a> Requests
40 Any tool capable of making HTTP requests can communicate with
41 the API, for example [curl](https://curl.haxx.se/).
43 Requests are only allowed to use the HTTPS protocol so that
44 traffic remains encrypted.
46 By default the Icinga 2 API listens on port `5665` which is shared with
47 the cluster stack. The port can be changed by setting the `bind_port` attribute
48 for the [ApiListener](9-object-types.md#objecttype-apilistener)
49 object in the `/etc/icinga2/features-available/api.conf`
52 Supported request methods:
56 GET | Retrieve information about configuration objects. Any request using the GET method is read-only and does not affect any objects.
57 POST | Update attributes of a specified configuration object.
58 PUT | Create a new object. The PUT request must include all attributes required to create a new object.
59 DELETE | Remove an object created by the API. The DELETE method is idempotent and does not require any check if the object actually exists.
61 All requests apart from `GET` require that the following `Accept` header is set:
63 Accept: application/json
65 Each URL is prefixed with the API version (currently "/v1").
67 ### <a id="icinga2-api-responses"></a> Responses
69 Successful requests will send back a response body containing a `results`
70 list. Depending on the number of affected objects in your request, the
71 `results` list may contain more than one entry.
73 The output will be sent back as a JSON object:
80 "status": "Object was created."
85 Tip: If you are working on the CLI with curl you can also use [jq](https://stedolan.github.io/jq/)
86 to format the returned JSON output in a readable manner. The documentation
87 prefers `python -m json.tool` as Python is available nearly everywhere.
91 > Future versions of Icinga 2 might set additional fields. Your application
92 > should gracefully handle fields it is not familiar with, for example by
95 ### <a id="icinga2-api-http-statuses"></a> HTTP Statuses
97 The API will return standard [HTTP statuses](https://www.ietf.org/rfc/rfc2616.txt)
98 including error codes.
100 When an error occurs, the response body will contain additional information
101 about the problem and its source.
103 A status code between 200 and 299 generally means that the request was
106 Return codes within the 400 range indicate that there was a problem with the
107 request. Either you did not authenticate correctly, you are missing the authorization
108 for your requested action, the requested object does not exist or the request
111 A status in the range of 500 generally means that there was a server-side problem
112 and Icinga 2 is unable to process your request.
114 ### <a id="icinga2-api-authentication"></a> Authentication
116 There are two different ways for authenticating against the Icinga 2 API:
118 * username and password using HTTP basic auth
121 In order to configure a new API user you'll need to add a new [ApiUser](9-object-types.md#objecttype-apiuser)
122 configuration object. In this example `root` will be the basic auth username
123 and the `password` attribute contains the basic auth password.
125 # vim /etc/icinga2/conf.d/api-users.conf
127 object ApiUser "root" {
131 Alternatively you can use X.509 client certificates by specifying the `client_cn`
132 the API should trust. The X.509 certificate has to be signed by the CA certificate
133 that is configured in the [ApiListener](9-object-types.md#objecttype-apilistener) object.
135 # vim /etc/icinga2/conf.d/api-users.conf
137 object ApiUser "root" {
138 client_cn = "CertificateCommonName"
141 An `ApiUser` object can have both authentication methods configured.
143 You can test authentication by sending a GET request to the API:
145 $ curl -k -s -u root:icinga 'https://localhost:5665/v1'
147 In case you get an error message make sure to check the API user credentials.
149 When using client certificates for authentication you'll need to pass your client certificate
150 and private key to the curl call:
152 $ curl -k --cert example.localdomain.crt --key example.localdomain.key 'https://example.localdomain:5665/v1/status'
154 In case of an error make sure to verify the client certificate and CA.
156 The curl parameter `-k` disables certificate verification and should therefore
157 only be used for testing. In order to securely check each connection you'll need to
158 specify the trusted CA certificate using the curl parameter`--cacert`:
160 $ curl -u root:icinga --cacert ca.crt 'icinga2.node1.localdomain:5665/v1'
162 Read the next chapter on [API permissions](12-icinga2-api.md#icinga2-api-permissions)
163 in order to configure authorization settings for your newly created API user.
165 ### <a id="icinga2-api-permissions"></a> Permissions
167 By default an API user does not have any permissions to perform
168 actions on the URL endpoints.
170 Permissions for API users must be specified in the `permissions` attribute
171 as array. The array items can be a list of permission strings with wildcard
174 Example for an API user with all permissions:
176 permissions = [ "*" ]
178 Note that you can use wildcards. Here's another example that only allows the user
179 to perform read-only object queries for hosts and services:
181 permissions = [ "objects/query/Host", "objects/query/Service" ]
183 You can also further restrict permissions by specifying a filter expression. The
184 filter expression has to be a [lambda function](17-language-reference.md#nullary-lambdas)
185 which must return a boolean value.
187 The following example allows the API user to query all hosts and services which have a
188 custom attribute `os` that matches the regular expression `^Linux`.
189 The [regex function](18-library-reference.md#global-functions-regex) is available as global function.
193 permission = "objects/query/Host"
194 filter = {{ regex("^Linux", host.vars.os) }}
197 permission = "objects/query/Service"
198 filter = {{ regex("^Linux", service.vars.os) }}
202 More information about filters can be found in the [filters](12-icinga2-api.md#icinga2-api-filters) chapter.
204 Available permissions for specific URL endpoints:
206 Permissions | URL Endpoint | Supports Filters
207 ------------------------------|---------------|-----------------
208 actions/<action> | /v1/actions | Yes
209 config/query | /v1/config | No
210 config/modify | /v1/config | No
211 console | /v1/console | No
212 events/<type> | /v1/events | No
213 objects/query/<type> | /v1/objects | Yes
214 objects/create/<type> | /v1/objects | No
215 objects/modify/<type> | /v1/objects | Yes
216 objects/delete/<type> | /v1/objects | Yes
217 status/query | /v1/status | Yes
218 templates/<type> | /v1/templates | Yes
219 types | /v1/types | Yes
220 variables | /v1/variables | Yes
222 The required actions or types can be replaced by using a wildcard match ("\*").
224 ### <a id="icinga2-api-parameters"></a> Parameters
226 Depending on the request method there are two ways of
227 passing parameters to the request:
229 * JSON object as request body (all request methods other than `GET`)
230 * Query string as URL parameter (all request methods)
232 Reserved characters by the HTTP protocol must be [URL-encoded](https://en.wikipedia.org/wiki/Percent-encoding)
233 as query string, e.g. a space character becomes `%20`.
235 Example for a URL-encoded query string:
237 /v1/objects/hosts?filter=match(%22example.localdomain*%22,host.name)&attrs=name&attrs=state
239 Here are the exact same query parameters as a JSON object:
241 { "filter": "match(\"example.localdomain*\",host.name)", "attrs": [ "host.name", "host.state" ] }
243 The [match function](18-library-reference.md#global-functions-match) is available as global function
246 ### <a id="icinga2-api-requests-method-override"></a> Request Method Override
248 `GET` requests do not allow you to send a request body. In case you cannot pass everything as URL
249 parameters (e.g. complex filters or JSON-encoded dictionaries) you can use the `X-HTTP-Method-Override`
250 header. This comes in handy when you are using HTTP proxies disallowing `PUT` or `DELETE` requests too.
252 Query an existing object by sending a `POST` request with `X-HTTP-Method-Override: GET` as request header:
254 $ curl -k -s -u 'root:icinga' -H 'Accept: application/json' -X POST -H 'X-HTTP-Method-Override: GET' 'https://localhost:5665/v1/objects/hosts'
256 Delete an existing object by sending a `POST` request with `X-HTTP-Method-Override: DELETE` as request header:
258 $ curl -k -s -u 'root:icinga' -H 'Accept: application/json' -X POST -H 'X-HTTP-Method-Override: DELETE' 'https://localhost:5665/v1/objects/hosts/example.localdomain'
260 ### <a id="icinga2-api-filters"></a> Filters
262 #### <a id="icinga2-api-simple-filters"></a> Simple Filters
264 By default actions and queries operate on all objects unless further restricted by the user. For
265 example, the following query returns all `Host` objects:
267 https://localhost:5665/v1/objects/hosts
269 If you're only interested in a single object, you can limit the output to that object by specifying its name:
271 https://localhost:5665/v1/objects/hosts?host=localhost
273 **The name of the URL parameter is the lower-case version of the type the query applies to.** For
274 example, for `Host` objects the URL parameter therefore is `host`, for `Service` objects it is
277 You can also specify multiple objects:
279 https://localhost:5665/v1/objects/hosts?hosts=first-host&hosts=second-host
281 Again -- like in the previous example -- the name of the URL parameter is the lower-case version of the type. However, because we're specifying multiple objects here the **plural form** of the type is used.
283 When specifying names for objects which have composite names like for example services the
284 full name has to be used:
286 https://localhost:5665/v1/objects/services?service=localhost!ping6
288 The full name of an object can be obtained by looking at the `__name` attribute.
290 #### <a id="icinga2-api-advanced-filters"></a> Advanced Filters
292 Most of the information provided in this chapter applies to both permission filters (as used when
293 configuring `ApiUser` objects) and filters specified in queries.
295 Advanced filters allow users to filter objects using lambda expressions. The syntax for these filters is the same like for [apply rule expressions](3-monitoring-basics.md#using-apply-expressions).
299 > Filters used as URL parameter must be URL-encoded. The following examples
300 > are **not URL-encoded** for better readability.
302 Example matching all services in NOT-OK state:
304 https://localhost:5665/v1/objects/services?filter=service.state!=ServiceOK
306 Example [matching](18-library-reference.md#global-functions-match) all hosts by a name string pattern:
308 https://localhost:5665/v1/objects/hosts?filter=match("example.localdomain*",host.name)
310 Example for all hosts which are in the host group `linux-servers`:
312 https://localhost:5665/v1/objects/hosts?filter="linux-servers" in host.groups
314 User-specified filters are run in a sandbox environment which ensures that filters cannot
315 modify Icinga's state, for example object attributes or global variables.
317 When querying objects of a specific type the filter expression is evaluated for each object
318 of that type. The object is made available to the filter expression as a variable whose name
319 is the lower-case version of the object's type name.
321 For example when querying objects of type `Host` the variable in the filter expression is named
322 `host`. Additionally related objects such as the host's check command are also made available
323 (e.g., via the `check_command` variable). The variable names are the exact same as for the `joins`
324 query parameter; see [object query joins](12-icinga2-api.md#icinga2-api-config-objects-query-joins)
327 The object is also made available via the `obj` variable. This makes it easier to build
328 filters which can be used for more than one object type (e.g., for permissions).
330 Some queries can be performed for more than just one object type. One example is the 'reschedule-check'
331 action which can be used for both hosts and services. When using advanced filters you will also have to specify the
332 type using the `type` parameter:
334 $ curl -k -s -u root:icinga -H 'Accept: application/json' -X POST 'https://localhost:5665/v1/actions/reschedule-check' \
335 -d '{ "type": "Service", "filter": "service.name==\"ping6\"" }' | python -m json.tool
337 When building filters you have to ensure that values such as
338 `"linux-servers"` are escaped properly according to the rules of the Icinga 2 configuration
341 To make using the API in scripts easier you can use the `filter_vars` attribute to specify
342 variables which should be made available to your filter expression. This way you don't have
343 to worry about escaping values:
345 $ curl -k -s -u 'root:icinga' -H 'Accept: application/json' -H 'X-HTTP-Method-Override: GET' -X POST 'https://localhost:5665/v1/objects/hosts' \
346 -d '{ "filter": "host.vars.os == os", "filter_vars": { "os": "Linux" } }'
348 We're using [X-HTTP-Method-Override](12-icinga2-api.md#icinga2-api-requests-method-override) here because
349 the HTTP specification does not allow message bodies for GET requests.
351 The `filters_vars` attribute can only be used inside the request body, but not as
352 a URL parameter because there is no way to specify a dictionary in a URL.
354 ## <a id="icinga2-api-config-objects"></a> Config Objects
356 Provides methods to manage configuration objects:
358 * [creating objects](12-icinga2-api.md#icinga2-api-config-objects-create)
359 * [querying objects](12-icinga2-api.md#icinga2-api-config-objects-query)
360 * [modifying objects](12-icinga2-api.md#icinga2-api-config-objects-modify)
361 * [deleting objects](12-icinga2-api.md#icinga2-api-config-objects-delete)
363 ### <a id="icinga2-api-config-objects-cluster-sync"></a> API Objects and Cluster Config Sync
365 Newly created or updated objects can be synced throughout your
366 Icinga 2 cluster. Set the `zone` attribute to the zone this object
367 belongs to and let the API and cluster handle the rest.
369 Objects without a zone attribute are only synced in the same zone the Icinga instance belongs to.
373 > Cluster nodes must accept configuration for creating, modifying
374 > and deleting objects. Ensure that `accept_config` is set to `true`
375 > in the [ApiListener](9-object-types.md#objecttype-apilistener) object
378 If you add a new cluster instance, or reconnect an instance which has been offline
379 for a while, Icinga 2 takes care of the initial object sync for all objects
382 ### <a id="icinga2-api-config-objects-query"></a> Querying Objects
384 You can request information about configuration objects by sending
385 a `GET` query to the `/v1/objects/<type>` URL endpoint. `<type` has
386 to be replaced with the plural name of the object type you are interested
389 $ curl -k -s -u root:icinga 'https://localhost:5665/v1/objects/hosts'
391 A list of all available configuration types is available in the
392 [object types](9-object-types.md#object-types) chapter.
394 The following URL parameters are available:
396 Parameters | Type | Description
397 -----------|--------------|----------------------------
398 attrs | string array | **Optional.** Limits attributes in the output.
399 joins | string array | **Optional.** Join related object types and their attributes (`?joins=host` for the entire set, or selectively by `?joins=host.name`).
400 meta | string array | **Optional.** Enable meta information using `?meta=used_by` (references from other objects) and/or `?meta=location` (location information). Defaults to disabled.
402 In addition to these parameters a [filter](12-icinga2-api.md#icinga2-api-filters) may be provided.
404 Instead of using a filter you can optionally specify the object name in the
405 URL path when querying a single object. For objects with composite names
406 (e.g. services) the full name (e.g. `example.localdomain!http`) must be specified:
408 $ curl -k -s -u root:icinga 'https://localhost:5665/v1/objects/services/example.localdomain!http'
410 You can limit the output to specific attributes using the `attrs` URL parameter:
412 $ curl -k -s -u root:icinga 'https://localhost:5665/v1/objects/hosts/example.localdomain?attrs=name&attrs=address' | python -m json.tool
417 "name": "example.localdomain"
418 "address": "192.168.1.1"
422 "name": "example.localdomain",
428 #### <a id="icinga2-api-config-objects-query-result"></a> Object Queries Result
430 Each response entry in the results array contains the following attributes:
432 Attribute | Type | Description
433 -----------|------------|--------------
434 name | string | Full object name.
435 type | string | Object type.
436 attrs | dictionary | Object attributes (can be filtered using the URL parameter `attrs`).
437 joins | dictionary | [Joined object types](12-icinga2-api.md#icinga2-api-config-objects-query-joins) as key, attributes as nested dictionary. Disabled by default.
438 meta | dictionary | Contains `used_by` object references. Disabled by default, enable it using `?meta=used_by` as URL parameter.
440 #### <a id="icinga2-api-config-objects-query-joins"></a> Object Query Joins
442 Icinga 2 knows about object relations. For example it can optionally return
443 information about the host when querying service objects.
445 The following query retrieves all host attributes:
447 https://localhost:5665/v1/objects/services?joins=host
449 Instead of requesting all host attributes you can also limit the output to specific
452 https://localhost:5665/v1/objects/services?joins=host.name&joins=host.address
454 You can request that all available joins are returned in the result set by using
455 the `all_joins` query parameter.
457 https://localhost:5665/v1/objects/services?all_joins=1
461 > For performance reasons you should only request attributes which your application
464 The following joins are available:
466 Object Type | Object Relations (`joins` prefix name)
467 -------------|------------------------------------------
468 Service | host, check\_command, check\_period, event\_command, command\_endpoint
469 Host | check\_command, check\_period, event\_command, command\_endpoint
470 Notification | host, service, command, period
471 Dependency | child\_host, child\_service, parent\_host, parent\_service, period
475 Here's an example that retrieves all service objects for hosts which have had their `os`
476 custom attribute set to `Linux`. The result set contains the `display_name` and `check_command`
477 attributes for the service. The query also returns the host's `name` and `address` attribute
480 $ curl -k -s -u root:icinga 'https://localhost:5665/v1/objects/services?attrs=display_name&attrs=check_command&joins=host.name&joins=host.address&filter=host.vars.os==%22Linux%22' | python -m json.tool
486 "check_command": "ping4",
487 "display_name": "ping4"
491 "address": "192.168.1.1",
492 "name": "example.localdomain"
496 "name": "example.localdomain!ping4",
501 "check_command": "ssh",
502 "display_name": "ssh"
506 "address": "192.168.1.1",
507 "name": "example.localdomain"
511 "name": "example.localdomain!ssh",
517 In case you want to fetch all [comments](9-object-types.md#objecttype-comment)
518 for hosts and services, you can use the following query URL (similar example
521 https://localhost:5665/v1/objects/comments?joins=host&joins=service
523 This is another example for listing all service objects which are unhandled problems (state is not OK
524 and no downtime or acknowledgement set). We're using [X-HTTP-Method-Override](12-icinga2-api.md#icinga2-api-requests-method-override)
525 here because we want to pass all query attributes in the request body.
527 $ curl -k -s -u root:icinga -H 'Accept: application/json' -H 'X-HTTP-Method-Override: GET' -X POST 'https://127.0.0.1:5665/v1/objects/services' \
528 -d '{ "joins": [ "host.name", "host.address" ], "attrs": [ "name", "state", "downtime_depth", "acknowledgement" ], "filter": "service.state != ServiceOK && service.downtime_depth == 0.0 && service.acknowledgement == 0.0" }' | python -m json.tool
534 "acknowledgement": 0.0,
535 "downtime_depth": 0.0,
536 "name": "10807-service",
546 "name": "10807-host!10807-service",
553 ### <a id="icinga2-api-config-objects-create"></a> Creating Config Objects
555 New objects must be created by sending a PUT request. The following
556 parameters need to be passed inside the JSON body:
558 Parameters | Type | Description
559 -----------|--------------|--------------------------
560 templates | string array | **Optional.** Import existing configuration templates for this object type. Note: These templates must either be statically configured or provided in [config packages](12-icinga2-api.md#icinga2-api-config-management)-
561 attrs | dictionary | **Required.** Set specific object attributes for this [object type](9-object-types.md#object-types).
563 The object name must be specified as part of the URL path. For objects with composite names (e.g. services)
564 the full name (e.g. `example.localdomain!http`) must be specified.
566 If attributes are of the Dictionary type, you can also use the indexer format. This might be necessary to only override specific custom variables and keep all other existing custom variables (e.g. from templates):
568 "attrs": { "vars.os": "Linux" }
570 Example for creating the new host object `example.localdomain`:
572 $ curl -k -s -u root:icinga -H 'Accept: application/json' -X PUT 'https://localhost:5665/v1/objects/hosts/example.localdomain' \
573 -d '{ "templates": [ "generic-host" ], "attrs": { "address": "192.168.1.1", "check_command": "hostalive", "vars.os" : "Linux" } }' \
574 | python -m json.tool
579 "status": "Object was created."
584 If the configuration validation fails, the new object will not be created and the response body
585 contains a detailed error message. The following example is missing the `check_command` attribute
586 which is required for host objects:
588 $ curl -k -s -u root:icinga -H 'Accept: application/json' -X PUT 'https://localhost:5665/v1/objects/hosts/example.localdomain' \
589 -d '{ "attrs": { "address": "192.168.1.1", "vars.os" : "Linux" } }' \
590 | python -m json.tool
596 "Error: Validation failed for object 'example.localdomain' of type 'Host'; Attribute 'check_command': Attribute must not be empty."
598 "status": "Object could not be created."
603 Service objects must be created using their full name ("hostname!servicename") referencing an existing host object:
605 $ curl -k -s -u root:icinga -H 'Accept: application/json' -X PUT 'https://localhost:5665/v1/objects/services/example.localdomain!realtime-load' \
606 -d '{ "templates": [ "generic-service" ], "attrs": { "check_command": "load", "check_interval": 1,"retry_interval": 1 } }'
609 Example for a new CheckCommand object:
611 $ curl -k -s -u root:icinga -H 'Accept: application/json' -X PUT 'https://localhost:5665/v1/objects/checkcommands/mytest' \
612 -d '{ "templates": [ "plugin-check-command" ], "attrs": { "command": [ "/usr/local/sbin/check_http" ], "arguments": { "-I": "$mytest_iparam$" } } }'
615 ### <a id="icinga2-api-config-objects-modify"></a> Modifying Objects
617 Existing objects must be modified by sending a `POST` request. The following
618 parameters need to be passed inside the JSON body:
620 Parameters | Type | Description
621 -----------|------------|---------------------------
622 attrs | dictionary | **Required.** Set specific object attributes for this [object type](9-object-types.md#object-types).
624 In addition to these parameters a [filter](12-icinga2-api.md#icinga2-api-filters) should be provided.
628 > Modified attributes do not trigger a re-evaluation of existing
629 > static [apply rules](3-monitoring-basics.md#using-apply) and [group assignments](3-monitoring-basics.md#group-assign-intro).
630 > Delete and re-create the objects if you require such changes.
632 > Furthermore you cannot modify templates which have already been resolved
633 > during [object creation](12-icinga2-api.md#icinga2-api-config-objects-create).
634 > There are attributes which can only be set for [PUT requests](12-icinga2-api.md#icinga2-api-config-objects-create) such as `groups`
635 > or `zone`. A complete list of `no_user_modify` attributes can be fetched from the [types](12-icinga2-api.md#icinga2-api-types) URL endpoint.
637 If attributes are of the Dictionary type, you can also use the indexer format:
639 "attrs": { "vars.os": "Linux" }
641 The following example updates the `address` attribute and the custom attribute `os` for the `example.localdomain` host:
643 $ curl -k -s -u root:icinga -H 'Accept: application/json' -X POST 'https://localhost:5665/v1/objects/hosts/example.localdomain' \
644 -d '{ "attrs": { "address": "192.168.1.2", "vars.os" : "Windows" } }' \
645 | python -m json.tool
650 "name": "example.localdomain",
651 "status": "Attributes updated.",
658 ### <a id="icinga2-api-config-objects-delete"></a> Deleting Objects
660 You can delete objects created using the API by sending a `DELETE`
663 Parameters | Type | Description
664 -----------|---------|---------------
665 cascade | boolean | **Optional.** Delete objects depending on the deleted objects (e.g. services on a host).
667 In addition to these parameters a [filter](12-icinga2-api.md#icinga2-api-filters) should be provided.
669 Example for deleting the host object `example.localdomain`:
671 $ curl -k -s -u root:icinga -H 'Accept: application/json' -X DELETE 'https://localhost:5665/v1/objects/hosts/example.localdomain?cascade=1' | python -m json.tool
676 "name": "example.localdomain",
677 "status": "Object was deleted.",
683 ## <a id="icinga2-api-config-templates"></a> Config Templates
685 Provides methods to manage configuration templates:
687 * [querying templates](12-icinga2-api.md#icinga2-api-config-templates-query)
689 Creation, modification and deletion of templates at runtime is not supported.
691 ### <a id="icinga2-api-config-templates-query"></a> Querying Templates
693 You can request information about configuration templates by sending
694 a `GET` query to the `/v1/templates/<type>` URL endpoint. `<type` has
695 to be replaced with the plural name of the object type you are interested
698 $ curl -k -s -u root:icinga 'https://localhost:5665/v1/templates/hosts'
700 A list of all available configuration types is available in the
701 [object types](9-object-types.md#object-types) chapter.
703 A [filter](12-icinga2-api.md#icinga2-api-filters) may be provided for this query type. The
704 template object can be accessed in the filter using the `tmpl` variable. In this
705 example the [match function](18-library-reference.md#global-functions-match) is used to
706 check a wildcard string pattern against `tmpl.name`.
707 The `filter` attribute is passed inside the request body thus requiring to use [X-HTTP-Method-Override](12-icinga2-api.md#icinga2-api-requests-method-override)
710 $ curl -k -s -u root:icinga -H 'Accept: application/json' -H 'X-HTTP-Method-Override: GET' -X POST 'https://localhost:5661/v1/templates/hosts' \
711 -d '{ "filter": "match(\"g*\", tmpl.name)" }'
713 Instead of using a filter you can optionally specify the template name in the
714 URL path when querying a single object:
716 $ curl -k -s -u root:icinga 'https://localhost:5665/v1/templates/hosts/generic-host'
718 The result set contains the type, name as well as the location of the template.
720 ## <a id="icinga2-api-variables"></a> Variables
722 Provides methods to manage global variables:
724 * [querying variables](12-icinga2-api.md#icinga2-api-variables-query)
726 ### <a id="icinga2-api-variables-query"></a> Querying Variables
728 You can request information about global variables by sending
729 a `GET` query to the `/v1/variables/` URL endpoint:
731 $ curl -k -s -u root:icinga 'https://localhost:5665/v1/variables'
733 A [filter](12-icinga2-api.md#icinga2-api-filters) may be provided for this query type. The
734 variable information object can be accessed in the filter using the `variable` variable.
735 The `filter` attribute is passed inside the request body thus requiring to use [X-HTTP-Method-Override](12-icinga2-api.md#icinga2-api-requests-method-override)
738 $ curl -k -s -u root:icinga -H 'Accept: application/json' -H 'X-HTTP-Method-Override: GET' -X POST 'https://localhost:5661/v1/variables' \
739 -d '{ "filter": "variable.type in [ \"String\", \"Number\" ]" }'
741 Instead of using a filter you can optionally specify the variable name in the
742 URL path when querying a single variable:
744 $ curl -k -s -u root:icinga 'https://localhost:5665/v1/variables/PrefixDir'
746 The result set contains the type, name and value of the global variable.
748 ## <a id="icinga2-api-actions"></a> Actions
750 There are several actions available for Icinga 2 provided by the `/v1/actions`
751 URL endpoint. You can run actions by sending a `POST` request.
753 In case you have been using the [external commands](14-features.md#external-commands)
754 in the past, the API actions provide a similar interface with filter
755 capabilities for some of the more common targets which do not directly change
758 All actions return a 200 `OK` or an appropriate error code for each
759 action performed on each object matching the supplied filter.
761 Actions which affect the Icinga Application itself such as disabling
762 notification on a program-wide basis must be applied by updating the
763 [IcingaApplication object](12-icinga2-api.md#icinga2-api-config-objects)
766 $ curl -k -s -u root:icinga -H 'Accept: application/json' -X POST 'https://localhost:5665/v1/objects/icingaapplications/app' -d '{ "attrs": { "enable_notifications": false } }'
768 ### <a id="icinga2-api-actions-process-check-result"></a> process-check-result
770 Process a check result for a host or a service.
772 Send a `POST` request to the URL endpoint `/v1/actions/process-check-result`.
774 Parameter | Type | Description
775 ------------------|--------------|--------------
776 exit\_status | integer | **Required.** For services: 0=OK, 1=WARNING, 2=CRITICAL, 3=UNKNOWN, for hosts: 0=OK, 1=CRITICAL.
777 plugin\_output | string | **Required.** The plugins main output. Does **not** contain the performance data.
778 performance\_data | string array | **Optional.** The performance data.
779 check\_command | string array | **Optional.** The first entry should be the check commands path, then one entry for each command line option followed by an entry for each of its argument.
780 check\_source | string | **Optional.** Usually the name of the `command_endpoint`
782 In addition to these parameters a [filter](12-icinga2-api.md#icinga2-api-filters) must be provided. The valid types for this action are `Host` and `Service`.
784 Example for the service `passive-ping6`:
786 $ curl -k -s -u root:icinga -H 'Accept: application/json' -X POST 'https://localhost:5665/v1/actions/process-check-result?service=example.localdomain!passive-ping6' \
787 -d '{ "exit_status": 2, "plugin_output": "PING CRITICAL - Packet loss = 100%", "performance_data": [ "rta=5000.000000ms;3000.000000;5000.000000;0.000000", "pl=100%;80;100;0" ], "check_source": "example.localdomain" }' | python -m json.tool
793 "status": "Successfully processed check result for object 'localdomain!passive-ping6'."
798 Example for using the `Host` type and filter by the host name:
800 $ curl -k -s -u root:icinga -H 'Accept: application/json' -X POST 'https://localhost:5665/v1/actions/process-check-result' \
801 -d '{ "filter": "host.name==\"example.localdomain\"", "type": "Host", "exit_status": 1, "plugin_output": "Host is not available." }'
803 You can avoid URL encoding of white spaces in object names by using the `filter` attribute in the request body.
805 ### <a id="icinga2-api-actions-reschedule-check"></a> reschedule-check
807 Reschedule a check for hosts and services. The check can be forced if required.
809 Send a `POST` request to the URL endpoint `/v1/actions/reschedule-check`.
811 Parameter | Type | Description
812 -------------|-----------|--------------
813 next\_check | timestamp | **Optional.** The next check will be run at this time. If omitted, the current time is used.
814 force\_check | boolean | **Optional.** Defaults to `false`. If enabled, the checks are executed regardless of time period restrictions and checks being disabled per object or on a global basis.
816 In addition to these parameters a [filter](12-icinga2-api.md#icinga2-api-filters) must be provided. The valid types for this action are `Host` and `Service`.
818 The example reschedules all services with the name "ping6" to immediately perform a check
819 (`next_check` default), ignoring any time periods or whether active checks are
820 allowed for the service (`force_check=true`).
822 $ curl -k -s -u root:icinga -H 'Accept: application/json' -X POST 'https://localhost:5665/v1/actions/reschedule-check' \
823 -d '{ "type": "Service", "filter": "service.name==\"ping6\"", "force_check": true }' | python -m json.tool
829 "status": "Successfully rescheduled check for object 'example.localdomain!ping6'."
835 ### <a id="icinga2-api-actions-send-custom-notification"></a> send-custom-notification
837 Send a custom notification for hosts and services. This notification
838 type can be forced being sent to all users.
840 Send a `POST` request to the URL endpoint `/v1/actions/send-custom-notification`.
842 Parameter | Type | Description
843 ----------|---------|--------------
844 author | string | **Required.** Name of the author, may be empty.
845 comment | string | **Required.** Comment text, may be empty.
846 force | boolean | **Optional.** Default: false. If true, the notification is sent regardless of downtimes or whether notifications are enabled or not.
848 In addition to these parameters a [filter](12-icinga2-api.md#icinga2-api-filters) must be provided. The valid types for this action are `Host` and `Service`.
850 Example for a custom host notification announcing a global maintenance to
853 $ curl -k -s -u root:icinga -H 'Accept: application/json' -X POST 'https://localhost:5665/v1/actions/send-custom-notification' \
854 -d '{ "type": "Host", "author": "icingaadmin", "comment": "System is going down for maintenance", "force": true }' | python -m json.tool
860 "status": "Successfully sent custom notification for object 'host0'."
864 "status": "Successfully sent custom notification for object 'host1'."
868 ### <a id="icinga2-api-actions-delay-notification"></a> delay-notification
870 Delay notifications for a host or a service.
871 Note that this will only have an effect if the service stays in the same problem
872 state that it is currently in. If the service changes to another state, a new
873 notification may go out before the time you specify in the `timestamp` argument.
875 Send a `POST` request to the URL endpoint `/v1/actions/delay-notification`.
877 Parameter | Type | Description
878 ----------|-----------|--------------
879 timestamp | timestamp | **Required.** Delay notifications until this timestamp.
881 In addition to these parameters a [filter](12-icinga2-api.md#icinga2-api-filters) must be provided. The valid types for this action are `Host` and `Service`.
885 $ curl -k -s -u root:icinga -H 'Accept: application/json' -X POST 'https://localhost:5665/v1/actions/delay-notification' \
886 -d '{ "type": "Service", "timestamp": 1446389894 }' | python -m json.tool
892 "status": "Successfully delayed notifications for object 'host0!service0'."
896 "status": "Successfully delayed notifications for object 'host1!service1'."
900 ### <a id="icinga2-api-actions-acknowledge-problem"></a> acknowledge-problem
902 Allows you to acknowledge the current problem for hosts or services. By
903 acknowledging the current problem, future notifications (for the same state if `sticky` is set to `false`)
906 Send a `POST` request to the URL endpoint `/v1/actions/acknowledge-problem`.
908 Parameter | Type | Description
909 ---------------------|-----------|--------------
910 author | string | **Required.** Name of the author, may be empty.
911 comment | string | **Required.** Comment text, may be empty.
912 expiry | timestamp | **Optional.** Whether the acknowledgement will be removed at the timestamp.
913 sticky | boolean | **Optional.** Whether the acknowledgement will be set until the service or host fully recovers. Defaults to `false`.
914 notify | boolean | **Optional.** Whether a notification of the `Acknowledgement` type will be sent. Defaults to `false`.
915 persistent | boolean | **Optional.** When the comment is of type `Acknowledgement` and this is set to `true`, the comment will remain after the acknowledgement recovers or expires. Defaults to `false`.
917 In addition to these parameters a [filter](12-icinga2-api.md#icinga2-api-filters) must be provided. The valid types for this action are `Host` and `Service`.
919 The following example acknowledges all services which are in a hard critical state and sends out
920 a notification for them:
922 $ curl -k -s -u root:icinga -H 'Accept: application/json' -X POST 'https://localhost:5665/v1/actions/acknowledge-problem?type=Service&filter=service.state==2&service.state_type=1' \
923 -d '{ "author": "icingaadmin", "comment": "Global outage. Working on it.", "notify": true }' | python -m json.tool
929 "status": "Successfully acknowledged problem for object 'example2.localdomain!ping4'."
933 "status": "Successfully acknowledged problem for object 'example.localdomain!ping4'."
938 ### <a id="icinga2-api-actions-remove-acknowledgement"></a> remove-acknowledgement
940 Removes the acknowledgements for services or hosts. Once the acknowledgement has
941 been removed notifications will be sent out again.
943 Send a `POST` request to the URL endpoint `/v1/actions/remove-acknowledgement`.
945 A [filter](12-icinga2-api.md#icinga2-api-filters) must be provided. The valid types for this action are `Host` and `Service`.
947 The example removes all service acknowledgements:
949 $ curl -k -s -u root:icinga -H 'Accept: application/json' -X POST 'https://localhost:5665/v1/actions/remove-acknowledgement?type=Service' | python -m json.tool
955 "status": "Successfully removed acknowledgement for object 'host0!service0'."
959 "status": "Successfully removed acknowledgement for object 'example2.localdomain!aws-health'."
963 ### <a id="icinga2-api-actions-add-comment"></a> add-comment
965 Adds a `comment` from an `author` to services or hosts.
967 Send a `POST` request to the URL endpoint `/v1/actions/add-comment`.
969 Parameter | Type | Description
970 ----------|--------|--------------
971 author | string | **Required.** Name of the author, may be empty.
972 comment | string | **Required.** Comment text, may be empty.
974 In addition to these parameters a [filter](12-icinga2-api.md#icinga2-api-filters) must be provided. The valid types for this action are `Host` and `Service`.
976 The following example adds a comment for all `ping4` services:
978 $ curl -k -s -u root:icinga -H 'Accept: application/json' -X POST 'https://localhost:5665/v1/actions/add-comment?type=Service&filter=service.name==%22ping4%22' -d '{ "author": "icingaadmin", "comment": "Troubleticket #123456789 opened." }' | python -m json.tool
984 "name": "example.localdomain!ping4!example.localdomain-1446824161-0",
985 "status": "Successfully added comment 'example.localdomain!ping4!example.localdomain-1446824161-0' for object 'example.localdomain!ping4'."
990 "name": "example2.localdomain!ping4!example.localdomain-1446824161-1",
991 "status": "Successfully added comment 'example2.localdomain!ping4!example.localdomain-1446824161-1' for object 'example2.localdomain!ping4'."
996 ### <a id="icinga2-api-actions-remove-comment"></a> remove-comment
998 Remove the comment using its `name` attribute , returns `OK` if the
999 comment did not exist.
1000 **Note**: This is **not** the legacy ID but the comment name returned by
1001 Icinga 2 when [adding a comment](12-icinga2-api.md#icinga2-api-actions-add-comment).
1003 Send a `POST` request to the URL endpoint `/v1/actions/remove-comment`.
1005 A [filter](12-icinga2-api.md#icinga2-api-filters) must be provided. The valid types for this action are `Host`, `Service` and `Comment`.
1007 Example for a simple filter using the `comment` URL parameter:
1009 $ curl -k -s -u root:icinga -H 'Accept: application/json' -X POST 'https://localhost:5665/v1/actions/remove-comment?comment=example2.localdomain!ping4!mbmif.local-1446986367-0' | python -m json.tool
1014 "status": "Successfully removed comment 'example2.localdomain!ping4!mbmif.local-1446986367-0'."
1019 Example for removing all service comments using a service name filter for `ping4`:
1021 $ curl -k -s -u root:icinga -H 'Accept: application/json' -X POST 'https://localhost:5665/v1/actions/remove-comment?filter=service.name==%22ping4%22&type=Service' | python -m json.tool
1026 "status": "Successfully removed all comments for object 'example2.localdomain!ping4'."
1030 "status": "Successfully removed all comments for object 'example.localdomain!ping4'."
1036 ### <a id="icinga2-api-actions-schedule-downtime"></a> schedule-downtime
1038 Schedule a downtime for hosts and services.
1040 Send a `POST` request to the URL endpoint `/v1/actions/schedule-downtime`.
1042 Parameter | Type | Description
1043 --------------|-----------|--------------
1044 author | string | **Required.** Name of the author.
1045 comment | string | **Required.** Comment text.
1046 start\_time | timestamp | **Required.** Timestamp marking the beginning of the downtime.
1047 end\_time | timestamp | **Required.** Timestamp marking the end of the downtime.
1048 fixed | boolean | **Optional.** Defaults to `true`. If true, the downtime is `fixed` otherwise `flexible`. See [downtimes](8-advanced-topics.md#downtimes) for more information.
1049 duration | integer | **Required for flexible downtimes.** Duration of the downtime in seconds if `fixed` is set to false.
1050 trigger\_name | string | **Optional.** Sets the trigger for a triggered downtime. See [downtimes](8-advanced-topics.md#downtimes) for more information on triggered downtimes.
1051 child\_options | integer | **Optional.** Schedule child downtimes. `0` does not do anything, `1` schedules child downtimes triggered by this downtime, `2` schedules non-triggered downtimes. Defaults to `0`.
1053 In addition to these parameters a [filter](12-icinga2-api.md#icinga2-api-filters) must be provided. The valid types for this action are `Host` and `Service`.
1057 $ curl -k -s -u root:icinga -H 'Accept: application/json' -X POST 'https://localhost:5665/v1/actions/schedule-downtime?type=Service&filter=service.name==%22ping4%22' -d '{ "start_time": 1446388806, "end_time": 1446389806, "duration": 1000, "author": "icingaadmin", "comment": "IPv4 network maintenance" }' | python -m json.tool
1063 "name": "example2.localdomain!ping4!example.localdomain-1446822004-0",
1064 "status": "Successfully scheduled downtime 'example2.localdomain!ping4!example.localdomain-1446822004-0' for object 'example2.localdomain!ping4'."
1069 "name": "example.localdomain!ping4!example.localdomain-1446822004-1",
1070 "status": "Successfully scheduled downtime 'example.localdomain!ping4!example.localdomain-1446822004-1' for object 'example.localdomain!ping4'."
1075 ### <a id="icinga2-api-actions-remove-downtime"></a> remove-downtime
1077 Remove the downtime using its `name` attribute , returns `OK` if the
1078 downtime did not exist.
1079 **Note**: This is **not** the legacy ID but the downtime name returned by
1080 Icinga 2 when [scheduling a downtime](12-icinga2-api.md#icinga2-api-actions-schedule-downtime).
1082 Send a `POST` request to the URL endpoint `/v1/actions/remove-downtime`.
1084 A [filter](12-icinga2-api.md#icinga2-api-filters) must be provided. The valid types for this action are `Host`, `Service` and `Downtime`.
1086 Example for a simple filter using the `downtime` URL parameter:
1088 $ curl -k -s -u root:icinga -H 'Accept: application/json' -X POST 'https://localhost:5665/v1/actions/remove-downtime?downtime=example.localdomain!ping4!mbmif.local-1446979168-6' | python -m json.tool
1093 "status": "Successfully removed downtime 'example.localdomain!ping4!mbmif.local-1446979168-6'."
1098 Example for removing all host downtimes using a host name filter for `example.localdomain`:
1100 $ curl -k -s -u root:icinga -H 'Accept: application/json' -X POST 'https://localhost:5665/v1/actions/remove-downtime?filter=host.name==%22example.localdomain%22&type=Host' | python -m json.tool
1105 "status": "Successfully removed all downtimes for object 'example.localdomain'."
1110 Example for removing a downtime from a host but not the services filtered by the author name. This example uses
1111 filter variables explained in the [advanced filters](12-icinga2-api.md#icinga2-api-advanced-filters) chapter.
1113 $ curl -k -s -u root:icinga -H 'Accept: application/json' -X POST 'https://localhost:5665/v1/actions/remove-downtime' \
1116 "filter": "host.name == filterHost && !service && downtime.author == filterAuthor",
1118 "filterHost": "example.localdomain",
1119 "filterAuthor": "icingaadmin"
1121 }' | python -m json.tool
1127 "status": "Successfully removed downtime 'example.localdomain!mbmif.local-1463043129-3'."
1132 ### <a id="icinga2-api-actions-shutdown-process"></a> shutdown-process
1134 Shuts down Icinga2. May or may not return.
1136 Send a `POST` request to the URL endpoint `/v1/actions/shutdown-process`.
1138 This action does not support a target type or filter.
1142 $ curl -k -s -u root:icinga -H 'Accept: application/json' -X POST 'https://localhost:5665/v1/actions/shutdown-process' | python -m json.tool
1148 "status": "Shutting down Icinga 2."
1153 ### <a id="icinga2-api-actions-restart-process"></a> restart-process
1155 Restarts Icinga2. May or may not return.
1157 Send a `POST` request to the URL endpoint `/v1/actions/restart-process`.
1159 This action does not support a target type or filter.
1163 $ curl -k -s -u root:icinga -H 'Accept: application/json' -X POST 'https://localhost:5665/v1/actions/restart-process' | python -m json.tool
1169 "status": "Restarting Icinga 2."
1174 ### <a id="icinga2-api-actions-generate-ticket"></a> generate-ticket
1176 Generates a PKI ticket for [CSR auto-signing](6-distributed-monitoring.md#distributed-monitoring-setup-csr-auto-signing).
1177 This can be used in combination with satellite/client setups requesting this ticket number.
1179 Send a `POST` request to the URL endpoint `/v1/actions/generate-ticket`.
1181 Parameter | Type | Description
1182 --------------|-----------|--------------
1183 cn | string | **Required.** The host's common name for which the ticket should be geenerated.
1187 $ curl -k -s -u root:icinga -H 'Accept: application/json' -X POST 'https://localhost:5665/v1/actions/generate-ticket' \
1188 -d '{ "cn": "icinga2-client1.localdomain" }' | python -m json.tool
1193 "status": "Generated PKI ticket '4f75d2ecd253575fe9180938ebff7cbca262f96e' for common name 'icinga2-client1.localdomain'.",
1194 "ticket": "4f75d2ecd253575fe9180938ebff7cbca262f96e"
1200 ## <a id="icinga2-api-event-streams"></a> Event Streams
1202 You can subscribe to event streams by sending a `POST` request to the URL endpoint `/v1/events`.
1203 The following parameters need to be specified (either as URL parameters or in a JSON-encoded message body):
1205 Parameter | Type | Description
1206 -----------|--------------|-------------
1207 types | string array | **Required.** Event type(s). Multiple types as URL parameters are supported.
1208 queue | string | **Required.** Unique queue name. Multiple HTTP clients can use the same queue as long as they use the same event types and filter.
1209 filter | string | **Optional.** Filter for specific event attributes using [filter expressions](12-icinga2-api.md#icinga2-api-filters).
1211 ### <a id="icinga2-api-event-streams-types"></a> Event Stream Types
1213 The following event stream types are available:
1216 -----------------------|--------------
1217 CheckResult | Check results for hosts and services.
1218 StateChange | Host/service state changes.
1219 Notification | Notification events including notified users for hosts and services.
1220 AcknowledgementSet | Acknowledgement set on hosts and services.
1221 AcknowledgementCleared | Acknowledgement cleared on hosts and services.
1222 CommentAdded | Comment added for hosts and services.
1223 CommentRemoved | Comment removed for hosts and services.
1224 DowntimeAdded | Downtime added for hosts and services.
1225 DowntimeRemoved | Downtime removed for hosts and services.
1226 DowntimeStarted | Downtime started for hosts and services.
1227 DowntimeTriggered | Downtime triggered for hosts and services.
1229 Note: Each type requires [API permissions](12-icinga2-api.md#icinga2-api-permissions)
1232 Example for all downtime events:
1234 &types=DowntimeAdded&types=DowntimeRemoved&types=DowntimeTriggered
1237 ### <a id="icinga2-api-event-streams-filter"></a> Event Stream Filter
1239 Event streams can be filtered by attributes using the prefix `event.`.
1241 Example for the `CheckResult` type with the `exit_code` set to `2`:
1243 &types=CheckResult&filter=event.check_result.exit_status==2
1245 Example for the `CheckResult` type with the service [matching](18-library-reference.md#global-functions-match)
1246 the string pattern "random\*":
1248 &types=CheckResult&filter=match%28%22random*%22,event.service%29
1251 ### <a id="icinga2-api-event-streams-response"></a> Event Stream Response
1253 The event stream response is separated with new lines. The HTTP client
1254 must support long-polling and HTTP/1.1. HTTP/1.0 is not supported.
1258 $ curl -k -s -u root:icinga -H 'Accept: application/json' -X POST 'https://localhost:5665/v1/events?queue=michi&types=CheckResult&filter=event.check_result.exit_status==2'
1260 {"check_result":{ ... },"host":"example.localdomain","service":"ping4","timestamp":1445421319.7226390839,"type":"CheckResult"}
1261 {"check_result":{ ... },"host":"example.localdomain","service":"ping4","timestamp":1445421324.7226390839,"type":"CheckResult"}
1262 {"check_result":{ ... },"host":"example.localdomain","service":"ping4","timestamp":1445421329.7226390839,"type":"CheckResult"}
1265 ## <a id="icinga2-api-status"></a> Status and Statistics
1267 Send a `GET` request to the URL endpoint `/v1/status` to retrieve status information and statistics for Icinga 2.
1271 $ curl -k -s -u root:icinga 'https://localhost:5665/v1/status' | python -m json.tool
1275 "name": "ApiListener",
1276 "perfdata": [ ... ],
1281 "name": "IcingaAplication",
1282 "perfdata": [ ... ],
1289 You can limit the output by specifying a status type in the URL, e.g. `IcingaApplication`:
1291 $ curl -k -s -u root:icinga 'https://localhost:5665/v1/status/IcingaApplication' | python -m json.tool
1297 "icingaapplication": {
1299 "enable_event_handlers": true,
1300 "enable_flapping": true,
1301 "enable_host_checks": true,
1302 "enable_notifications": true,
1303 "enable_perfdata": true,
1304 "enable_service_checks": true,
1305 "node_name": "example.localdomain",
1307 "program_start": 1443019345.093372,
1308 "version": "v2.3.0-573-g380a131"
1317 ## <a id="icinga2-api-config-management"></a> Configuration Management
1319 The main idea behind configuration management is to allow external applications
1320 creating configuration packages and stages based on configuration files and
1321 directory trees. This replaces any additional SSH connection and whatnot to
1322 dump configuration files to Icinga 2 directly.
1323 In case you are pushing a new configuration stage to a package, Icinga 2 will
1324 validate the configuration asynchronously and populate a status log which
1325 can be fetched in a separated request.
1328 ### <a id="icinga2-api-config-management-create-package"></a> Creating a Config Package
1330 Send a `POST` request to a new config package called `example-cmdb` in this example. This
1331 will create a new empty configuration package.
1333 $ curl -k -s -u root:icinga -H 'Accept: application/json' -X POST \
1334 'https://localhost:5665/v1/config/packages/example-cmdb' | python -m json.tool
1339 "package": "example-cmdb",
1340 "status": "Created package."
1345 Package names starting with an underscore are reserved for internal packages and must not be used.
1347 ### <a id="icinga2-api-config-management-create-config-stage"></a> Uploading configuration for a Config Package
1349 Configuration files in packages are managed in stages.
1350 Stages provide a way to maintain multiple configuration versions for a package.
1352 Send a `POST` request to the URL endpoint `/v1/config/stages` and add the name of an existing
1353 configuration package to the URL path (e.g. `example-cmdb`).
1354 The request body must contain the `files` attribute with the value being
1355 a dictionary of file targets and their content.
1357 The file path requires one of these two directories inside its path:
1359 Directory | Description
1360 ------------|------------------------------------
1361 conf.d | Local configuration directory.
1362 zones.d | Configuration directory for cluster zones, each zone must be put into its own zone directory underneath. Supports the [cluster config sync](6-distributed-monitoring.md#distributed-monitoring-top-down-config-sync).
1364 Example for a local configuration in the `conf.d` directory:
1366 "files": { "conf.d/host1.conf": "object Host \"local-host\" { address = \"127.0.0.1\", check_command = \"hostalive\" }" }
1368 Example for a host configuration inside the `satellite` zone in the `zones.d` directory:
1370 "files": { "zones.d/satellite/host2.conf": "object Host \"satellite-host\" { address = \"192.168.1.100\", check_command = \"hostalive\" }" }
1373 The example below will create a new file called `test.conf` in the `conf.d`
1374 directory. Note: This example contains an error (`chec_command`). This is
1377 $ curl -k -s -u root:icinga -H 'Accept: application/json' -X POST \
1378 -d '{ "files": { "conf.d/test.conf": "object Host \"cmdb-host\" { chec_command = \"dummy\" }" } }' \
1379 'https://localhost:5665/v1/config/stages/example-cmdb' | python -m json.tool
1384 "package": "example-cmdb",
1385 "stage": "example.localdomain-1441625839-0",
1386 "status": "Created stage."
1391 The Icinga 2 API returns the `package` name this stage was created for, and also
1392 generates a unique name for the `stage` attribute you'll need for later requests.
1394 Icinga 2 automatically restarts the daemon in order to activate the new config stage.
1395 If the validation for the new config stage failed, the old stage and its configuration objects
1400 > Old stages are not purged automatically. You can [remove stages](12-icinga2-api.md#icinga2-api-config-management-delete-config-stage) that are no longer in use.
1402 Icinga 2 will create the following files in the configuration package
1403 stage after configuration validation:
1406 ------------|--------------
1407 status | Contains the [configuration validation](11-cli-commands.md#config-validation) exit code (everything else than 0 indicates an error).
1408 startup.log | Contains the [configuration validation](11-cli-commands.md#config-validation) output.
1410 You can [fetch these files](12-icinga2-api.md#icinga2-api-config-management-fetch-config-package-stage-files)
1411 in order to verify that the new configuration was deployed successfully.
1414 ### <a id="icinga2-api-config-management-list-config-packages"></a> List Configuration Packages and their Stages
1416 A list of packages and their stages can be retrieved by sending a `GET` request to the URL endpoint `/v1/config/packages`.
1418 The following example contains one configuration package `example-cmdb`. The package does not currently
1419 have an active stage.
1421 $ curl -k -s -u root:icinga 'https://localhost:5665/v1/config/packages' | python -m json.tool
1426 "name": "example-cmdb",
1428 "example.localdomain-1441625839-0"
1435 ### <a id="icinga2-api-config-management-list-config-package-stage-files"></a> List Configuration Packages and their Stages
1437 In order to retrieve a list of files for a stage you can send a `GET` request to
1438 the URL endpoint `/v1/config/stages`. You need to include
1439 the package name (`example-cmdb`) and stage name (`example.localdomain-1441625839-0`) in the URL:
1441 $ curl -k -s -u root:icinga 'https://localhost:5665/v1/config/stages/example-cmdb/example.localdomain-1441625839-0' | python -m json.tool
1446 "name": "startup.log",
1462 "name": "conf.d/test.conf",
1468 ### <a id="icinga2-api-config-management-fetch-config-package-stage-files"></a> Fetch Configuration Package Stage Files
1470 Send a `GET` request to the URL endpoint `/v1/config/files` and add
1471 the package name, the stage name and the relative path to the file to the URL path.
1475 > The returned files are plain-text instead of JSON-encoded.
1477 The following example fetches the configuration file `conf.d/test.conf`:
1479 $ curl -k -s -u root:icinga 'https://localhost:5665/v1/config/files/example-cmdb/example.localdomain-1441625839-0/conf.d/test.conf'
1481 object Host "cmdb-host" { chec_command = "dummy" }
1483 You can fetch a [list of existing files](12-icinga2-api.md#icinga2-api-config-management-list-config-package-stage-files)
1484 in a configuration stage and then specifically request their content.
1486 ### <a id="icinga2-api-config-management-config-package-stage-errors"></a> Configuration Package Stage Errors
1488 Now that we don't have an active stage for `example-cmdb` yet seen [here](12-icinga2-api.md#icinga2-api-config-management-list-config-packages),
1489 there must have been an error.
1491 In order to check for validation errors you can fetch the `startup.log` file
1492 by sending a `GET` request to the URL endpoint `/v1/config/files`. You must include
1493 the package name, stage name and the `startup.log` in the URL path.
1495 $ curl -k -s -u root:icinga 'https://localhost:5665/v1/config/files/example-cmdb/example.localdomain-1441133065-1/startup.log'
1498 critical/config: Error: Attribute 'chec_command' does not exist.
1500 /var/lib/icinga2/api/packages/example-cmdb/example.localdomain-1441133065-1/conf.d/test.conf(1): object Host "cmdb-host" { chec_command = "dummy" }
1501 ^^^^^^^^^^^^^^^^^^^^^^
1503 critical/config: 1 error
1505 The output is similar to the manual [configuration validation](11-cli-commands.md#config-validation).
1509 > The returned output is plain-text instead of JSON-encoded.
1512 ### <a id="icinga2-api-config-management-delete-config-stage"></a> Deleting Configuration Package Stage
1514 You can send a `DELETE` request to the URL endpoint `/v1/config/stages`
1515 in order to purge a configuration stage. You must include the package and
1516 stage name inside the URL path.
1518 The following example removes the failed configuration stage `example.localdomain-1441133065-1`
1519 in the `example-cmdb` configuration package:
1521 $ curl -k -s -u root:icinga -H 'Accept: application/json' -X DELETE \
1522 'https://localhost:5665/v1/config/stages/example-cmdb/example.localdomain-1441133065-1' | python -m json.tool
1527 "status": "Stage deleted."
1533 ### <a id="icinga2-api-config-management-delete-config-package"></a> Deleting Configuration Package
1535 In order to completely purge a configuration package and its stages
1536 you can send a `DELETE` request to the URL endpoint `/v1/config/packages`
1537 with the package name in the URL path.
1539 This example entirely deletes the configuration package `example-cmdb`:
1541 $ curl -k -s -u root:icinga -H 'Accept: application/json' -X DELETE \
1542 'https://localhost:5665/v1/config/packages/example-cmdb' | python -m json.tool
1547 "package": "example-cmdb",
1548 "status": "Deleted package."
1554 ## <a id="icinga2-api-types"></a> Types
1556 You can retrieve the configuration object types by sending a `GET` request to URL
1557 endpoint `/v1/types`.
1559 Each response entry in the results array contains the following attributes:
1561 Attribute | Type | Description
1562 ---------------|--------------|---------------------
1563 name | string | The type name.
1564 plural_name | string | The plural type name.
1565 fields | dictionary | Available fields including details on e.g. the type and attribute accessibility.
1566 abstract | boolean | Whether objects can be instantiated for this type.
1567 base | boolean | The base type (e.g. `Service` inherits fields and prototype methods from `Checkable`).
1568 prototype_keys | string array | Available prototype methods.
1570 In order to view a specific configuration object type specify its name inside the URL path:
1572 $ curl -k -s -u root:icinga 'https://localhost:5665/v1/types/Object' | python -m json.tool
1582 "navigation": false,
1583 "no_user_modify": false,
1584 "no_user_view": false,
1593 "plural_name": "Objects",
1604 ## <a id="icinga2-api-console"></a> Console
1606 You can inspect variables and execute other expressions by sending a `POST` request to the URL endpoint `/v1/console/execute-script`.
1607 In order to receive auto-completion suggestions, send a `POST` request to the URL endpoint `/v1/console/auto-complete-script`.
1609 The following parameters need to be specified (either as URL parameters or in a JSON-encoded message body):
1611 Parameter | Type | Description
1612 -----------|--------------|-------------
1613 session | string | **Optional.** The session ID. Ideally this should be a GUID or some other unique identifier.
1614 command | string | **Required.** Command expression for execution or auto-completion.
1615 sandboxed | number | **Optional.** Whether runtime changes are allowed or forbidden. Defaults to disabled.
1617 The [API permission](12-icinga2-api.md#icinga2-api-permissions) `console` is required for executing
1622 > Runtime modifications via `execute-script` calls are not validated and might cause the Icinga 2
1623 > daemon to crash or behave in an unexpected way. Use these runtime changes at your own risk.
1625 If you specify a session identifier, the same script context can be reused for multiple requests. This allows you to, for example, set a local variable in a request and use that local variable in another request. Sessions automatically expire after a set period of inactivity (currently 30 minutes).
1627 Example for fetching the command line from the local host's last check result:
1629 $ curl -k -s -u root:icinga -H 'Accept: application/json' -X POST 'https://localhost:5665/v1/console/execute-script?command=get_host(NodeName).last_check_result.command&sandboxed=0&session=bb75fd7c-c686-407d-9688-582c04227756' | python -m json.tool
1635 "/usr/local/sbin/check_ping",
1643 "status": "Executed successfully."
1648 Example for fetching auto-completion suggestions for the `Host.` type. This works in a
1649 similar fashion when pressing TAB inside the [console CLI command](11-cli-commands.md#cli-command-console):
1651 $ curl -k -s -u root:icinga -H 'Accept: application/json' -X POST 'https://localhost:5665/v1/console/auto-complete-script?command=Host.&sandboxed=0&session=bb75fd7c-c686-407d-9688-582c04227756' | python -m json.tool
1656 "status": "Auto-completed successfully.",
1662 "Host.register_attribute_handler",
1664 "Host.notify_attribute",
1672 ## <a id="icinga2-api-clients"></a> API Clients
1674 There are a couple of existing clients which can be used with the Icinga 2 API:
1676 * [curl](https://curl.haxx.se/) or any other HTTP client really
1677 * [Icinga 2 console (CLI command)](12-icinga2-api.md#icinga2-api-clients-cli-console)
1678 * [Icinga Studio](12-icinga2-api.md#icinga2-api-clients-icinga-studio)
1679 * [Icinga Web 2 Director](https://www.icinga.com/products/icinga-web-2-modules/)
1683 * [Dashing](https://github.com/Icinga/dashing-icinga2)
1684 * [API examples](https://github.com/Icinga/icinga2-api-examples)
1686 Additional [programmatic examples](12-icinga2-api.md#icinga2-api-clients-programmatic-examples)
1687 will help you getting started using the Icinga 2 API in your environment.
1689 ### <a id="icinga2-api-clients-icinga-studio"></a> Icinga Studio
1691 Icinga Studio is a graphical application to query configuration objects provided by the API.
1693 ![Icinga Studio Connection](images/icinga2-api/icinga2_api_icinga_studio_connect.png)
1695 ![Icinga Studio Overview](images/icinga2-api/icinga2_api_icinga_studio_overview.png)
1697 Please check the package repository of your distribution for available
1701 > Icinga Studio does not currently support SSL certificate verification.
1703 The Windows installer already includes Icinga Studio. On Debian and Ubuntu the package
1704 `icinga2-studio` can be used to install Icinga Studio.
1706 ### <a id="icinga2-api-clients-cli-console"></a> Icinga 2 Console
1708 By default the [console CLI command](11-cli-commands.md#cli-command-console) evaluates
1709 expressions in a local interpreter, i.e. independently from your Icinga 2 daemon.
1710 Add the `--connect` parameter to debug and evaluate expressions via the API.
1712 ### <a id="icinga2-api-clients-programmatic-examples"></a> API Clients Programmatic Examples
1714 The programmatic examples use HTTP basic authentication and SSL certificate
1715 verification. The CA file is expected in `pki/icinga2-ca.crt`
1716 but you may adjust the examples for your likings.
1718 The [request method](icinga2-api-requests) is `POST` using
1719 [X-HTTP-Method-Override: GET](12-icinga2-api.md#icinga2-api-requests-method-override)
1720 which allows you to send a JSON request body. The examples request
1721 specific service attributes joined with host attributes. `attrs`
1722 and `joins` are therefore specified as array.
1723 The `filter` attribute [matches](18-library-reference.md#global-functions-match)
1724 on all services with `ping` in their name.
1726 #### <a id="icinga2-api-clients-programmatic-examples-python"></a> Example API Client in Python
1728 The following example uses **Python** and the `requests` and `json` module:
1730 # pip install requests
1733 $ vim icinga2-api-example.py
1735 #!/usr/bin/env python
1737 import requests, json
1739 # Replace 'localhost' with your FQDN and certificate CN
1740 # for SSL verification
1741 request_url = "https://localhost:5665/v1/objects/services"
1743 'Accept': 'application/json',
1744 'X-HTTP-Method-Override': 'GET'
1747 "attrs": [ "name", "state", "last_check_result" ],
1748 "joins": [ "host.name", "host.state", "host.last_check_result" ],
1749 "filter": "match(\"ping*\", service.name)",
1752 r = requests.post(request_url,
1754 auth=('root', 'icinga'),
1755 data=json.dumps(data),
1756 verify="pki/icinga2-ca.crt")
1758 print "Request URL: " + str(r.url)
1759 print "Status code: " + str(r.status_code)
1761 if (r.status_code == 200):
1762 print "Result: " + json.dumps(r.json())
1765 r.raise_for_status()
1767 $ python icinga2-api-example.py
1770 #### <a id="icinga2-api-clients-programmatic-examples-ruby"></a> Example API Client in Ruby
1772 The following example uses **Ruby** and the `rest_client` gem:
1774 # gem install rest_client
1776 $ vim icinga2-api-example.rb
1780 require 'rest_client'
1782 # Replace 'localhost' with your FQDN and certificate CN
1783 # for SSL verification
1784 request_url = "https://localhost:5665/v1/objects/services"
1786 "Accept" => "application/json",
1787 "X-HTTP-Method-Override" => "GET"
1790 "attrs" => [ "name", "state", "last_check_result" ],
1791 "joins" => [ "host.name", "host.state", "host.last_check_result" ],
1792 "filter" => "match(\"ping*\", service.name)",
1795 r = RestClient::Resource.new(
1796 URI.encode(request_url),
1797 :headers => headers,
1799 :password => "icinga",
1800 :ssl_ca_file => "pki/icinga2-ca.crt")
1803 response = r.post(data.to_json)
1805 response = e.response
1808 puts "Status: " + response.code.to_s
1809 if response.code == 200
1810 puts "Result: " + (JSON.pretty_generate JSON.parse(response.body))
1812 puts "Error: " + response
1815 $ ruby icinga2-api-example.rb
1817 A more detailed example can be found in the [Dashing demo](https://github.com/Icinga/dashing-icinga2).
1819 #### <a id="icinga2-api-clients-programmatic-examples-php"></a> Example API Client in PHP
1821 The following example uses **PHP** and its `curl` library:
1823 $ vim icinga2-api-example.php
1827 # Replace 'localhost' with your FQDN and certificate CN
1828 # for SSL verification
1829 $request_url = "https://localhost:5665/v1/objects/services";
1831 $password = "icinga";
1833 'Accept: application/json',
1834 'X-HTTP-Method-Override: GET'
1837 attrs => array('name', 'state', 'last_check_result'),
1838 joins => array('host.name', 'host.state', 'host.last_check_result'),
1839 filter => 'match("ping*", service.name)',
1843 curl_setopt_array($ch, array(
1844 CURLOPT_URL => $request_url,
1845 CURLOPT_HTTPHEADER => $headers,
1846 CURLOPT_USERPWD => $username . ":" . $password,
1847 CURLOPT_RETURNTRANSFER => true,
1848 CURLOPT_CAINFO => "pki/icinga2-ca.crt",
1849 CURLOPT_POST => count($data),
1850 CURLOPT_POSTFIELDS => json_encode($data)
1853 $response = curl_exec($ch);
1854 if ($response === false) {
1855 print "Error: " . curl_error($ch) . "(" . $response . ")\n";
1858 $code = curl_getinfo($ch, CURLINFO_HTTP_CODE);
1860 print "Status: " . $code . "\n";
1863 $response = json_decode($response, true);
1868 $ php icinga2-api-example.php
1870 #### <a id="icinga2-api-clients-programmatic-examples-perl"></a> Example API Client in Perl
1872 The following example uses **Perl** and the `Rest::Client` module:
1874 # perl -MCPAN -e 'install REST::Client'
1875 # perl -MCPAN -e 'install JSON'
1876 # perl -MCPAN -e 'install MIME::Base64'
1877 # perl -MCPAN -e 'install Data::Dumper'
1879 $ vim icinga2-api-example.pl
1890 # Replace 'localhost' with your FQDN and certificate CN
1891 # for SSL verification
1892 my $request_host = "https://localhost:5665";
1893 my $userpass = "root:icinga";
1895 my $client = REST::Client->new();
1896 $client->setHost($request_host);
1897 $client->setCa("pki/icinga2-ca.crt");
1898 $client->addHeader("Accept", "application/json");
1899 $client->addHeader("X-HTTP-Method-Override", "GET");
1900 $client->addHeader("Authorization", "Basic " . encode_base64($userpass));
1902 attrs => ['name', 'state', 'last_check_result'],
1903 joins => ['host.name', 'host.state', 'host.last_check_result'],
1904 filter => 'match("ping*", service.name)',
1906 my $data = encode_json(\%json_data);
1907 $client->POST("/v1/objects/services", $data);
1909 my $status = $client->responseCode();
1910 print "Status: " . $status . "\n";
1911 my $response = $client->responseContent();
1912 if ($status == 200) {
1913 print "Result: " . Dumper(decode_json($response)) . "\n";
1915 print "Error: " . $response . "\n";
1918 $ perl icinga2-api-example.pl