Skip to content

Comments

[DOCS][SECURITY] Updates API docs for Elastic Endpoint exceptions#223053

Merged
nastasha-solomon merged 35 commits intoelastic:mainfrom
nastasha-solomon:issue-1636-endpoint-list-api-9.x
Jun 30, 2025
Merged

[DOCS][SECURITY] Updates API docs for Elastic Endpoint exceptions#223053
nastasha-solomon merged 35 commits intoelastic:mainfrom
nastasha-solomon:issue-1636-endpoint-list-api-9.x

Conversation

@nastasha-solomon
Copy link
Contributor

@nastasha-solomon nastasha-solomon commented Jun 6, 2025

Summary

Contributes to elastic/docs-content#1636 by updating ESS (8.17+) and Serverless API docs for the Elastic Endpoint exceptions endpoint.

Doc updates

Made the following changes to the docs for the Elastic Endpoint exceptions endpoint:

  • Updated descriptions and titles for the Elastic Endpoint operations to show that they should only be used for exceptions to the Elastic Endpoint rule.

    Before
    Screenshot 2025-06-11 at 12 36 20 PM

    After
    Screenshot 2025-06-30 at 12 21 50 PM

  • Modified the example included in the list_id param description. When you create a new Endpoint exception list, the list_id will be endpoint_list.

    Before
    Screenshot 2025-06-30 at 11 31 58 AM

    After
    Screenshot 2025-06-30 at 11 32 39 AM

@nastasha-solomon nastasha-solomon self-assigned this Jun 6, 2025
@nastasha-solomon nastasha-solomon added release_note:skip Skip the PR/issue when compiling release notes v9.0.0 backport:version Backport to applied version labels labels Jun 6, 2025
@nastasha-solomon nastasha-solomon marked this pull request as ready for review June 27, 2025 17:42
@nastasha-solomon nastasha-solomon requested a review from a team as a code owner June 27, 2025 17:42
Copy link
Contributor

@rylnd rylnd left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@nastasha-solomon this looks great, I just had two high-level nits:

  1. "e.g. list_id" should become just "list_id", as it's the only possible value
  2. The phrase "by using" should be replaced with something like "identified by" or "specified via" or something more clear/specific.

@nastasha-solomon nastasha-solomon merged commit 938ead0 into elastic:main Jun 30, 2025
15 checks passed
@kibanamachine
Copy link
Contributor

Starting backport for target branches: 8.18, 8.19, 9.0, 9.1

https://github.com/elastic/kibana/actions/runs/15983086520

@kibanamachine
Copy link
Contributor

Starting backport for target branches: 8.18, 8.19, 9.0, 9.1

https://github.com/elastic/kibana/actions/runs/15983093147

kibanamachine added a commit to kibanamachine/kibana that referenced this pull request Jun 30, 2025
…astic#223053)

## Summary

Contributes to elastic/docs-content#1636 by
updating ESS (8.17+) and Serverless API docs for the Elastic Endpoint
exceptions endpoint.

## Doc updates
Made the following changes to the docs for the Elastic Endpoint
exceptions endpoint:
- Updated descriptions and titles for the Elastic Endpoint operations to
show that they should only be used for exceptions to the Elastic
Endpoint rule.

   **Before**
<img width="320" alt="Screenshot 2025-06-11 at 12 36 20 PM"
src="https://github.com/user-attachments/assets/a70ab2a3-0efb-4c67-93d3-f1c99a980dbf"
/>

   **After**
<img width="321" alt="Screenshot 2025-06-30 at 12 21 50 PM"
src="https://github.com/user-attachments/assets/24ed9b71-d71a-41d7-8e02-9a4136460042"
/>

- Modified the example included in the `list_id` param description. When
you create a new Endpoint exception list, the `list_id` will be
`endpoint_list`.

   **Before**
<img width="450" alt="Screenshot 2025-06-30 at 11 31 58 AM"
src="https://github.com/user-attachments/assets/d52c0d18-7682-4fb4-8365-abec6e4c3c16"
/>

   **After**
<img width="450" alt="Screenshot 2025-06-30 at 11 32 39 AM"
src="https://github.com/user-attachments/assets/2e0463d6-3344-4346-96e3-03c446a3914f"
/>

---------

Co-authored-by: Ryland Herrick <ryalnd@gmail.com>
Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>
(cherry picked from commit 938ead0)
kibanamachine added a commit to kibanamachine/kibana that referenced this pull request Jun 30, 2025
…astic#223053)

## Summary

Contributes to elastic/docs-content#1636 by
updating ESS (8.17+) and Serverless API docs for the Elastic Endpoint
exceptions endpoint.

## Doc updates
Made the following changes to the docs for the Elastic Endpoint
exceptions endpoint:
- Updated descriptions and titles for the Elastic Endpoint operations to
show that they should only be used for exceptions to the Elastic
Endpoint rule.

   **Before**
<img width="320" alt="Screenshot 2025-06-11 at 12 36 20 PM"
src="https://github.com/user-attachments/assets/a70ab2a3-0efb-4c67-93d3-f1c99a980dbf"
/>

   **After**
<img width="321" alt="Screenshot 2025-06-30 at 12 21 50 PM"
src="https://github.com/user-attachments/assets/24ed9b71-d71a-41d7-8e02-9a4136460042"
/>

- Modified the example included in the `list_id` param description. When
you create a new Endpoint exception list, the `list_id` will be
`endpoint_list`.

   **Before**
<img width="450" alt="Screenshot 2025-06-30 at 11 31 58 AM"
src="https://github.com/user-attachments/assets/d52c0d18-7682-4fb4-8365-abec6e4c3c16"
/>

   **After**
<img width="450" alt="Screenshot 2025-06-30 at 11 32 39 AM"
src="https://github.com/user-attachments/assets/2e0463d6-3344-4346-96e3-03c446a3914f"
/>

---------

Co-authored-by: Ryland Herrick <ryalnd@gmail.com>
Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>
(cherry picked from commit 938ead0)
kibanamachine added a commit to kibanamachine/kibana that referenced this pull request Jun 30, 2025
…astic#223053)

## Summary

Contributes to elastic/docs-content#1636 by
updating ESS (8.17+) and Serverless API docs for the Elastic Endpoint
exceptions endpoint.

## Doc updates
Made the following changes to the docs for the Elastic Endpoint
exceptions endpoint:
- Updated descriptions and titles for the Elastic Endpoint operations to
show that they should only be used for exceptions to the Elastic
Endpoint rule.

   **Before**
<img width="320" alt="Screenshot 2025-06-11 at 12 36 20 PM"
src="https://github.com/user-attachments/assets/a70ab2a3-0efb-4c67-93d3-f1c99a980dbf"
/>

   **After**
<img width="321" alt="Screenshot 2025-06-30 at 12 21 50 PM"
src="https://github.com/user-attachments/assets/24ed9b71-d71a-41d7-8e02-9a4136460042"
/>

- Modified the example included in the `list_id` param description. When
you create a new Endpoint exception list, the `list_id` will be
`endpoint_list`.

   **Before**
<img width="450" alt="Screenshot 2025-06-30 at 11 31 58 AM"
src="https://github.com/user-attachments/assets/d52c0d18-7682-4fb4-8365-abec6e4c3c16"
/>

   **After**
<img width="450" alt="Screenshot 2025-06-30 at 11 32 39 AM"
src="https://github.com/user-attachments/assets/2e0463d6-3344-4346-96e3-03c446a3914f"
/>

---------

Co-authored-by: Ryland Herrick <ryalnd@gmail.com>
Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>
(cherry picked from commit 938ead0)
kibanamachine added a commit to kibanamachine/kibana that referenced this pull request Jun 30, 2025
…astic#223053)

## Summary

Contributes to elastic/docs-content#1636 by
updating ESS (8.17+) and Serverless API docs for the Elastic Endpoint
exceptions endpoint.

## Doc updates
Made the following changes to the docs for the Elastic Endpoint
exceptions endpoint:
- Updated descriptions and titles for the Elastic Endpoint operations to
show that they should only be used for exceptions to the Elastic
Endpoint rule.

   **Before**
<img width="320" alt="Screenshot 2025-06-11 at 12 36 20 PM"
src="https://github.com/user-attachments/assets/a70ab2a3-0efb-4c67-93d3-f1c99a980dbf"
/>

   **After**
<img width="321" alt="Screenshot 2025-06-30 at 12 21 50 PM"
src="https://github.com/user-attachments/assets/24ed9b71-d71a-41d7-8e02-9a4136460042"
/>

- Modified the example included in the `list_id` param description. When
you create a new Endpoint exception list, the `list_id` will be
`endpoint_list`.

   **Before**
<img width="450" alt="Screenshot 2025-06-30 at 11 31 58 AM"
src="https://github.com/user-attachments/assets/d52c0d18-7682-4fb4-8365-abec6e4c3c16"
/>

   **After**
<img width="450" alt="Screenshot 2025-06-30 at 11 32 39 AM"
src="https://github.com/user-attachments/assets/2e0463d6-3344-4346-96e3-03c446a3914f"
/>

---------

Co-authored-by: Ryland Herrick <ryalnd@gmail.com>
Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>
(cherry picked from commit 938ead0)
@kibanamachine
Copy link
Contributor

💔 Some backports could not be created

Status Branch Result
8.18 An unhandled error occurred. Please see the logs for details
8.19 Backport failed because of merge conflicts
9.0
9.1

Note: Successful backport PRs will be merged automatically after passing CI.

Manual backport

To create the backport manually run:

node scripts/backport --pr 223053

Questions ?

Please refer to the Backport tool documentation

kibanamachine added a commit to kibanamachine/kibana that referenced this pull request Jun 30, 2025
…astic#223053)

## Summary

Contributes to elastic/docs-content#1636 by
updating ESS (8.17+) and Serverless API docs for the Elastic Endpoint
exceptions endpoint.

## Doc updates
Made the following changes to the docs for the Elastic Endpoint
exceptions endpoint:
- Updated descriptions and titles for the Elastic Endpoint operations to
show that they should only be used for exceptions to the Elastic
Endpoint rule.

   **Before**
<img width="320" alt="Screenshot 2025-06-11 at 12 36 20 PM"
src="https://github.com/user-attachments/assets/a70ab2a3-0efb-4c67-93d3-f1c99a980dbf"
/>

   **After**
<img width="321" alt="Screenshot 2025-06-30 at 12 21 50 PM"
src="https://github.com/user-attachments/assets/24ed9b71-d71a-41d7-8e02-9a4136460042"
/>

- Modified the example included in the `list_id` param description. When
you create a new Endpoint exception list, the `list_id` will be
`endpoint_list`.

   **Before**
<img width="450" alt="Screenshot 2025-06-30 at 11 31 58 AM"
src="https://github.com/user-attachments/assets/d52c0d18-7682-4fb4-8365-abec6e4c3c16"
/>

   **After**
<img width="450" alt="Screenshot 2025-06-30 at 11 32 39 AM"
src="https://github.com/user-attachments/assets/2e0463d6-3344-4346-96e3-03c446a3914f"
/>

---------

Co-authored-by: Ryland Herrick <ryalnd@gmail.com>
Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>
(cherry picked from commit 938ead0)
@kibanamachine
Copy link
Contributor

💔 Some backports could not be created

Status Branch Result
8.18
8.19 Backport failed because of merge conflicts
9.0
9.1

Note: Successful backport PRs will be merged automatically after passing CI.

Manual backport

To create the backport manually run:

node scripts/backport --pr 223053

Questions ?

Please refer to the Backport tool documentation

