elastic / elastic/docs-content

[Alerting V2] Rotate a rule's API key with the new Update API key action

Open
#8,069 1 comment 0 reactions 1 assignee Claimed by @nastasha-solomon View on GitHub
alerting-v2 Team:SKI
Dominant language
No language data
Stars
47
Forks
261
Avg merge
3d 12h
Merged PRs (30d)
116

Description

## Summary

Alerting V2 rules now have an Update API key action, available as a single-rule action (rule details page and rules list row actions) and as a bulk action from the rules list. Invoking it regenerates the API key the rule executor uses to query Elasticsearch, using the current user's credentials and privileges, without requiring a full edit-and-save of the rule. The action is disabled for disabled rules, and the rule's enabled state and schedule interval are preserved.

**Why this needs docs:** New menu action confirmed via i18n-labeled 'Update API key' entries in both the single-rule actions menu and the rules bulk actions component; this adds a new, faster remediation path for a problem (stale rule API key) that the authorization docs currently describe only one way to fix.

## Resources

- PR [#281337](https://github.com/elastic/kibana/pull/281337) — [Alerting V2] Add "Update API key" action (single + bulk) for rules

Screenshots from PR

![screenshot](https://github.com/user-attachments/assets/9ec8ac88-912c-4322-8832-6000d1dff035)

## Availability

| Channel | Details |
|---------|---------|
| **Stack** | v9.6.0 |
| **Serverless** | Aug 17–Aug 21 |
| **Feature status** | preview |
| **Feature flag** | None — active by default |

---
*Created with [Docs Quest Scanner](https://github.com/florent-leborgne/docs-quest-scanner) by @nastasha-solomon*

## Suggested edits

[Rule, action policy, and workflow authorization in the experimental alerting system](https://www.elastic.co/docs/explore-analyze/alerting/experimental-alerting-system/authorization) > Check and fix authorization errors
- **What the docs say:** Error type: Stale or not valid API key. Cause: The stored key is no longer valid... How to resolve it: Refresh the key by saving the rule again or toggling it off and back on.
- **What to add:** The listed remediation only mentions re-saving or toggling the rule. Add that rules now also have a dedicated Update API key action (single, from the rule's actions menu on the details page or rules list; or bulk, from the rules list) that regenerates the key directly without a full edit. Applies from 9.6.0 and in serverless.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.