IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.

« Create index API Create or update component template API »

› › ›

Create or update alias API

edit

Create or update alias API

edit

Adds a data stream or index to an alias.

response = client.indices.put_alias(
  index: 'my-data-stream',
  name: 'my-alias'
)
puts response

PUT my-data-stream/_alias/my-alias

Request

edit

POST <target>/_alias/<alias>

POST <target>/_aliases/<alias>

PUT <target>/_alias/<alias>

PUT <target>/_aliases/<alias>

Prerequisites

edit

If the Elasticsearch security features are enabled, you must have the manage index privilege for the alias and its data streams or indices.

Path parameters

edit

<alias>: (Required, string) Alias to update. If the alias doesn’t exist, the request creates it. Index alias names support date math.
<target>: (Required, string) Comma-separated list of data streams or indices to add. Supports wildcards (*). Wildcard patterns that match both data streams and indices return an error.

Query parameters

edit

master_timeout: (Optional, time units) 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. Defaults to 30s. Can also be set to -1 to indicate that the request should never timeout.
timeout: (Optional, time units) Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. Defaults to 30s.

Request body

edit

filter

(Optional, Query DSL object Query used to limit documents the alias can access.

index_routing

(Optional, string) Value used to route indexing operations to a specific shard. If specified, this overwrites the routing value for indexing operations. Data stream aliases don’t support this parameter.

is_hidden

(Optional, Boolean) If true, the alias is hidden. Defaults to false. All data streams or indices for the alias must have the same is_hidden value.

is_write_index

(Optional, Boolean) If true, sets the write index or data stream for the alias.

If an alias points to multiple indices or data streams and is_write_index isn’t set, the alias rejects write requests. If an index alias points to one index and is_write_index isn’t set, the index automatically acts as the write index. Data stream aliases don’t automatically set a write data stream, even if the alias points to one data stream.

must_exist

(Optional, Boolean) Affects the behavior when attempting to remove an alias which does not exist. If true, removing an alias which does not exist will cause all actions to fail. If false, removing an alias which does not exist will only cause that removal to fail. Defaults to false.

routing

(Optional, string) Value used to route indexing and search operations to a specific shard. Data stream aliases don’t support this parameter.

search_routing

(Optional, string) Value used to route search operations to a specific shard. If specified, this overwrites the routing value for search operations. Data stream aliases don’t support this parameter.

« Create index API Create or update component template API »