Docs
  • Release notes
  • Troubleshoot
  • Reference
  • Get started
  • Solutions and use cases
  • Manage data
  • Explore and analyze
  • Deploy and manage
  • Manage your Cloud account and preferences
  • Troubleshoot
  • Extend and contribute
  • Release notes
  • Security
    • Fields and object schemas
      • Elastic Security ECS field reference
      • Timeline schema
      • Alert schema
    • Endpoint command reference
    • Detection Rules Overview
  • Observability
    • Fields and object schemas
  • Elasticsearch and index management
    • Configuration
      • Circuit breaker settings
      • Auditing settings
      • Enrich settings
      • Cluster-level shard allocation and routing settings
      • Miscellaneous cluster settings
      • Cross-cluster replication settings
      • Discovery and cluster formation settings
      • Field data cache settings
      • Health Diagnostic settings
      • Index lifecycle management settings
      • Data stream lifecycle settings
      • Index management settings
      • Index recovery settings
      • Indexing buffer settings
      • License settings
      • Local gateway
      • Machine learning settings
      • Inference settings
      • Monitoring settings
      • Node settings
      • Networking settings
      • Node query cache settings
      • Search settings
      • Security settings
      • Shard request cache
      • Snapshot and restore settings
      • Transforms settings
      • Thread pool settings
      • Watcher settings
    • JVM settings
    • Roles
    • Elasticsearch privileges
    • Index settings
      • Data tier allocation
      • General
      • History retention
      • Index block
      • Index recovery prioritization
      • Indexing pressure
      • Mapping limit
      • Merge
      • Path
      • Shard allocation
        • Total shards per node
      • Similarity
      • Slow log
      • Sorting
        • Use index sorting to speed up conjunctions
      • Store
        • Preloading data into the file system cache
      • Time series
      • Translog
    • Index lifecycle actions
      • Allocate
      • Delete
      • Force merge
      • Migrate
      • Read only
      • Rollover
      • Downsample
      • Searchable snapshot
      • Set priority
      • Shrink
      • Unfollow
      • Wait for snapshot
    • REST APIs
      • API conventions
      • Common options
      • Compatibility
      • API examples
        • The refresh parameter
        • Optimistic concurrency control
        • Sort search results
        • Paginate search results
        • Retrieve selected fields
        • Search multiple data streams and indices
        • Collapse search results
        • Filter search results
        • Highlighting
        • Retrieve inner hits
        • Search shard routing
        • Searching with query rules
        • Reciprocal rank fusion
        • Retrievers
        • Reindex data stream
        • Create index from source
        • The shard request cache
        • Suggesters
        • Profile search requests
        • Ranking evaluation
    • Mapping
      • Document metadata fields
        • _doc_count field
        • _field_names field
        • _ignored field
        • _id field
        • _index field
        • _meta field
        • _routing field
        • _source field
        • _tier field
      • Field data types
        • Aggregate metric
        • Alias
        • Arrays
        • Binary
        • Boolean
        • Completion
        • Date
        • Date nanoseconds
        • Dense vector
        • Flattened
        • Geopoint
        • Geoshape
        • Histogram
        • IP
        • Join
        • Keyword
        • Nested
        • Numeric
        • Object
        • Pass-through object
        • Percolator
        • Point
        • Range
        • Rank feature
        • Rank features
        • Rank Vectors
        • Search-as-you-type
        • Semantic text
        • Shape
        • Sparse vector
        • Text
        • Token count
        • Unsigned long
        • Version
      • Mapping parameters
        • analyzer
        • coerce
        • copy_to
        • doc_values
        • dynamic
        • eager_global_ordinals
        • enabled
        • format
        • ignore_above
        • index.mapping.ignore_above
        • ignore_malformed
        • index
        • index_options
        • index_phrases
        • index_prefixes
        • meta
        • fields
        • normalizer
        • norms
        • null_value
        • position_increment_gap
        • properties
        • search_analyzer
        • similarity
        • store
        • subobjects
        • term_vector
    • Elasticsearch audit events
    • Command line tools
      • elasticsearch-certgen
      • elasticsearch-certutil
      • elasticsearch-create-enrollment-token
      • elasticsearch-croneval
      • elasticsearch-keystore
      • elasticsearch-node
      • elasticsearch-reconfigure-node
      • elasticsearch-reset-password
      • elasticsearch-saml-metadata
      • elasticsearch-service-tokens
      • elasticsearch-setup-passwords
      • elasticsearch-shard
      • elasticsearch-syskeygen
      • elasticsearch-users
    • 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
        • 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
        • 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?
    • Clients
      • Eland
        • Installation
        • Data Frames
        • Machine Learning
      • Go
        • Getting started
        • Installation
        • Connecting
        • Typed API
          • Getting started with the API
          • Conventions
          • Running queries
          • Using ES|QL
          • Examples
      • Java
        • Getting started
        • Setup
          • Installation
          • Connecting
          • Using OpenTelemetry
        • API conventions
          • Package structure and namespace clients
          • Method naming conventions
          • Blocking and asynchronous clients
          • Building API objects
          • Lists and maps
          • Variant types
          • Object life cycles and thread safety
          • Creating API objects from JSON data
          • Exceptions
        • Using the Java API client
          • Indexing single documents
          • Bulk: indexing multiple documents
          • Reading documents by id
          • Searching for documents
          • Aggregations
          • ES|QL in the Java client
        • Troubleshooting
          • Missing required property
          • NoSuchMethodError: removeHeader
          • IOReactor errors
          • Serializing without typed keys
          • Could not resolve dependencies
          • NoClassDefFoundError: LogFactory
        • Transport layer
          • REST 5 Client
            • Getting started
              • Initialization
              • Performing requests
              • Reading responses
              • Logging
            • Common configuration
              • Timeouts
              • Number of threads
              • Basic authentication
              • Other authentication methods
              • Encrypted communication
              • Others
              • Node selector
            • Sniffer
          • Legacy REST Client
            • Getting started
              • Javadoc
              • Maven Repository
              • Dependencies
              • Shading
              • Initialization
              • Performing requests
              • Reading responses
              • Logging
            • Common configuration
              • Timeouts
              • Number of threads
              • Basic authentication
              • Other authentication methods
              • Encrypted communication
              • Others
              • Node selector
            • Sniffer
              • Javadoc
              • Maven Repository
              • Usage
        • Javadoc and source code
        • External resources
        • Breaking changes policy
        • Release highlights
        • License
      • JavaScript
        • Getting started
        • Installation
        • Connecting
        • Configuration
          • Basic configuration
          • Advanced configuration
          • Creating a child client
          • Testing
        • Integrations
          • Observability
          • Transport
          • TypeScript support
        • API Reference
        • Examples
          • asStream
          • Bulk
          • Exists
          • Get
          • Ignore
          • MSearch
          • Scroll
          • Search
          • Suggest
          • transport.request
          • SQL
          • Update
          • Update By Query
          • Reindex
        • Client helpers
        • Timeout best practices
      • .NET
        • Getting started
        • Installation
        • Connecting
        • Configuration
          • Options on ElasticsearchClientSettings
        • Client concepts
          • Serialization
            • Source serialization
        • Using the .NET Client
          • Aggregation examples
          • Using ES|QL
          • CRUD usage examples
          • Custom mapping examples
          • Query examples
          • Usage recommendations
          • Low level Transport example
        • Troubleshoot
          • Logging
            • Logging with OnRequestCompleted
            • Logging with Fiddler
          • Debugging
            • Audit trail
            • Debug information
            • Debug mode
      • PHP
        • Getting started
        • Installation
        • Connecting
        • Configuration
          • Dealing with JSON arrays and objects in PHP
          • Host Configuration
          • Set retries
          • HTTP Meta Data
          • Enabling the Logger
          • Configure the HTTP client
          • Namespaces
          • Node Pool
        • Operations
          • Index management operations
          • Search operations
          • Indexing documents
          • Getting documents
          • Updating documents
          • Deleting documents
        • Client helpers
          • Iterators
          • ES|QL
      • Python
        • Getting started
        • Installation
        • Connecting
        • Configuration
        • Querying
        • Using with asyncio
        • Integrations
          • Using OpenTelemetry
          • ES|QL and Pandas
        • Examples
        • Elasticsearch Python DSL
          • Configuration
          • Tutorials
          • How-To Guides
          • Examples
          • Migrating from the elasticsearch-dsl package
        • Client helpers
      • Ruby
        • Getting started
        • Installation
        • Connecting
        • Configuration