Home

Curator Documentation

Like a museum curator manages the exhibits and collections on display, Elasticsearch Curator helps you curate, or manage your time-series indices, with commands like:

delete
optimize
close
snapshot
alias

…and more!

Browse through the documentation here for more information.

Curator API Documentation

The documentation in this wiki is meant to bridge the Curator API documentation and the functionality provided by the entry-point script usually installed by pip as /usr/bin/curator or /usr/local/bin/curator. This entry-point script is actually called curator_script.py and will reside in the dist-packages/curator path for your particular Python installation. Having this script still callable as curator is intended to preserve reverse-compatibility.

New in Curator 2.0, the API calls and the wrapper script (curator_script.py) have been separated. This allows you to write your own scripts to accomplish similar goals, or even new and different things with the Curator API, and the Elasticsearch Python API.

Curator script vs. Curator API

The wiki, being extensible, can contain information about both the API and the script. Unless otherwise specified, however, this wiki documentation should be presumed to refer to the behavior of the Curator script.

All-in-One documentation

Usage

• Installation
• Examples
• Combined Arguments
• Logstash
• FAQ

Commands

• alias Alias (and unalias)
• allocation Routing Allocation (Shard and Index-level routing)
• bloom Disable Bloom Filter Cache
• close Close indices
• delete Delete indices
• optimize Optimize indices
• show Show indices and snapshots
• snapshot Snapshot

Flags and settings

• Help
• Port (See Host).
• Separator (deprecated since v1.2.0)
• Dry Run (execute, but make no changes)
• Show Show indices and snapshots
• URL Prefix
• Auth
• SSL
• Version
• Master-Only
• Logfile
• Loglevel
• Logformat
• Debug
• Older-Than
• Time-Unit
• Timestring

Errata

• Combined Arguments