Icinga DB Web

https://icinga.com/docs/icinga-db-web/latest/
Admin
Icinga DB Web is a modern web interface for the Icinga monitoring ecosystem that connects to Redis...
Tokens:12,640
Snippets:145
Trust Score:10
Update:5 months ago
Show doc for...
Tokens:
Raw
### Install icingadb-web Package

Source: https://icinga.com/docs/icinga-db-web/latest/doc/02-Installation/Debian

Installs the icingadb-web package using APT after the repository has been configured.

```bash
apt install icingadb-web

```

--------------------------------

### Install Icinga DB Web Package on openSUSE

Source: https://icinga.com/docs/icinga-db-web/latest/doc/02-Installation/openSUSE

Installs the icingadb-web package using the zypper package manager after the repository has been added.

```bash
zypper install icingadb-web
```

--------------------------------

### Install icingadb-web Package on Fedora

Source: https://icinga.com/docs/icinga-db-web/latest/doc/02-Installation/Fedora

Install the icingadb-web package using the dnf package manager after the repository has been added.

```bash
dnf install icingadb-web

```

--------------------------------

### Custom Variable Paths Example

Source: https://icinga.com/docs/icinga-db-web/latest/doc/04-Security

Demonstrates how to reference custom variables and their nested structures, including array elements, using dot notation and bracket notation for arrays. Supports wildcard matching for array elements.

```plaintext
vars.os = "Linux"
vars.team = {
  name = "Support",
  on-site = ["mo", "tue", "wed", "thu", "fr"]
}


```

```plaintext
os
team.name
team.on-site[0]
team.on-site[4]
team.on-site[*]
```

--------------------------------

### Add Icinga GPG Key and Install apt-transport-https

Source: https://icinga.com/docs/icinga-db-web/latest/doc/02-Installation/Debian

Installs necessary packages and downloads the Icinga GPG key for the APT repository.

```bash
apt update
apt -y install apt-transport-https wget

wget -O icinga-archive-keyring.deb "https://packages.icinga.com/icinga-archive-keyring_latest+debian$(
 . /etc/os-release; echo "$VERSION_ID"
).deb"

apt install ./icinga-archive-keyring.deb

```

--------------------------------

### Install icingadb-web Package on Amazon Linux 2

Source: https://icinga.com/docs/icinga-db-web/latest/doc/02-Installation/Amazon-Linux

Install the icingadb-web package using the yum package manager on Amazon Linux 2.

```bash
yum install icingadb-web

```

--------------------------------

### Add Icinga Package Repository GPG Key

Source: https://icinga.com/docs/icinga-db-web/latest/doc/02-Installation/Ubuntu

Installs necessary packages and downloads the Icinga archive keyring for Ubuntu. Ensure apt is updated before proceeding.

```bash
apt update
apt -y install apt-transport-https wget

wget -O icinga-archive-keyring.deb "https://packages.icinga.com/icinga-archive-keyring_latest+ubuntu$( 
 . /etc/os-release; echo "$VERSION_ID"
).deb"

apt install ./icinga-archive-keyring.deb

```

--------------------------------

### Add Icinga APT Repository

Source: https://icinga.com/docs/icinga-db-web/latest/doc/02-Installation/Ubuntu

Configures the APT sources list to include the Icinga repository for your Ubuntu distribution. This ensures you can install Icinga packages.

```bash
. /etc/os-release; if [ ! -z ${UBUNTU_CODENAME+x} ]; then DIST="${UBUNTU_CODENAME}"; else DIST="$(lsb_release -c| awk '{print $2}')"; fi; \
 echo "deb [signed-by=/usr/share/keyrings/icinga-archive-keyring.gpg] https://packages.icinga.com/ubuntu icinga-${DIST} main" > \
 /etc/apt/sources.list.d/${DIST}-icinga.list
 echo "deb-src [signed-by=/usr/share/keyrings/icinga-archive-keyring.gpg] https://packages.icinga.com/ubuntu icinga-${DIST} main" >> \
 /etc/apt/sources.list.d/${DIST}-icinga.list

apt update

```

--------------------------------

### Example JSON Response - Success

Source: https://icinga.com/docs/icinga-db-web/latest/doc/09-Automation

