Create or update an alias

Auth

Adds a data stream or index to an alias.

Required privileges

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

master_timeout string · default: 30s: Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.
timeout string · default: 30s: Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.

filter {} Query: Query used to limit documents the alias can access.
index_routing 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_write_index 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.
routing string: Value used to route indexing and search operations to a specific shard. Data stream aliases don’t support this parameter.
search_routing 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.

application/json

acknowledged boolean required: For a successful response, this value is always true. On failure, an exception is returned instead.
errors boolean The Elastic Stack includes Elastic's core products such as Elasticsearch, Kibana, Logstash, and Beats. Availability Generally available since 8.14 This functionality is generally available and ready for production usage. Unless stated otherwise on the page, this functionality is available when your Elastic Stack is deployed on Elastic Cloud Hosted, Elastic Cloud Enterprise, Elastic Cloud on Kubernetes, and self-managed environments. This documentation corresponds to the latest patch available for each minor version. If you're not using the latest patch, check the release notes for changes.: If true, at least one alias action failed. The request still returns HTTP 200.