Alert API

Notifiers have been renamed to actions, except in the actual API. See Alerts for general information about alerts.

The endpoints displayed on this page are deprecated starting with version 1.23 of Humio. These endpoints will remain operational for some time, but users are encouraged to use instead the corresponding queries and mutations found in our GraphQL API.

List Alerts

GET /api/v1/repositories/$DATASPACE/alerts

Example:

curl -H "Content-Type: application/json" -H "Authorization: Bearer $TOKEN"  http://$YOUR_HUMIO_URL/api/v1/repositories/$DATASPACE/alerts

Get Alert by ID

GET /api/v1/repositories/$DATASPACE/alerts/$ID

Example:

curl -H "Content-Type: application/json" -H "Authorization: Bearer $TOKEN"  http://$YOUR_HUMIO_URL/api/v1/repositories/$DATASPACE/alerts/hZuxvyEitdisEA06EqzEO52gCd8PO0OR

Create Alert

POST /api/v1/repositories/$DATASPACE/alerts

Params:

  • name — string
  • query:
    • queryString — string
    • start — string
  • description — string
  • throttleTimeMillis — integer — minimum time between invoking actions
  • throttleField — string — set this field to do field-based throttling
  • silenced — boolean — whether the alert is enabled or not
  • notifiers — array — array of action ID strings
  • labels — array — array of text labels

Example:

curl -X POST -H "Content-Type: application/json" -H "Authorization: Bearer $TOKEN"  http://$YOUR_HUMIO_URL/api/v1/repositories/$DATASPACE/alerts -d '{"name":"test", "query": {"queryString":"foobar", "start":"1h"}, "description":"this is a test", "throttleTimeMillis":600000, "silenced":false, "notifiers":["GrpMXUR2me8045Sz39qcsoWjXT3fJ7rT"], "labels":["test"]}'

Update Alert

PUT /api/v1/repositories/$DATASPACE/alerts/$ID

Params:

  • name — string
  • query:
    • queryString — string
    • start — string
  • description — string
  • throttleTimeMillis — integer — minimum time between invoking actions
  • throttleField — string — set this field to do field-based throttling
  • silenced — boolean — whether the alert is enabled or not
  • notifiers — array — array of action ID strings
  • labels — array — array of text labels

Example:

curl -X PUT -H "Content-Type: application/json" -H "Authorization: Bearer $TOKEN"  http://$YOUR_HUMIO_URL/api/v1/repositories/$DATASPACE/alerts/hZuxvyEitdisEA06EqzEO52gCd8PO0OR -d '{"name":"different test", "query": {"queryString":"foobar", "start":"1h"}, "description":"this is a test", "throttleTimeMillis":600000, "throttleField":"server", "silenced":false, "notifiers":["GrpMXUR2me8045Sz39qcsoWjXT3fJ7rT"], "labels":["test"]}'

Delete Alert

DELETE /api/v1/repositories/$DATASPACE/alerts/$ID

Example:

curl-X DELETE -H "Authorization: Bearer $TOKEN"  http://$YOUR_HUMIO_URL/api/v1/repositories/$DATASPACE/alerts/hZuxvyEitdisEA06EqzEO52gCd8PO0OR