This page contains the information you need to connect and use the Client with Elasticsearch.

On this page


This document contains code snippets to show you how to connect to various Elasticsearch providers.

Elastic Cloudedit

If you are using Elastic Cloud, the client offers an easy way to connect to it. You must pass the Cloud ID that you can find in the cloud console, then your username and password.

require 'elasticsearch'

client =
  cloud_id: '<CloudID>'
  user: '<Username>',
  password: '<Password>',

You can also connect to the Cloud by using API Key authentication:

client =
  cloud_id: '<CloudID>',
  api_key: {id: '<Id>', api_key: '<APIKey>'}

API Key authenticationedit

You can also use the ApiKey authentication.

If you provide both basic authentication credentials and the ApiKey configuration, the ApiKey takes precedence. You can also use API Key authentication:
  host: host,
  transport_options: transport_options,
  api_key: credentials

Where credentials is either the base64 encoding of id and api_key joined by a colon or a hash with the id and api_key:
  host: host,
  transport_options: transport_options,
  api_key: {id: 'my_id', api_key: 'my_api_key'}

Basic authenticationedit

You can pass the authentication credentials, scheme and port in the host configuration hash:

client =
    	   host: 'my-protected-host',
    	   port: '443',
    	   user: 'USERNAME',
    	   password: 'PASSWORD',
    	   scheme: 'https'

Or use the common URL format:

client = https://username:password@localhost:9200)

To pass a custom certificate for SSL peer verification to Faraday-based clients, use the transport_options option:
  url: 'https://username:password@localhost:9200',
  transport_options: {
	ssl: { ca_file: '/path/to/cacert.pem' }


The following snippet shows an example of using the Ruby client:

require 'elasticsearch'

client = log: true

client.index(index: 'my-index', type: 'my-document', id: 1, body: { title: 'Test' })

client.indices.refresh(index: 'my-index') 'my-index', body: { query: { match: { title: 'test' } } })