Get to know the ElasticSearch API again

• REST APIs

  ElasticSearch exposes REST APIs that used by the UI components and can be called directly to configure and access Elasticsearch features.

• Search API

  GET /<target>/_search
  GET /_search
  POST /<target1, target2, ...>/_search
  POST /_search
  
  GET /my-index-000001/_search
  

• cat APIs

  cat APIs are only intended for human consumption using the Kibana console or command line. They are not intended for use by applications.

• Document APIs

  Index APIs under Document APIs:

  PUT /<target>/_doc/<_id>
  

  target could be the name of the data stream or index .

• Index APIs

  PUT /<index>
  

• Ingest API

  // Put pipeline API
  PUT /_ingest/pipeline/<pipeline>
  // Get pipeline API
  GET /_ingest/pipeline/<pipeline>?query_parameter
  GET /_ingest/pipeline
  // Delete pipeline API
  DELETE /_ingest/pipeline/<pipeline>
  // Simulate pipeline API
  POST /_ingest/pipeline/<pipeline>/_simulate
  GET /_ingest/pipeline/<pipeline>/_simulate
  POST /_ingest/pipeline/_simulate
  GET /_ingest/pipeline/_simulate
  

• Common Options

  The following options can be applied to all of the REST APIs.

  ?pretty=true
  ?format=yaml
  ?human=false
  ?now+1h
  ?now-1h/d
  ?filter_path=took,hits.hits._id,hits.hits._score
  ?flat_settings=true
  

  filter_path parameter that can be used to reduce the response returned by Elasticsearch. This parameter takes a comma separated list of filters expressed with the dot notation. It also supports the * wildcard character to match any field or part of a field’s name.

• References

1. ElasticSearch REST APIs