Add an index block

PUT /{index}/_block/{block}

Copy endpoint

Add an index block to an index. Index blocks limit the operations allowed on an index by blocking specific operation types.

Parameters

path Path Parameters

Name Type

Name	Type
`index` required A comma-separated list or wildcard expression of index names used to limit the request. By default, you must explicitly name the indices you are adding blocks to. To allow the adding of blocks to indices with `_all`, `*`, or other wildcard expressions, change the `action.destructive_requires_name` setting to `false`. You can update this setting in the `elasticsearch.yml` file or by using the cluster update settings API.	type TypesIndices = type TypesIndexName = string \| type TypesIndexName = string[]
`block` required The block type to add to the index.	type IndicesTypesIndicesBlockOptions = "metadata" \| "read" \| "read_only" \| "write"

index required

A comma-separated list or wildcard expression of index names used to limit the request. By default, you must explicitly name the indices you are adding blocks to. To allow the adding of blocks to indices with _all, *, or other wildcard expressions, change the action.destructive_requires_name setting to false. You can update this setting in the elasticsearch.yml file or by using the cluster update settings API.

type TypesIndices = type TypesIndexName = string | type TypesIndexName = string[]

block required

The block type to add to the index.

type IndicesTypesIndicesBlockOptions = "metadata" | "read" | "read_only" | "write"

query Query Parameters

Name	Type
`allow_no_indices` If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request targeting `foo,bar` returns an error if an index starts with `foo` but no index starts with `bar`.	boolean
`expand_wildcards` The type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. It supports comma-separated values, such as `open,hidden`.	type TypesExpandWildcards = type TypesExpandWildcard = "all" \| "open" \| "closed" \| "hidden" \| "none" \| type TypesExpandWildcard = "all" \| "open" \| "closed" \| "hidden" \| "none"[]
`ignore_unavailable` If `false`, the request returns an error if it targets a missing or closed index.	boolean
`master_timeout` The period to wait for the master node. If the master node is not available before the timeout expires, the request fails and returns an error. It can also be set to `-1` to indicate that the request should never timeout.	type TypesDuration = string \| "-1" \| "0"
`timeout` The period to wait for a response from all relevant nodes in the cluster after updating the cluster metadata. If no response is received before the timeout expires, the cluster metadata update still applies but the response will indicate that it was not completely acknowledged. It can also be set to `-1` to indicate that the request should never timeout.	type TypesDuration = string \| "-1" \| "0"

Responses

200 application/json

{ acknowledged: boolean;shards_acknowledged: boolean;indices:

IndicesAddBlockAddIndicesBlockStatus

interface IndicesAddBlockAddIndicesBlockStatus {
name: TypesIndexName;
blocked: boolean;
}

[]; }