Create or update an alias | Elasticsearch API documentation (original) (raw)

Dismiss highlight Show more

Path parameters

• index
  string | array[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.
• Alias to update. If the alias doesn’t exist, the request creates it. Index alias names support date math.

Query parameters

• 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.
• Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.

application/json

Body

• An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.
  External documentation
• 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.

Responses

• 200 application/json
  Hide response attribute Show response attribute object
  • For a successful response, this value is always true. On failure, an exception is returned instead.