IMPORTANT: elasticsearch.js has been replaced by the new Elasticsearch JavaScript client. We strongly advise you to migrate to the new client. To learn more, see the migration guide.

« indices.open indices.putMapping »
Elastic Docs ›elasticsearch.js ›7.0 API

indices.putAlias

edit

indices.putAlias

edit
client.indices.putAlias([params, [callback]])

Create an alias for a specific index/indices.

Check the API Conventions and the elasticsearch docs for more information pertaining to this method.

Params

timeout

DurationString — Explicit timestamp for the document

masterTimeout

DurationString — Specify timeout for connection to master

index

String, String[], Boolean — A comma-separated list of index names the alias should point to (supports wildcards); use _all to perform the operation on all indices.

name

String — The name of the alias to be created or updated

body

Object, JSON — An optional request body, as either JSON or a JSON serializable object. See the elasticsearch docs for details about what can be specified here.

back to top

« indices.open indices.putMapping »