This is a successful response format from the Icinga Web API.

```json
{
  "status": "success",
  "data": [
    {
      "type": "success",
      "message": "Added comment successfully"
    }
  ]
}

```

--------------------------------

### Example JSON Response - Failure

Source: https://icinga.com/docs/icinga-db-web/latest/doc/09-Automation

This is a failure response format from the Icinga Web API, indicating issues with provided options.

```json
{
  "status": "fail",
  "data": {
    "comment": [],
    "expire": [],
    "expire_time": ["The expire time must not be in the past"]
  }
}

```

--------------------------------

### Copy Configuration File

Source: https://icinga.com/docs/icinga-db-web/latest/doc/10-Migration

Copy the monitoring module's config.ini to the Icinga DB module directory. The behavior of these options remains the same.

```bash
cp /etc/icingaweb2/modules/monitoring/config.ini /etc/icingaweb2/modules/icingadb/config.ini
```

--------------------------------

### Add Icinga Package Repository

Source: https://icinga.com/docs/icinga-db-web/latest/doc/02-Installation/Amazon-Linux

Use this command to download the Icinga release repository configuration file. Ensure you have the necessary subscription and credentials.

```bash
curl https://packages.icinga.com/amazon/ICINGA-release.repo -o /etc/yum.repos.d/ICINGA-release.repo

```

--------------------------------

### Add Icinga Package Repository

Source: https://icinga.com/docs/icinga-db-web/latest/doc/02-Installation/RHEL

Use this command to download the official Icinga release repository configuration file. Ensure you have the necessary subscription and credentials.

```bash
curl https://packages.icinga.com/rhel/ICINGA-release.repo -o /etc/yum.repos.d/ICINGA-release.repo

```

--------------------------------

### Add Icinga Package Repository on Fedora

Source: https://icinga.com/docs/icinga-db-web/latest/doc/02-Installation/Fedora

Import the GPG key and add the official Icinga release repository configuration file to your system.

```bash
rpm --import https://packages.icinga.com/icinga.key
curl https://packages.icinga.com/fedora/ICINGA-release.repo -o /etc/yum.repos.d/ICINGA-release.repo

```

--------------------------------

### Check Now

Source: https://icinga.com/docs/icinga-db-web/latest/doc/09-Automation

Trigger an immediate check for hosts or services.

```APIDOC
## POST icingadb/hosts/check-now

### Description
Trigger an immediate check for a host.

### Method
POST

### Endpoint
/icingadb/hosts/check-now

### Parameters
No specific options are required for this endpoint. Filters in the query string determine which hosts are checked.

### Request Example
```bash
USER="icingaadmin"
PASSWORD="icinga"
BASEURL="http://localhost/icingaweb2"
FILTER="host.name=docker-master"
curl -H "Accept: application/json" -u $USER:$PASSWORD "$BASEURL/icingadb/hosts/check-now?$FILTER"
```

### Response
#### Success Response (200)
- **status** (string) - Indicates the status of the operation ('success').
- **data** (array) - An array of objects, each containing a 'type' and 'message' for the result.

#### Response Example
```json
{
  "status": "success",
  "data": [
    {
      "type": "success",
      "message": "Check scheduled successfully"
    }
  ]
}
```
```

```APIDOC
## POST icingadb/services/check-now

### Description
Trigger an immediate check for a service.

### Method
POST

### Endpoint
/icingadb/services/check-now

### Parameters
No specific options are required for this endpoint. Filters in the query string determine which services are checked.

### Request Example
```bash
USER="icingaadmin"
PASSWORD="icinga"
BASEURL="http://localhost/icingaweb2"
FILTER="service.name=my_service"
curl -H "Accept: application/json" -u $USER:$PASSWORD "$BASEURL/icingadb/services/check-now?$FILTER"
```

### Response
#### Success Response (200)
- **status** (string) - Indicates the status of the operation ('success').
- **data** (array) - An array of objects, each containing a 'type' and 'message' for the result.

#### Response Example
```json
{
  "status": "success",
  "data": [
    {
      "type": "success",
      "message": "Check scheduled successfully"
    }
  ]
}
```
```

