Roll over to a new index | Elasticsearch API (v8)

Roll over to a new index Added in 5.0.0

POST /{alias}/_rollover

Creates a new index for a data stream or index alias.

Path parameters

alias string Required

Name of the data stream or index alias to roll over.

Query parameters

dry_run boolean

If true, checks whether the current index satisfies the specified conditions but does not perform a rollover.
master_timeout string

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

Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.
wait_for_active_shards number | string

The number of shard copies that must be active before proceeding with the operation. Set to all or any positive integer up to the total number of shards in the index (number_of_replicas+1).

application/json

Body

aliases object

Aliases for the target index. Data streams do not support this parameter.
Hide aliases attribute Show aliases attribute object
- * object Additional properties
  
  Additional properties are allowed.
  Hide * attributes Show * attributes object
  
  filter object
  
  Additional properties are allowed.
  
  External documentation
  
  index_routing string
  
  is_hidden boolean
  
  If true, the alias is hidden. All indices for the alias must have the same is_hidden value.
  
  is_write_index boolean
  
  If true, the index is the write index for the alias.
  
  routing string
  
  search_routing string
conditions object

Additional properties are allowed.
Hide conditions attributes Show conditions attributes object
- min_age string
  
  A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
- max_age string
  
  A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
- max_age_millis number
  
  Time unit for milliseconds
- min_docs number
- max_docs number
- max_size number | string
  
  One of:
  _types:ByteSize number _types:ByteSize string
- max_size_bytes number
- min_size number | string
  
  One of:
  _types:ByteSize number _types:ByteSize string
- min_size_bytes number
- max_primary_shard_size number | string
  
  One of:
  _types:ByteSize number _types:ByteSize string
- max_primary_shard_size_bytes number
- min_primary_shard_size number | string
  
  One of:
  _types:ByteSize number _types:ByteSize string
- min_primary_shard_size_bytes number
- max_primary_shard_docs number
- min_primary_shard_docs number
mappings object

Additional properties are allowed.
Hide mappings attributes Show mappings attributes object
- all_field object
  
  Additional properties are allowed.
  Hide all_field attributes Show all_field attributes object
  
  analyzer string Required
  
  enabled boolean Required
  
  omit_norms boolean Required
  
  search_analyzer string Required
  
  similarity string Required
  
  store boolean Required
  
  store_term_vector_offsets boolean Required
  
  store_term_vector_payloads boolean Required
  
  store_term_vector_positions boolean Required
  
  store_term_vectors boolean Required
- date_detection boolean
- dynamic string
  
  Values are strict, runtime, true, or false.
- dynamic_date_formats array[string]
- dynamic_templates array[object]
- _field_names object
  
  Additional properties are allowed.
  Hide _field_names attribute Show _field_names attribute object
  
  enabled boolean Required
- index_field object
  
  Additional properties are allowed.
  Hide index_field attribute Show index_field attribute object
  
  enabled boolean Required
- _meta object
  Hide _meta attribute Show _meta attribute object
  
  * object Additional properties
  
  Additional properties are allowed.
- numeric_detection boolean
- properties object
- _routing object
  
  Additional properties are allowed.
  Hide _routing attribute Show _routing attribute object
  
  required boolean Required
- _size object
  
  Additional properties are allowed.
  Hide _size attribute Show _size attribute object
  
  enabled boolean Required
- _source object
  
  Additional properties are allowed.
  Hide _source attributes Show _source attributes object
  
  compress boolean
  
  compress_threshold string
  
  enabled boolean
  
  excludes array[string]
  
  includes array[string]
  
  mode string
  
  Values are disabled, stored, or synthetic.
