Alerts

List alerts (optionally matching certain criteria that are specified by query parameters).

get

Sample URLs

  • List only alerts that are either in state PENDING or ACCEPTED: https://api.ilert.com/api/alerts?states=PENDING&states=ACCEPTED

  • List only alerts that belong to the alert source with ID 1243 or 1743 and where user jd is a responder: https://api.ilert.com/api/alerts?sources=1243&sources=1743&responders=jd

  • Paginate first batch for a range of alerts (note: query parameters should be url encoded): https://api.ilert.com/api/alerts?start-index=0&max-results=100&from=2021-03-01T21:24:56.771Z&until=2021-04-01T21:24:56.771Z

  • Fetch next page, assuming equal to max-results were returned: https://api.ilert.com/api/alerts?start-index=100&max-results=100&from=2021-03-01T21:24:56.771Z&until=2021-04-01T21:24:56.771Z

  • Pagination should be done based on the reportTime field using the parameters from and until as well as start-index. When building a local alert state store the id field should be used as identifier. The alertKey field is not suitable for this, as it is used to group related alerts to each other.

Authorizations
Query parameters
start-indexinteger · int32Optional

an integer specifying the starting point (beginning with 0) when paging through a list of entities

Default: 0
max-resultsinteger · int32 · max: 100Optional

the maximum number of results when paging through a list of entities.

Default: 50
sourcesinteger · int64[]Optional

alert source IDs of the alert's alert source

policiesinteger · int64[]Optional

escalation policy IDs of the alert's escalation policy

respondersstring[]Optional

user ids of the user that is a responder of the alert

fromstring · date-timeOptional

from date, ISO-UTC e.g. 2021-05-25T21:24:56.771Z, based on reportTime

untilstring · date-timeOptional

until date, ISO-UTC e.g. 2021-05-26T21:24:56.771Z, based on reportTime

Responses
200
OK
application/json
get
GET /api/alerts HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
200

OK

[
  {
    "id": 1,
    "summary": "text",
    "details": "text",
    "reportTime": "2025-07-08T10:34:03.807Z",
    "resolvedOn": "2025-07-08T10:34:03.807Z",
    "status": "PENDING",
    "alertSource": {
      "id": 1,
      "teams": [
        {
          "id": 1,
          "name": "text"
        }
      ],
      "name": "text",
      "iconUrl": "text",
      "lightIconUrl": "text",
      "darkIconUrl": "text",
      "escalationPolicy": {
        "id": 1,
        "name": "text",
        "escalationRules": [
          {
            "escalationTimeout": 1,
            "user": {
              "id": 1
            },
            "schedule": {
              "id": 1
            },
            "users": [
              {
                "id": 1,
                "firstName": "text",
                "lastName": "text"
              }
            ],
            "schedules": [
              {
                "id": 1,
                "name": "text",
                "type": "STATIC"
              }
            ]
          }
        ],
        "teams": [
          {
            "id": 1,
            "name": "text"
          }
        ],
        "repeating": false,
        "frequency": 1,
        "delayMin": 0,
        "routingKey": "text"
      },
      "integrationType": "NAGIOS",
      "integrationKey": "text",
      "integrationUrl": "text",
      "autoResolutionTimeout": "text",
      "alertGroupingWindow": "text",
      "alertCreation": "ONE_ALERT_PER_EMAIL",
      "status": "PENDING",
      "active": true,
      "alertPriorityRule": "HIGH",
      "supportHours": {
        "id": 1,
        "name": "text",
        "teams": [
          {
            "id": 1,
            "name": "text"
          }
        ],
        "timezone": "Europe/Berlin",
        "supportDays": {
          "MONDAY": {
            "start": "10:34:03",
            "end": "10:34:03"
          },
          "TUESDAY": {
            "start": "10:34:03",
            "end": "10:34:03"
          },
          "WEDNESDAY": {
            "start": "10:34:03",
            "end": "10:34:03"
          },
          "THURSDAY": {
            "start": "10:34:03",
            "end": "10:34:03"
          },
          "FRIDAY": {
            "start": "10:34:03",
            "end": "10:34:03"
          },
          "SATURDAY": {
            "start": "10:34:03",
            "end": "10:34:03"
          },
          "SUNDAY": {
            "start": "10:34:03",
            "end": "10:34:03"
          }
        }
      },
      "bidirectional": true,
      "summaryTemplate": {
        "textTemplate": "text",
        "elements": [
          {
            "type": "TEXT",
            "val": "text",
            "func": "text",
            "args": [
              {
                "S": "text",
                "N": 1
              }
            ]
          }
        ]
      },
      "detailsTemplate": {
        "textTemplate": "text",
        "elements": [
          {
            "type": "TEXT",
            "val": "text",
            "func": "text",
            "args": [
              {
                "S": "text",
                "N": 1
              }
            ]
          }
        ]
      },
      "routingTemplate": {
        "textTemplate": "text",
        "elements": [
          {
            "type": "TEXT",
            "val": "text",
            "func": "text",
            "args": [
              {
                "S": "text",
                "N": 1
              }
            ]
          }
        ]
      },
      "linkTemplates": [
        {
          "text": "text",
          "hrefTemplate": {
            "textTemplate": "text",
            "elements": [
              {
                "type": "TEXT",
                "val": "text",
                "func": "text",
                "args": [
                  {
                    "S": "text",
                    "N": 1
                  }
                ]
              }
            ]
          }
        }
      ],
      "priorityTemplate": {
        "valueTemplate": {
          "textTemplate": "text",
          "elements": [
            {
              "type": "TEXT",
              "val": "text",
              "func": "text",
              "args": [
                {
                  "S": "text",
                  "N": 1
                }
              ]
            }
          ]
        },
        "mappings": [
          {
            "value": "text",
            "priority": "LOW"
          }
        ]
      },
      "eventFilter": "text",
      "alertKeyTemplate": {
        "textTemplate": "text",
        "elements": [
          {
            "type": "TEXT",
            "val": "text",
            "func": "text",
            "args": [
              {
                "S": "text",
                "N": 1
              }
            ]
          }
        ]
      },
      "eventTypeFilterCreate": "text",
      "eventTypeFilterAccept": "text",
      "eventTypeFilterResolve": "text"
    },
    "escalationPolicy": {
      "id": 1,
      "name": "text",
      "escalationRules": [
        {
          "escalationTimeout": 1,
          "user": {
            "id": 1
          },
          "schedule": {
            "id": 1
          },
          "users": [
            {
              "id": 1,
              "firstName": "text",
              "lastName": "text"
            }
          ],
          "schedules": [
            {
              "id": 1,
              "name": "text",
              "type": "STATIC"
            }
          ]
        }
      ],
      "teams": [
        {
          "id": 1,
          "name": "text"
        }
      ],
      "repeating": false,
      "frequency": 1,
      "delayMin": 0,
      "routingKey": "text"
    },
    "priority": "HIGH",
    "alertKey": "text",
    "assignedTo": {
      "id": 1
    },
    "nextEscalation": "2025-07-08T10:34:03.807Z",
    "escalationRules": [
      {
        "escalationTimeout": 1,
        "user": {
          "id": 1
        },
        "schedule": {
          "id": 1
        },
        "users": [
          {
            "id": 1,
            "firstName": "text",
            "lastName": "text"
          }
        ],
        "schedules": [
          {
            "id": 1,
            "name": "text",
            "type": "STATIC"
          }
        ]
      }
    ],
    "nextEscalationUser": {
      "id": 1,
      "firstName": "text",
      "lastName": "text",
      "email": "text",
      "timezone": "Europe/Berlin",
      "position": "text",
      "department": "text",
      "avatarUrl": "text",
      "language": "de",
      "region": "DE",
      "role": "STAKEHOLDER",
      "shiftColor": "text",
      "mutedUntil": "2025-07-08T10:34:03.807Z",
      "createdAt": "2025-07-08T10:34:03.807Z",
      "updatedAt": "2025-07-08T10:34:03.807Z"
    },
    "nextEscalationRuleIndex": 1,
    "images": [
      {
        "src": "text",
        "href": "text",
        "alt": "text"
      }
    ],
    "links": [
      {
        "href": "text",
        "text": "text"
      }
    ],
    "responders": [
      {
        "user": {
          "id": 1,
          "firstName": "text",
          "lastName": "text"
        },
        "status": "PENDING",
        "acceptedAt": "2025-07-08T10:34:03.807Z"
      }
    ]
  }
]

