Bulk tag alert episodes

Base URL: https://{kibana_url}

POST /api/alerting/v2/episodes/_bulk_tag

Auth

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

Required privileges

Privileges manage_alerting-v2-alerts

Header parameters

kbn-xsrf string required: A required header to protect against CSRF attacks

Request body

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

Responses

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

application/json

affected_count integer · min: 0 · max: 9007199254740991 required: Number of resources the operation successfully touched.
errors object[] required: Errors encountered during the operation.

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

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

Console Kibana Dev Tools

POST kbn:/api/alerting/v2/episodes/_bulk_tag
{
  "items": [
    {
      "episode_id": "episode-1",
      "tags": [
        "production"
      ]
    },
    {
      "episode_id": "episode-2",
      "tags": [
        "production"
      ]
    }
  ]
}

Generated from the API spec

curl Shell

curl -X POST "${KIBANA_URL}/api/alerting/v2/episodes/_bulk_tag" \
  -H "kbn-xsrf: true" \
  -H "Authorization: ApiKey ${API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{
    "items": [
      {
        "episode_id": "episode-1",
        "tags": [
          "production"
        ]
      },
      {
        "episode_id": "episode-2",
        "tags": [
          "production"
        ]
      }
    ]
  }'

Generated from the API spec

Response

{
  "affected_count": 2,
  "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."
}