Skip to content

[UIAM API key] Adds docs for Elastic Cloud API keys and rules#6722

Draft
nastasha-solomon wants to merge 11 commits into
mainfrom
issue-702
Draft

[UIAM API key] Adds docs for Elastic Cloud API keys and rules#6722
nastasha-solomon wants to merge 11 commits into
mainfrom
issue-702

Conversation

@nastasha-solomon

@nastasha-solomon nastasha-solomon commented May 26, 2026

Copy link
Copy Markdown
Member

Summary

Fixes https://github.com/elastic/docs-content-internal/issues/702 by adding a new reference page for Elastic Cloud API keys and alerting rules, and propagating a Serverless-scoped note across all relevant rule creation and management pages.

New page

explore-analyze/alerting/alerts/rules-and-elastic-cloud-api-keys.md (moved from deploy-manage/api-keys/; redirect added in redirects.yml)

The page covers:

  • Terms table — definitions for both Elasticsearch API keys and Elastic Cloud API keys in the context of alerting rules
  • About the migration — context on the completed phased rollout from ES API keys to Elastic Cloud API keys in Serverless projects, including post-migration default behavior and what happens to rules managed via the public APIs
  • How API keys affect rule behavior — comparison table across deployment type, ownership, privilege scope, expiry, and key management
  • API key ownership and rule scope — how ES and Elastic Cloud API keys handle ownership differently, what does not update automatically (new roles, role definition changes, orphaned rules), and how to manually update a rule's API key (including a note for Security detection rules)
  • After the migration — post-migration checklist organized into three collapsed dropdowns:
    • Right after migration: check rule execution status, resolve migration errors, verify index access
    • Within 90 days: review API key expiration, check for rules tagged Missing Elastic Cloud Api Key, review rules that use custom roles
    • Ongoing: orphaned rules, role changes, ownership behavior on edit, new rules and automation
  • How your rules improve after the migration — table summarizing the key improvements

Updated pages

Alerting setup

  • explore-analyze/alerting/alerts/alerting-setup.md: Added a Serverless-specific paragraph to the API keys section to parallel the existing Stack paragraph — clarifies that keys are created automatically in Serverless too, but unlike Stack, the key is not updated when a rule is edited. Links to the new reference page.

Stack alerting docs

  • Elasticsearch query rule
  • Index threshold rule
  • Transform health rules

Observability alerting docs

  • Alerting overview (authentication section)
  • Create and manage Observability rules
  • Create a degraded docs rule
  • Create a failed docs rule
  • Create an anomaly detection rule
  • Create an APM anomaly rule
  • Create an Elasticsearch query rule
  • Create an error count threshold rule
  • Create an inventory rule
  • Create an SLO burn rate rule
  • Create an uptime duration anomaly rule
  • Create a custom threshold rule
  • Create a failed transaction rate threshold rule
  • Create a latency threshold rule
  • Create a log threshold rule
  • Create a metric threshold rule
  • Create a monitor status rule
  • Create a TLS certificate rule

Security alerting docs

  • Detection rule concepts (rule authorization section and key terms)
  • Detections privileges
  • Manage detection rules
  • Create a detection rule using the UI

Reusable snippet

solutions/_snippets/api-key-rules.md — a Serverless-scoped note explaining that rules use an API key to authorize background tasks, with links to the relevant key type docs for each deployment. Included on all rule creation pages listed above.

@nastasha-solomon nastasha-solomon self-assigned this May 26, 2026
@github-actions

Copy link
Copy Markdown
Contributor

Elastic Docs AI PR menu

Check the box to run an AI review for this pull request.

  • Review docs changes (docs-review). Status: not started.

Powered by GitHub Agentic Workflows and docs-actions. For more information, reach out to the docs team.

@github-actions

github-actions Bot commented May 26, 2026

Copy link
Copy Markdown
Contributor

🔍 Preview links for changed docs

More links …

@github-actions

github-actions Bot commented May 26, 2026

Copy link
Copy Markdown
Contributor

Elastic Docs Style Checker (Vale)

Summary: 1 suggestion found

💡 Suggestions (1): Optional style improvements. Apply when helpful.
File Line Rule Message
solutions/security/detect-and-alert/detection-rule-concepts.md 123 Elastic.WordChoice Consider using 'run, start' instead of 'execute', unless the term is in the UI.

The Vale linter checks documentation changes against the Elastic Docs style guide. To use Vale locally or report issues, refer to Elastic style guide for Vale.

@tiamliu

tiamliu commented May 30, 2026

Copy link
Copy Markdown

@nastasha-solomon reviewed. Thank you

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants