Docs
  • Guides
  • APIs (opens in a new tab)
  • Products
    Elasticsearch Observability Security Elastic Cloud
  • Reference
  • Troubleshoot
  • Release notes
  1. Docs /
  2. Reference /
  3. Elasticsearch /
  4. Curator

Examples

These examples should help illustrate how to build your own actions.

You can use environment variables in your configuration files.

  • alias
  • allocation
  • close
  • cluster_routing
  • create_index
  • delete_indices
  • delete_snapshots
  • forcemerge
  • open
  • reindex
  • replicas
  • restore
  • rollover
  • shrink
  • snapshot
Previous
week_starts_on
Next
alias
  • View as Markdown
  • Report a docs issue
  • Edit this page
  • Learn how to contribute
Get started free
  • 14-day free trial
  • All features included
  • No setup required
Section
Reference
Docs Guides APIs (opens in a new tab)
Products
Elasticsearch Observability Security Elastic Cloud
Reference Troubleshoot Release notes
Version
Reference Elasticsearch
  • Curator
    • Curator and index lifecycle management
      • ILM Actions
      • ILM or Curator?
      • ILM and Curator!
    • About
      • Origin
      • Features
      • Command-Line Interface (CLI)
      • Application Program Interface (API)
      • License
      • Site Corrections
      • Contributing
    • Installation
      • pip
      • Installation from source
      • Docker
    • Running Curator
      • Command Line Interface
      • Singleton Command Line Interface
      • Exit Codes
    • Configuration
      • Environment Variables
      • Action File
      • Configuration File
    • Actions
      • Alias
      • Allocation
      • Close
      • Cluster Routing
      • Cold2Frozen
      • Create Index
      • Delete Indices
      • Delete Snapshots
      • Forcemerge
      • Index Settings
      • open
      • Reindex
      • Replicas
      • Restore
      • Rollover
      • Shrink
      • Snapshot
    • Options
      • allocation_type
      • allow_ilm_indices
      • continue_if_exception
      • copy_aliases
      • count
      • delay
      • delete_after
      • delete_aliases
      • skip_flush
      • disable_action
      • extra_settings
      • ignore_empty_list
      • ignore_unavailable
      • include_aliases
      • include_global_state
      • include_hidden
      • indices
      • key
      • max_age
      • max_docs
      • max_size
      • max_num_segments
      • max_wait
      • migration_prefix
      • migration_suffix
      • name
      • new_index
      • node_filters
      • number_of_replicas
      • number_of_shards
      • partial
      • post_allocation
      • preserve_existing
      • refresh
      • remote_certificate
      • remote_client_cert
      • remote_client_key
      • remote_filters
      • remote_url_prefix
      • rename_pattern
      • rename_replacement
      • repository
      • requests_per_second
      • request_body
      • retry_count
      • retry_interval
      • routing_type
      • search_pattern
      • setting
      • shrink_node
      • shrink_prefix
      • shrink_suffix
      • slices
      • skip_repo_fs_check
      • timeout
      • timeout_override
      • value
      • wait_for_active_shards
      • wait_for_completion
      • wait_for_rebalance
      • wait_interval
      • warn_if_no_indices
    • Filters
      • filtertype
      • age
      • alias
      • allocated
      • closed
      • count
      • empty
      • forcemerged
      • kibana
      • none
      • opened
      • pattern
      • period
      • space
      • state
    • Filter Elements
      • aliases
      • allocation_type
      • count
      • date_from
      • date_from_format
      • date_to
      • date_to_format
      • direction
      • disk_space
      • epoch
      • exclude
      • field
      • intersect
      • key
      • kind
      • max_num_segments
      • pattern
      • period_type
      • range_from
      • range_to
      • reverse
      • source
      • state
      • stats_result
      • timestring
      • threshold_behavior
      • unit
      • unit_count
      • unit_count_pattern
      • use_age
      • value
      • week_starts_on
    • Examples
      • alias
      • allocation
      • close
      • cluster_routing
      • create_index
      • delete_indices
      • delete_snapshots
      • forcemerge
      • index_settings
      • open
      • reindex action examples
      • replicas
      • restore
      • rollover
      • shrink
      • snapshot
    • Frequently Asked Questions
      • Q: How can I report an error in the documentation?
      • Q: Can I delete only certain data from within indices?
      • Q: Can Curator handle index names with strange characters?
Elastic logo
  • Trademarks
  • Terms of Use
  • Privacy
  • Sitemap

© 2026 Elasticsearch B.V. All Rights Reserved.

This content is available in different formats for convenience only. All original licensing terms apply.

Elasticsearch is a trademark of Elasticsearch B.V., registered in the U.S. and in other countries. Apache, Apache Lucene, Apache Hadoop, Hadoop, HDFS and the yellow elephant logo are trademarks of the Apache Software Foundation in the United States and/or other countries.