--------------------------------

### Migrate Navigation Items

Source: https://icinga.com/docs/icinga-db-web/latest/doc/10-Migration

Use the icingacli command to automatically migrate navigation items from the monitoring module to Icinga DB Web. Specify users with --user and control backup creation with --no-backup. Use --override to re-migrate.

```bash
icingacli icingadb migrate navigation --user=<name> [--no-backup] [--override]
```

--------------------------------

### Add Icinga Debian Repository

Source: https://icinga.com/docs/icinga-db-web/latest/doc/02-Installation/Debian

Configures the APT sources list to include the Icinga repository for Debian.

```bash
DIST=$(awk -F"[)(]+" '/VERSION=/ {print $2}' /etc/os-release); \
 echo "deb [signed-by=/usr/share/keyrings/icinga-archive-keyring.gpg] https://packages.icinga.com/debian icinga-${DIST} main" > \
 /etc/apt/sources.list.d/${DIST}-icinga.list
 echo "deb-src [signed-by=/usr/share/keyrings/icinga-archive-keyring.gpg] https://packages.icinga.com/debian icinga-${DIST} main" >> \
 /etc/apt/sources.list.d/${DIST}-icinga.list

apt update

```

--------------------------------

### Configure Acknowledgement Defaults

Source: https://icinga.com/docs/icinga-db-web/latest/doc/03-Configuration

Set default values for acknowledgements, such as enabling expire time and setting a default expire duration.

```ini
[settings]
acknowledge_expire = 1
acknowledge_expire_time = PT2H

```

--------------------------------

### Add Icinga Package Repository on openSUSE

Source: https://icinga.com/docs/icinga-db-web/latest/doc/02-Installation/openSUSE

Adds the official Icinga release repository to your openSUSE system using zypper.

```bash
zypper ar -r https://packages.icinga.com/opensuse/$releasever/release/ icinga-release
```

--------------------------------

### Migrate Dashboard Items

Source: https://icinga.com/docs/icinga-db-web/latest/doc/10-Migration

Use the icingacli command to automatically migrate dashboard items referencing monitoring module views to Icinga DB Web views. Backups are created by default; disable with --no-backup.

```bash
icingacli icingadb migrate dashboard --user=<name> [--no-backup]
```

--------------------------------

### Copy Command Transports Configuration

Source: https://icinga.com/docs/icinga-db-web/latest/doc/10-Migration

Copy the monitoring module's commandtransports.ini to the Icinga DB module directory. Ensure to remove sections not using 'transport=api' as commandfile is no longer supported.

```bash
cp /etc/icingaweb2/modules/monitoring/commandtransports.ini /etc/icingaweb2/modules/icingadb/commandtransports.ini
```

--------------------------------

### Schedule Check

Source: https://icinga.com/docs/icinga-db-web/latest/doc/09-Automation

Schedule an immediate check for hosts or services.

```APIDOC
## POST icingadb/hosts/schedule-check

### Description
Schedule an immediate check for a host.

### Method
POST

### Endpoint
/icingadb/hosts/schedule-check

### Parameters
#### Request Body
- **check_time** (DateTime) - Required - The time when the check should be scheduled. Defaults to now + 1 hour.
- **force_check** (BoolEnum) - Optional - Whether to force the check, even if it's not scheduled yet.

### Request Example
```bash
USER="icingaadmin"
PASSWORD="icinga"
BASEURL="http://localhost/icingaweb2"
FILTER="host.name=docker-master"
curl -H "Accept: application/json" -u $USER:$PASSWORD "$BASEURL/icingadb/hosts/schedule-check?$FILTER" \
  -F "check_time=2023-10-05T20:00:00" -F "force_check=y"
```

### Response
#### Success Response (200)
- **status** (string) - Indicates the status of the operation ('success').
- **data** (array) - An array of objects, each containing a 'type' and 'message' for the result.

#### Response Example
```json
{
  "status": "success",
  "data": [
    {
      "type": "success",
      "message": "Check scheduled successfully"
    }
  ]
}
```
```

