Deactivate an alert episode

Base URL: https://{kibana_url}

POST /api/alerting/v2/episodes/{episode_id}/_deactivate

Create an action for a specific alert episode.

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 episode was not found, or is not the latest episode of its series (activate and deactivate only).

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/episodes/EPISODE_ID/_deactivate
{
  "reason": "False positive confirmed by on-call."
}

Generated from the API spec

curl Shell

curl -X POST "${KIBANA_URL}/api/alerting/v2/episodes/${EPISODE_ID}/_deactivate" \
  -H "kbn-xsrf: true" \
  -H "Authorization: ApiKey ${API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{
    "reason": "False positive confirmed by on-call."
  }'

Generated from the API spec

Response

{
  "code": "BAD_REQUEST",
  "details": {
    "errors": {
      "episode_id": [
        "Required"
      ]
    }
  },
  "error": "Bad Request",
  "message": "episode_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_EPISODE_NOT_FOUND",
  "details": {
    "episode_id": "episode-1"
  },
  "error": "Not Found",
  "message": "Alert episode with episode_id [episode-1] not found"
}

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

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

Required authorization

Authentication

Path parameters

Header parameters

Request body { }

Responses

Request body