Bulk deactivate alert episodes

Server: https://{kibana_url}

POST /api/alerting/v2/episodes/_bulk_deactivate

Create the same action for multiple alert episodes in a single request.

[Required authorization] Route required privileges: manage_alerting-v2-alerts.

Request

items [] object · min: 1 · max: 100 required: List of 1 to 100 deactivate actions to create.

Responses

Returns the number of created actions and per-item errors for actions that were not created.

application/json

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 an unexpected server-side error.

application/json

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

application/json

Examples

Request Console 1 / 2 languages

Console Kibana Dev Tools

POST /api/alerting/v2/episodes/_bulk_deactivate
{
  "items": [
    {
      "episode_id": "episode-1",
      "reason": "false positive"
    }
  ]
}

curl Shell

curl -X POST "https://{kibana_url}/api/alerting/v2/episodes/_bulk_deactivate" \
  -H "kbn-xsrf: true" \
  -H "Content-Type: application/json" \
  -d '{
  "items": [
    {
      "episode_id": "episode-1",
      "reason": "false positive"
    }
  ]
}'

Response

{
  "affected_count": 1,
  "errors": []
}

{
  "code": "BAD_REQUEST",
  "details": {
    "errors": {
      "items": [
        "At least one action must be provided"
      ]
    }
  },
  "error": "Bad Request",
  "message": "items: At least one action must be provided"
}

{
  "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": "INTERNAL_SERVER_ERROR",
  "error": "Internal Server Error",
  "message": "An unexpected error occurred."
}

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