NOTE: You are looking at documentation for an older release. For the latest information, see the current release documentation.

› ›

indices.rollover

edit

indices.rollover

edit

client.indices.rollover({
  alias: string,
  new_index: string,
  include_type_name: boolean,
  timeout: string,
  dry_run: boolean,
  master_timeout: string,
  wait_for_active_shards: string,
  body: object
})

Reference

`alias`	`string` - The name of the alias to rollover
`new_index` or `newIndex`	`string` - The name of the rollover index
`include_type_name` or `includeTypeName`	`boolean` - Whether a type should be included in the body of the mappings.
`timeout`	`string` - Explicit operation timeout
`dry_run` or `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
`master_timeout` or `masterTimeout`	`string` - Specify timeout for connection to master
`wait_for_active_shards` or `waitForActiveShards`	`string` - Set the number of active shards to wait for on the newly created rollover index before the operation returns.
`body`	`object` - The conditions that needs to be met for executing rollover

« indices.refresh indices.segments »