Acknowledge an alert

Base URL: https://{kibana_url}

POST /api/alerting/v2/alerts/{id}/_ack
POST /s/{space_id}/api/alerting/v2/alerts/{id}/_ack

Refer to Spaces for more information.

Create an action for a specific alert.

Required authorization

Authentication

Api key

Authorization: <value>

These APIs use key-based authentication. You must create an API key and use the encoded value in the request header. For example: Authorization: ApiKey base64AccessApiKey

Basic

Authorization: Basic <credentials>

Path parameters

Header parameters

Request body

Responses

204

Indicates the action was created.

Indicates an invalid schema or parameters.

application/json

Indicates the request was not authenticated.

application/json

Indicates the user does not have the required privileges to perform the request.

application/json

Indicates the alert was not found.

application/json

Indicates the alert is already acknowledged.

application/json

Indicates an unexpected server-side error.

application/json

Indicates the alerting engine is disabled by the alerting:v2:enabled advanced setting.

application/json

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

Console Kibana Dev Tools

POST kbn:/api/alerting/v2/alerts/ID/_ack
{}

Generated from the API spec

curl Shell

curl -X POST "${KIBANA_URL}/api/alerting/v2/alerts/${ID}/_ack" \
  -H "kbn-xsrf: true" \
  -H "Authorization: ApiKey ${API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{}'

Generated from the API spec

Response

{
  "code": "BAD_REQUEST",
  "details": {
    "errors": {
      "id": [
        "Required"
      ]
    }
  },
  "error": "Bad Request",
  "message": "id: Required"
}

{
  "code": "UNAUTHORIZED",
  "error": "Unauthorized",
  "message": "Authentication required to access this API."
}

{
  "code": "FORBIDDEN",
  "error": "Forbidden",
  "message": "The current user does not have the required privileges for this request."
}

{
  "code": "ALERT_NOT_FOUND",
  "details": {
    "alert_id": "alert-1"
  },
  "error": "Not Found",
  "message": "Alert with alert_id [alert-1] not found"
}

{
  "code": "INVALID_ALERT_STATE_TRANSITION",
  "details": {
    "action_type": "ack",
    "alert_id": "alert-1",
    "group_hash": "98058cb569017ecb6b08b554ecbcb2524ff7dd8971828f4f2e5939c1e6667e56"
  },
  "error": "Conflict",
  "message": "[alert-1] is already acknowledged."
}

{
  "code": "INTERNAL_SERVER_ERROR",
  "error": "Internal Server Error",
  "message": "An unexpected error occurred."
}

{
  "code": "ALERTING_DISABLED",
  "error": "Service Unavailable",
  "message": "Alerting is disabled."
}