-
Notifications
You must be signed in to change notification settings - Fork 8.3k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[Security Solution] Disable deprecated rules bulk CRUD API endpoints #193184
Labels
9.0 candidate
Breaking Change
Feature:Rule Management
Security Solution Detection Rule Management area
Team:Detection Rule Management
Security Detection Rule Management Team
Team:Detections and Resp
Security Detection Response Team
Team: SecuritySolution
Security Solutions Team working on SIEM, Endpoint, Timeline, Resolver, etc.
v9.0.0
Comments
banderror
added
8.17 candidate
Breaking Change
Feature:Rule Management
Security Solution Detection Rule Management area
Team: SecuritySolution
Security Solutions Team working on SIEM, Endpoint, Timeline, Resolver, etc.
Team:Detection Rule Management
Security Detection Rule Management Team
Team:Detections and Resp
Security Detection Response Team
v9.0.0
labels
Sep 17, 2024
Pinging @elastic/security-detection-rule-management (Team:Detection Rule Management) |
Pinging @elastic/security-detections-response (Team:Detections and Resp) |
Pinging @elastic/security-solution (Team: SecuritySolution) |
banderror
changed the title
[Security Solution] Delete rules bulk CRUD endpoints (DRAFT)
[Security Solution] Disable deprecated rules bulk CRUD endpoints
Sep 17, 2024
banderror
changed the title
[Security Solution] Disable deprecated rules bulk CRUD endpoints
[Security Solution] Disable deprecated rules bulk CRUD API endpoints
Sep 17, 2024
This was referenced Oct 23, 2024
Merged
banderror
added a commit
that referenced
this issue
Nov 1, 2024
…in Serverless and 9.0 (#197422) **Partially addresses:** #193184 **Breaking change proposal:** elastic/dev#2772 (internal) ## Summary This PR disables the following deprecated [bulk API endpoints for creating, updating and deleting detection rules](https://www.elastic.co/guide/en/security/current/bulk-actions-rules-api.html) from [Elastic Security APIs](https://www.elastic.co/guide/en/security/current/security-apis.html) in Serverless and upcoming `v9.0.0`: | Method | Endpoint | | ------ | ------------------------------------------------------- | | POST | /api/detection_engine/rules/\_bulk_create | | PUT | /api/detection_engine/rules/\_bulk_update | | PATCH | /api/detection_engine/rules/\_bulk_update | | DELETE | /api/detection_engine/rules/\_bulk_delete | | POST | /api/detection_engine/rules/\_bulk_delete | Specifically, as a first step we remove the endpoints from the route registrations. Once elastic/dev#2772 is approved, we will merge this PR and remove the corresponding endpoint handlers and associated code in a follow-up PR. ### Checklist - [x] [Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html) was added for features that require explanation or tutorials - [x] elastic/security-docs#5981 - [x] [Unit or functional tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html) were updated or added to match the most common scenarios ### For maintainers - [x] This was checked for breaking API changes and was [labeled appropriately](https://www.elastic.co/guide/en/kibana/master/contributing.html#_add_your_labels) - [x] This will appear in the **Release Notes** and follow the [guidelines](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process)
nikitaindik
added a commit
that referenced
this issue
Jan 22, 2025
…nt (#207091) **Partially addresses: #193184 ## Summary We are going to remove our deprecated [bulk action endpoints](#193184) in v9.0.0. They are already unavailable in `main`. This PR makes deprecated bulk endpoints visible in Upgrade Assistant. Also, it adds an upgrade guide to the documentation to help users transition to supported endpoints.⚠️ This PR temporarily adds the deprecated endpoints back to `register_routes.ts`. This is needed to make merging changes easier. I'll open up a follow up PR for `main` that will delete these endpoints from `9.0`. Will do it once this PR is merged. ## Screenshots **Deprecated endpoints visible in Upgrade Assistant table** <img width="1276" alt="Schermafbeelding 2025-01-21 om 11 27 53" src="https://github.com/user-attachments/assets/909c7a20-31d9-46bb-89ec-b409550074e4" /> **Clicking on a table item opens a flyout with more info** <table> <tr> <td> <img width="1270" alt="patch_update" src="https://github.com/user-attachments/assets/8e99459d-1ea1-40c4-936c-23074c02cd6f" /> </td> <td> <img width="1270" alt="post_create" src="https://github.com/user-attachments/assets/6e734e97-4cf4-4d96-9f8d-51efeb3977ad" /> </td> </tr> <tr> <td> <img width="1270" alt="put_update" src="https://github.com/user-attachments/assets/d5b08e16-bf49-475d-81a9-fe5654483e1d" /> </td> <td> <img width="1271" alt="post_delete" src="https://github.com/user-attachments/assets/ccb74552-50a4-4bdb-b04e-06857caa8f38" /> </td> </tr> </table> **Clicking on "Learn more" in the flyout takes you to the [upgrade guide](https://kibana_bk_207091.docs-preview.app.elstc.co/guide/en/kibana/master/breaking-changes-summary.html#breaking-207091)** <img width="731" alt="upgrade_notes" src="https://github.com/user-attachments/assets/b8b471ea-98c7-4b07-91db-b1630c382554" /> ## Testing Once you send a request to one of the deprecated endpoints it should show up in Upgrade Assistant at `<basePath>/app/management/stack/upgrade_assistant/kibana_deprecations`. Please refer to [this ticket](#193184) for the list of deprecated endpoints. Work started on: 16-Jan-2025
nikitaindik
added a commit
to nikitaindik/kibana
that referenced
this issue
Jan 22, 2025
…nt (elastic#207091) **Partially addresses: elastic#193184 ## Summary We are going to remove our deprecated [bulk action endpoints](elastic#193184) in v9.0.0. They are already unavailable in `main`. This PR makes deprecated bulk endpoints visible in Upgrade Assistant. Also, it adds an upgrade guide to the documentation to help users transition to supported endpoints.⚠️ This PR temporarily adds the deprecated endpoints back to `register_routes.ts`. This is needed to make merging changes easier. I'll open up a follow up PR for `main` that will delete these endpoints from `9.0`. Will do it once this PR is merged. ## Screenshots **Deprecated endpoints visible in Upgrade Assistant table** <img width="1276" alt="Schermafbeelding 2025-01-21 om 11 27 53" src="https://github.com/user-attachments/assets/909c7a20-31d9-46bb-89ec-b409550074e4" /> **Clicking on a table item opens a flyout with more info** <table> <tr> <td> <img width="1270" alt="patch_update" src="https://github.com/user-attachments/assets/8e99459d-1ea1-40c4-936c-23074c02cd6f" /> </td> <td> <img width="1270" alt="post_create" src="https://github.com/user-attachments/assets/6e734e97-4cf4-4d96-9f8d-51efeb3977ad" /> </td> </tr> <tr> <td> <img width="1270" alt="put_update" src="https://github.com/user-attachments/assets/d5b08e16-bf49-475d-81a9-fe5654483e1d" /> </td> <td> <img width="1271" alt="post_delete" src="https://github.com/user-attachments/assets/ccb74552-50a4-4bdb-b04e-06857caa8f38" /> </td> </tr> </table> **Clicking on "Learn more" in the flyout takes you to the [upgrade guide](https://kibana_bk_207091.docs-preview.app.elstc.co/guide/en/kibana/master/breaking-changes-summary.html#breaking-207091)** <img width="731" alt="upgrade_notes" src="https://github.com/user-attachments/assets/b8b471ea-98c7-4b07-91db-b1630c382554" /> ## Testing Once you send a request to one of the deprecated endpoints it should show up in Upgrade Assistant at `<basePath>/app/management/stack/upgrade_assistant/kibana_deprecations`. Please refer to [this ticket](elastic#193184) for the list of deprecated endpoints. Work started on: 16-Jan-2025
nikitaindik
added a commit
that referenced
this issue
Jan 22, 2025
…ssistant (#207091) (#207882) # Backport This will backport the following commits from `main` to `8.x`: - [[Security Solution] Show deprecated bulk endpoints in Upgrade Assistant (#207091)](#207091) <!--- Backport version: 9.6.4 --> ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sorenlouv/backport) <!--BACKPORT [{"author":{"name":"Nikita Indik","email":"[email protected]"},"sourceCommit":{"committedDate":"2025-01-22T16:36:24Z","message":"[Security Solution] Show deprecated bulk endpoints in Upgrade Assistant (#207091)\n\n**Partially addresses: https://github.com/elastic/kibana/issues/193184**\n\n## Summary\nWe are going to remove our deprecated [bulk action\nendpoints](#193184) in v9.0.0.\nThey are already unavailable in `main`.\n\nThis PR makes deprecated bulk endpoints visible in Upgrade Assistant.\nAlso, it adds an upgrade guide to the documentation to help users\ntransition to supported endpoints.\n\n⚠️ This PR temporarily adds the deprecated endpoints back to\n`register_routes.ts`. This is needed to make merging changes easier.\nI'll open up a follow up PR for `main` that will delete these endpoints\nfrom `9.0`. Will do it once this PR is merged.\n\n## Screenshots\n**Deprecated endpoints visible in Upgrade Assistant table**\n<img width=\"1276\" alt=\"Schermafbeelding 2025-01-21 om 11 27 53\"\nsrc=\"https://github.com/user-attachments/assets/909c7a20-31d9-46bb-89ec-b409550074e4\"\n/>\n\n**Clicking on a table item opens a flyout with more info**\n<table>\n <tr>\n <td>\n<img width=\"1270\" alt=\"patch_update\"\nsrc=\"https://github.com/user-attachments/assets/8e99459d-1ea1-40c4-936c-23074c02cd6f\"\n/>\n </td>\n <td>\n<img width=\"1270\" alt=\"post_create\"\nsrc=\"https://github.com/user-attachments/assets/6e734e97-4cf4-4d96-9f8d-51efeb3977ad\"\n/>\n </td>\n </tr>\n <tr>\n <td>\n<img width=\"1270\" alt=\"put_update\"\nsrc=\"https://github.com/user-attachments/assets/d5b08e16-bf49-475d-81a9-fe5654483e1d\"\n/>\n </td>\n <td>\n<img width=\"1271\" alt=\"post_delete\"\nsrc=\"https://github.com/user-attachments/assets/ccb74552-50a4-4bdb-b04e-06857caa8f38\"\n/>\n </td>\n </tr>\n</table>\n\n**Clicking on \"Learn more\" in the flyout takes you to the [upgrade\nguide](https://kibana_bk_207091.docs-preview.app.elstc.co/guide/en/kibana/master/breaking-changes-summary.html#breaking-207091)**\n<img width=\"731\" alt=\"upgrade_notes\"\nsrc=\"https://github.com/user-attachments/assets/b8b471ea-98c7-4b07-91db-b1630c382554\"\n/>\n\n\n## Testing\nOnce you send a request to one of the deprecated endpoints it should\nshow up in Upgrade Assistant at\n`<basePath>/app/management/stack/upgrade_assistant/kibana_deprecations`.\nPlease refer to [this\nticket](#193184) for the list of\ndeprecated endpoints.\n\nWork started on: 16-Jan-2025","sha":"33145379e57825f022dffa8405ded308d5eba8d0","branchLabelMapping":{"^v9.0.0$":"main","^v8.18.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:skip","v9.0.0","Team:Detections and Resp","Team: SecuritySolution","Feature:Rule Management","Team:Detection Rule Management","ui-copy","ci:cloud-deploy","ci:project-deploy-security","backport:version","v8.18.0"],"title":"[Security Solution] Show deprecated bulk endpoints in Upgrade Assistant","number":207091,"url":"https://github.com/elastic/kibana/pull/207091","mergeCommit":{"message":"[Security Solution] Show deprecated bulk endpoints in Upgrade Assistant (#207091)\n\n**Partially addresses: https://github.com/elastic/kibana/issues/193184**\n\n## Summary\nWe are going to remove our deprecated [bulk action\nendpoints](#193184) in v9.0.0.\nThey are already unavailable in `main`.\n\nThis PR makes deprecated bulk endpoints visible in Upgrade Assistant.\nAlso, it adds an upgrade guide to the documentation to help users\ntransition to supported endpoints.\n\n⚠️ This PR temporarily adds the deprecated endpoints back to\n`register_routes.ts`. This is needed to make merging changes easier.\nI'll open up a follow up PR for `main` that will delete these endpoints\nfrom `9.0`. Will do it once this PR is merged.\n\n## Screenshots\n**Deprecated endpoints visible in Upgrade Assistant table**\n<img width=\"1276\" alt=\"Schermafbeelding 2025-01-21 om 11 27 53\"\nsrc=\"https://github.com/user-attachments/assets/909c7a20-31d9-46bb-89ec-b409550074e4\"\n/>\n\n**Clicking on a table item opens a flyout with more info**\n<table>\n <tr>\n <td>\n<img width=\"1270\" alt=\"patch_update\"\nsrc=\"https://github.com/user-attachments/assets/8e99459d-1ea1-40c4-936c-23074c02cd6f\"\n/>\n </td>\n <td>\n<img width=\"1270\" alt=\"post_create\"\nsrc=\"https://github.com/user-attachments/assets/6e734e97-4cf4-4d96-9f8d-51efeb3977ad\"\n/>\n </td>\n </tr>\n <tr>\n <td>\n<img width=\"1270\" alt=\"put_update\"\nsrc=\"https://github.com/user-attachments/assets/d5b08e16-bf49-475d-81a9-fe5654483e1d\"\n/>\n </td>\n <td>\n<img width=\"1271\" alt=\"post_delete\"\nsrc=\"https://github.com/user-attachments/assets/ccb74552-50a4-4bdb-b04e-06857caa8f38\"\n/>\n </td>\n </tr>\n</table>\n\n**Clicking on \"Learn more\" in the flyout takes you to the [upgrade\nguide](https://kibana_bk_207091.docs-preview.app.elstc.co/guide/en/kibana/master/breaking-changes-summary.html#breaking-207091)**\n<img width=\"731\" alt=\"upgrade_notes\"\nsrc=\"https://github.com/user-attachments/assets/b8b471ea-98c7-4b07-91db-b1630c382554\"\n/>\n\n\n## Testing\nOnce you send a request to one of the deprecated endpoints it should\nshow up in Upgrade Assistant at\n`<basePath>/app/management/stack/upgrade_assistant/kibana_deprecations`.\nPlease refer to [this\nticket](#193184) for the list of\ndeprecated endpoints.\n\nWork started on: 16-Jan-2025","sha":"33145379e57825f022dffa8405ded308d5eba8d0"}},"sourceBranch":"main","suggestedTargetBranches":["8.x"],"targetPullRequestStates":[{"branch":"main","label":"v9.0.0","branchLabelMappingKey":"^v9.0.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/207091","number":207091,"mergeCommit":{"message":"[Security Solution] Show deprecated bulk endpoints in Upgrade Assistant (#207091)\n\n**Partially addresses: https://github.com/elastic/kibana/issues/193184**\n\n## Summary\nWe are going to remove our deprecated [bulk action\nendpoints](#193184) in v9.0.0.\nThey are already unavailable in `main`.\n\nThis PR makes deprecated bulk endpoints visible in Upgrade Assistant.\nAlso, it adds an upgrade guide to the documentation to help users\ntransition to supported endpoints.\n\n⚠️ This PR temporarily adds the deprecated endpoints back to\n`register_routes.ts`. This is needed to make merging changes easier.\nI'll open up a follow up PR for `main` that will delete these endpoints\nfrom `9.0`. Will do it once this PR is merged.\n\n## Screenshots\n**Deprecated endpoints visible in Upgrade Assistant table**\n<img width=\"1276\" alt=\"Schermafbeelding 2025-01-21 om 11 27 53\"\nsrc=\"https://github.com/user-attachments/assets/909c7a20-31d9-46bb-89ec-b409550074e4\"\n/>\n\n**Clicking on a table item opens a flyout with more info**\n<table>\n <tr>\n <td>\n<img width=\"1270\" alt=\"patch_update\"\nsrc=\"https://github.com/user-attachments/assets/8e99459d-1ea1-40c4-936c-23074c02cd6f\"\n/>\n </td>\n <td>\n<img width=\"1270\" alt=\"post_create\"\nsrc=\"https://github.com/user-attachments/assets/6e734e97-4cf4-4d96-9f8d-51efeb3977ad\"\n/>\n </td>\n </tr>\n <tr>\n <td>\n<img width=\"1270\" alt=\"put_update\"\nsrc=\"https://github.com/user-attachments/assets/d5b08e16-bf49-475d-81a9-fe5654483e1d\"\n/>\n </td>\n <td>\n<img width=\"1271\" alt=\"post_delete\"\nsrc=\"https://github.com/user-attachments/assets/ccb74552-50a4-4bdb-b04e-06857caa8f38\"\n/>\n </td>\n </tr>\n</table>\n\n**Clicking on \"Learn more\" in the flyout takes you to the [upgrade\nguide](https://kibana_bk_207091.docs-preview.app.elstc.co/guide/en/kibana/master/breaking-changes-summary.html#breaking-207091)**\n<img width=\"731\" alt=\"upgrade_notes\"\nsrc=\"https://github.com/user-attachments/assets/b8b471ea-98c7-4b07-91db-b1630c382554\"\n/>\n\n\n## Testing\nOnce you send a request to one of the deprecated endpoints it should\nshow up in Upgrade Assistant at\n`<basePath>/app/management/stack/upgrade_assistant/kibana_deprecations`.\nPlease refer to [this\nticket](#193184) for the list of\ndeprecated endpoints.\n\nWork started on: 16-Jan-2025","sha":"33145379e57825f022dffa8405ded308d5eba8d0"}},{"branch":"8.x","label":"v8.18.0","branchLabelMappingKey":"^v8.18.0$","isSourceBranch":false,"state":"NOT_CREATED"}]}] BACKPORT-->
nikitaindik
added a commit
that referenced
this issue
Jan 23, 2025
…7906) **Partially addresses: #193184 **Is a follow-up to: #207091 ## Summary This PR removes deprecated bulk action API endpoints from router, making them unavailable in `v9.0.0` and Serverless. We've already added an upgrade guide for users of these endpoints in #207091. Once our team has more free capacity, we'll open another PR to properly remove route handlers and associated code (tests, utils, etc.) Work started on: 22-Jan-2025
viduni94
pushed a commit
to viduni94/kibana
that referenced
this issue
Jan 23, 2025
…nt (elastic#207091) **Partially addresses: elastic#193184 ## Summary We are going to remove our deprecated [bulk action endpoints](elastic#193184) in v9.0.0. They are already unavailable in `main`. This PR makes deprecated bulk endpoints visible in Upgrade Assistant. Also, it adds an upgrade guide to the documentation to help users transition to supported endpoints.⚠️ This PR temporarily adds the deprecated endpoints back to `register_routes.ts`. This is needed to make merging changes easier. I'll open up a follow up PR for `main` that will delete these endpoints from `9.0`. Will do it once this PR is merged. ## Screenshots **Deprecated endpoints visible in Upgrade Assistant table** <img width="1276" alt="Schermafbeelding 2025-01-21 om 11 27 53" src="https://github.com/user-attachments/assets/909c7a20-31d9-46bb-89ec-b409550074e4" /> **Clicking on a table item opens a flyout with more info** <table> <tr> <td> <img width="1270" alt="patch_update" src="https://github.com/user-attachments/assets/8e99459d-1ea1-40c4-936c-23074c02cd6f" /> </td> <td> <img width="1270" alt="post_create" src="https://github.com/user-attachments/assets/6e734e97-4cf4-4d96-9f8d-51efeb3977ad" /> </td> </tr> <tr> <td> <img width="1270" alt="put_update" src="https://github.com/user-attachments/assets/d5b08e16-bf49-475d-81a9-fe5654483e1d" /> </td> <td> <img width="1271" alt="post_delete" src="https://github.com/user-attachments/assets/ccb74552-50a4-4bdb-b04e-06857caa8f38" /> </td> </tr> </table> **Clicking on "Learn more" in the flyout takes you to the [upgrade guide](https://kibana_bk_207091.docs-preview.app.elstc.co/guide/en/kibana/master/breaking-changes-summary.html#breaking-207091)** <img width="731" alt="upgrade_notes" src="https://github.com/user-attachments/assets/b8b471ea-98c7-4b07-91db-b1630c382554" /> ## Testing Once you send a request to one of the deprecated endpoints it should show up in Upgrade Assistant at `<basePath>/app/management/stack/upgrade_assistant/kibana_deprecations`. Please refer to [this ticket](elastic#193184) for the list of deprecated endpoints. Work started on: 16-Jan-2025
viduni94
pushed a commit
to viduni94/kibana
that referenced
this issue
Jan 23, 2025
…stic#207906) **Partially addresses: elastic#193184 **Is a follow-up to: elastic#207091 ## Summary This PR removes deprecated bulk action API endpoints from router, making them unavailable in `v9.0.0` and Serverless. We've already added an upgrade guide for users of these endpoints in elastic#207091. Once our team has more free capacity, we'll open another PR to properly remove route handlers and associated code (tests, utils, etc.) Work started on: 22-Jan-2025
qn895
pushed a commit
to qn895/kibana
that referenced
this issue
Jan 23, 2025
…stic#207906) **Partially addresses: elastic#193184 **Is a follow-up to: elastic#207091 ## Summary This PR removes deprecated bulk action API endpoints from router, making them unavailable in `v9.0.0` and Serverless. We've already added an upgrade guide for users of these endpoints in elastic#207091. Once our team has more free capacity, we'll open another PR to properly remove route handlers and associated code (tests, utils, etc.) Work started on: 22-Jan-2025
This was referenced Jan 24, 2025
Created a separate issue to handle leftovers. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
9.0 candidate
Breaking Change
Feature:Rule Management
Security Solution Detection Rule Management area
Team:Detection Rule Management
Security Detection Rule Management Team
Team:Detections and Resp
Security Detection Response Team
Team: SecuritySolution
Security Solutions Team working on SIEM, Endpoint, Timeline, Resolver, etc.
v9.0.0
Related to: https://github.com/elastic/security-team/issues/9707 (internal), https://github.com/elastic/security-team/issues/9691 (internal), https://github.com/elastic/security-team/issues/7242 (internal)
Breaking change proposal: https://github.com/elastic/dev/issues/2772 (internal)
Docs ticket: elastic/security-docs#5981
PR (makes endpoints visible in Upgrade Assistant): #207091
Summary
We have deprecated certain bulk API endpoints that we don't intend to expose neither in Serverless, nor in the 9.0 stack version. These deprecated APIs are documented here:
We should unregister these endpoints in the
main
branch. This will disable them in Serverless (we want to do that before GA) and in the upcoming 9.0 version. We can consider completely removing their code from the repo.This doesn't apply to the bulk actions endpoint.
Deprecation period
All these endpoints have been deprecated since Kibana
v8.2
released in May 2022, which makes the deprecation period of more than 2 years:Documentation
Please open a docs ticket for documenting this breaking change in 9.0.
Also, we'd probably need to think about what should we do with the OpenAPI specs to make sure that the user of the API reference website understands that these endpoints are not available in Serverless and stack 9.0, but available in stack 8.x.
Useful links
Todo
Tasks
The text was updated successfully, but these errors were encountered: