Home

Curator Documentation for V3.0+

Like a museum curator manages the exhibits and collections on display, Elasticsearch Curator helps you curate, or manage your Elasticsearch indices.

• Installation
• Upgrading

Curator API Documentation (External)

The documentation in this wiki is intended 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.

Since Curator 2.0, the API calls and the command-line script 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 Command-Line Documentation (this wiki)

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 command-line, with commands like:

delete
optimize
close
snapshot
alias

…and more!

Browse through the documentation here for more information.

All-in-One documentation

Usage

• Installation
• Examples
• Exit-Codes
• 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
• open Open indices
• optimize Optimize indices
• replicas Change the number of indices shard Replicas
• show Show indices or snapshots
• snapshot Snapshot indices (Backup)

Flags and settings

• Help
• Port (See Host).
• Dry Run (execute, but make no changes)
• Show Show indices and snapshots
• URL Prefix
• Auth
• SSL
• Version
• Master-Only
• Logfile
• Loglevel
• Logformat
• Debug

Index Selection Flags

• Newer-Than
• Older-Than
• Prefix
• Suffix
• Time-Unit
• Timestring
• Exclude
• Index

Snapshot Selection Flags

• Newer-Than
• Older-Than
• Prefix
• Suffix
• Time-Unit
• Timestring
• Exclude
• Index (Also covers the --snapshot flag)