Add RemoveBlock API to allow `DELETE /{index}/_block/{block}` by HyunsangHan · Pull Request #129128 · elastic/elasticsearch

HyunsangHan · 2025-06-08T23:44:12Z

Summary

Introduces a new RemoveBlock API that complements the existing AddBlock API by allowing users to remove index blocks using DELETE /{index}/_block/{block}.

Resolves: #128966

Background

Currently, users add blocks via the AddBlock API (PUT /{index}/_block/{block}) but must remove them through the more generic Settings API (PUT /{index}/_settings).

What’s Changed

Core

Introduced new classes: RemoveIndexBlockRequest, RemoveIndexBlockResponse, TransportRemoveIndexBlockAction.
Added removeIndexBlock to MetadataIndexStateService.

REST API

New endpoint: DELETE /{index}/_block/{block}
Added new API spec: indices.remove_block.json
Response uses AcknowledgedResponse (no shard-level confirmation required)

Features

Integrated with security and operator privileges.
Safe to re-run (idempotent behavior).

Compatibility

Fully backward compatible
Existing Settings API remains unchanged
AddBlock API untouched

Testing

Unit tests for service logic
Integration tests covering full API usage and edge cases
REST YAML tests for endpoint validation
Security tests for permission checks

- Add RemoveIndexBlockRequest/Response/ClusterStateUpdateRequest classes - Add removeIndexBlock method to MetadataIndexStateService Provides core service infrastructure for removing index blocks.

- Add TransportRemoveIndexBlockAction and RemoveIndexBlockRequestBuilder - Add prepareRemoveBlock() and removeBlock() methods to IndicesAdminClient - Register RemoveBlock actions in ActionModule - Add integration tests and security permissions

- Add RestRemoveIndexBlockAction for DELETE /{index}/_block/{block} - Add indices.remove_block.json API specification - Update YAML REST tests and documentation - Remove shards_acknowledged field references from docs Completes public HTTP interface providing symmetry with addBlock API.

cla-checker-service · 2025-06-08T23:44:17Z

💚 CLA has been signed

elasticsearchmachine · 2025-06-10T09:16:39Z

Pinging @elastic/es-data-management (Team:Data Management)

nielsbauman

Hi @HyunsangHan, thank you very much for your contribution to Elasticsearch! The PR is already looking good, I just have a few small comments for now - I need to have another look later on. I also pushed some changes myself, as they're hard to explain, but I didn't want to completely hijack your PR, so I'll let you take care of the remaining changes.

.../src/main/java/org/elasticsearch/action/admin/indices/readonly/RemoveIndexBlockResponse.java

...r/src/main/java/org/elasticsearch/action/admin/indices/readonly/RemoveIndexBlockRequest.java

rest-api-spec/src/yamlRestTest/resources/rest-api-spec/test/indices.blocks/10_basic.yml

.../src/main/java/org/elasticsearch/action/admin/indices/readonly/RemoveIndexBlockResponse.java

nielsbauman · 2025-06-11T11:21:27Z

buildkite test this

Replace implicit default timeouts with explicit parameters in constructor to improve code clarity and follow established patterns.

nielsbauman

I just noticed I didn't actually push my commit last time, so I just did so. I added a few more comments. Thanks for incorporating my previous comments so soon!

rest-api-spec/src/yamlRestTest/resources/rest-api-spec/test/indices.blocks/10_basic.yml

server/src/internalClusterTest/java/org/elasticsearch/blocks/SimpleBlocksIT.java

docs/reference/elasticsearch/index-settings/index-block.md

rest-api-spec/src/main/resources/rest-api-spec/api/indices.remove_block.json

...rc/internalClusterTest/java/org/elasticsearch/operateAllIndices/DestructiveOperationsIT.java

github-actions · 2025-06-18T21:29:31Z

🔍 Preview links for changed docs:

docs/reference/elasticsearch/index-settings/index-block.md

🔔 The preview site may take up to 3 minutes to finish building. These links will become live once it completes.

nielsbauman · 2025-06-18T21:29:55Z

buildkite test this

nielsbauman · 2025-06-19T18:21:21Z

buildkite test this

nielsbauman

Hi @HyunsangHan, sorry for the late reply. I was discussing the changes with some colleagues who are more familiar with the inner workings of blocks. I added two more small comments, after that I think we're good to go.

server/src/main/java/org/elasticsearch/cluster/metadata/MetadataIndexStateService.java

- Add logic to MetadataIndexStateService.removeIndexBlock() to automatically clear VERIFIED_READ_ONLY_SETTING when no write-blocking constraints remain

server/src/main/java/org/elasticsearch/cluster/metadata/MetadataIndexStateService.java