Create alerts with customised parameters without requiring events from monitoring tools that use our Events API.

post

ATTENTION: do not use this endpoint to create monitoring related (or high volumes of) alerts, use '/api/events' instead, you have been warned! Escalation of the alert will be based on the alert source's escalation policy or may be overridden by providing a specific escalation policy or lastly specific set of responders (users), latter will only notify the user(s) and will not escalate any further.

Authorizations
Body
summarystringRequired
detailsstringOptional
prioritystring · enumOptionalPossible values:
Responses
201
the created and freshly escalated alert
application/json
post
POST /api/alerts HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 289

{
  "summary": "text",
  "details": "text",
  "alertSource": {
    "id": 1
  },
  "escalationPolicy": {
    "id": 1
  },
  "priority": "HIGH",
  "assignedTo": {
    "id": 1
  },
  "images": [
    {
      "src": "text",
      "href": "text",
      "alt": "text"
    }
  ],
  "links": [
    {
      "href": "text",
      "text": "text"
    }
  ],
  "responders": [
    {
      "user": {
        "id": 1,
        "firstName": "text",
        "lastName": "text"
      }
    }
  ]
}
201

the created and freshly escalated alert

{
  "id": 1,
  "summary": "text",
  "details": "text",
  "reportTime": "2025-07-08T10:34:03.807Z",
  "resolvedOn": "2025-07-08T10:34:03.807Z",
  "status": "PENDING",
  "alertSource": {
    "id": 1,
    "teams": [
      {
        "id": 1,
        "name": "text"
      }
    ],
    "name": "text",
    "iconUrl": "text",
    "lightIconUrl": "text",
    "darkIconUrl": "text",
    "escalationPolicy": {
      "id": 1,
      "name": "text",
      "escalationRules": [
        {
          "escalationTimeout": 1,
          "user": {
            "id": 1
          },
          "schedule": {
            "id": 1
          },
          "users": [
            {
              "id": 1,
              "firstName": "text",
              "lastName": "text"
            }
          ],
          "schedules": [
            {
              "id": 1,
              "name": "text",
              "type": "STATIC"
            }
          ]
        }
      ],
      "teams": [
        {
          "id": 1,
          "name": "text"
        }
      ],
      "repeating": false,
      "frequency": 1,
      "delayMin": 0,
      "routingKey": "text"
    },
    "integrationType": "NAGIOS",
    "integrationKey": "text",
    "integrationUrl": "text",
    "autoResolutionTimeout": "text",
    "alertGroupingWindow": "text",
    "alertCreation": "ONE_ALERT_PER_EMAIL",
    "status": "PENDING",
    "active": true,
    "alertPriorityRule": "HIGH",
    "supportHours": {
      "id": 1,
      "name": "text",
      "teams": [
        {
          "id": 1,
          "name": "text"
        }
      ],
      "timezone": "Europe/Berlin",
      "supportDays": {
        "MONDAY": {
          "start": "10:34:03",
          "end": "10:34:03"
        },
        "TUESDAY": {
          "start": "10:34:03",
          "end": "10:34:03"
        },
        "WEDNESDAY": {
          "start": "10:34:03",
          "end": "10:34:03"
        },
        "THURSDAY": {
          "start": "10:34:03",
          "end": "10:34:03"
        },
        "FRIDAY": {
          "start": "10:34:03",
          "end": "10:34:03"
        },
        "SATURDAY": {
          "start": "10:34:03",
          "end": "10:34:03"
        },
        "SUNDAY": {
          "start": "10:34:03",
          "end": "10:34:03"
        }
      }
    },
    "bidirectional": true,
    "summaryTemplate": {
      "textTemplate": "text",
      "elements": [
        {
          "type": "TEXT",
          "val": "text",
          "func": "text",
          "args": [
            {
              "S": "text",
              "N": 1
            }
          ]
        }
      ]
    },
    "detailsTemplate": {
      "textTemplate": "text",
      "elements": [
        {
          "type": "TEXT",
          "val": "text",
          "func": "text",
          "args": [
            {
              "S": "text",
              "N": 1
            }
          ]
        }
      ]
    },
    "routingTemplate": {
      "textTemplate": "text",
      "elements": [
        {
          "type": "TEXT",
          "val": "text",
          "func": "text",
          "args": [
            {
              "S": "text",
              "N": 1
            }
          ]
        }
      ]
    },
    "linkTemplates": [
      {
        "text": "text",
        "hrefTemplate": {
          "textTemplate": "text",
          "elements": [
            {
              "type": "TEXT",
              "val": "text",
              "func": "text",
              "args": [
                {
                  "S": "text",
                  "N": 1
                }
              ]
            }
          ]
        }
      }
    ],
    "priorityTemplate": {
      "valueTemplate": {
        "textTemplate": "text",
        "elements": [
          {
            "type": "TEXT",
            "val": "text",
            "func": "text",
            "args": [
              {
                "S": "text",
                "N": 1
              }
            ]
          }
        ]
      },
      "mappings": [
        {
          "value": "text",
          "priority": "LOW"
        }
      ]
    },
    "eventFilter": "text",
    "alertKeyTemplate": {
      "textTemplate": "text",
      "elements": [
        {
          "type": "TEXT",
          "val": "text",
          "func": "text",
          "args": [
            {
              "S": "text",
              "N": 1
            }
          ]
        }
      ]
    },
    "eventTypeFilterCreate": "text",
    "eventTypeFilterAccept": "text",
    "eventTypeFilterResolve": "text"
  },
  "escalationPolicy": {
    "id": 1,
    "name": "text",
    "escalationRules": [
      {
        "escalationTimeout": 1,
        "user": {
          "id": 1
        },
        "schedule": {
          "id": 1
        },
        "users": [
          {
            "id": 1,
            "firstName": "text",
            "lastName": "text"
          }
        ],
        "schedules": [
          {
            "id": 1,
            "name": "text",
            "type": "STATIC"
          }
        ]
      }
    ],
    "teams": [
      {
        "id": 1,
        "name": "text"
      }
    ],
    "repeating": false,
    "frequency": 1,
    "delayMin": 0,
    "routingKey": "text"
  },
  "priority": "HIGH",
  "alertKey": "text",
  "assignedTo": {
    "id": 1
  },
  "nextEscalation": "2025-07-08T10:34:03.807Z",
  "escalationRules": [
    {
      "escalationTimeout": 1,
      "user": {
        "id": 1
      },
      "schedule": {
        "id": 1
      },
      "users": [
        {
          "id": 1,
          "firstName": "text",
          "lastName": "text"
        }
      ],
      "schedules": [
        {
          "id": 1,
          "name": "text",
          "type": "STATIC"
        }
      ]
    }
  ],
  "nextEscalationUser": {
    "id": 1,
    "firstName": "text",
    "lastName": "text",
    "email": "text",
    "timezone": "Europe/Berlin",
    "position": "text",
    "department": "text",
    "avatarUrl": "text",
    "language": "de",
    "region": "DE",
    "role": "STAKEHOLDER",
    "shiftColor": "text",
    "mutedUntil": "2025-07-08T10:34:03.807Z",
    "createdAt": "2025-07-08T10:34:03.807Z",
    "updatedAt": "2025-07-08T10:34:03.807Z"
  },
  "nextEscalationRuleIndex": 1,
  "images": [
    {
      "src": "text",
      "href": "text",
      "alt": "text"
    }
  ],
  "links": [
    {
      "href": "text",
      "text": "text"
    }
  ],
  "responders": [
    {
      "user": {
        "id": 1,
        "firstName": "text",
        "lastName": "text"
      },
      "status": "PENDING",
      "acceptedAt": "2025-07-08T10:34:03.807Z"
    }
  ]
}

Get the alert count matching the specified criteria.

get
Authorizations
Query parameters
sourcesinteger · int64[]Optional

alert source IDs of the alert's alert source

respondersstring[]Optional

user ids of the user that is a responder of the alert

fromstring · date-timeOptional

from date

untilstring · date-timeOptional

until date

Responses
200
the number of alerts matching the specified criteria
application/json
get
GET /api/alerts/count HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
200

the number of alerts matching the specified criteria

{
  "count": 1
}

Get the alert with the specified id.

get
Authorizations
Path parameters
idnumberRequired

entity ID

Query parameters
Responses
200
alert object
application/json
get
GET /api/alerts/{id} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
200

alert object

{
  "id": 1,
  "summary": "text",
  "details": "text",
  "reportTime": "2025-07-08T10:34:03.807Z",
  "resolvedOn": "2025-07-08T10:34:03.807Z",
  "status": "PENDING",
  "alertSource": {
    "id": 1,
    "teams": [
      {
        "id": 1,
        "name": "text"
      }
    ],
    "name": "text",
    "iconUrl": "text",
    "lightIconUrl": "text",
    "darkIconUrl": "text",
    "escalationPolicy": {
      "id": 1,
      "name": "text",
      "escalationRules": [
        {
          "escalationTimeout": 1,
          "user": {
            "id": 1
          },
          "schedule": {
            "id": 1
          },
          "users": [
            {
              "id": 1,
              "firstName": "text",
              "lastName": "text"
            }
          ],
          "schedules": [
            {
              "id": 1,
              "name": "text",
              "type": "STATIC"
            }
          ]
        }
      ],
      "teams": [
        {
          "id": 1,
          "name": "text"
        }
      ],
      "repeating": false,
      "frequency": 1,
      "delayMin": 0,
      "routingKey": "text"
    },
    "integrationType": "NAGIOS",
    "integrationKey": "text",
    "integrationUrl": "text",
    "autoResolutionTimeout": "text",
    "alertGroupingWindow": "text",
    "alertCreation": "ONE_ALERT_PER_EMAIL",
    "status": "PENDING",
    "active": true,
    "alertPriorityRule": "HIGH",
    "supportHours": {
      "id": 1,
      "name": "text",
      "teams": [
        {
          "id": 1,
          "name": "text"
        }
      ],
      "timezone": "Europe/Berlin",
      "supportDays": {
        "MONDAY": {
          "start": "10:34:03",
          "end": "10:34:03"
        },
        "TUESDAY": {
          "start": "10:34:03",
          "end": "10:34:03"
        },
        "WEDNESDAY": {
          "start": "10:34:03",
          "end": "10:34:03"
        },
        "THURSDAY": {
          "start": "10:34:03",
          "end": "10:34:03"
        },
        "FRIDAY": {
          "start": "10:34:03",
          "end": "10:34:03"
        },
        "SATURDAY": {
          "start": "10:34:03",
          "end": "10:34:03"
        },
        "SUNDAY": {
          "start": "10:34:03",
          "end": "10:34:03"
        }
      }
    },
    "bidirectional": true,
    "summaryTemplate": {
      "textTemplate": "text",
      "elements": [
        {
          "type": "TEXT",
          "val": "text",
          "func": "text",
          "args": [
            {
              "S": "text",
              "N": 1
            }
          ]
        }
      ]
    },
    "detailsTemplate": {
      "textTemplate": "text",
      "elements": [
        {
          "type": "TEXT",
          "val": "text",
          "func": "text",
          "args": [
            {
              "S": "text",
              "N": 1
            }
          ]
        }
      ]
    },
    "routingTemplate": {
      "textTemplate": "text",
      "elements": [
        {
          "type": "TEXT",
          "val": "text",
          "func": "text",
          "args": [
            {
              "S": "text",
              "N": 1
            }
          ]
        }
      ]
    },
    "linkTemplates": [
      {
        "text": "text",
        "hrefTemplate": {
          "textTemplate": "text",
          "elements": [
            {
              "type": "TEXT",
              "val": "text",
              "func": "text",
              "args": [
                {
                  "S": "text",
                  "N": 1
                }
              ]
            }
          ]
        }
      }
    ],
    "priorityTemplate": {
      "valueTemplate": {
        "textTemplate": "text",
        "elements": [
          {
            "type": "TEXT",
            "val": "text",
            "func": "text",
            "args": [
              {
                "S": "text",
                "N": 1
              }
            ]
          }
        ]
      },
      "mappings": [
        {
          "value": "text",
          "priority": "LOW"
        }
      ]
    },
    "eventFilter": "text",
    "alertKeyTemplate": {
      "textTemplate": "text",
      "elements": [
        {
          "type": "TEXT",
          "val": "text",
          "func": "text",
          "args": [
            {
              "S": "text",
              "N": 1
            }
          ]
        }
      ]
    },
    "eventTypeFilterCreate": "text",
    "eventTypeFilterAccept": "text",
    "eventTypeFilterResolve": "text"
  },
  "escalationPolicy": {
    "id": 1,
    "name": "text",
    "escalationRules": [
      {
        "escalationTimeout": 1,
        "user": {
          "id": 1
        },
        "schedule": {
          "id": 1
        },
        "users": [
          {
            "id": 1,
            "firstName": "text",
            "lastName": "text"
          }
        ],
        "schedules": [
          {
            "id": 1,
            "name": "text",
            "type": "STATIC"
          }
        ]
      }
    ],
    "teams": [
      {
        "id": 1,
        "name": "text"
      }
    ],
    "repeating": false,
    "frequency": 1,
    "delayMin": 0,
    "routingKey": "text"
  },
  "priority": "HIGH",
  "alertKey": "text",
  "assignedTo": {
    "id": 1
  },
  "nextEscalation": "2025-07-08T10:34:03.807Z",
  "escalationRules": [
    {
      "escalationTimeout": 1,
      "user": {
        "id": 1
      },
      "schedule": {
        "id": 1
      },
      "users": [
        {
          "id": 1,
          "firstName": "text",
          "lastName": "text"
        }
      ],
      "schedules": [
        {
          "id": 1,
          "name": "text",
          "type": "STATIC"
        }
      ]
    }
  ],
  "nextEscalationUser": {
    "id": 1,
    "firstName": "text",
    "lastName": "text",
    "email": "text",
    "timezone": "Europe/Berlin",
    "position": "text",
    "department": "text",
    "avatarUrl": "text",
    "language": "de",
    "region": "DE",
    "role": "STAKEHOLDER",
    "shiftColor": "text",
    "mutedUntil": "2025-07-08T10:34:03.807Z",
    "createdAt": "2025-07-08T10:34:03.807Z",
    "updatedAt": "2025-07-08T10:34:03.807Z"
  },
  "nextEscalationRuleIndex": 1,
  "images": [
    {
      "src": "text",
      "href": "text",
      "alt": "text"
    }
  ],
  "links": [
    {
      "href": "text",
      "text": "text"
    }
  ],
  "responders": [
    {
      "user": {
        "id": 1,
        "firstName": "text",
        "lastName": "text"
      },
      "status": "PENDING",
      "acceptedAt": "2025-07-08T10:34:03.807Z"
    }
  ]
}

Get available (assignable) responders for the alert with the specified id.

get
Authorizations
Path parameters
idnumberRequired

entity ID

Query parameters
langstringOptional

locale for response text eg. 'en' or 'de'

Responses
200
the list of alert responders
application/json
get
GET /api/alerts/{id}/suggested-responders HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
200

the list of alert responders

[
  {
    "group": "SUGGESTED",
    "id": 1,
    "name": "text",
    "disabled": true
  }
]

Add an additional responder to the alert.

post
Authorizations
Path parameters
idnumberRequired

entity ID

Responses
201
the created alert responder object
application/json
post
POST /api/alerts/{id}/responders HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
{
  "user": {
    "id": 1,
    "firstName": "text",
    "lastName": "text"
  },
  "status": "PENDING",
  "acceptedAt": "2025-07-08T10:34:03.807Z"
}

Remove a responder from the alert.

delete
Authorizations
Path parameters
idnumberRequired

entity ID

user-idstringRequired

numeric user id

Responses
204
Responder has been removed
delete
DELETE /api/alerts/{id}/responders/{user-id} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

No content

Assign the alert.

put

Either provide a user-id, policy-id (escalation policy) or schedule-id (on-call schedule) that the specific alert should be assigned to.

Authorizations
Path parameters
idnumberRequired

entity ID

Query parameters
userstringOptional

numeric user id

policystringOptional

numeric policy id

schedulestringOptional

numeric schedule id

Responses
200
the updated alert object
application/json
put
PUT /api/alerts/{id}/assign HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
200

the updated alert object

{
  "id": 1,
  "summary": "text",
  "details": "text",
  "reportTime": "2025-07-08T10:34:03.807Z",
  "resolvedOn": "2025-07-08T10:34:03.807Z",
  "status": "PENDING",
  "alertSource": {
    "id": 1,
    "teams": [
      {
        "id": 1,
        "name": "text"
      }
    ],
    "name": "text",
    "iconUrl": "text",
    "lightIconUrl": "text",
    "darkIconUrl": "text",
    "escalationPolicy": {
      "id": 1,
      "name": "text",
      "escalationRules": [
        {
          "escalationTimeout": 1,
          "user": {
            "id": 1
          },
          "schedule": {
            "id": 1
          },
          "users": [
            {
              "id": 1,
              "firstName": "text",
              "lastName": "text"
            }
          ],
          "schedules": [
            {
              "id": 1,
              "name": "text",
              "type": "STATIC"
            }
          ]
        }
      ],
      "teams": [
        {
          "id": 1,
          "name": "text"
        }
      ],
      "repeating": false,
      "frequency": 1,
      "delayMin": 0,
      "routingKey": "text"
    },
    "integrationType": "NAGIOS",
    "integrationKey": "text",
    "integrationUrl": "text",
    "autoResolutionTimeout": "text",
    "alertGroupingWindow": "text",
    "alertCreation": "ONE_ALERT_PER_EMAIL",
    "status": "PENDING",
    "active": true,
    "alertPriorityRule": "HIGH",
    "supportHours": {
      "id": 1,
      "name": "text",
      "teams": [
        {
          "id": 1,
          "name": "text"
        }
      ],
      "timezone": "Europe/Berlin",
      "supportDays": {
        "MONDAY": {
          "start": "10:34:03",
          "end": "10:34:03"
        },
        "TUESDAY": {
          "start": "10:34:03",
          "end": "10:34:03"
        },
        "WEDNESDAY": {
          "start": "10:34:03",
          "end": "10:34:03"
        },
        "THURSDAY": {
          "start": "10:34:03",
          "end": "10:34:03"
        },
        "FRIDAY": {
          "start": "10:34:03",
          "end": "10:34:03"
        },
        "SATURDAY": {
          "start": "10:34:03",
          "end": "10:34:03"
        },
        "SUNDAY": {
          "start": "10:34:03",
          "end": "10:34:03"
        }
      }
    },
    "bidirectional": true,
    "summaryTemplate": {
      "textTemplate": "text",
      "elements": [
        {
          "type": "TEXT",
          "val": "text",
          "func": "text",
          "args": [
            {
              "S": "text",
              "N": 1
            }
          ]
        }
      ]
    },
    "detailsTemplate": {
      "textTemplate": "text",
      "elements": [
        {
          "type": "TEXT",
          "val": "text",
          "func": "text",
          "args": [
            {
              "S": "text",
              "N": 1
            }
          ]
        }
      ]
    },
    "routingTemplate": {
      "textTemplate": "text",
      "elements": [
        {
          "type": "TEXT",
          "val": "text",
          "func": "text",
          "args": [
            {
              "S": "text",
              "N": 1
            }
          ]
        }
      ]
    },
    "linkTemplates": [
      {
        "text": "text",
        "hrefTemplate": {
          "textTemplate": "text",
          "elements": [
            {
              "type": "TEXT",
              "val": "text",
              "func": "text",
              "args": [
                {
                  "S": "text",
                  "N": 1
                }
              ]
            }
          ]
        }
      }
    ],
    "priorityTemplate": {
      "valueTemplate": {
        "textTemplate": "text",
        "elements": [
          {
            "type": "TEXT",
            "val": "text",
            "func": "text",
            "args": [
              {
                "S": "text",
                "N": 1
              }
            ]
          }
        ]
      },
      "mappings": [
        {
          "value": "text",
          "priority": "LOW"
        }
      ]
    },
    "eventFilter": "text",
    "alertKeyTemplate": {
      "textTemplate": "text",
      "elements": [
        {
          "type": "TEXT",
          "val": "text",
          "func": "text",
          "args": [
            {
              "S": "text",
              "N": 1
            }
          ]
        }
      ]
    },
    "eventTypeFilterCreate": "text",
    "eventTypeFilterAccept": "text",
    "eventTypeFilterResolve": "text"
  },
  "escalationPolicy": {
    "id": 1,
    "name": "text",
    "escalationRules": [
      {
        "escalationTimeout": 1,
        "user": {
          "id": 1
        },
        "schedule": {
          "id": 1
        },
        "users": [
          {
            "id": 1,
            "firstName": "text",
            "lastName": "text"
          }
        ],
        "schedules": [
          {
            "id": 1,
            "name": "text",
            "type": "STATIC"
          }
        ]
      }
    ],
    "teams": [
      {
        "id": 1,
        "name": "text"
      }
    ],
    "repeating": false,
    "frequency": 1,
    "delayMin": 0,
    "routingKey": "text"
  },
  "priority": "HIGH",
  "alertKey": "text",
  "assignedTo": {
    "id": 1
  },
  "nextEscalation": "2025-07-08T10:34:03.807Z",
  "escalationRules": [
    {
      "escalationTimeout": 1,
      "user": {
        "id": 1
      },
      "schedule": {
        "id": 1
      },
      "users": [
        {
          "id": 1,
          "firstName": "text",
          "lastName": "text"
        }
      ],
      "schedules": [
        {
          "id": 1,
          "name": "text",
          "type": "STATIC"
        }
      ]
    }
  ],
  "nextEscalationUser": {
    "id": 1,
    "firstName": "text",
    "lastName": "text",
    "email": "text",
    "timezone": "Europe/Berlin",
    "position": "text",
    "department": "text",
    "avatarUrl": "text",
    "language": "de",
    "region": "DE",
    "role": "STAKEHOLDER",
    "shiftColor": "text",
    "mutedUntil": "2025-07-08T10:34:03.807Z",
    "createdAt": "2025-07-08T10:34:03.807Z",
    "updatedAt": "2025-07-08T10:34:03.807Z"
  },
  "nextEscalationRuleIndex": 1,
  "images": [
    {
      "src": "text",
      "href": "text",
      "alt": "text"
    }
  ],
  "links": [
    {
      "href": "text",
      "text": "text"
    }
  ],
  "responders": [
    {
      "user": {
        "id": 1,
        "firstName": "text",
        "lastName": "text"
      },
      "status": "PENDING",
      "acceptedAt": "2025-07-08T10:34:03.807Z"
    }
  ]
}