kibanamachine added a commit that referenced this pull request Jun 30, 2025
…ns (#223053) (#225923)

# Backport

This will backport the following commits from `main` to `9.1`:
- [[DOCS][SECURITY] Updates API docs for Elastic Endpoint exceptions
(#223053)](#223053)

<!--- Backport version: 9.6.6 -->

### Questions ?
Please refer to the [Backport tool
documentation](https://github.com/sorenlouv/backport)

<!--BACKPORT [{"author":{"name":"Nastasha
Solomon","email":"79124755+nastasha-solomon@users.noreply.github.com"},"sourceCommit":{"committedDate":"2025-06-30T20:33:23Z","message":"[DOCS][SECURITY]
Updates API docs for Elastic Endpoint exceptions (#223053)\n\n##
Summary\n\nContributes to
elastic/docs-content#1636 by\nupdating ESS
(8.17+) and Serverless API docs for the Elastic Endpoint\nexceptions
endpoint.\n\n## Doc updates\nMade the following changes to the docs for
the Elastic Endpoint\nexceptions endpoint:\n- Updated descriptions and
titles for the Elastic Endpoint operations to\nshow that they should
only be used for exceptions to the Elastic\nEndpoint rule.\n\n
**Before**\n<img width=\"320\" alt=\"Screenshot 2025-06-11 at 12 36
20 PM\"\nsrc=\"https://github.com/user-attachments/assets/a70ab2a3-0efb-4c67-93d3-f1c99a980dbf\"\n/>\n\n
**After**\n<img width=\"321\" alt=\"Screenshot 2025-06-30 at 12 21
50 PM\"\nsrc=\"https://github.com/user-attachments/assets/24ed9b71-d71a-41d7-8e02-9a4136460042\"\n/>\n\n\n-
Modified the example included in the `list_id` param description.
When\nyou create a new Endpoint exception list, the `list_id` will
be\n`endpoint_list`.\n\n **Before**\n<img width=\"450\" alt=\"Screenshot
2025-06-30 at 11 31
58 AM\"\nsrc=\"https://github.com/user-attachments/assets/d52c0d18-7682-4fb4-8365-abec6e4c3c16\"\n/>\n\n\n
**After**\n<img width=\"450\" alt=\"Screenshot 2025-06-30 at 11 32
39 AM\"\nsrc=\"https://github.com/user-attachments/assets/2e0463d6-3344-4346-96e3-03c446a3914f\"\n/>\n\n---------\n\nCo-authored-by:
Ryland Herrick <ryalnd@gmail.com>\nCo-authored-by: kibanamachine
<42973632+kibanamachine@users.noreply.github.com>","sha":"938ead0ec0a86eb72fd03361f335c6c3b9cc743f","branchLabelMapping":{"^v9.2.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:skip","v9.0.0","backport:version","v8.18.0","v9.1.0","v8.19.0","v9.2.0"],"title":"[DOCS][SECURITY]
Updates API docs for Elastic Endpoint
exceptions","number":223053,"url":"https://github.com/elastic/kibana/pull/223053","mergeCommit":{"message":"[DOCS][SECURITY]
Updates API docs for Elastic Endpoint exceptions (#223053)\n\n##
Summary\n\nContributes to
elastic/docs-content#1636 by\nupdating ESS
(8.17+) and Serverless API docs for the Elastic Endpoint\nexceptions
endpoint.\n\n## Doc updates\nMade the following changes to the docs for
the Elastic Endpoint\nexceptions endpoint:\n- Updated descriptions and
titles for the Elastic Endpoint operations to\nshow that they should
only be used for exceptions to the Elastic\nEndpoint rule.\n\n
**Before**\n<img width=\"320\" alt=\"Screenshot 2025-06-11 at 12 36
20 PM\"\nsrc=\"https://github.com/user-attachments/assets/a70ab2a3-0efb-4c67-93d3-f1c99a980dbf\"\n/>\n\n
**After**\n<img width=\"321\" alt=\"Screenshot 2025-06-30 at 12 21
50 PM\"\nsrc=\"https://github.com/user-attachments/assets/24ed9b71-d71a-41d7-8e02-9a4136460042\"\n/>\n\n\n-
Modified the example included in the `list_id` param description.
When\nyou create a new Endpoint exception list, the `list_id` will
be\n`endpoint_list`.\n\n **Before**\n<img width=\"450\" alt=\"Screenshot
2025-06-30 at 11 31
58 AM\"\nsrc=\"https://github.com/user-attachments/assets/d52c0d18-7682-4fb4-8365-abec6e4c3c16\"\n/>\n\n\n
**After**\n<img width=\"450\" alt=\"Screenshot 2025-06-30 at 11 32
39 AM\"\nsrc=\"https://github.com/user-attachments/assets/2e0463d6-3344-4346-96e3-03c446a3914f\"\n/>\n\n---------\n\nCo-authored-by:
Ryland Herrick <ryalnd@gmail.com>\nCo-authored-by: kibanamachine
<42973632+kibanamachine@users.noreply.github.com>","sha":"938ead0ec0a86eb72fd03361f335c6c3b9cc743f"}},"sourceBranch":"main","suggestedTargetBranches":["9.0","8.18","9.1","8.19"],"targetPullRequestStates":[{"branch":"9.0","label":"v9.0.0","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.18","label":"v8.18.0","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"9.1","label":"v9.1.0","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.19","label":"v8.19.0","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"main","label":"v9.2.0","branchLabelMappingKey":"^v9.2.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/223053","number":223053,"mergeCommit":{"message":"[DOCS][SECURITY]
Updates API docs for Elastic Endpoint exceptions (#223053)\n\n##
Summary\n\nContributes to
elastic/docs-content#1636 by\nupdating ESS
(8.17+) and Serverless API docs for the Elastic Endpoint\nexceptions
endpoint.\n\n## Doc updates\nMade the following changes to the docs for
the Elastic Endpoint\nexceptions endpoint:\n- Updated descriptions and
titles for the Elastic Endpoint operations to\nshow that they should
only be used for exceptions to the Elastic\nEndpoint rule.\n\n
**Before**\n<img width=\"320\" alt=\"Screenshot 2025-06-11 at 12 36
20 PM\"\nsrc=\"https://github.com/user-attachments/assets/a70ab2a3-0efb-4c67-93d3-f1c99a980dbf\"\n/>\n\n
**After**\n<img width=\"321\" alt=\"Screenshot 2025-06-30 at 12 21
50 PM\"\nsrc=\"https://github.com/user-attachments/assets/24ed9b71-d71a-41d7-8e02-9a4136460042\"\n/>\n\n\n-
Modified the example included in the `list_id` param description.
When\nyou create a new Endpoint exception list, the `list_id` will
be\n`endpoint_list`.\n\n **Before**\n<img width=\"450\" alt=\"Screenshot
2025-06-30 at 11 31
58 AM\"\nsrc=\"https://github.com/user-attachments/assets/d52c0d18-7682-4fb4-8365-abec6e4c3c16\"\n/>\n\n\n
**After**\n<img width=\"450\" alt=\"Screenshot 2025-06-30 at 11 32
39 AM\"\nsrc=\"https://github.com/user-attachments/assets/2e0463d6-3344-4346-96e3-03c446a3914f\"\n/>\n\n---------\n\nCo-authored-by:
Ryland Herrick <ryalnd@gmail.com>\nCo-authored-by: kibanamachine
<42973632+kibanamachine@users.noreply.github.com>","sha":"938ead0ec0a86eb72fd03361f335c6c3b9cc743f"}}]}]
BACKPORT-->

Co-authored-by: Nastasha Solomon <79124755+nastasha-solomon@users.noreply.github.com>
Co-authored-by: Ryland Herrick <ryalnd@gmail.com>
kibanamachine added a commit that referenced this pull request Jun 30, 2025
…ns (#223053) (#225922)

# Backport

This will backport the following commits from `main` to `9.0`:
- [[DOCS][SECURITY] Updates API docs for Elastic Endpoint exceptions
(#223053)](#223053)

<!--- Backport version: 9.6.6 -->

### Questions ?
Please refer to the [Backport tool
documentation](https://github.com/sorenlouv/backport)

<!--BACKPORT [{"author":{"name":"Nastasha
Solomon","email":"79124755+nastasha-solomon@users.noreply.github.com"},"sourceCommit":{"committedDate":"2025-06-30T20:33:23Z","message":"[DOCS][SECURITY]
Updates API docs for Elastic Endpoint exceptions (#223053)\n\n##
Summary\n\nContributes to
elastic/docs-content#1636 by\nupdating ESS
(8.17+) and Serverless API docs for the Elastic Endpoint\nexceptions
endpoint.\n\n## Doc updates\nMade the following changes to the docs for
the Elastic Endpoint\nexceptions endpoint:\n- Updated descriptions and
titles for the Elastic Endpoint operations to\nshow that they should
only be used for exceptions to the Elastic\nEndpoint rule.\n\n
**Before**\n<img width=\"320\" alt=\"Screenshot 2025-06-11 at 12 36
20 PM\"\nsrc=\"https://github.com/user-attachments/assets/a70ab2a3-0efb-4c67-93d3-f1c99a980dbf\"\n/>\n\n
**After**\n<img width=\"321\" alt=\"Screenshot 2025-06-30 at 12 21
50 PM\"\nsrc=\"https://github.com/user-attachments/assets/24ed9b71-d71a-41d7-8e02-9a4136460042\"\n/>\n\n\n-
Modified the example included in the `list_id` param description.
When\nyou create a new Endpoint exception list, the `list_id` will
be\n`endpoint_list`.\n\n **Before**\n<img width=\"450\" alt=\"Screenshot
2025-06-30 at 11 31
58 AM\"\nsrc=\"https://github.com/user-attachments/assets/d52c0d18-7682-4fb4-8365-abec6e4c3c16\"\n/>\n\n\n
**After**\n<img width=\"450\" alt=\"Screenshot 2025-06-30 at 11 32
39 AM\"\nsrc=\"https://github.com/user-attachments/assets/2e0463d6-3344-4346-96e3-03c446a3914f\"\n/>\n\n---------\n\nCo-authored-by:
Ryland Herrick <ryalnd@gmail.com>\nCo-authored-by: kibanamachine
<42973632+kibanamachine@users.noreply.github.com>","sha":"938ead0ec0a86eb72fd03361f335c6c3b9cc743f","branchLabelMapping":{"^v9.2.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:skip","v9.0.0","backport:version","v8.18.0","v9.1.0","v8.19.0","v9.2.0"],"title":"[DOCS][SECURITY]
Updates API docs for Elastic Endpoint
exceptions","number":223053,"url":"https://github.com/elastic/kibana/pull/223053","mergeCommit":{"message":"[DOCS][SECURITY]
Updates API docs for Elastic Endpoint exceptions (#223053)\n\n##
Summary\n\nContributes to
elastic/docs-content#1636 by\nupdating ESS
(8.17+) and Serverless API docs for the Elastic Endpoint\nexceptions
endpoint.\n\n## Doc updates\nMade the following changes to the docs for
the Elastic Endpoint\nexceptions endpoint:\n- Updated descriptions and
titles for the Elastic Endpoint operations to\nshow that they should
only be used for exceptions to the Elastic\nEndpoint rule.\n\n
**Before**\n<img width=\"320\" alt=\"Screenshot 2025-06-11 at 12 36
20 PM\"\nsrc=\"https://github.com/user-attachments/assets/a70ab2a3-0efb-4c67-93d3-f1c99a980dbf\"\n/>\n\n
**After**\n<img width=\"321\" alt=\"Screenshot 2025-06-30 at 12 21
50 PM\"\nsrc=\"https://github.com/user-attachments/assets/24ed9b71-d71a-41d7-8e02-9a4136460042\"\n/>\n\n\n-
Modified the example included in the `list_id` param description.
When\nyou create a new Endpoint exception list, the `list_id` will
be\n`endpoint_list`.\n\n **Before**\n<img width=\"450\" alt=\"Screenshot
2025-06-30 at 11 31
58 AM\"\nsrc=\"https://github.com/user-attachments/assets/d52c0d18-7682-4fb4-8365-abec6e4c3c16\"\n/>\n\n\n
**After**\n<img width=\"450\" alt=\"Screenshot 2025-06-30 at 11 32
39 AM\"\nsrc=\"https://github.com/user-attachments/assets/2e0463d6-3344-4346-96e3-03c446a3914f\"\n/>\n\n---------\n\nCo-authored-by:
Ryland Herrick <ryalnd@gmail.com>\nCo-authored-by: kibanamachine
<42973632+kibanamachine@users.noreply.github.com>","sha":"938ead0ec0a86eb72fd03361f335c6c3b9cc743f"}},"sourceBranch":"main","suggestedTargetBranches":["9.0","8.18","9.1","8.19"],"targetPullRequestStates":[{"branch":"9.0","label":"v9.0.0","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.18","label":"v8.18.0","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"9.1","label":"v9.1.0","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.19","label":"v8.19.0","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"main","label":"v9.2.0","branchLabelMappingKey":"^v9.2.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/223053","number":223053,"mergeCommit":{"message":"[DOCS][SECURITY]
Updates API docs for Elastic Endpoint exceptions (#223053)\n\n##
Summary\n\nContributes to
elastic/docs-content#1636 by\nupdating ESS
(8.17+) and Serverless API docs for the Elastic Endpoint\nexceptions
endpoint.\n\n## Doc updates\nMade the following changes to the docs for
the Elastic Endpoint\nexceptions endpoint:\n- Updated descriptions and
titles for the Elastic Endpoint operations to\nshow that they should
only be used for exceptions to the Elastic\nEndpoint rule.\n\n
**Before**\n<img width=\"320\" alt=\"Screenshot 2025-06-11 at 12 36
20 PM\"\nsrc=\"https://github.com/user-attachments/assets/a70ab2a3-0efb-4c67-93d3-f1c99a980dbf\"\n/>\n\n
**After**\n<img width=\"321\" alt=\"Screenshot 2025-06-30 at 12 21
50 PM\"\nsrc=\"https://github.com/user-attachments/assets/24ed9b71-d71a-41d7-8e02-9a4136460042\"\n/>\n\n\n-
Modified the example included in the `list_id` param description.
When\nyou create a new Endpoint exception list, the `list_id` will
be\n`endpoint_list`.\n\n **Before**\n<img width=\"450\" alt=\"Screenshot
2025-06-30 at 11 31
58 AM\"\nsrc=\"https://github.com/user-attachments/assets/d52c0d18-7682-4fb4-8365-abec6e4c3c16\"\n/>\n\n\n
**After**\n<img width=\"450\" alt=\"Screenshot 2025-06-30 at 11 32
39 AM\"\nsrc=\"https://github.com/user-attachments/assets/2e0463d6-3344-4346-96e3-03c446a3914f\"\n/>\n\n---------\n\nCo-authored-by:
Ryland Herrick <ryalnd@gmail.com>\nCo-authored-by: kibanamachine
<42973632+kibanamachine@users.noreply.github.com>","sha":"938ead0ec0a86eb72fd03361f335c6c3b9cc743f"}}]}]
BACKPORT-->

Co-authored-by: Nastasha Solomon <79124755+nastasha-solomon@users.noreply.github.com>
Co-authored-by: Ryland Herrick <ryalnd@gmail.com>
@kibanamachine
Copy link
Contributor

Starting backport for target branches: 8.18, 8.19, 9.0, 9.1

https://github.com/elastic/kibana/actions/runs/15985379765

kibanamachine added a commit to kibanamachine/kibana that referenced this pull request Jun 30, 2025
…astic#223053)

## Summary

Contributes to elastic/docs-content#1636 by
updating ESS (8.17+) and Serverless API docs for the Elastic Endpoint
exceptions endpoint.

## Doc updates
Made the following changes to the docs for the Elastic Endpoint
exceptions endpoint:
- Updated descriptions and titles for the Elastic Endpoint operations to
show that they should only be used for exceptions to the Elastic
Endpoint rule.

   **Before**
<img width="320" alt="Screenshot 2025-06-11 at 12 36 20 PM"
src="https://github.com/user-attachments/assets/a70ab2a3-0efb-4c67-93d3-f1c99a980dbf"
/>

   **After**
<img width="321" alt="Screenshot 2025-06-30 at 12 21 50 PM"
src="https://github.com/user-attachments/assets/24ed9b71-d71a-41d7-8e02-9a4136460042"
/>

- Modified the example included in the `list_id` param description. When
you create a new Endpoint exception list, the `list_id` will be
`endpoint_list`.

   **Before**
<img width="450" alt="Screenshot 2025-06-30 at 11 31 58 AM"
src="https://github.com/user-attachments/assets/d52c0d18-7682-4fb4-8365-abec6e4c3c16"
/>

   **After**
<img width="450" alt="Screenshot 2025-06-30 at 11 32 39 AM"
src="https://github.com/user-attachments/assets/2e0463d6-3344-4346-96e3-03c446a3914f"
/>

---------

Co-authored-by: Ryland Herrick <ryalnd@gmail.com>
Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>
(cherry picked from commit 938ead0)
@kibanamachine
Copy link
Contributor

💔 Some backports could not be created

Status Branch Result
8.18
8.19 Backport failed because of merge conflicts
9.0 Cherrypick failed because the selected commit (938ead0) is empty. It looks like the commit was already backported in #225922
9.1 Cherrypick failed because the selected commit (938ead0) is empty. It looks like the commit was already backported in #225923

Note: Successful backport PRs will be merged automatically after passing CI.

Manual backport

To create the backport manually run:

node scripts/backport --pr 223053

Questions ?

Please refer to the Backport tool documentation

kibanamachine added a commit that referenced this pull request Jul 1, 2025
…ons (#223053) (#225921)

# Backport

This will backport the following commits from `main` to `8.18`:
- [[DOCS][SECURITY] Updates API docs for Elastic Endpoint exceptions
(#223053)](#223053)

<!--- Backport version: 9.6.6 -->

### Questions ?
Please refer to the [Backport tool
documentation](https://github.com/sorenlouv/backport)

<!--BACKPORT [{"author":{"name":"Nastasha
Solomon","email":"79124755+nastasha-solomon@users.noreply.github.com"},"sourceCommit":{"committedDate":"2025-06-30T20:33:23Z","message":"[DOCS][SECURITY]
Updates API docs for Elastic Endpoint exceptions (#223053)\n\n##
Summary\n\nContributes to
elastic/docs-content#1636 by\nupdating ESS
(8.17+) and Serverless API docs for the Elastic Endpoint\nexceptions
endpoint.\n\n## Doc updates\nMade the following changes to the docs for
the Elastic Endpoint\nexceptions endpoint:\n- Updated descriptions and
titles for the Elastic Endpoint operations to\nshow that they should
only be used for exceptions to the Elastic\nEndpoint rule.\n\n
**Before**\n<img width=\"320\" alt=\"Screenshot 2025-06-11 at 12 36
20 PM\"\nsrc=\"https://github.com/user-attachments/assets/a70ab2a3-0efb-4c67-93d3-f1c99a980dbf\"\n/>\n\n
**After**\n<img width=\"321\" alt=\"Screenshot 2025-06-30 at 12 21
50 PM\"\nsrc=\"https://github.com/user-attachments/assets/24ed9b71-d71a-41d7-8e02-9a4136460042\"\n/>\n\n\n-
Modified the example included in the `list_id` param description.
When\nyou create a new Endpoint exception list, the `list_id` will
be\n`endpoint_list`.\n\n **Before**\n<img width=\"450\" alt=\"Screenshot
2025-06-30 at 11 31
58 AM\"\nsrc=\"https://github.com/user-attachments/assets/d52c0d18-7682-4fb4-8365-abec6e4c3c16\"\n/>\n\n\n
**After**\n<img width=\"450\" alt=\"Screenshot 2025-06-30 at 11 32
39 AM\"\nsrc=\"https://github.com/user-attachments/assets/2e0463d6-3344-4346-96e3-03c446a3914f\"\n/>\n\n---------\n\nCo-authored-by:
Ryland Herrick <ryalnd@gmail.com>\nCo-authored-by: kibanamachine
<42973632+kibanamachine@users.noreply.github.com>","sha":"938ead0ec0a86eb72fd03361f335c6c3b9cc743f","branchLabelMapping":{"^v9.2.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:skip","v9.0.0","backport:version","v8.18.0","v9.1.0","v8.19.0","v9.2.0"],"title":"[DOCS][SECURITY]
Updates API docs for Elastic Endpoint
exceptions","number":223053,"url":"https://github.com/elastic/kibana/pull/223053","mergeCommit":{"message":"[DOCS][SECURITY]
Updates API docs for Elastic Endpoint exceptions (#223053)\n\n##
Summary\n\nContributes to
elastic/docs-content#1636 by\nupdating ESS
(8.17+) and Serverless API docs for the Elastic Endpoint\nexceptions
endpoint.\n\n## Doc updates\nMade the following changes to the docs for
the Elastic Endpoint\nexceptions endpoint:\n- Updated descriptions and
titles for the Elastic Endpoint operations to\nshow that they should
only be used for exceptions to the Elastic\nEndpoint rule.\n\n
**Before**\n<img width=\"320\" alt=\"Screenshot 2025-06-11 at 12 36
20 PM\"\nsrc=\"https://github.com/user-attachments/assets/a70ab2a3-0efb-4c67-93d3-f1c99a980dbf\"\n/>\n\n
**After**\n<img width=\"321\" alt=\"Screenshot 2025-06-30 at 12 21
50 PM\"\nsrc=\"https://github.com/user-attachments/assets/24ed9b71-d71a-41d7-8e02-9a4136460042\"\n/>\n\n\n-
Modified the example included in the `list_id` param description.
When\nyou create a new Endpoint exception list, the `list_id` will
be\n`endpoint_list`.\n\n **Before**\n<img width=\"450\" alt=\"Screenshot
2025-06-30 at 11 31
58 AM\"\nsrc=\"https://github.com/user-attachments/assets/d52c0d18-7682-4fb4-8365-abec6e4c3c16\"\n/>\n\n\n
**After**\n<img width=\"450\" alt=\"Screenshot 2025-06-30 at 11 32
39 AM\"\nsrc=\"https://github.com/user-attachments/assets/2e0463d6-3344-4346-96e3-03c446a3914f\"\n/>\n\n---------\n\nCo-authored-by:
Ryland Herrick <ryalnd@gmail.com>\nCo-authored-by: kibanamachine
<42973632+kibanamachine@users.noreply.github.com>","sha":"938ead0ec0a86eb72fd03361f335c6c3b9cc743f"}},"sourceBranch":"main","suggestedTargetBranches":["9.0","8.18","9.1","8.19"],"targetPullRequestStates":[{"branch":"9.0","label":"v9.0.0","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.18","label":"v8.18.0","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"9.1","label":"v9.1.0","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.19","label":"v8.19.0","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"main","label":"v9.2.0","branchLabelMappingKey":"^v9.2.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/223053","number":223053,"mergeCommit":{"message":"[DOCS][SECURITY]
Updates API docs for Elastic Endpoint exceptions (#223053)\n\n##
Summary\n\nContributes to
elastic/docs-content#1636 by\nupdating ESS
(8.17+) and Serverless API docs for the Elastic Endpoint\nexceptions
endpoint.\n\n## Doc updates\nMade the following changes to the docs for
the Elastic Endpoint\nexceptions endpoint:\n- Updated descriptions and
titles for the Elastic Endpoint operations to\nshow that they should
only be used for exceptions to the Elastic\nEndpoint rule.\n\n
**Before**\n<img width=\"320\" alt=\"Screenshot 2025-06-11 at 12 36
20 PM\"\nsrc=\"https://github.com/user-attachments/assets/a70ab2a3-0efb-4c67-93d3-f1c99a980dbf\"\n/>\n\n
**After**\n<img width=\"321\" alt=\"Screenshot 2025-06-30 at 12 21
50 PM\"\nsrc=\"https://github.com/user-attachments/assets/24ed9b71-d71a-41d7-8e02-9a4136460042\"\n/>\n\n\n-
Modified the example included in the `list_id` param description.
When\nyou create a new Endpoint exception list, the `list_id` will
be\n`endpoint_list`.\n\n **Before**\n<img width=\"450\" alt=\"Screenshot
2025-06-30 at 11 31
58 AM\"\nsrc=\"https://github.com/user-attachments/assets/d52c0d18-7682-4fb4-8365-abec6e4c3c16\"\n/>\n\n\n
**After**\n<img width=\"450\" alt=\"Screenshot 2025-06-30 at 11 32
39 AM\"\nsrc=\"https://github.com/user-attachments/assets/2e0463d6-3344-4346-96e3-03c446a3914f\"\n/>\n\n---------\n\nCo-authored-by:
Ryland Herrick <ryalnd@gmail.com>\nCo-authored-by: kibanamachine
<42973632+kibanamachine@users.noreply.github.com>","sha":"938ead0ec0a86eb72fd03361f335c6c3b9cc743f"}}]}]
BACKPORT-->

---------

Co-authored-by: Nastasha Solomon <79124755+nastasha-solomon@users.noreply.github.com>
Co-authored-by: Ryland Herrick <ryalnd@gmail.com>
@kibanamachine
Copy link
Contributor

Starting backport for target branches: 8.18, 8.19, 9.0, 9.1

https://github.com/elastic/kibana/actions/runs/15987331065

@kibanamachine
Copy link
Contributor

💔 All backports failed

Status Branch Result
8.18 Backport failed because of merge conflicts
8.19 Backport failed because of merge conflicts

You might need to backport the following PRs to 8.19:
- [OAS] Remove doc version (#225487)
9.0 Cherrypick failed because the selected commit (938ead0) is empty. It looks like the commit was already backported in #225922
9.1 Cherrypick failed because the selected commit (938ead0) is empty. It looks like the commit was already backported in #225923

Manual backport

To create the backport manually run:

node scripts/backport --pr 223053

Questions ?

Please refer to the Backport tool documentation

nastasha-solomon added a commit that referenced this pull request Aug 1, 2025
…point exceptions (#226316)

Manually creates an 8.19 backport for
#223053.

Related:
- elastic/docs-content#1636
- #223053

---------

Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

backport:version Backport to applied version labels release_note:skip Skip the PR/issue when compiling release notes v8.18.0 v8.18.4 v8.19.0 v9.0.0 v9.0.4 v9.1.0 v9.2.0

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants