# REST API Overview

**URL:** <https://community.icinga.com/t/rest-api-overview/165>\
**Category:** Icinga 2\
**Tags:** api, icinga2\
**Created:** [January 11, 2019, 11:23am UTC](https://community.icinga.com/t/rest-api-overview/165 "2019-01-11T11:23:23Z")\
**Posts on this page:** 1\
**Page:** 1

<div class="post-metadata">

**Author:** ![dnsmichi](https://community.icinga.com/user_avatar/community.icinga.com/dnsmichi/32/7721_2.png) [@dnsmichi](https://community.icinga.com/u/dnsmichi)\
**Post date:** [January 11, 2019, 11:23am UTC](https://community.icinga.com/t/rest-api-overview/165/1 "2019-01-11T11:23:23Z")

</div>

Icinga 2’s REST API is used to manage the core application and retrieve details about the objects state. This API is intended for programmatic usage.

# Documentation

The [documentation](https://icinga.com/docs/icinga2/latest/doc/12-icinga2-api/) covers everything you need, including programming examples.

# Examples

Collected examples from community and developers can be found in [this GitHub repository](https://github.com/Icinga/icinga2-api-examples). Missing something there? Please edit it and send a pull request 🙂

> [@Dashing for Icinga 2](https://community.icinga.com/t/dashing-for-icinga-2/104):
>
> This is a standalone Dashing dashboard which can be installed on any Linux client or \*PI device. The Dashing job connects to the Icinga 2 REST API and presents the current stats and metrics on your office dashboard. More details [here](https://github.com/dnsmichi/dashing-icinga2).