```APIDOC
## POST icingadb/services/schedule-check

### Description
Schedule an immediate check for a service.

### Method
POST

### Endpoint
/icingadb/services/schedule-check

### Parameters
#### Request Body
- **check_time** (DateTime) - Required - The time when the check should be scheduled. Defaults to now + 1 hour.
- **force_check** (BoolEnum) - Optional - Whether to force the check, even if it's not scheduled yet.

### Request Example
```bash
USER="icingaadmin"
PASSWORD="icinga"
BASEURL="http://localhost/icingaweb2"
FILTER="service.name=my_service"
curl -H "Accept: application/json" -u $USER:$PASSWORD "$BASEURL/icingadb/services/schedule-check?$FILTER" \
  -F "check_time=2023-10-05T20:00:00" -F "force_check=y"
```

### Response
#### Success Response (200)
- **status** (string) - Indicates the status of the operation ('success').
- **data** (array) - An array of objects, each containing a 'type' and 'message' for the result.

#### Response Example
```json
{
  "status": "success",
  "data": [
    {
      "type": "success",
      "message": "Check scheduled successfully"
    }
  ]
}
```
```

--------------------------------

### Add Icinga Package Repository on SLES

Source: https://icinga.com/docs/icinga-db-web/latest/doc/02-Installation/SLES

Adds the official Icinga release repository to your SLES system using `zypper`. Ensure your package manager is configured for restricted repositories if necessary.

```bash
zypper ar -r https://packages.icinga.com/sles/$releasever/release/ icinga-release
```

--------------------------------

### Acknowledge Problem

Source: https://icinga.com/docs/icinga-db-web/latest/doc/09-Automation

Acknowledge a problem for hosts or services. This can be done with or without an expiration time and can be configured to be persistent, notify users, and be sticky.

```APIDOC
## POST icingadb/hosts/acknowledge

### Description
Acknowledge a problem for a host.

### Method
POST

### Endpoint
/icingadb/hosts/acknowledge

### Parameters
#### Request Body
- **comment** (Text) - Required - The comment text for the acknowledgement.
- **persistent** (BoolEnum) - Optional - Whether the acknowledgement should be persistent. Defaults to 'n'.
- **notify** (BoolEnum) - Optional - Whether to notify users about the acknowledgement. Defaults to 'y'.
- **sticky** (BoolEnum) - Optional - Whether the acknowledgement should be sticky. Defaults to 'n'.
- **expire** (BoolEnum) - Optional - Whether the acknowledgement should expire. Defaults to 'n'.
- **expire_time** (DateTime) - Required if expire is 'y' - The time when the acknowledgement should expire.

### Request Example
```bash
curl -H "Accept: application/json" -u icingaadmin:icinga \"http://localhost/icingaweb2/icingadb/hosts/acknowledge?host.name=docker-master\" \
  -F "comment=Host is down" -F "expire_time=2023-10-05T20:00:00" -F "expire=y"
```

### Response
#### Success Response (200)
- **status** (string) - Indicates the status of the operation ('success').
- **data** (array) - An array of objects, each containing a 'type' and 'message' for the result.

#### Response Example
```json
{
  "status": "success",
  "data": [
    {
      "type": "success",
      "message": "Acknowledgement added successfully"
    }
  ]
}
```
```

```APIDOC
## POST icingadb/services/acknowledge

### Description
Acknowledge a problem for a service.

### Method
POST

### Endpoint
/icingadb/services/acknowledge

### Parameters
#### Request Body
- **comment** (Text) - Required - The comment text for the acknowledgement.
- **persistent** (BoolEnum) - Optional - Whether the acknowledgement should be persistent. Defaults to 'n'.
- **notify** (BoolEnum) - Optional - Whether to notify users about the acknowledgement. Defaults to 'y'.
- **sticky** (BoolEnum) - Optional - Whether the acknowledgement should be sticky. Defaults to 'n'.
- **expire** (BoolEnum) - Optional - Whether the acknowledgement should expire. Defaults to 'n'.
- **expire_time** (DateTime) - Required if expire is 'y' - The time when the acknowledgement should expire.

### Request Example
```bash
curl -H "Accept: application/json" -u icingaadmin:icinga \"http://localhost/icingaweb2/icingadb/services/acknowledge?service.name=my_service\" \
  -F "comment=Service is not responding" -F "expire_time=2023-10-05T20:00:00" -F "expire=y"