nielsbauman · 2025-06-24T18:42:30Z

buildkite test this

nielsbauman

LGTM! Thank you very much for your contribution and iterations on this PR, @HyunsangHan!

HyunsangHan · 2025-06-24T23:25:06Z

@nielsbauman
Thank you! 🙌 I really enjoyed working through the iterations and learned a lot from the process.
Appreciate all your feedback and support!

…c#129128) Introduces a new `RemoveBlock` API that complements the existing `AddBlock` API by allowing users to remove index blocks using `DELETE /{index}/_block/{block}`. Resolves elastic#128966 --------- Co-authored-by: Niels Bauman <nielsbauman@gmail.com>

Follow-up of elastic/elasticsearch#129128

injae-kim · 2025-06-27T11:58:37Z

Awesome work @HyunsangHan !! 👏👏👏

HyunsangHan · 2025-06-27T17:57:20Z

@nielsbauman
Hi, Niels!
I noticed that this feature is already reflected in the official documentation.
I've opened an issue to report it: #130242

nielsbauman · 2025-06-27T18:02:27Z

Hi @HyunsangHan, thank you very much for addressing that and opening a new issue. I've asked someone from our docs team to have a look at what's going on there.

* Add index block removal API Follow-up of elastic/elasticsearch#129128 * Fix block enum * Add doc-id to table * Fix lint * Move IndicesBlockOptions and IndicesBlockStatus to indices/_types It's breaking but avoids duplicating the type names, which is forbidden. * Separate BlockStatus as it is different * Rename response example file * Fix response fields * Add index privilege --------- Co-authored-by: Quentin Pradet <quentin.pradet@elastic.co>

* Add index block removal API Follow-up of elastic/elasticsearch#129128 * Fix block enum * Add doc-id to table * Fix lint * Move IndicesBlockOptions and IndicesBlockStatus to indices/_types It's breaking but avoids duplicating the type names, which is forbidden. * Separate BlockStatus as it is different * Rename response example file * Fix response fields * Add index privilege --------- Co-authored-by: Quentin Pradet <quentin.pradet@elastic.co> (cherry picked from commit e668a98)

* Add index block removal API Follow-up of elastic/elasticsearch#129128 * Fix block enum * Add doc-id to table * Fix lint * Move IndicesBlockOptions and IndicesBlockStatus to indices/_types It's breaking but avoids duplicating the type names, which is forbidden. * Separate BlockStatus as it is different * Rename response example file * Fix response fields * Add index privilege --------- (cherry picked from commit e668a98) Co-authored-by: Niels Bauman <33722607+nielsbauman@users.noreply.github.com> Co-authored-by: Quentin Pradet <quentin.pradet@elastic.co>

HyunsangHan · 2025-08-16T05:56:19Z

We can find RemoveBlock API in the document after recent release:
https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-remove-block

HyunsangHan added 3 commits June 9, 2025 00:59

Add RemoveBlock core service implementation

20e57fe

- Add RemoveIndexBlockRequest/Response/ClusterStateUpdateRequest classes - Add removeIndexBlock method to MetadataIndexStateService Provides core service infrastructure for removing index blocks.

elasticsearchmachine added v9.1.0 needs:triage Requires assignment of a team area label external-contributor Pull request authored by a developer outside the Elasticsearch team labels Jun 8, 2025

HyunsangHan closed this Jun 8, 2025

HyunsangHan reopened this Jun 8, 2025

AI-IshanBhatt added the :Data Management/Indices APIs DO NOT USE. Use ":Distributed/Indices APIs" or ":StorageEngine/Templates" instead. label Jun 10, 2025

elasticsearchmachine added the Team:Data Management (obsolete) DO NOT USE. This team no longer exists. label Jun 10, 2025

elasticsearchmachine removed the needs:triage Requires assignment of a team area label label Jun 10, 2025

nielsbauman self-assigned this Jun 10, 2025

nielsbauman self-requested a review June 10, 2025 09:26

nielsbauman added the >enhancement label Jun 10, 2025

nielsbauman reviewed Jun 11, 2025

View reviewed changes

HyunsangHan added 3 commits June 11, 2025 23:40

Restore settings test and add new remove block test

4bc5893

Edit variable name and remove unnecessary overrides

383d1ce

Pass timeout parameters directly in RemoveIndexBlockRequest constructor

017a4f0

Replace implicit default timeouts with explicit parameters in constructor to improve code clarity and follow established patterns.

HyunsangHan requested a review from nielsbauman June 11, 2025 15:10

nielsbauman added 3 commits June 13, 2025 09:33

Move cluster task logic to transport action

53895fc

Use ProjectState

a5c86d0

Make request cancelleable

9f57645

nielsbauman reviewed Jun 13, 2025

View reviewed changes

HyunsangHan added 4 commits June 15, 2025 18:47

Fix broken test cases using prepareRemoveBlock

38b06aa

Update remove_block API test to use capabilities feature

131bfb0

Remove redundant description in index-block.md

7c602bc

Add new line to the end of indices.remove_block.json

2d50a14

Merge branch 'main' into api-remove-index-block

0ff2031

nielsbauman and others added 2 commits June 18, 2025 18:42

Add changelog

15461ad

Merge branch 'main' into api-remove-index-block

1a2e208

nielsbauman reviewed Jun 24, 2025

View reviewed changes

server/src/main/java/org/elasticsearch/cluster/metadata/MetadataIndexStateService.java Outdated Show resolved Hide resolved

server/src/main/java/org/elasticsearch/cluster/metadata/MetadataIndexStateService.java Show resolved Hide resolved

Remove VERIFIED_READ_ONLY_SETTING when write blocks are cleared

bc938f8

- Add logic to MetadataIndexStateService.removeIndexBlock() to automatically clear VERIFIED_READ_ONLY_SETTING when no write-blocking constraints remain

HyunsangHan requested a review from nielsbauman June 24, 2025 16:57

nielsbauman reviewed Jun 24, 2025

View reviewed changes

server/src/main/java/org/elasticsearch/cluster/metadata/MetadataIndexStateService.java Outdated Show resolved Hide resolved

nielsbauman added 2 commits June 24, 2025 15:42

Refactor hasBlock

6f59e01

Merge branch 'main' into api-remove-index-block

9fe16a4

nielsbauman approved these changes Jun 24, 2025

View reviewed changes

nielsbauman enabled auto-merge (squash) June 24, 2025 18:44

nielsbauman merged commit d16271b into elastic:main Jun 24, 2025
34 checks passed

nielsbauman added a commit to elastic/elasticsearch-specification that referenced this pull request Jun 25, 2025

Add index block removal API

686c483

Follow-up of elastic/elasticsearch#129128

nielsbauman mentioned this pull request Jun 25, 2025

Add index block removal API elastic/elasticsearch-specification#4684

Merged

HyunsangHan mentioned this pull request Jun 27, 2025

Documentation showing unreleased feature (Remove Index Block API) #130242

Closed

kilfoyle mentioned this pull request Jun 27, 2025

[Docs] Revert addition of 'Remove index block API' #130248

Merged

HyunsangHan mentioned this pull request Dec 28, 2025

📢오픈소스 기여모임 - 운영진 소개 opensource-contributors-group/opensource-contributors#2

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add RemoveBlock API to allow `DELETE /{index}/_block/{block}`#129128

Add RemoveBlock API to allow `DELETE /{index}/_block/{block}`#129128
nielsbauman merged 23 commits intoelastic:mainfrom
HyunsangHan:api-remove-index-block

HyunsangHan commented Jun 8, 2025

cla-checker-service bot commented Jun 8, 2025 •

edited

Loading

elasticsearchmachine commented Jun 10, 2025

nielsbauman left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

nielsbauman commented Jun 11, 2025

nielsbauman left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

github-actions bot commented Jun 18, 2025 •

edited

Loading

nielsbauman commented Jun 18, 2025

nielsbauman commented Jun 19, 2025

nielsbauman left a comment

Uh oh!

Uh oh!

Uh oh!

nielsbauman commented Jun 24, 2025

nielsbauman left a comment

Uh oh!

HyunsangHan commented Jun 24, 2025

injae-kim commented Jun 27, 2025

HyunsangHan commented Jun 27, 2025

nielsbauman commented Jun 27, 2025

HyunsangHan commented Aug 16, 2025

Labels

5 participants

Conversation

HyunsangHan commented Jun 8, 2025

Summary

Background

What’s Changed

Core

REST API

Features

Compatibility

Testing

cla-checker-service bot commented Jun 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

elasticsearchmachine commented Jun 10, 2025

nielsbauman left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

nielsbauman commented Jun 11, 2025

nielsbauman left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

github-actions bot commented Jun 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

nielsbauman commented Jun 18, 2025

nielsbauman commented Jun 19, 2025

nielsbauman left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

nielsbauman commented Jun 24, 2025

nielsbauman left a comment

Choose a reason for hiding this comment

Uh oh!

HyunsangHan commented Jun 24, 2025

injae-kim commented Jun 27, 2025

HyunsangHan commented Jun 27, 2025

nielsbauman commented Jun 27, 2025

HyunsangHan commented Aug 16, 2025

Labels

5 participants

cla-checker-service bot commented Jun 8, 2025 •

edited

Loading

github-actions bot commented Jun 18, 2025 •

edited

Loading