Api¶
This section describes the REST APIs elasticsearch provides (mainly) using JSON. The API is exposed using HTTP, thrift, memcached.
Nodes¶
Most cluster level APIs allow to specify which nodes to execute on (for example, getting the node stats for a node). Nodes can be identified in the APIs either using their internal node id, the node name, address, custom attributes, or just the _local node receiving the request. For example, here are some sample executions of nodes info:
# Local
curl localhost:9200/_cluster/nodes/_local
# Address
curl localhost:9200/_cluster/nodes/10.0.0.3,10.0.0.4
curl localhost:9200/_cluster/nodes/10.0.0.*
# Names
curl localhost:9200/_cluster/nodes/node_name_goes_here
curl localhost:9200/_cluster/nodes/node_name_goes_*
# Attributes (set something like node.rack: 2 in the config)
curl localhost:9200/_cluster/nodes/rack:2
curl localhost:9200/_cluster/nodes/ra*:2
curl localhost:9200/_cluster/nodes/ra*:2*
Options¶
Pretty Results¶
When appending ?pretty=true to any request made, the JSON returned will be pretty formatted (use it for debugging only!).
Parameters¶
Rest parameters (when using HTTP, map to HTTP URL parameters) follow the convention of using underscore casing.
Boolean Values¶
All REST APIs parameters (both request parameters and JSON body) support providing boolean “false” as the values: false, 0 and off. All other values are considered “true”. Note, this is not related to fields within a document indexed treated as boolean fields.
Number Values¶
All REST APIs support providing numbered parameters as string on top of supporting the native JSON number types.
Result Casing¶
All REST APIs accept the case parameter. When set to camelCase, all field names in the result will be returned in camel casing, otherwise, underscore casing will be used. Note, this does not apply to the source document indexed.
Request body in query string¶
For libraries that don’t accept a request body for non-POST requests, you can pass the request body as the source query string parameter instead.
- Admin Cluster Health
- Admin Cluster Nodes Info
- Admin Cluster Nodes Shutdown
- Admin Cluster Nodes Stats
- Admin Cluster State
- Admin Cluster Update Settings
- Admin Indices Aliases
- Admin Indices Analyze
- Admin Indices Clearcache
- Admin Indices Create Index
- Admin Indices Delete Index
- Admin Indices Delete Mapping
- Admin Indices Flush
- Admin Indices Gateway Snapshot
- Admin Indices Get Mapping
- Admin Indices Indices Exists
- Admin Indices Open Close
- Admin Indices Optimize
- Admin Indices Put Mapping
- Admin Indices Refresh
- Admin Indices Segments
- Admin Indices Stats
- Admin Indices Status
- Admin Indices Templates
- Admin Indices Get Settings
- Admin Indices Update Settings
- Bulk
- Count
- Delete By Query
- Delete
- Get
- Index
- More Like This
- Multi Get
- Multi Index
- Multi Search
- Percolate
- Search
- Update
- Validate