```

### Response
#### Success Response (200)
- **status** (string) - Indicates the status of the operation ('success').
- **data** (array) - An array of objects, each containing a 'type' and 'message' for the result.

#### Response Example
```json
{
  "status": "success",
  "data": [
    {
      "type": "success",
      "message": "Acknowledgement added successfully"
    }
  ]
}
```
```

--------------------------------

### Transform Filters with icingacli

Source: https://icinga.com/docs/icinga-db-web/latest/doc/05-Upgrading

Use this command to transform filters for navigation items, dashboards, and roles when upgrading to Icinga DB Web v1.1. Backups are created by default.

```bash
icingacli icingadb migrate filter [--no-backup]
```

--------------------------------

### Schedule Host Downtime

Source: https://icinga.com/docs/icinga-db-web/latest/doc/09-Automation

Schedule downtime for a host.

```APIDOC
## POST icingadb/hosts/schedule-downtime

### Description
Schedule downtime for a host.

### Method
POST

### Endpoint
/icingadb/hosts/schedule-downtime

### Parameters
#### Request Body
- **comment** (Text) - Required - The comment text for the downtime.
- **start_time** (DateTime) - Required - The start time of the downtime.
- **end_time** (DateTime) - Required - The end time of the downtime.
- **is_flexible** (BoolEnum) - Optional - Whether the downtime is flexible.
- **trigger_url** (Text) - Optional - URL to trigger the downtime.
- **type** (Enum) - Optional - The type of downtime (0: normal, 1: scheduled, 2: non-triggered).

### Request Example
```bash
USER="icingaadmin"
PASSWORD="icinga"
BASEURL="http://localhost/icingaweb2"
FILTER="host.name=docker-master"
curl -H "Accept: application/json" -u $USER:$PASSWORD "$BASEURL/icingadb/hosts/schedule-downtime?$FILTER" \
  -F "comment=Scheduled maintenance" -F "start_time=2023-10-05T20:00:00" -F "end_time=2023-10-05T22:00:00"
```

### Response
#### Success Response (200)
- **status** (string) - Indicates the status of the operation ('success').
- **data** (array) - An array of objects, each containing a 'type' and 'message' for the result.

#### Response Example
```json
{
  "status": "success",
  "data": [
    {
      "type": "success",
      "message": "Downtime scheduled successfully"
    }
  ]
}
```
```

--------------------------------

### Add Comment to Host via Curl

Source: https://icinga.com/docs/icinga-db-web/latest/doc/09-Automation

Use this curl command to add a comment to a specific host. Ensure you set the correct user, password, base URL, and filter.

```bash
USER="icingaadmin"
PASSWORD="icinga"
BASEURL="http://localhost/icingaweb2"
FILTER="host.name=docker-master"
curl -H "Accept: application/json" -u $USER:$PASSWORD "$BASEURL/icingadb/hosts/add-comment?$FILTER" \
  -F "comment=kaput" -F "expire_time=2023-10-05T20:00:00" -F "expire=y"


```

--------------------------------

### Send Custom Notification (Host)

Source: https://icinga.com/docs/icinga-db-web/latest/doc/09-Automation

Sends a custom notification for a specific host. This can be used to inform users about specific events or states.

```APIDOC
## POST icingadb/hosts/send-custom-notification

### Description
Sends a custom notification for a specific host.

### Endpoint
POST /icingadb/hosts/send-custom-notification

### Parameters
#### Request Body
- **comment** (Text) - Required - A comment describing the custom notification.
- **forced** (BoolEnum) - Optional - If set to 'y', forces the notification even if the host is not in a problematic state. Defaults to 'n'.
```

--------------------------------

### Schedule Host Downtime

Source: https://icinga.com/docs/icinga-db-web/latest/doc/09-Automation

Schedules a downtime for a specific host. This allows for planned maintenance without triggering alerts.

