New

The executive guide to generative AI

Read more
About usPartnersSupport|Login

IMPORTANT: elasticsearch.js has been replaced by the new Elasticsearch JavaScript client. We strongly advise you to migrate to the new client. To learn more, see the migration guide.

« API Conventions Config values you can override per request »
Elastic Docs ›elasticsearch.js ›API Conventions

Generic Parameters

edit

Generic Parameters

edit

By default, all api methods accept the following parameters. They are omitted from the param lists of each method for brevity.

method

String — The HTTP method to use for this request. All of the API methods have their own default.

body

String, Anything — The body to send along with this request. If the body is a string it will be passed along as is, otherwise it is passed to the serializer and converted to either JSON or a newline separated list of JSON objects based on the API method.

the bodybuilder, elastic-builder or elastic.js libraries can be used to make building request bodies simpler.

ignore

Number, Number[] — HTTP status codes which should not be considered errors for this request.

filterPath

String|String[] — Starting in elasticsearch 1.6 the filterPath parameter can be passed to any API to filter its reponse values. See the elasticsearch response filtering docs for more information.
« API Conventions Config values you can override per request »
Was this helpful?
Feedback