You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/reference.asciidoc
+74-69Lines changed: 74 additions & 69 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2321,18 +2321,6 @@ client.enrich.putPolicy({ name })
2321
2321
** *`match` (Optional, { enrich_fields, indices, match_field, query, name, elasticsearch_version })*: Matches enrich data to incoming documents based on a `term` query.
2322
2322
** *`range` (Optional, { enrich_fields, indices, match_field, query, name, elasticsearch_version })*: Matches a number, date, or IP address in incoming documents to a range in the enrich index based on a `term` query.
2323
2323
2324
-
[discrete]
2325
-
==== stats
2326
-
Get enrich stats.
2327
-
Returns enrich coordinator statistics and information about enrich policies that are currently executing.
** *`name` (string | string[])*: A list of data streams of which the data stream lifecycle will be deleted; use `*` to get all data streams
2665
-
** *`expand_wildcards` (Optional, Enum("all" | "open" | "closed" | "hidden" | "none") | Enum("all" | "open" | "closed" | "hidden" | "none")[])*: Whether wildcard expressions should get expanded to open or closed indices (default: open)
2666
-
** *`master_timeout` (Optional, string | -1 | 0)*: Specify timeout for connection to master
2667
-
** *`timeout` (Optional, string | -1 | 0)*: Explicit timestamp for the document
2668
-
2669
2637
[discrete]
2670
2638
==== delete_data_stream
2671
2639
Delete data streams.
@@ -3129,7 +3097,7 @@ client.indices.putIndexTemplate({ name })
3129
3097
Component templates are merged in the order specified, meaning that the last component template specified has the highest precedence.
3130
3098
** *`template` (Optional, { aliases, mappings, settings, lifecycle })*: Template to be applied.
3131
3099
It may optionally include an `aliases`, `mappings`, or `settings` configuration.
3132
-
** *`data_stream` (Optional, { hidden })*: If this object is included, the template is used to create data streams and their backing indices.
3100
+
** *`data_stream` (Optional, { hidden, allow_custom_routing })*: If this object is included, the template is used to create data streams and their backing indices.
3133
3101
Supports an empty object.
3134
3102
Data streams require a matching index template with a `data_stream` object.
3135
3103
** *`priority` (Optional, number)*: Priority to determine index template precedence when a new data stream or index is created.
@@ -3241,39 +3209,6 @@ error.
3241
3209
** *`timeout` (Optional, string | -1 | 0)*: Period to wait for a response. If no response is received before the
3242
3210
timeout expires, the request fails and returns an error.
3243
3211
3244
-
[discrete]
3245
-
==== put_template
3246
-
Create or update an index template.
3247
-
Index templates define settings, mappings, and aliases that can be applied automatically to new indices.
** *`version` (Optional, number)*: Version number used to manage index templates externally. This number
3271
-
is not automatically generated by Elasticsearch.
3272
-
** *`create` (Optional, boolean)*: If true, this request cannot replace or update existing index templates.
3273
-
** *`master_timeout` (Optional, string | -1 | 0)*: Period to wait for a connection to the master node. If no response is
3274
-
received before the timeout expires, the request fails and returns an error.
3275
-
** *`cause` (Optional, string)*
3276
-
3277
3212
[discrete]
3278
3213
==== refresh
3279
3214
Refresh an index.
@@ -3409,7 +3344,7 @@ If set to `false`, then indices or data streams matching the template must alway
3409
3344
Component templates are merged in the order specified, meaning that the last component template specified has the highest precedence.
3410
3345
** *`template` (Optional, { aliases, mappings, settings, lifecycle })*: Template to be applied.
3411
3346
It may optionally include an `aliases`, `mappings`, or `settings` configuration.
3412
-
** *`data_stream` (Optional, { hidden })*: If this object is included, the template is used to create data streams and their backing indices.
3347
+
** *`data_stream` (Optional, { hidden, allow_custom_routing })*: If this object is included, the template is used to create data streams and their backing indices.
3413
3348
Supports an empty object.
3414
3349
Data streams require a matching index template with a `data_stream` object.
3415
3350
** *`priority` (Optional, number)*: Priority to determine index template precedence when a new data stream or index is created.
@@ -3643,8 +3578,8 @@ client.ingest.putPipeline({ id })
3643
3578
** *`id` (string)*: ID of the ingest pipeline to create or update.
3644
3579
** *`_meta` (Optional, Record<string, User-defined value>)*: Optional metadata about the ingest pipeline. May have any contents. This map is not automatically generated by Elasticsearch.
3645
3580
** *`description` (Optional, string)*: Description of the ingest pipeline.
3646
-
** *`on_failure` (Optional, { append, attachment, bytes, circle, convert, csv, date, date_index_name, dissect, dot_expander, drop, enrich, fail, foreach, geo_grid, geoip, grok, gsub, html_strip, inference, join, json, kv, lowercase, pipeline, redact, remove, rename, reroute, script, set, set_security_user, sort, split, trim, uppercase, urldecode, uri_parts, user_agent }[])*: Processors to run immediately after a processor failure. Each processor supports a processor-level `on_failure` value. If a processor without an `on_failure` value fails, Elasticsearch uses this pipeline-level parameter as a fallback. The processors in this parameter run sequentially in the order specified. Elasticsearch will not attempt to run the pipeline's remaining processors.
3647
-
** *`processors` (Optional, { append, attachment, bytes, circle, convert, csv, date, date_index_name, dissect, dot_expander, drop, enrich, fail, foreach, geo_grid, geoip, grok, gsub, html_strip, inference, join, json, kv, lowercase, pipeline, redact, remove, rename, reroute, script, set, set_security_user, sort, split, trim, uppercase, urldecode, uri_parts, user_agent }[])*: Processors used to perform transformations on documents before indexing. Processors run sequentially in the order specified.
3581
+
** *`on_failure` (Optional, { append, attachment, bytes, circle, convert, csv, date, date_index_name, dissect, dot_expander, drop, enrich, fail, foreach, geo_grid, geoip, grok, gsub, html_strip, inference, join, json, kv, lowercase, pipeline, redact, remove, rename, reroute, script, set, set_security_user, sort, split, terminate, trim, uppercase, urldecode, uri_parts, user_agent }[])*: Processors to run immediately after a processor failure. Each processor supports a processor-level `on_failure` value. If a processor without an `on_failure` value fails, Elasticsearch uses this pipeline-level parameter as a fallback. The processors in this parameter run sequentially in the order specified. Elasticsearch will not attempt to run the pipeline's remaining processors.
3582
+
** *`processors` (Optional, { append, attachment, bytes, circle, convert, csv, date, date_index_name, dissect, dot_expander, drop, enrich, fail, foreach, geo_grid, geoip, grok, gsub, html_strip, inference, join, json, kv, lowercase, pipeline, redact, remove, rename, reroute, script, set, set_security_user, sort, split, terminate, trim, uppercase, urldecode, uri_parts, user_agent }[])*: Processors used to perform transformations on documents before indexing. Processors run sequentially in the order specified.
3648
3583
** *`version` (Optional, number)*: Version number used by external systems to track ingest pipelines. This parameter is intended for external systems only. Elasticsearch does not use or validate pipeline version numbers.
3649
3584
** *`deprecated` (Optional, boolean)*: Marks this ingest pipeline as deprecated.
3650
3585
When a deprecated ingest pipeline is referenced as the default or final pipeline when creating or updating a non-deprecated index template, Elasticsearch will emit a deprecation warning.
** *`metadata` (Optional, Record<string, User-defined value>)*: Arbitrary metadata that you want to associate with the API key. It supports nested data structure. Within the metadata object, keys beginning with `_` are reserved for system usage.
5600
5535
** *`refresh` (Optional, Enum(true | false | "wait_for"))*: If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes.
** *`refresh` (Optional, Enum(true | false | "wait_for"))*: If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes.
5553
+
5602
5554
[discrete]
5603
5555
==== get_api_key
5604
5556
Get API key information.
@@ -5634,6 +5586,34 @@ descriptors and the owner user's role descriptors.
5634
5586
** *`active_only` (Optional, boolean)*: A boolean flag that can be used to query API keys that are currently active. An API key is considered active if it is neither invalidated, nor expired at query time. You can specify this together with other parameters such as `owner` or `name`. If `active_only` is false, the response will include both active and inactive (expired or invalidated) keys.
5635
5587
** *`with_profile_uid` (Optional, boolean)*: Determines whether to also retrieve the profile uid, for the API key owner principal, if it exists.
5636
5588
5589
+
[discrete]
5590
+
==== get_builtin_privileges
5591
+
Retrieves the list of cluster privileges and index privileges that are available in this version of Elasticsearch.
** *`name` (Optional, string | string[])*: The name of the role. You can specify multiple roles as a list. If you do not specify this parameter, the API returns information about all roles.
5616
+
5637
5617
[discrete]
5638
5618
==== has_privileges
5639
5619
Check user privileges.
@@ -5687,6 +5667,31 @@ This parameter cannot be used with either `ids` or `name`, or when `owner` flag
5687
5667
** *`username` (Optional, string)*: The username of a user.
5688
5668
This parameter cannot be used with either `ids` or `name`, or when `owner` flag is set to `true`.
5689
5669
5670
+
[discrete]
5671
+
==== put_role
5672
+
The role management APIs are generally the preferred way to manage roles, rather than using file-based role management.
5673
+
The create or update roles API cannot update roles that are defined in roles files.
** *`name` (string)*: The name of the role that is being created or updated. On Elasticsearch Serverless, the role name must begin with a letter or digit and can only contain letters, digits and the characters '_', '-', and '.'. Each role must have a unique name, as this will serve as the identifier for that role.
5686
+
** *`applications` (Optional, { application, privileges, resources }[])*: A list of application privilege entries.
** *`indices` (Optional, { field_security, names, privileges, query }[])*: A list of indices permissions entries.
5689
+
** *`metadata` (Optional, Record<string, User-defined value>)*: Optional metadata. Within the metadata object, keys that begin with an underscore (`_`) are reserved for system use.
5690
+
** *`run_as` (Optional, string[])*: A list of users that the owners of this role can impersonate. *Note*: in Serverless, the run-as feature is disabled. For API compatibility, you can still specify an empty `run_as` field, but a non-empty list will be rejected.
5691
+
** *`description` (Optional, string)*: Optional description of the role descriptor
5692
+
** *`transient_metadata` (Optional, Record<string, User-defined value>)*: Indicates roles that might be incompatible with the current cluster license, specifically roles with document and field level security. When the cluster license doesn’t allow certain features for a given role, this parameter is updated dynamically to list the incompatible features. If `enabled` is `false`, the role is ignored, but is still listed in the response from the authenticate API.
5693
+
** *`refresh` (Optional, Enum(true | false | "wait_for"))*: If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes.
0 commit comments