```APIDOC
## POST icingadb/hosts/schedule-downtime

### Description
Schedules a downtime for a specific host.

### Endpoint
POST /icingadb/hosts/schedule-downtime

### Parameters
#### Request Body
- **comment** (Text) - Required - A comment describing the reason for the downtime.
- **start** (DateTime) - Required - The start time of the downtime. Defaults to the current time.
- **end** (DateTime) - Required - The end time of the downtime. Defaults to 1 hour from now (fixed) or 2 hours from now (flexible).
- **flexible** (BoolEnum) - Optional - If set to 'y', allows for flexible end time based on duration. Defaults to 'n'.
- **hours** (Number) - Required if flexible is 'y' - The duration in hours for a flexible downtime. Defaults to 2.
- **minutes** (Number) - Required if flexible is 'y' - The duration in minutes for a flexible downtime. Defaults to 0.
- **all_services** (BoolEnum) - Optional - If set to 'y', schedules downtime for all services on the host. Defaults to 'n'.
- **child_options** (ChildOption) - Optional - Options for scheduling downtime on child hosts.
```

--------------------------------

### Add Comment

Source: https://icinga.com/docs/icinga-db-web/latest/doc/09-Automation

Add a comment to hosts or services. Comments can optionally have an expiration time.

```APIDOC
## POST icingadb/hosts/add-comment

### Description
Add a comment to a host.

### Method
POST

### Endpoint
/icingadb/hosts/add-comment

### Parameters
#### Request Body
- **comment** (Text) - Required - The comment text.
- **expire** (BoolEnum) - Optional - Whether the comment should expire. Defaults to 'n'.
- **expire_time** (DateTime) - Required if expire is 'y' - The time when the comment should expire.

### Request Example
```bash
USER="icingaadmin"
PASSWORD="icinga"
BASEURL="http://localhost/icingaweb2"
FILTER="host.name=docker-master"
curl -H "Accept: application/json" -u $USER:$PASSWORD "$BASEURL/icingadb/hosts/add-comment?$FILTER" \
  -F "comment=kaput" -F "expire_time=2023-10-05T20:00:00" -F "expire=y"
```

### Response
#### Success Response (200)
- **status** (string) - Indicates the status of the operation ('success').
- **data** (array) - An array of objects, each containing a 'type' and 'message' for the result.

#### Response Example
```json
{
  "status": "success",
  "data": [
    {
      "type": "success",
      "message": "Added comment successfully"
    }
  ]
}
```
```

```APIDOC
## POST icingadb/services/add-comment

### Description
Add a comment to a service.

### Method
POST

### Endpoint
/icingadb/services/add-comment

### Parameters
#### Request Body
- **comment** (Text) - Required - The comment text.
- **expire** (BoolEnum) - Optional - Whether the comment should expire. Defaults to 'n'.
- **expire_time** (DateTime) - Required if expire is 'y' - The time when the comment should expire.

### Request Example
```bash
USER="icingaadmin"
PASSWORD="icinga"
BASEURL="http://localhost/icingaweb2"
FILTER="service.name=my_service"
curl -H "Accept: application/json" -u $USER:$PASSWORD "$BASEURL/icingadb/services/add-comment?$FILTER" \
  -F "comment=Service issue" -F "expire_time=2023-10-05T20:00:00" -F "expire=y"
```

### Response
#### Success Response (200)
- **status** (string) - Indicates the status of the operation ('success').
- **data** (array) - An array of objects, each containing a 'type' and 'message' for the result.

#### Response Example
```json
{
  "status": "success",
  "data": [
    {
      "type": "success",
      "message": "Added comment successfully"
    }
  ]
}
```
```

--------------------------------

### Send Custom Notification (Service)

Source: https://icinga.com/docs/icinga-db-web/latest/doc/09-Automation

Sends a custom notification for a specific service. This allows for targeted communication about service-related events.

```APIDOC
## POST icingadb/services/send-custom-notification

### Description
Sends a custom notification for a specific service.

### Endpoint
POST /icingadb/services/send-custom-notification

### Parameters
#### Request Body
- **comment** (Text) - Required - A comment describing the custom notification.
- **forced** (BoolEnum) - Optional - If set to 'y', forces the notification even if the service is not in a problematic state. Defaults to 'n'.
```

--------------------------------

### Process Check Result

Source: https://icinga.com/docs/icinga-db-web/latest/doc/09-Automation

