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.refresh indices.segments »
Elastic Docs ›elasticsearch.js ›7.3 API

indices.rollover

edit

indices.rollover

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

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

Params

includeTypeName

Boolean — Whether a type should be included in the body of the mappings.

timeout

DurationString — Explicit operation timeout

dryRun

Boolean — If set to true the rollover action will only be validated but not actually performed even if a condition matches. The default is false

masterTimeout

DurationString — Specify timeout for connection to master

waitForActiveShards

String — Set the number of active shards to wait for on the newly created rollover index before the operation returns.

alias

String — The name of the alias to rollover

newIndex

String — The name of the rollover index

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.refresh indices.segments »