Validate a query

POST also GET /{index}/_validate/query
POST also GET /_validate/query

Validates a query without running it.

Authentication

Api key

Authorization: <value>

Elasticsearch APIs support key-based authentication. You must create an API key and use the encoded value in the request header. For example:

		curl -X GET "${ES_URL}/_cat/indices?v=true" \
  -H "Authorization: ApiKey ${API_KEY}"

To get API keys, use the /_security/api_key APIs.

Basic

Authorization: Basic <credentials>

Bearer

Authorization: Bearer <token>

Elasticsearch APIs support the use of bearer tokens in the Authorization HTTP header to authenticate with the API. For examples, refer to Token-based authentication services

Query parameters

allow_no_indices boolean · default: true

If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. This behavior applies even if the request targets other open indices.

all_shards boolean · default: false

If true, the validation is executed on all shards instead of one random shard per index.

analyzer string

Analyzer to use for the query string. This parameter can only be used when the q query string parameter is specified.

analyze_wildcard boolean · default: false

If true, wildcard and prefix queries are analyzed.

default_operator enum · default: or

The default operator for query string query: and or or.

Values: and AND or OR

df string

Field to use as default where no field prefix is given in the query string. This parameter can only be used when the q query string parameter is specified.

expand_wildcards string · default: open

Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as open,hidden.

Supported values include:

all: Match any data stream or index, including hidden ones.
open: Match open, non-hidden indices. Also matches any non-hidden data stream.
closed: Match closed, non-hidden indices. Also matches any non-hidden data stream. Data streams cannot be closed.
hidden: Match hidden data streams and hidden indices. Must be combined with open, closed, or both.
none: Wildcard expressions are not accepted.

Values: all open closed hidden none

explain boolean · default: false

If true, the response returns detailed information if an error has occurred.

ignore_unavailable boolean · default: false

If false, the request returns an error if it targets a missing or closed index.

lenient boolean · default: false

If true, format-based query failures (such as providing text to a numeric field) in the query string will be ignored.

rewrite boolean · default: false

If true, returns a more detailed explanation showing the actual Lucene query that will be executed.

q string

Query in the Lucene query string syntax.

Request body

Response

application/json

Examples

Request Console 1 / 8 languages

Console Kibana Dev Tools

POST my-index-000001/_validate/query?q=user.id:kimchy

JavaScript Elasticsearch JavaScript Client

const response = await client.indices.validateQuery({
  index: "my-index-000001",
  q: "user.id:kimchy",
});

Python Elasticsearch Python Client

resp = client.indices.validate_query(
    index="my-index-000001",
    q="user.id:kimchy",
)

curl Shell

curl -X POST "$ELASTICSEARCH_URL/my-index-000001/_validate/query?q=user.id:kimchy" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY"

Java Elasticsearch Java Client

client.indices().validateQuery(v -> v
    .index("my-index-000001")
    .q("user.id:kimchy")
);

C# Elasticsearch .NET Client

var response = await client.Indices
    .ValidateQueryAsync(d1 => d1
        .Indices(new[] { "my-index-000001" })
        .QueryLuceneSyntax("user.id:kimchy")
    );

PHP Elasticsearch PHP Client

$resp = $client->indices()->validateQuery([
    "index" => "my-index-000001",
    "q" => "user.id:kimchy",
]);

Ruby Elasticsearch Ruby Client

response = client.indices.validate_query(
  index: "my-index-000001",
  q: "user.id:kimchy"
)

Response

No example

Authentication

Path parameters

Query parameters

Request body { }

Response

Request body