Accept the Alert.

put
Authorizations
Path parameters
idnumberRequired

entity ID

Responses
200
the updated alert object
application/json
put
PUT /api/alerts/{id}/accept HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
200

the updated alert object

{
  "id": 1,
  "summary": "text",
  "details": "text",
  "reportTime": "2025-07-08T10:34:03.807Z",
  "resolvedOn": "2025-07-08T10:34:03.807Z",
  "status": "PENDING",
  "alertSource": {
    "id": 1,
    "teams": [
      {
        "id": 1,
        "name": "text"
      }
    ],
    "name": "text",
    "iconUrl": "text",
    "lightIconUrl": "text",
    "darkIconUrl": "text",
    "escalationPolicy": {
      "id": 1,
      "name": "text",
      "escalationRules": [
        {
          "escalationTimeout": 1,
          "user": {
            "id": 1
          },
          "schedule": {
            "id": 1
          },
          "users": [
            {
              "id": 1,
              "firstName": "text",
              "lastName": "text"
            }
          ],
          "schedules": [
            {
              "id": 1,
              "name": "text",
              "type": "STATIC"
            }
          ]
        }
      ],
      "teams": [
        {
          "id": 1,
          "name": "text"
        }
      ],
      "repeating": false,
      "frequency": 1,
      "delayMin": 0,
      "routingKey": "text"
    },
    "integrationType": "NAGIOS",
    "integrationKey": "text",
    "integrationUrl": "text",
    "autoResolutionTimeout": "text",
    "alertGroupingWindow": "text",
    "alertCreation": "ONE_ALERT_PER_EMAIL",
    "status": "PENDING",
    "active": true,
    "alertPriorityRule": "HIGH",
    "supportHours": {
      "id": 1,
      "name": "text",
      "teams": [
        {
          "id": 1,
          "name": "text"
        }
      ],
      "timezone": "Europe/Berlin",
      "supportDays": {
        "MONDAY": {
          "start": "10:34:03",
          "end": "10:34:03"
        },
        "TUESDAY": {
          "start": "10:34:03",
          "end": "10:34:03"
        },
        "WEDNESDAY": {
          "start": "10:34:03",
          "end": "10:34:03"
        },
        "THURSDAY": {
          "start": "10:34:03",
          "end": "10:34:03"
        },
        "FRIDAY": {
          "start": "10:34:03",
          "end": "10:34:03"
        },
        "SATURDAY": {
          "start": "10:34:03",
          "end": "10:34:03"
        },
        "SUNDAY": {
          "start": "10:34:03",
          "end": "10:34:03"
        }
      }
    },
    "bidirectional": true,
    "summaryTemplate": {
      "textTemplate": "text",
      "elements": [
        {
          "type": "TEXT",
          "val": "text",
          "func": "text",
          "args": [
            {
              "S": "text",
              "N": 1
            }
          ]
        }
      ]
    },
    "detailsTemplate": {
      "textTemplate": "text",
      "elements": [
        {
          "type": "TEXT",
          "val": "text",
          "func": "text",
          "args": [
            {
              "S": "text",
              "N": 1
            }
          ]
        }
      ]
    },
    "routingTemplate": {
      "textTemplate": "text",
      "elements": [
        {
          "type": "TEXT",
          "val": "text",
          "func": "text",
          "args": [
            {
              "S": "text",
              "N": 1
            }
          ]
        }
      ]
    },
    "linkTemplates": [
      {
        "text": "text",
        "hrefTemplate": {
          "textTemplate": "text",
          "elements": [
            {
              "type": "TEXT",
              "val": "text",
              "func": "text",
              "args": [
                {
                  "S": "text",
                  "N": 1
                }
              ]
            }
          ]
        }
      }
    ],
    "priorityTemplate": {
      "valueTemplate": {
        "textTemplate": "text",
        "elements": [
          {
            "type": "TEXT",
            "val": "text",
            "func": "text",
            "args": [
              {
                "S": "text",
                "N": 1
              }
            ]
          }
        ]
      },
      "mappings": [
        {
          "value": "text",
          "priority": "LOW"
        }
      ]
    },
    "eventFilter": "text",
    "alertKeyTemplate": {
      "textTemplate": "text",
      "elements": [
        {
          "type": "TEXT",
          "val": "text",
          "func": "text",
          "args": [
            {
              "S": "text",
              "N": 1
            }
          ]
        }
      ]
    },
    "eventTypeFilterCreate": "text",
    "eventTypeFilterAccept": "text",
    "eventTypeFilterResolve": "text"
  },
  "escalationPolicy": {
    "id": 1,
    "name": "text",
    "escalationRules": [
      {
        "escalationTimeout": 1,
        "user": {
          "id": 1
        },
        "schedule": {
          "id": 1
        },
        "users": [
          {
            "id": 1,
            "firstName": "text",
            "lastName": "text"
          }
        ],
        "schedules": [
          {
            "id": 1,
            "name": "text",
            "type": "STATIC"
          }
        ]
      }
    ],
    "teams": [
      {
        "id": 1,
        "name": "text"
      }
    ],
    "repeating": false,
    "frequency": 1,
    "delayMin": 0,
    "routingKey": "text"
  },
  "priority": "HIGH",
  "alertKey": "text",
  "assignedTo": {
    "id": 1
  },
  "nextEscalation": "2025-07-08T10:34:03.807Z",
  "escalationRules": [
    {
      "escalationTimeout": 1,
      "user": {
        "id": 1
      },
      "schedule": {
        "id": 1
      },
      "users": [
        {
          "id": 1,
          "firstName": "text",
          "lastName": "text"
        }
      ],
      "schedules": [
        {
          "id": 1,
          "name": "text",
          "type": "STATIC"
        }
      ]
    }
  ],
  "nextEscalationUser": {
    "id": 1,
    "firstName": "text",
    "lastName": "text",
    "email": "text",
    "timezone": "Europe/Berlin",
    "position": "text",
    "department": "text",
    "avatarUrl": "text",
    "language": "de",
    "region": "DE",
    "role": "STAKEHOLDER",
    "shiftColor": "text",
    "mutedUntil": "2025-07-08T10:34:03.807Z",
    "createdAt": "2025-07-08T10:34:03.807Z",
    "updatedAt": "2025-07-08T10:34:03.807Z"
  },
  "nextEscalationRuleIndex": 1,
  "images": [
    {
      "src": "text",
      "href": "text",
      "alt": "text"
    }
  ],
  "links": [
    {
      "href": "text",
      "text": "text"
    }
  ],
  "responders": [
    {
      "user": {
        "id": 1,
        "firstName": "text",
        "lastName": "text"
      },
      "status": "PENDING",
      "acceptedAt": "2025-07-08T10:34:03.807Z"
    }
  ]
}