Manually process the result of a check for hosts or services, including status, output, and performance data.

```APIDOC
## POST icingadb/hosts/process-checkresult

### Description
Manually process the result of a check for a host.

### Method
POST

### Endpoint
/icingadb/hosts/process-checkresult

### Parameters
#### Request Body
- **status** (State) - Required - The status of the check (0: UP, 1: DOWN, 2: CRITICAL, 3: UNKNOWN).
- **output** (Text) - Required - The output message from the check.
- **perfdata** (PerfData) - Optional - Performance data from the check.

### Request Example
```bash
USER="icingaadmin"
PASSWORD="icinga"
BASEURL="http://localhost/icingaweb2"
FILTER="host.name=docker-master"
curl -H "Accept: application/json" -u $USER:$PASSWORD "$BASEURL/icingadb/hosts/process-checkresult?$FILTER" \
  -F "status=0" -F "output=Host is up and running" -F "perfdata=load=0.5;0.8;1.0;0;100"
```

### Response
#### Success Response (200)
- **status** (string) - Indicates the status of the operation ('success').
- **data** (array) - An array of objects, each containing a 'type' and 'message' for the result.

#### Response Example
```json
{
  "status": "success",
  "data": [
    {
      "type": "success",
      "message": "Check result processed successfully"
    }
  ]
}
```
```

```APIDOC
## POST icingadb/services/process-checkresult

### Description
Manually process the result of a check for a service.

### Method
POST

### Endpoint
/icingadb/services/process-checkresult

### Parameters
#### Request Body
- **status** (State) - Required - The status of the check (0: OK, 1: WARNING, 2: CRITICAL, 3: UNKNOWN).
- **output** (Text) - Required - The output message from the check.
- **perfdata** (PerfData) - Optional - Performance data from the check.

### Request Example
```bash
USER="icingaadmin"
PASSWORD="icinga"
BASEURL="http://localhost/icingaweb2"
FILTER="service.name=my_service"
curl -H "Accept: application/json" -u $USER:$PASSWORD "$BASEURL/icingadb/services/process-checkresult?$FILTER" \
  -F "status=0" -F "output=Service is OK" -F "perfdata=time=10ms;20ms;30ms;0;100"
```

### Response
#### Success Response (200)
- **status** (string) - Indicates the status of the operation ('success').
- **data** (array) - An array of objects, each containing a 'type' and 'message' for the result.

#### Response Example
```json
{
  "status": "success",
  "data": [
    {
      "type": "success",
      "message": "Check result processed successfully"
    }
  ]
}
```
```

--------------------------------

### Configure Icinga 2 API User for Icinga DB Web

Source: https://icinga.com/docs/icinga-db-web/latest/doc/03-Configuration

Define an ApiUser object in Icinga 2 configuration to grant Icinga DB Web necessary permissions for actions like acknowledging problems and scheduling downtimes. Ensure the password is changed from the default.

```icinga2
object ApiUser "icingadb-web" {
    password = "CHANGEME"
    permissions = [ "actions/*", "objects/modify/*", "objects/query/*", "status/query" ]
}

```

--------------------------------

### Schedule Service Downtime

Source: https://icinga.com/docs/icinga-db-web/latest/doc/09-Automation

Schedules a downtime for a specific service. This is useful for planned maintenance on individual services.

```APIDOC
## POST icingadb/services/schedule-downtime

### Description
Schedules a downtime for a specific service.

### Endpoint
POST /icingadb/services/schedule-downtime

### Parameters
#### Request Body
- **comment** (Text) - Required - A comment describing the reason for the downtime.
- **start** (DateTime) - Required - The start time of the downtime. Defaults to the current time.
- **end** (DateTime) - Required - The end time of the downtime. Defaults to 1 hour from now (fixed) or 2 hours from now (flexible).
- **flexible** (BoolEnum) - Optional - If set to 'y', allows for flexible end time based on duration. Defaults to 'n'.
- **hours** (Number) - Required if flexible is 'y' - The duration in hours for a flexible downtime. Defaults to 2.
- **minutes** (Number) - Required if flexible is 'y' - The duration in minutes for a flexible downtime. Defaults to 0.
```

