Query API keys
Retrieves a paginated list of API keys and their information. You can optionally filter the results with a query.
Query parameters
-
with_limited_by boolean
Return the snapshot of the owner user's role descriptors associated with the API key. An API key's actual permission is the intersection of its assigned role descriptors and the owner user's role descriptors.
-
with_profile_uid boolean
Determines whether to also retrieve the profile uid, for the API key owner principal, if it exists.
-
typed_keys boolean
Determines whether aggregation names are prefixed by their respective types in the response.
Body
-
aggregations object
Any aggregations to run over the corpus of returned API keys. Aggregations and queries work together. Aggregations are computed only on the API keys that match the query. This supports only a subset of aggregation types, namely:
terms,range,date_range,missing,cardinality,value_count,composite,filter, andfilters. Additionally, aggregations only run over the same subset of fields that query works with. -
query object
Hide query attributes Show query attributes object
-
bool object
Hide bool attributes Show bool attributes object
-
boost number
Floating point number used to decrease or increase the relevance scores of the query. Boost values are relative to the default value of 1.0. A boost value between 0 and 1.0 decreases the relevance score. A value greater than 1.0 increases the relevance score.
-
_name string
filter object | array[object]
The clause (query) must appear in matching documents. However, unlike
must, the score of the query will be ignored.One of: Hide attributes Show attributes
-
boosting object
-
combined_fields object
-
constant_score object
-
dis_max object
-
exists object
-
function_score object
-
fuzzy object
Returns documents that contain terms similar to the search term, as measured by a Levenshtein edit distance.
-
geo_bounding_box object
-
geo_distance object
-
geo_polygon object
-
geo_shape object
-
has_child object
-
has_parent object
-
ids object
-
intervals object
Returns documents based on the order and proximity of matching terms.
-
knn object
-
match object
Returns documents that match a provided text, number, date or boolean value. The provided text is analyzed before matching.
-
match_all object
-
match_bool_prefix object
Analyzes its input and constructs a
boolquery from the terms. Each term except the last is used in atermquery. The last term is used in a prefix query. -
match_none object
-
match_phrase object
Analyzes the text and creates a phrase query out of the analyzed text.
-
match_phrase_prefix object
Returns documents that contain the words of a provided text, in the same order as provided. The last term of the provided text is treated as a prefix, matching any words that begin with that term.
-
more_like_this object
-
multi_match object
-
nested object
-
parent_id object
-
percolate object
-
prefix object
Returns documents that contain a specific prefix in a provided field.
-
query_string object
-
range object
Returns documents that contain terms within a provided range.
-
rank_feature object
-
regexp object
Returns documents that contain terms matching a regular expression.
-
rule object
-
script object
-
script_score object
-
semantic object
-
shape object
-
simple_query_string object
-
span_containing object
-
span_field_masking object
-
span_first object
-
span_multi object
-
span_near object
-
span_not object
-
span_or object
-
span_term object
Matches spans containing a term.
-
span_within object
-
term object
Returns documents that contain an exact term in a provided field. To return a document, the query term must exactly match the queried field's value, including whitespace and capitalization.
-
terms object
-
terms_set object
Returns documents that contain a minimum number of exact terms in a provided field. To return a document, a required number of terms must exactly match the field values, including whitespace and capitalization.
-
Uses a natural language processing model to convert the query text into a list of token-weight pairs which are then used in a query against a sparse vector or rank features field.
-
Supports returning text_expansion query results by sending in precomputed tokens with the query.
-
wildcard object
Returns documents that contain terms matching a wildcard pattern.
-
wrapper object
-
type object
Hide attributes Show attributes object
-
fuzzy object
Returns documents that contain terms similar to the search term, as measured by a Levenshtein edit distance.
-
intervals object
Returns documents based on the order and proximity of matching terms.
-
match object
Returns documents that match a provided text, number, date or boolean value. The provided text is analyzed before matching.
-
match_bool_prefix object
Analyzes its input and constructs a
boolquery from the terms. Each term except the last is used in atermquery. The last term is used in a prefix query. -
match_phrase object
Analyzes the text and creates a phrase query out of the analyzed text.
-
match_phrase_prefix object
Returns documents that contain the words of a provided text, in the same order as provided. The last term of the provided text is treated as a prefix, matching any words that begin with that term.
-
prefix object
Returns documents that contain a specific prefix in a provided field.
-
range object
Returns documents that contain terms within a provided range.
-
regexp object
Returns documents that contain terms matching a regular expression.
-
span_term object
Matches spans containing a term.
-
term object
Returns documents that contain an exact term in a provided field. To return a document, the query term must exactly match the queried field's value, including whitespace and capitalization.
-
terms_set object
Returns documents that contain a minimum number of exact terms in a provided field. To return a document, a required number of terms must exactly match the field values, including whitespace and capitalization.
-
Uses a natural language processing model to convert the query text into a list of token-weight pairs which are then used in a query against a sparse vector or rank features field.
-
Supports returning text_expansion query results by sending in precomputed tokens with the query.
-
wildcard object
Returns documents that contain terms matching a wildcard pattern.
minimum_should_match number | string
The minimum number of terms that should match as integer, percentage or range
must object | array[object]
The clause (query) must appear in matching documents and will contribute to the score.
One of: Hide attributes Show attributes
-
boosting object
-
combined_fields object
-
constant_score object
-
dis_max object
-
exists object
-
function_score object
-
fuzzy object
Returns documents that contain terms similar to the search term, as measured by a Levenshtein edit distance.
-
geo_bounding_box object
-
geo_distance object
-
geo_polygon object
-
geo_shape object
-
has_child object
-
has_parent object
-
ids object
-
intervals object
Returns documents based on the order and proximity of matching terms.
-
knn object
-
match object
Returns documents that match a provided text, number, date or boolean value. The provided text is analyzed before matching.
-
match_all object
-
match_bool_prefix object
Analyzes its input and constructs a
boolquery from the terms. Each term except the last is used in atermquery. The last term is used in a prefix query. -
match_none object
-
match_phrase object
Analyzes the text and creates a phrase query out of the analyzed text.
-
match_phrase_prefix object
Returns documents that contain the words of a provided text, in the same order as provided. The last term of the provided text is treated as a prefix, matching any words that begin with that term.
-
more_like_this object
-
multi_match object
-
nested object
-
parent_id object
-
percolate object
-
prefix object
Returns documents that contain a specific prefix in a provided field.
-
query_string object
-
range object
Returns documents that contain terms within a provided range.
-
rank_feature object
-
regexp object
Returns documents that contain terms matching a regular expression.
-
rule object
-
script object
-
script_score object
-
semantic object
-
shape object
-
simple_query_string object
-
span_containing object
-
span_field_masking object
-
span_first object
-
span_multi object
-
span_near object
-
span_not object
-
span_or object
-
span_term object
Matches spans containing a term.
-
span_within object
-
term object
Returns documents that contain an exact term in a provided field. To return a document, the query term must exactly match the queried field's value, including whitespace and capitalization.
-
terms object
-
terms_set object
Returns documents that contain a minimum number of exact terms in a provided field. To return a document, a required number of terms must exactly match the field values, including whitespace and capitalization.
-
Uses a natural language processing model to convert the query text into a list of token-weight pairs which are then used in a query against a sparse vector or rank features field.
-
Supports returning text_expansion query results by sending in precomputed tokens with the query.
-
wildcard object
Returns documents that contain terms matching a wildcard pattern.
-
wrapper object
-
type object
Hide attributes Show attributes object
-
fuzzy object
Returns documents that contain terms similar to the search term, as measured by a Levenshtein edit distance.
-
intervals object
Returns documents based on the order and proximity of matching terms.
-
match object
Returns documents that match a provided text, number, date or boolean value. The provided text is analyzed before matching.
-
match_bool_prefix object
Analyzes its input and constructs a
boolquery from the terms. Each term except the last is used in atermquery. The last term is used in a prefix query. -
match_phrase object
Analyzes the text and creates a phrase query out of the analyzed text.
-
match_phrase_prefix object
Returns documents that contain the words of a provided text, in the same order as provided. The last term of the provided text is treated as a prefix, matching any words that begin with that term.
-
prefix object
Returns documents that contain a specific prefix in a provided field.
-
range object
Returns documents that contain terms within a provided range.
-
regexp object
Returns documents that contain terms matching a regular expression.
-
span_term object
Matches spans containing a term.
-
term object
Returns documents that contain an exact term in a provided field. To return a document, the query term must exactly match the queried field's value, including whitespace and capitalization.
-
terms_set object
Returns documents that contain a minimum number of exact terms in a provided field. To return a document, a required number of terms must exactly match the field values, including whitespace and capitalization.
-
Uses a natural language processing model to convert the query text into a list of token-weight pairs which are then used in a query against a sparse vector or rank features field.
-
Supports returning text_expansion query results by sending in precomputed tokens with the query.
-
wildcard object
Returns documents that contain terms matching a wildcard pattern.
must_not object | array[object]
The clause (query) must not appear in the matching documents. Because scoring is ignored, a score of
0is returned for all documents.One of: Hide attributes Show attributes
-
boosting object
-
combined_fields object
-
constant_score object
-
dis_max object
-
exists object
-
function_score object
-
fuzzy object
Returns documents that contain terms similar to the search term, as measured by a Levenshtein edit distance.
-
geo_bounding_box object
-
geo_distance object
-
geo_polygon object
-
geo_shape object
-
has_child object
-
has_parent object
-
ids object
-
intervals object
Returns documents based on the order and proximity of matching terms.
-
knn object
-
match object
Returns documents that match a provided text, number, date or boolean value. The provided text is analyzed before matching.
-
match_all object
-
match_bool_prefix object
Analyzes its input and constructs a
boolquery from the terms. Each term except the last is used in atermquery. The last term is used in a prefix query. -
match_none object
-
match_phrase object
Analyzes the text and creates a phrase query out of the analyzed text.
-
match_phrase_prefix object
Returns documents that contain the words of a provided text, in the same order as provided. The last term of the provided text is treated as a prefix, matching any words that begin with that term.
-
more_like_this object
-
multi_match object
-
nested object
-
parent_id object
-
percolate object
-
prefix object
Returns documents that contain a specific prefix in a provided field.
-
query_string object
-
range object
Returns documents that contain terms within a provided range.
-
rank_feature object
-
regexp object
Returns documents that contain terms matching a regular expression.
-
rule object
-
script object
-
script_score object
-
semantic object
-
shape object
-
simple_query_string object
-
span_containing object
-
span_field_masking object
-
span_first object
-
span_multi object
-
span_near object
-
span_not object
-
span_or object
-
span_term object
Matches spans containing a term.
-
span_within object
-
term object
Returns documents that contain an exact term in a provided field. To return a document, the query term must exactly match the queried field's value, including whitespace and capitalization.
-
terms object
-
terms_set object
Returns documents that contain a minimum number of exact terms in a provided field. To return a document, a required number of terms must exactly match the field values, including whitespace and capitalization.
-
Uses a natural language processing model to convert the query text into a list of token-weight pairs which are then used in a query against a sparse vector or rank features field.
-
Supports returning text_expansion query results by sending in precomputed tokens with the query.
-
wildcard object
Returns documents that contain terms matching a wildcard pattern.
-
wrapper object
-
type object
Hide attributes Show attributes object
-
fuzzy object
Returns documents that contain terms similar to the search term, as measured by a Levenshtein edit distance.
-
intervals object
Returns documents based on the order and proximity of matching terms.
-
match object
Returns documents that match a provided text, number, date or boolean value. The provided text is analyzed before matching.
-
match_bool_prefix object
Analyzes its input and constructs a
boolquery from the terms. Each term except the last is used in atermquery. The last term is used in a prefix query. -
match_phrase object
Analyzes the text and creates a phrase query out of the analyzed text.
-
match_phrase_prefix object
Returns documents that contain the words of a provided text, in the same order as provided. The last term of the provided text is treated as a prefix, matching any words that begin with that term.
-
prefix object
Returns documents that contain a specific prefix in a provided field.
-
range object
Returns documents that contain terms within a provided range.
-
regexp object
Returns documents that contain terms matching a regular expression.
-
span_term object
Matches spans containing a term.
-
term object
Returns documents that contain an exact term in a provided field. To return a document, the query term must exactly match the queried field's value, including whitespace and capitalization.
-
terms_set object
Returns documents that contain a minimum number of exact terms in a provided field. To return a document, a required number of terms must exactly match the field values, including whitespace and capitalization.
-
Uses a natural language processing model to convert the query text into a list of token-weight pairs which are then used in a query against a sparse vector or rank features field.
-
Supports returning text_expansion query results by sending in precomputed tokens with the query.
-
wildcard object
Returns documents that contain terms matching a wildcard pattern.
should object | array[object]
The clause (query) should appear in the matching document.
One of: Hide attributes Show attributes
-
boosting object
-
combined_fields object
-
constant_score object
-
dis_max object
-
exists object
-
function_score object
-
fuzzy object
Returns documents that contain terms similar to the search term, as measured by a Levenshtein edit distance.
-
geo_bounding_box object
-
geo_distance object
-
geo_polygon object
-
geo_shape object
-
has_child object
-
has_parent object
-
ids object
-
intervals object
Returns documents based on the order and proximity of matching terms.
-
knn object
-
match object
Returns documents that match a provided text, number, date or boolean value. The provided text is analyzed before matching.
-
match_all object
-
match_bool_prefix object
Analyzes its input and constructs a
boolquery from the terms. Each term except the last is used in atermquery. The last term is used in a prefix query. -
match_none object
-
match_phrase object
Analyzes the text and creates a phrase query out of the analyzed text.
-
match_phrase_prefix object
Returns documents that contain the words of a provided text, in the same order as provided. The last term of the provided text is treated as a prefix, matching any words that begin with that term.
-
more_like_this object
-
multi_match object
-
nested object
-
parent_id object
-
percolate object
-
prefix object
Returns documents that contain a specific prefix in a provided field.
-
query_string object
-
range object
Returns documents that contain terms within a provided range.
-
rank_feature object
-
regexp object
Returns documents that contain terms matching a regular expression.
-
rule object
-
script object
-
script_score object
-
semantic object
-
shape object
-
simple_query_string object
-
span_containing object
-
span_field_masking object
-
span_first object
-
span_multi object
-
span_near object
-
span_not object
-
span_or object
-
span_term object
Matches spans containing a term.
-
span_within object
-
term object
Returns documents that contain an exact term in a provided field. To return a document, the query term must exactly match the queried field's value, including whitespace and capitalization.
-
terms object
-
terms_set object
Returns documents that contain a minimum number of exact terms in a provided field. To return a document, a required number of terms must exactly match the field values, including whitespace and capitalization.
-
Uses a natural language processing model to convert the query text into a list of token-weight pairs which are then used in a query against a sparse vector or rank features field.
-
Supports returning text_expansion query results by sending in precomputed tokens with the query.
-
wildcard object
Returns documents that contain terms matching a wildcard pattern.
-
wrapper object
-
type object
Hide attributes Show attributes object
-
fuzzy object
Returns documents that contain terms similar to the search term, as measured by a Levenshtein edit distance.
-
intervals object
Returns documents based on the order and proximity of matching terms.
-
match object
Returns documents that match a provided text, number, date or boolean value. The provided text is analyzed before matching.
-
match_bool_prefix object
Analyzes its input and constructs a
boolquery from the terms. Each term except the last is used in atermquery. The last term is used in a prefix query. -
match_phrase object
Analyzes the text and creates a phrase query out of the analyzed text.
-
match_phrase_prefix object
Returns documents that contain the words of a provided text, in the same order as provided. The last term of the provided text is treated as a prefix, matching any words that begin with that term.
-
prefix object
Returns documents that contain a specific prefix in a provided field.
-
range object
Returns documents that contain terms within a provided range.
-
regexp object
Returns documents that contain terms matching a regular expression.
-
span_term object
Matches spans containing a term.
-
term object
Returns documents that contain an exact term in a provided field. To return a document, the query term must exactly match the queried field's value, including whitespace and capitalization.
-
terms_set object
Returns documents that contain a minimum number of exact terms in a provided field. To return a document, a required number of terms must exactly match the field values, including whitespace and capitalization.
-
Uses a natural language processing model to convert the query text into a list of token-weight pairs which are then used in a query against a sparse vector or rank features field.
-
Supports returning text_expansion query results by sending in precomputed tokens with the query.
-
wildcard object
Returns documents that contain terms matching a wildcard pattern.
-
-
exists object
Hide exists attributes Show exists attributes object
-
boost number
Floating point number used to decrease or increase the relevance scores of the query. Boost values are relative to the default value of 1.0. A boost value between 0 and 1.0 decreases the relevance score. A value greater than 1.0 increases the relevance score.
-
_name string
-
Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
-
-
ids object
Hide ids attributes Show ids attributes object
-
boost number
Floating point number used to decrease or increase the relevance scores of the query. Boost values are relative to the default value of 1.0. A boost value between 0 and 1.0 decreases the relevance score. A value greater than 1.0 increases the relevance score.
-
_name string
values string | array[string]
-
-
match object
Returns documents that match a provided text, number, date or boolean value. The provided text is analyzed before matching.
-
match_all object
Hide match_all attributes Show match_all attributes object
-
prefix object
Returns documents that contain a specific prefix in a provided field.
-
range object
Returns documents that contain terms within a provided range.
-
simple_query_string object
Hide simple_query_string attributes Show simple_query_string attributes object
-
boost number
Floating point number used to decrease or increase the relevance scores of the query. Boost values are relative to the default value of 1.0. A boost value between 0 and 1.0 decreases the relevance score. A value greater than 1.0 increases the relevance score.
-
_name string
-
analyzer string
Analyzer used to convert text in the query string into tokens.
-
analyze_wildcard boolean
If
true, the query attempts to analyze wildcard terms in the query string. -
If
true, the parser creates a match_phrase query for each multi-position token. -
default_operator string
Values are
and,AND,or, orOR. -
fields array[string]
Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
flags string
Query flags can be either a single flag or a combination of flags, e.g.
OR|AND|PREFIXOne of: Query flags can be either a single flag or a combination of flags, e.g.
OR|AND|PREFIXValues are
NONE,AND,NOT,OR,PREFIX,PHRASE,PRECEDENCE,ESCAPE,WHITESPACE,FUZZY,NEAR,SLOP, orALL.Query flags can be either a single flag or a combination of flags, e.g.
OR|AND|PREFIX-
fuzzy_max_expansions number
Maximum number of terms to which the query expands for fuzzy matching.
-
fuzzy_prefix_length number
Number of beginning characters left unchanged for fuzzy matching.
-
fuzzy_transpositions boolean
If
true, edits for fuzzy matching include transpositions of two adjacent characters (for example,abtoba). -
lenient boolean
If
true, format-based errors, such as providing a text value for a numeric field, are ignored. minimum_should_match number | string
The minimum number of terms that should match as integer, percentage or range
-
Query string in the simple query string syntax you wish to parse and use for search.
-
quote_field_suffix string
Suffix appended to quoted text in the query string.
-
-
term object
Returns documents that contain an exact term in a provided field. To return a document, the query term must exactly match the queried field's value, including whitespace and capitalization.
-
terms object
Hide terms attributes Show terms attributes object
-
wildcard object
Returns documents that contain terms matching a wildcard pattern.
-
-
from number
Starting document offset. By default, you cannot page through more than 10,000 hits using the from and size parameters. To page through more hits, use the
search_afterparameter. sort string | object | array[string | object]
One of: Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
Hide attributes Show attributes
-
_score object
Hide _score attribute Show _score attribute object
-
order string
Values are
ascordesc.
-
-
_doc object
Hide _doc attribute Show _doc attribute object
-
order string
Values are
ascordesc.
-
-
_geo_distance object
Hide _geo_distance attributes Show _geo_distance attributes object
-
mode string
Values are
min,max,sum,avg, ormedian. -
distance_type string
Values are
arcorplane. -
ignore_unmapped boolean
-
order string
Values are
ascordesc. -
unit string
Values are
in,ft,yd,mi,nmi,km,m,cm, ormm. -
nested object
Hide nested attributes Show nested attributes object
-
filter object
Hide filter attributes Show filter attributes object
-
fuzzy object
Returns documents that contain terms similar to the search term, as measured by a Levenshtein edit distance.
-
intervals object
Returns documents based on the order and proximity of matching terms.
-
match object
Returns documents that match a provided text, number, date or boolean value. The provided text is analyzed before matching.
-
match_bool_prefix object
Analyzes its input and constructs a
boolquery from the terms. Each term except the last is used in atermquery. The last term is used in a prefix query. -
match_phrase object
Analyzes the text and creates a phrase query out of the analyzed text.
-
match_phrase_prefix object
Returns documents that contain the words of a provided text, in the same order as provided. The last term of the provided text is treated as a prefix, matching any words that begin with that term.
-
prefix object
Returns documents that contain a specific prefix in a provided field.
-
range object
Returns documents that contain terms within a provided range.
-
regexp object
Returns documents that contain terms matching a regular expression.
-
span_term object
Matches spans containing a term.
-
term object
Returns documents that contain an exact term in a provided field. To return a document, the query term must exactly match the queried field's value, including whitespace and capitalization.
-
terms_set object
Returns documents that contain a minimum number of exact terms in a provided field. To return a document, a required number of terms must exactly match the field values, including whitespace and capitalization.
-
Uses a natural language processing model to convert the query text into a list of token-weight pairs which are then used in a query against a sparse vector or rank features field.
-
Supports returning text_expansion query results by sending in precomputed tokens with the query.
-
wildcard object
Returns documents that contain terms matching a wildcard pattern.
-
max_children number
-
nested object
-
Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
-
-
-
_script object
Hide _script attributes Show _script attributes object
-
order string
Values are
ascordesc. -
Hide script attributes Show script attributes object
-
source string
The script source.
-
id string
-
params object
Specifies any named parameters that are passed into the script as variables. Use parameters instead of hard-coded values to decrease compile time.
Hide params attributes Show params attributes object
-
key object
-
options object
Hide options attributes Show options attributes object
-
key string
-
-
type string
Values are
string,number, orversion. -
mode string
Values are
min,max,sum,avg, ormedian. -
nested object
Hide nested attributes Show nested attributes object
-
filter object
Hide filter attributes Show filter attributes object
-
fuzzy object
Returns documents that contain terms similar to the search term, as measured by a Levenshtein edit distance.
-
intervals object
Returns documents based on the order and proximity of matching terms.
-
match object
Returns documents that match a provided text, number, date or boolean value. The provided text is analyzed before matching.
-
match_bool_prefix object
Analyzes its input and constructs a
boolquery from the terms. Each term except the last is used in atermquery. The last term is used in a prefix query. -
match_phrase object
Analyzes the text and creates a phrase query out of the analyzed text.
-
match_phrase_prefix object
Returns documents that contain the words of a provided text, in the same order as provided. The last term of the provided text is treated as a prefix, matching any words that begin with that term.
-
prefix object
Returns documents that contain a specific prefix in a provided field.
-
range object
Returns documents that contain terms within a provided range.
-
regexp object
Returns documents that contain terms matching a regular expression.
-
span_term object
Matches spans containing a term.
-
term object
Returns documents that contain an exact term in a provided field. To return a document, the query term must exactly match the queried field's value, including whitespace and capitalization.
-
terms_set object
Returns documents that contain a minimum number of exact terms in a provided field. To return a document, a required number of terms must exactly match the field values, including whitespace and capitalization.
-
Uses a natural language processing model to convert the query text into a list of token-weight pairs which are then used in a query against a sparse vector or rank features field.
-
Supports returning text_expansion query results by sending in precomputed tokens with the query.
-
wildcard object
Returns documents that contain terms matching a wildcard pattern.
-
max_children number
-
nested object
-
Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
-
-
One of: Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
Hide attributes Show attributes
-
_score object
Hide _score attribute Show _score attribute object
-
order string
Values are
ascordesc.
-
-
_doc object
Hide _doc attribute Show _doc attribute object
-
order string
Values are
ascordesc.
-
-
_geo_distance object
Hide _geo_distance attributes Show _geo_distance attributes object
-
mode string
Values are
min,max,sum,avg, ormedian. -
distance_type string
Values are
arcorplane. -
ignore_unmapped boolean
-
order string
Values are
ascordesc. -
unit string
Values are
in,ft,yd,mi,nmi,km,m,cm, ormm. -
nested object
Hide nested attributes Show nested attributes object
-
filter object
-
max_children number
-
nested object
-
Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
-
-
-
_script object
Hide _script attributes Show _script attributes object
-
order string
Values are
ascordesc. -
type string
Values are
string,number, orversion. -
mode string
Values are
min,max,sum,avg, ormedian. -
nested object
Hide nested attributes Show nested attributes object
-
filter object
-
max_children number
-
nested object
-
Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
-
-
-
-
size number
The number of hits to return. By default, you cannot page through more than 10,000 hits using the
fromandsizeparameters. To page through more hits, use thesearch_afterparameter. -
search_after array[number | string | boolean | null | object]
Responses
-
200 application/json
Hide response attributes Show response attributes object
-
The total number of API keys found.
-
The number of API keys returned in the response.
-
A list of API key information.
Hide api_keys attributes Show api_keys attributes object
-
creation number
Creation time for the API key in milliseconds.
-
expiration number
Expiration time for the API key in milliseconds.
-
invalidated boolean
Invalidation status for the API key. If the key has been invalidated, it has a value of
true. Otherwise, it isfalse. -
realm string
Realm name of the principal for which this API key was created.
-
realm_type string
Realm type of the principal for which this API key was created
-
username string
-
profile_uid string
The profile uid for the API key owner principal, if requested and if it exists
-
metadata object
Hide metadata attributes Show metadata attributes object
-
key object
-
role_descriptors object
Hide role_descriptors attributes Show role_descriptors attributes object
-
cluster array[string]
A list of cluster privileges. These privileges define the cluster level actions that API keys are able to execute.
-
indices array[object]
A list of indices permissions entries.
-
applications array[object]
A list of application privilege entries
-
metadata object
Hide metadata attributes Show metadata attributes object
-
key object
-
run_as array[string]
A list of users that the API keys can impersonate. Note: in Serverless, the run-as feature is disabled. For API compatibility, you can still specify an empty
run_asfield, but a non-empty list will be rejected. -
description string
Optional description of the role descriptor
-
transient_metadata object
Hide transient_metadata attributes Show transient_metadata attributes object
-
key object
-
limited_by array[object]
The owner user’s permissions associated with the API key. It is a point-in-time snapshot captured at creation and subsequent updates. An API key’s effective permissions are an intersection of its assigned privileges and the owner user’s permissions.
Hide limited_by attributes Show limited_by attributes object
-
cluster array[string]
A list of cluster privileges. These privileges define the cluster level actions that API keys are able to execute.
-
indices array[object]
A list of indices permissions entries.
-
applications array[object]
A list of application privilege entries
-
metadata object
-
run_as array[string]
A list of users that the API keys can impersonate. Note: in Serverless, the run-as feature is disabled. For API compatibility, you can still specify an empty
run_asfield, but a non-empty list will be rejected. -
description string
Optional description of the role descriptor
-
transient_metadata object
-
_sort array[number | string | boolean | null | object]
-
-
aggregations object
The aggregations result, if requested.
-
curl \
-X GET http://api.example.com/_security/_query/api_key \
-H "Content-Type: application/json" \
-d '{"aggregations":{},"query":{"":{"boost":42.0,"_name":"string"},"match":{},"prefix":{},"range":{},"term":{},"wildcard":{}},"from":42.0,"":"string","size":42.0,"search_after":[42.0]}'