Resolve the alert.

put
Authorizations
Path parameters
idnumberRequired

entity ID

Responses
200
the updated alert object
application/json
put
PUT /api/alerts/{id}/resolve HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
200

the updated alert object

{
  "id": 1,
  "summary": "text",
  "details": "text",
  "reportTime": "2025-07-08T10:34:03.807Z",
  "resolvedOn": "2025-07-08T10:34:03.807Z",
  "status": "PENDING",
  "alertSource": {
    "id": 1,
    "teams": [
      {
        "id": 1,
        "name": "text"
      }
    ],
    "name": "text",
    "iconUrl": "text",
    "lightIconUrl": "text",
    "darkIconUrl": "text",
    "escalationPolicy": {
      "id": 1,
      "name": "text",
      "escalationRules": [
        {
          "escalationTimeout": 1,
          "user": {
            "id": 1
          },
          "schedule": {
            "id": 1
          },
          "users": [
            {
              "id": 1,
              "firstName": "text",
              "lastName": "text"
            }
          ],
          "schedules": [
            {
              "id": 1,
              "name": "text",
              "type": "STATIC"
            }
          ]
        }
      ],
      "teams": [
        {
          "id": 1,
          "name": "text"
        }
      ],
      "repeating": false,
      "frequency": 1,
      "delayMin": 0,
      "routingKey": "text"
    },
    "integrationType": "NAGIOS",
    "integrationKey": "text",
    "integrationUrl": "text",
    "autoResolutionTimeout": "text",
    "alertGroupingWindow": "text",
    "alertCreation": "ONE_ALERT_PER_EMAIL",
    "status": "PENDING",
    "active": true,
    "alertPriorityRule": "HIGH",
    "supportHours": {
      "id": 1,
      "name": "text",
      "teams": [
        {
          "id": 1,
          "name": "text"
        }
      ],
      "timezone": "Europe/Berlin",
      "supportDays": {
        "MONDAY": {
          "start": "10:34:03",
          "end": "10:34:03"
        },
        "TUESDAY": {
          "start": "10:34:03",
          "end": "10:34:03"
        },
        "WEDNESDAY": {
          "start": "10:34:03",
          "end": "10:34:03"
        },
        "THURSDAY": {
          "start": "10:34:03",
          "end": "10:34:03"
        },
        "FRIDAY": {
          "start": "10:34:03",
          "end": "10:34:03"
        },
        "SATURDAY": {
          "start": "10:34:03",
          "end": "10:34:03"
        },
        "SUNDAY": {
          "start": "10:34:03",
          "end": "10:34:03"
        }
      }
    },
    "bidirectional": true,
    "summaryTemplate": {
      "textTemplate": "text",
      "elements": [
        {
          "type": "TEXT",
          "val": "text",
          "func": "text",
          "args": [
            {
              "S": "text",
              "N": 1
            }
          ]
        }
      ]
    },
    "detailsTemplate": {
      "textTemplate": "text",
      "elements": [
        {
          "type": "TEXT",
          "val": "text",
          "func": "text",
          "args": [
            {
              "S": "text",
              "N": 1
            }
          ]
        }
      ]
    },
    "routingTemplate": {
      "textTemplate": "text",
      "elements": [
        {
          "type": "TEXT",
          "val": "text",
          "func": "text",
          "args": [
            {
              "S": "text",
              "N": 1
            }
          ]
        }
      ]
    },
    "linkTemplates": [
      {
        "text": "text",
        "hrefTemplate": {
          "textTemplate": "text",
          "elements": [
            {
              "type": "TEXT",
              "val": "text",
              "func": "text",
              "args": [
                {
                  "S": "text",
                  "N": 1
                }
              ]
            }
          ]
        }
      }
    ],
    "priorityTemplate": {
      "valueTemplate": {
        "textTemplate": "text",
        "elements": [
          {
            "type": "TEXT",
            "val": "text",
            "func": "text",
            "args": [
              {
                "S": "text",
                "N": 1
              }
            ]
          }
        ]
      },
      "mappings": [
        {
          "value": "text",
          "priority": "LOW"
        }
      ]
    },
    "eventFilter": "text",
    "alertKeyTemplate": {
      "textTemplate": "text",
      "elements": [
        {
          "type": "TEXT",
          "val": "text",
          "func": "text",
          "args": [
            {
              "S": "text",
              "N": 1
            }
          ]
        }
      ]
    },
    "eventTypeFilterCreate": "text",
    "eventTypeFilterAccept": "text",
    "eventTypeFilterResolve": "text"
  },
  "escalationPolicy": {
    "id": 1,
    "name": "text",
    "escalationRules": [
      {
        "escalationTimeout": 1,
        "user": {
          "id": 1
        },
        "schedule": {
          "id": 1
        },
        "users": [
          {
            "id": 1,
            "firstName": "text",
            "lastName": "text"
          }
        ],
        "schedules": [
          {
            "id": 1,
            "name": "text",
            "type": "STATIC"
          }
        ]
      }
    ],
    "teams": [
      {
        "id": 1,
        "name": "text"
      }
    ],
    "repeating": false,
    "frequency": 1,
    "delayMin": 0,
    "routingKey": "text"
  },
  "priority": "HIGH",
  "alertKey": "text",
  "assignedTo": {
    "id": 1
  },
  "nextEscalation": "2025-07-08T10:34:03.807Z",
  "escalationRules": [
    {
      "escalationTimeout": 1,
      "user": {
        "id": 1
      },
      "schedule": {
        "id": 1
      },
      "users": [
        {
          "id": 1,
          "firstName": "text",
          "lastName": "text"
        }
      ],
      "schedules": [
        {
          "id": 1,
          "name": "text",
          "type": "STATIC"
        }
      ]
    }
  ],
  "nextEscalationUser": {
    "id": 1,
    "firstName": "text",
    "lastName": "text",
    "email": "text",
    "timezone": "Europe/Berlin",
    "position": "text",
    "department": "text",
    "avatarUrl": "text",
    "language": "de",
    "region": "DE",
    "role": "STAKEHOLDER",
    "shiftColor": "text",
    "mutedUntil": "2025-07-08T10:34:03.807Z",
    "createdAt": "2025-07-08T10:34:03.807Z",
    "updatedAt": "2025-07-08T10:34:03.807Z"
  },
  "nextEscalationRuleIndex": 1,
  "images": [
    {
      "src": "text",
      "href": "text",
      "alt": "text"
    }
  ],
  "links": [
    {
      "href": "text",
      "text": "text"
    }
  ],
  "responders": [
    {
      "user": {
        "id": 1,
        "firstName": "text",
        "lastName": "text"
      },
      "status": "PENDING",
      "acceptedAt": "2025-07-08T10:34:03.807Z"
    }
  ]
}