- runtime object
  Hide runtime attribute Show runtime attribute object
  
  * object Additional properties
  
  Additional properties are allowed.
  
  Hide * attributes Show * attributes object
  
  fields object
  
  For type composite
  
  Hide fields attribute Show fields attribute object
  
  * object Additional properties
  
  Additional properties are allowed.
  
  Hide * attribute Show * attribute object
  
  type string Required
  
  Values are boolean, composite, date, double, geo_point, ip, keyword, long, or lookup.
  
  fetch_fields array[object]
  
  For type lookup
  
  Hide fetch_fields attributes Show fetch_fields attributes object
  
  field string Required
  
  Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
  
  format string
  
  format string
  
  A custom format for date type runtime fields.
  
  input_field string
  
  Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
  
  target_field string
  
  Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
  
  target_index string
  
  script object
  
  Additional properties are allowed.
  
  Hide script attributes Show script attributes object
  
  source string
  
  The script source.
  
  id string
  
  params object
  
  Specifies any named parameters that are passed into the script as variables. Use parameters instead of hard-coded values to decrease compile time.
  
  Hide params attribute Show params attribute object
  
  * object Additional properties
  
  Additional properties are allowed.
  
  lang string
  
  Any of:
  _types:ScriptLanguage string _types:ScriptLanguage string
  
  Values are painless, expression, mustache, or java.
  
  options object
  
  Hide options attribute Show options attribute object
  
  * string Additional properties
  
  type string Required
  
  Values are boolean, composite, date, double, geo_point, ip, keyword, long, or lookup.
- enabled boolean
- subobjects boolean
- _data_stream_timestamp object
  
  Additional properties are allowed.
  Hide _data_stream_timestamp attribute Show _data_stream_timestamp attribute object
  
  enabled boolean Required
settings object

Configuration options for the index. Data streams do not support this parameter.
Hide settings attribute Show settings attribute object
- * object Additional properties
  
  Additional properties are allowed.

Responses

200 application/json
Hide response attributes Show response attributes object
- acknowledged boolean Required
- conditions object Required
  
  Hide conditions attribute Show conditions attribute object
  
  * boolean Additional properties
- dry_run boolean Required
- new_index string Required
- old_index string Required
- rolled_over boolean Required
- shards_acknowledged boolean Required

POST /{alias}/_rollover

curl \
 -X POST http://api.example.com/{alias}/_rollover \
 -H "Content-Type: application/json" \
 -d '{"aliases":{"additionalProperty1":{"filter":{},"index_routing":"string","is_hidden":true,"is_write_index":true,"routing":"string","search_routing":"string"},"additionalProperty2":{"filter":{},"index_routing":"string","is_hidden":true,"is_write_index":true,"routing":"string","search_routing":"string"}},"conditions":{"min_age":"string","max_age":"string","":42.0,"min_docs":42.0,"max_docs":42.0,"max_size_bytes":42.0,"min_size_bytes":42.0,"max_primary_shard_size_bytes":42.0,"min_primary_shard_size_bytes":42.0,"max_primary_shard_docs":42.0,"min_primary_shard_docs":42.0},"mappings":{"all_field":{"analyzer":"string","enabled":true,"omit_norms":true,"search_analyzer":"string","similarity":"string","store":true,"store_term_vector_offsets":true,"store_term_vector_payloads":true,"store_term_vector_positions":true,"store_term_vectors":true},"date_detection":true,"dynamic":"strict","dynamic_date_formats":["string"],"dynamic_templates":[{}],"_field_names":{"enabled":true},"index_field":{"enabled":true},"_meta":{"additionalProperty1":{},"additionalProperty2":{}},"numeric_detection":true,"properties":{},"_routing":{"required":true},"_size":{"enabled":true},"_source":{"compress":true,"compress_threshold":"string","enabled":true,"excludes":["string"],"includes":["string"],"mode":"disabled"},"runtime":{"additionalProperty1":{"fields":{"additionalProperty1":{"type":"boolean"},"additionalProperty2":{"type":"boolean"}},"fetch_fields":[{"field":"string","format":"string"}],"format":"string","input_field":"string","target_field":"string","target_index":"string","script":{"source":"string","id":"string","params":{"additionalProperty1":{},"additionalProperty2":{}},"":"painless","options":{"additionalProperty1":"string","additionalProperty2":"string"}},"type":"boolean"},"additionalProperty2":{"fields":{"additionalProperty1":{"type":"boolean"},"additionalProperty2":{"type":"boolean"}},"fetch_fields":[{"field":"string","format":"string"}],"format":"string","input_field":"string","target_field":"string","target_index":"string","script":{"source":"string","id":"string","params":{"additionalProperty1":{},"additionalProperty2":{}},"":"painless","options":{"additionalProperty1":"string","additionalProperty2":"string"}},"type":"boolean"}},"enabled":true,"subobjects":true,"_data_stream_timestamp":{"enabled":true}},"settings":{"additionalProperty1":{},"additionalProperty2":{}}}'

Request examples

{
  "aliases": {
    "additionalProperty1": {
      "filter": {},
      "index_routing": "string",
      "is_hidden": true,
      "is_write_index": true,
      "routing": "string",
      "search_routing": "string"
    },
    "additionalProperty2": {
      "filter": {},
      "index_routing": "string",
      "is_hidden": true,
      "is_write_index": true,
      "routing": "string",
      "search_routing": "string"
    }
  },
  "conditions": {
    "min_age": "string",
    "max_age": "string",
    "": 42.0,
    "min_docs": 42.0,
    "max_docs": 42.0,
    "max_size_bytes": 42.0,
    "min_size_bytes": 42.0,
    "max_primary_shard_size_bytes": 42.0,
    "min_primary_shard_size_bytes": 42.0,
    "max_primary_shard_docs": 42.0,
    "min_primary_shard_docs": 42.0
  },
  "mappings": {
    "all_field": {
      "analyzer": "string",
      "enabled": true,
      "omit_norms": true,
      "search_analyzer": "string",
      "similarity": "string",
      "store": true,
      "store_term_vector_offsets": true,
      "store_term_vector_payloads": true,
      "store_term_vector_positions": true,
      "store_term_vectors": true
    },
    "date_detection": true,
    "dynamic": "strict",
    "dynamic_date_formats": [
      "string"
    ],
    "dynamic_templates": [
      {}
    ],
    "_field_names": {
      "enabled": true
    },
    "index_field": {
      "enabled": true
    },
    "_meta": {
      "additionalProperty1": {},
      "additionalProperty2": {}
    },
    "numeric_detection": true,
    "properties": {},
    "_routing": {
      "required": true
    },
    "_size": {
      "enabled": true
    },
    "_source": {
      "compress": true,
      "compress_threshold": "string",
      "enabled": true,
      "excludes": [
        "string"
      ],
      "includes": [
        "string"
      ],
      "mode": "disabled"
    },
    "runtime": {
      "additionalProperty1": {
        "fields": {
          "additionalProperty1": {
            "type": "boolean"
          },
          "additionalProperty2": {
            "type": "boolean"
          }
        },
        "fetch_fields": [
          {
            "field": "string",
            "format": "string"
          }
        ],
        "format": "string",
        "input_field": "string",
        "target_field": "string",
        "target_index": "string",
        "script": {
          "source": "string",
          "id": "string",
          "params": {
            "additionalProperty1": {},
            "additionalProperty2": {}
          },
          "": "painless",
          "options": {
            "additionalProperty1": "string",
            "additionalProperty2": "string"
          }
        },
        "type": "boolean"
      },
      "additionalProperty2": {
        "fields": {
          "additionalProperty1": {
            "type": "boolean"
          },
          "additionalProperty2": {
            "type": "boolean"
          }
        },
        "fetch_fields": [
          {
            "field": "string",
            "format": "string"
          }
        ],
        "format": "string",
        "input_field": "string",
        "target_field": "string",
        "target_index": "string",
        "script": {
          "source": "string",
          "id": "string",
          "params": {
            "additionalProperty1": {},
            "additionalProperty2": {}
          },
          "": "painless",
          "options": {
            "additionalProperty1": "string",
            "additionalProperty2": "string"
          }
        },
        "type": "boolean"
      }
    },
    "enabled": true,
    "subobjects": true,
    "_data_stream_timestamp": {
      "enabled": true
    }
  },
  "settings": {
    "additionalProperty1": {},
    "additionalProperty2": {}
  }
}

Response examples (200)

{
  "acknowledged": true,
  "conditions": {
    "additionalProperty1": true,
    "additionalProperty2": true
  },
  "dry_run": true,
  "new_index": "string",
  "old_index": "string",
  "rolled_over": true,
  "shards_acknowledged": true
}

Roll over to a new index Added in 5.0.0

Path parameters

Query parameters

Body

max_size number | string

min_size number | string

max_primary_shard_size number | string

min_primary_shard_size number | string

lang string

Responses