1. Java /
  2. Transport layer /
  3. Legacy REST Client /
  4. Getting started

Javadoc for the Elasticsearch Java REST client

Note

This is the legacy RestClient. Please migrate to Rest5Client, a drop-in replacement with an up-to-date http library.

The javadoc for the low level REST client can be found at https://snapshots.elastic.co/javadoc/org/elasticsearch/client/elasticsearch-rest-client/9.5.0/.

Previous
Getting started
Next
Maven repository
  • View as Markdown
  • Edit this page
  • Java

  • 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
          • More config options
          • 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
          • More config options
          • Node selector
        • Sniffer
          • Javadoc
          • Maven Repository
          • Usage
    • Javadoc and source code
    • External resources
    • Breaking changes policy
    • Release highlights
    • License
  • Elasticsearch Java Client
    • Known issues
    • 9.5.0
    • 9.4.0
    • 9.3.0
    • 9.2.0
    • 9.1.0
    • 9.0.4
    • 9.0.0
Elastic logo

© 2026 Elasticsearch B.V. All Rights Reserved.

  • Terms of Use
  • Privacy