Get notifications for the specified alert.

get
Authorizations
Path parameters
idnumberRequired

entity ID

Responses
200
a list of notification objects
application/json
get
GET /api/alerts/{id}/notifications HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
200

a list of notification objects

[
  {
    "id": 1,
    "method": "PUSH",
    "target": "text",
    "subject": "text",
    "alertId": 1,
    "user": {
      "id": 1,
      "firstname": "text",
      "lastname": "text"
    },
    "notificationTime": "2025-07-08T10:34:03.807Z",
    "status": "SCHEDULED",
    "errorMessage": "text"
  }
]

Get log entries for the specified alert.

get
Authorizations
Path parameters
idnumberRequired

entity ID

Query parameters
langstring · enumOptional

log entry language

Possible values:
start-indexinteger · int32Optional

an integer specifying the starting point (beginning with 0) when paging through a list of entities

Default: 0
max-resultsinteger · int32 · max: 100Optional

the maximum number of results when paging through a list of entities.

Default: 50
Responses
200
list of log entries
application/json
get
GET /api/alerts/{id}/log-entries HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
200

list of log entries

[
  {
    "id": 1,
    "timestamp": "2025-07-08T10:34:03.807Z",
    "logEntryType": "ConnectorAutomaticResultErrorLogEntry",
    "text": "text",
    "alertId": 1,
    "filterTypes": [
      "NOTIFICATIONS"
    ],
    "vars": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    }
  }
]

Was this helpful?