--------------------------------

### Delete Comment from Host via Curl

Source: https://icinga.com/docs/icinga-db-web/latest/doc/09-Automation

Use this curl command to delete comments from a specific host. The request method is POST.

```bash
USER="icingaadmin"
PASSWORD="icinga"
BASEURL="http://localhost/icingaweb2"
FILTER="host.name=docker-master"
curl -H "Accept: application/json" -u $USER:$PASSWORD -X POST "$BASEURL/icingadb/hosts/delete-comment?$FILTER"


```

--------------------------------

### Delete Downtimes

Source: https://icinga.com/docs/icinga-db-web/latest/doc/09-Automation

Deletes existing downtimes. This can be used to cancel scheduled downtimes.

```APIDOC
## DELETE icingadb/downtimes/delete

### Description
Deletes existing downtimes.

### Endpoint
DELETE /icingadb/downtimes/delete

### Parameters
#### Request Body
None.
```

--------------------------------

### Remove Acknowledgement

Source: https://icinga.com/docs/icinga-db-web/latest/doc/09-Automation

Remove an acknowledgement from hosts or services.

```APIDOC
## POST icingadb/hosts/remove-acknowledgement

### Description
Remove an acknowledgement from a host.

### Method
POST

### Endpoint
/icingadb/hosts/remove-acknowledgement

### Parameters
No specific options are required for this endpoint. Filters in the query string determine which hosts have their acknowledgements removed.

### Request Example
```bash
USER="icingaadmin"
PASSWORD="icinga"
BASEURL="http://localhost/icingaweb2"
FILTER="host.name=docker-master"
curl -H "Accept: application/json" -u $USER:$PASSWORD "$BASEURL/icingadb/hosts/remove-acknowledgement?$FILTER"
```

### Response
#### Success Response (200)
- **status** (string) - Indicates the status of the operation ('success').
- **data** (array) - An array of objects, each containing a 'type' and 'message' for the result.

#### Response Example
```json
{
  "status": "success",
  "data": [
    {
      "type": "success",
      "message": "Acknowledgement removed successfully"
    }
  ]
}
```
```

```APIDOC
## POST icingadb/services/remove-acknowledgement

### Description
Remove an acknowledgement from a service.

### Method
POST

### Endpoint
/icingadb/services/remove-acknowledgement

### Parameters
No specific options are required for this endpoint. Filters in the query string determine which services have their acknowledgements removed.

### Request Example
```bash
USER="icingaadmin"
PASSWORD="icinga"
BASEURL="http://localhost/icingaweb2"
FILTER="service.name=my_service"
curl -H "Accept: application/json" -u $USER:$PASSWORD "$BASEURL/icingadb/services/remove-acknowledgement?$FILTER"
```

### Response
#### Success Response (200)
- **status** (string) - Indicates the status of the operation ('success').
- **data** (array) - An array of objects, each containing a 'type' and 'message' for the result.

#### Response Example
```json
{
  "status": "success",
  "data": [
    {
      "type": "success",
      "message": "Acknowledgement removed successfully"
    }
  ]
}
```
```

--------------------------------

### Delete Comments

Source: https://icinga.com/docs/icinga-db-web/latest/doc/09-Automation

Delete comments from hosts or services.

```APIDOC
## POST icingadb/comments/delete

### Description
Delete comments from hosts or services.

### Method
POST

### Endpoint
/icingadb/comments/delete

### Parameters
No specific options are required for this endpoint. Filters in the query string determine which comments are deleted.

### Request Example
```bash
USER="icingaadmin"
PASSWORD="icinga"
BASEURL="http://localhost/icingaweb2"
FILTER="host.name=docker-master"
curl -H "Accept: application/json" -u $USER:$PASSWORD "$BASEURL/icingadb/comments/delete?$FILTER"
```

### Response
#### Success Response (200)
- **status** (string) - Indicates the status of the operation ('success').
- **data** (array) - An array of objects, each containing a 'type' and 'message' for the result.

#### Response Example
```json
{
  "status": "success",
  "data": [
    {
      "type": "success",
      "message": "Comments deleted successfully"
    }
  ]
}
```
```
Tokens:
Raw