@lap v0.3 # Machine-readable API spec. Each @endpoint block is one API call. @api Elasticsearch Request & Response Specification @auth ApiKey ids in path @endpoints 824 @hint download_for_search @toc _async_search(4), {index}(123), _bulk(2), _cat(47), _ccr(7), _search(10), _pit(1), _cluster(15), _component_template(6), _info(1), _remote(1), _connector(30), _count(2), _dangling(3), _delete_by_query(1), _scripts(8), _enrich(6), _eql(3), _query(7), _features(2), _field_caps(2), _fleet(2), _script_context(1), _script_language(1), _health_report(2), _ilm(9), _analyze(2), _migration(6), _cache(1), _data_stream(19), _create_from(2), _index_template(9), _template(6), _alias(3), _flush(2), _forcemerge(1), _lifecycle(1), _mapping(2), _settings(3), _recovery(1), _refresh(2), _resolve(4), {alias}(2), _segments(1), _shard_stores(1), _stats(2), _aliases(1), _validate(2), _inference(45), root(2), _ingest(22), _license(8), _logstash(4), _mget(2), _ml(107), _msearch(4), _mtermvectors(2), _nodes(20), _query_rules(8), _rank_eval(2), _reindex(2), _render(4), _rollup(8), _application(12), _search_shards(2), _searchable_snapshots(4), _snapshot(19), _security(95), _slm(10), _sql(8), _ssl(1), _streams(3), _synonyms(7), _tasks(4), _text_structure(6), _transform(17), _update_by_query(1), _watcher(24), _xpack(2) @group _async_search @endpoint GET /_async_search/{id} @desc Get async search results @required {id: str # A unique identifier for the async search.} @optional {keep_alive: any # The length of time that the async search should be available in the cluster. When not specified, the `keep_alive` set with the corresponding submit async request will be used. Otherwise, it is possible to override the value and extend the validity of the request. When this period expires, the search, if still running, is cancelled. If the search is completed, its saved results are deleted., typed_keys: bool # Specify whether aggregation and suggester names should be prefixed by their respective types in the response, wait_for_completion_timeout: any # Specifies to wait for the search to be completed up until the provided timeout. Final results will be returned if available before the timeout expires, otherwise the currently available results will be returned once the timeout expires. By default no timeout is set meaning that the currently available results will be returned without any additional wait., return_intermediate_results: bool # Specifies whether the response should contain intermediate results if the query is still running when the wait_for_completion_timeout expires or if no wait_for_completion_timeout is specified. If true and the search is still running, the search response will include any hits and partial aggregations that are available. If false and the search is still running, the search response will not include any hits (but possibly include total hits) nor will include any partial aggregations. When not specified, the intermediate results are returned for running queries.} @returns(200) @endpoint DELETE /_async_search/{id} @desc Delete an async search @required {id: str # A unique identifier for the async search.} @returns(200) {acknowledged: bool} @endpoint GET /_async_search/status/{id} @desc Get the async search status @required {id: str # A unique identifier for the async search.} @optional {keep_alive: any # The length of time that the async search needs to be available. Ongoing async searches and any saved search results are deleted after this period.} @returns(200) @endpoint POST /_async_search @desc Run an async search @optional {wait_for_completion_timeout: any # Blocks and waits until the search is completed up to a certain timeout. When the async search completes within the timeout, the response won’t include the ID as the results are not stored in the cluster., keep_alive: any # Specifies how long the async search needs to be available. Ongoing async searches and any saved search results are deleted after this period., keep_on_completion: bool # If `true`, results are stored for later retrieval when the search completes within the `wait_for_completion_timeout`., allow_no_indices: bool # A setting that does two separate checks on the index expression. If `false`, the request returns an error (1) if any wildcard expression (including `_all` and `*`) resolves to zero matching indices or (2) if the complete set of resolved indices, aliases or data streams is empty after all expressions are evaluated. If `true`, index expressions that resolve to no indices are allowed and the request returns an empty result., allow_partial_search_results: bool # Indicate if an error should be returned if there is a partial search failure or timeout, analyzer: str # The analyzer to use for the query string, analyze_wildcard: bool # Specify whether wildcard and prefix queries should be analyzed, batched_reduce_size: num # Affects how often partial results become available, which happens whenever shard results are reduced. A partial reduction is performed every time the coordinating node has received a certain number of new shard responses (5 by default)., ccs_minimize_roundtrips: bool # The default value is the only supported value., default_operator: str # The default operator for query string query (AND or OR), df: str # The field to use as default where no field prefix is given in the query string, docvalue_fields: any # A comma-separated list of fields to return as the docvalue representation of a field for each hit, expand_wildcards: any # Whether to expand wildcard expression to concrete indices that are open, closed or both, explain: bool # Specify whether to return detailed information about score computation as part of a hit, ignore_throttled: bool # Whether specified concrete, expanded or aliased indices should be ignored when throttled, ignore_unavailable: bool # If `false`, the request returns an error if it targets a concrete (non-wildcarded) index, alias, or data stream that is missing, closed, or otherwise unavailable. If `true`, unavailable concrete targets are silently ignored., lenient: bool # Specify whether format-based query failures (such as providing text to a numeric field) should be ignored, max_concurrent_shard_requests: num # The number of concurrent shard requests per node this search executes concurrently. This value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests, preference: str # Specify the node or shard the operation should be performed on, request_cache: bool # Specify if request cache should be used for this request or not, defaults to true, routing: any # A comma-separated list of specific routing values, search_type: str # Search operation type, stats: [str] # Specific 'tag' of the request for logging and statistical purposes, stored_fields: any # A comma-separated list of stored fields to return as part of a hit, suggest_field: str # Specifies which field to use for suggestions., suggest_mode: str # Specify suggest mode, suggest_size: num # How many suggestions to return in response, suggest_text: str # The source text for which the suggestions should be returned., terminate_after: num # The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early, timeout: any # Explicit operation timeout, track_total_hits: any # Indicate if the number of documents that match the query should be tracked. A number can also be specified, to accurately track the total hit count up to the number., track_scores: bool # Whether to calculate and return scores even if they are not used for sorting, typed_keys: bool # Specify whether aggregation and suggester names should be prefixed by their respective types in the response, rest_total_hits_as_int: bool # Indicates whether hits.total should be rendered as an integer or an object in the rest search response, version: bool # Specify whether to return document version as part of a hit, _source: any # True or false to return the _source field or not, or a list of fields to return, _source_excludes: any # A list of fields to exclude from the returned _source field, _source_includes: any # A list of fields to extract and return from the _source field, seq_no_primary_term: bool # Specify whether to return sequence number and primary term of the last modification of each hit, q: str # Query in the Lucene query string syntax, size: num # Number of hits to return, from: num # Starting offset, sort: any # A comma-separated list of : pairs, aggregations: map, collapse: any, explain: bool=false # If true, returns detailed information about score computation as part of a hit., ext: map # Configuration of search extensions defined by Elasticsearch plugins., from: num=0 # 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_after parameter., highlight: any, track_total_hits: any # Number of hits matching the query to count accurately. If true, the exact number of hits is returned at the cost of some performance. If false, the response does not include the total number of hits matching the query. Defaults to 10,000 hits., indices_boost: [map] # Boosts the _score of documents from specified indices., docvalue_fields: [map{field!: any, format: str, include_unmapped: bool}] # Array of wildcard (*) patterns. The request returns doc values for field names matching these patterns in the hits.fields property of the response., knn: any # Defines the approximate kNN search to run., min_score: num # Minimum _score for matching documents. Documents with a lower _score are not included in search results and results collected by aggregations., post_filter: any, profile: bool, query: any # Defines the search definition using the Query DSL., rescore: any, script_fields: map # Retrieve a script evaluation (based on different fields) for each hit., search_after: any, size: num=10 # The number of hits to return. 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_after parameter., slice: any, sort: any, _source: any # Indicates which source fields are returned for matching documents. These fields are returned in the hits._source property of the search response., fields: [map{field!: any, format: str, include_unmapped: bool}] # Array of wildcard (*) patterns. The request returns values for field names matching these patterns in the hits.fields property of the response., suggest: any, terminate_after: num=0 # Maximum number of documents to collect for each shard. If a query reaches this limit, Elasticsearch terminates the query early. Elasticsearch collects documents before sorting. Defaults to 0, which does not terminate query execution early., timeout: str # Specifies the period of time to wait for a response from each shard. If no response is received before the timeout expires, the request fails and returns an error. Defaults to no timeout., track_scores: bool=false # If true, calculate and return document scores, even if the scores are not used for sorting., version: bool=false # If true, returns document version as part of a hit., seq_no_primary_term: bool # If true, returns sequence number and primary term of the last modification of each hit. See Optimistic concurrency control., stored_fields: any # List of stored fields to return as part of a hit. If no fields are specified, no stored fields are included in the response. If this field is specified, the _source parameter defaults to false. You can pass _source: true to return both source fields and stored fields in the search response., pit: any # Limits the search to a point in time (PIT). If you provide a PIT, you cannot specify an in the request path., runtime_mappings: any # Defines one or more runtime fields in the search request. These fields take precedence over mapped fields with the same name., stats: [str] # Stats groups to associate with the search. Each group maintains a statistics aggregation for its associated searches. You can retrieve these stats using the indices stats API.} @returns(200) @example_request "{\n \"sort\": [\n { \"date\": { \"order\": \"asc\" } }\n ],\n \"aggs\": {\n \"sale_date\": {\n \"date_histogram\": {\n \"field\": \"date\",\n \"calendar_interval\": \"1d\"\n }\n }\n }\n}" @endgroup @group {index} @endpoint POST /{index}/_async_search @desc Run an async search @required {index: any # A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices} @optional {wait_for_completion_timeout: any # Blocks and waits until the search is completed up to a certain timeout. When the async search completes within the timeout, the response won’t include the ID as the results are not stored in the cluster., keep_alive: any # Specifies how long the async search needs to be available. Ongoing async searches and any saved search results are deleted after this period., keep_on_completion: bool # If `true`, results are stored for later retrieval when the search completes within the `wait_for_completion_timeout`., allow_no_indices: bool # A setting that does two separate checks on the index expression. If `false`, the request returns an error (1) if any wildcard expression (including `_all` and `*`) resolves to zero matching indices or (2) if the complete set of resolved indices, aliases or data streams is empty after all expressions are evaluated. If `true`, index expressions that resolve to no indices are allowed and the request returns an empty result., allow_partial_search_results: bool # Indicate if an error should be returned if there is a partial search failure or timeout, analyzer: str # The analyzer to use for the query string, analyze_wildcard: bool # Specify whether wildcard and prefix queries should be analyzed, batched_reduce_size: num # Affects how often partial results become available, which happens whenever shard results are reduced. A partial reduction is performed every time the coordinating node has received a certain number of new shard responses (5 by default)., ccs_minimize_roundtrips: bool # The default value is the only supported value., default_operator: str # The default operator for query string query (AND or OR), df: str # The field to use as default where no field prefix is given in the query string, docvalue_fields: any # A comma-separated list of fields to return as the docvalue representation of a field for each hit, expand_wildcards: any # Whether to expand wildcard expression to concrete indices that are open, closed or both, explain: bool # Specify whether to return detailed information about score computation as part of a hit, ignore_throttled: bool # Whether specified concrete, expanded or aliased indices should be ignored when throttled, ignore_unavailable: bool # If `false`, the request returns an error if it targets a concrete (non-wildcarded) index, alias, or data stream that is missing, closed, or otherwise unavailable. If `true`, unavailable concrete targets are silently ignored., lenient: bool # Specify whether format-based query failures (such as providing text to a numeric field) should be ignored, max_concurrent_shard_requests: num # The number of concurrent shard requests per node this search executes concurrently. This value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests, preference: str # Specify the node or shard the operation should be performed on, request_cache: bool # Specify if request cache should be used for this request or not, defaults to true, routing: any # A comma-separated list of specific routing values, search_type: str # Search operation type, stats: [str] # Specific 'tag' of the request for logging and statistical purposes, stored_fields: any # A comma-separated list of stored fields to return as part of a hit, suggest_field: str # Specifies which field to use for suggestions., suggest_mode: str # Specify suggest mode, suggest_size: num # How many suggestions to return in response, suggest_text: str # The source text for which the suggestions should be returned., terminate_after: num # The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early, timeout: any # Explicit operation timeout, track_total_hits: any # Indicate if the number of documents that match the query should be tracked. A number can also be specified, to accurately track the total hit count up to the number., track_scores: bool # Whether to calculate and return scores even if they are not used for sorting, typed_keys: bool # Specify whether aggregation and suggester names should be prefixed by their respective types in the response, rest_total_hits_as_int: bool # Indicates whether hits.total should be rendered as an integer or an object in the rest search response, version: bool # Specify whether to return document version as part of a hit, _source: any # True or false to return the _source field or not, or a list of fields to return, _source_excludes: any # A list of fields to exclude from the returned _source field, _source_includes: any # A list of fields to extract and return from the _source field, seq_no_primary_term: bool # Specify whether to return sequence number and primary term of the last modification of each hit, q: str # Query in the Lucene query string syntax, size: num # Number of hits to return, from: num # Starting offset, sort: any # A comma-separated list of : pairs, aggregations: map, collapse: any, explain: bool=false # If true, returns detailed information about score computation as part of a hit., ext: map # Configuration of search extensions defined by Elasticsearch plugins., from: num=0 # 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_after parameter., highlight: any, track_total_hits: any # Number of hits matching the query to count accurately. If true, the exact number of hits is returned at the cost of some performance. If false, the response does not include the total number of hits matching the query. Defaults to 10,000 hits., indices_boost: [map] # Boosts the _score of documents from specified indices., docvalue_fields: [map{field!: any, format: str, include_unmapped: bool}] # Array of wildcard (*) patterns. The request returns doc values for field names matching these patterns in the hits.fields property of the response., knn: any # Defines the approximate kNN search to run., min_score: num # Minimum _score for matching documents. Documents with a lower _score are not included in search results and results collected by aggregations., post_filter: any, profile: bool, query: any # Defines the search definition using the Query DSL., rescore: any, script_fields: map # Retrieve a script evaluation (based on different fields) for each hit., search_after: any, size: num=10 # The number of hits to return. 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_after parameter., slice: any, sort: any, _source: any # Indicates which source fields are returned for matching documents. These fields are returned in the hits._source property of the search response., fields: [map{field!: any, format: str, include_unmapped: bool}] # Array of wildcard (*) patterns. The request returns values for field names matching these patterns in the hits.fields property of the response., suggest: any, terminate_after: num=0 # Maximum number of documents to collect for each shard. If a query reaches this limit, Elasticsearch terminates the query early. Elasticsearch collects documents before sorting. Defaults to 0, which does not terminate query execution early., timeout: str # Specifies the period of time to wait for a response from each shard. If no response is received before the timeout expires, the request fails and returns an error. Defaults to no timeout., track_scores: bool=false # If true, calculate and return document scores, even if the scores are not used for sorting., version: bool=false # If true, returns document version as part of a hit., seq_no_primary_term: bool # If true, returns sequence number and primary term of the last modification of each hit. See Optimistic concurrency control., stored_fields: any # List of stored fields to return as part of a hit. If no fields are specified, no stored fields are included in the response. If this field is specified, the _source parameter defaults to false. You can pass _source: true to return both source fields and stored fields in the search response., pit: any # Limits the search to a point in time (PIT). If you provide a PIT, you cannot specify an in the request path., runtime_mappings: any # Defines one or more runtime fields in the search request. These fields take precedence over mapped fields with the same name., stats: [str] # Stats groups to associate with the search. Each group maintains a statistics aggregation for its associated searches. You can retrieve these stats using the indices stats API.} @returns(200) @example_request "{\n \"sort\": [\n { \"date\": { \"order\": \"asc\" } }\n ],\n \"aggs\": {\n \"sale_date\": {\n \"date_histogram\": {\n \"field\": \"date\",\n \"calendar_interval\": \"1d\"\n }\n }\n }\n}" @endgroup @group _bulk @endpoint PUT /_bulk @desc Bulk index or delete documents @optional {include_source_on_error: bool # True or false if to include the document source in the error message in case of parsing errors., list_executed_pipelines: bool # If `true`, the response will include the ingest pipelines that were run for each index or create., pipeline: str # The pipeline identifier to use to preprocess incoming documents. If the index has a default ingest pipeline specified, setting the value to `_none` turns off the default ingest pipeline for this request. If a final pipeline is configured, it will always run regardless of the value of this parameter., refresh: str # If `true`, Elasticsearch refreshes the affected shards to make this operation visible to search. If `wait_for`, wait for a refresh to make this operation visible to search. If `false`, do nothing with refreshes. Valid values: `true`, `false`, `wait_for`., routing: any # A custom value that is used to route operations to a specific shard., _source: any # Indicates whether to return the `_source` field (`true` or `false`) or contains a list of fields to return., _source_excludes: any # A comma-separated list of source fields to exclude from the response. You can also use this parameter to exclude fields from the subset specified in `_source_includes` query parameter. If the `_source` parameter is `false`, this parameter is ignored., _source_includes: any # A comma-separated list of source fields to include in the response. If this parameter is specified, only these source fields are returned. You can exclude fields from this subset using the `_source_excludes` query parameter. If the `_source` parameter is `false`, this parameter is ignored., timeout: any # The period each action waits for the following operations: automatic index creation, dynamic mapping updates, and waiting for active shards. The default is `1m` (one minute), which guarantees Elasticsearch waits for at least the timeout before failing. The actual wait time could be longer, particularly when multiple waits occur., wait_for_active_shards: any # The number of shard copies that must be active before proceeding with the operation. Set to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). The default is `1`, which waits for each primary shard to be active., require_alias: bool # If `true`, the request's actions must target an index alias., require_data_stream: bool # If `true`, the request's actions must target a data stream (existing or to be created).} @returns(200) {errors: bool, items: [map], took: num, ingest_took: num} @example_request "{ \"index\" : { \"_index\" : \"test\", \"_id\" : \"1\" } }\n{ \"field1\" : \"value1\" }\n{ \"delete\" : { \"_index\" : \"test\", \"_id\" : \"2\" } }\n{ \"create\" : { \"_index\" : \"test\", \"_id\" : \"3\" } }\n{ \"field1\" : \"value3\" }\n{ \"update\" : {\"_id\" : \"1\", \"_index\" : \"test\"} }\n{ \"doc\" : {\"field2\" : \"value2\"} }" @endpoint POST /_bulk @desc Bulk index or delete documents @optional {include_source_on_error: bool # True or false if to include the document source in the error message in case of parsing errors., list_executed_pipelines: bool # If `true`, the response will include the ingest pipelines that were run for each index or create., pipeline: str # The pipeline identifier to use to preprocess incoming documents. If the index has a default ingest pipeline specified, setting the value to `_none` turns off the default ingest pipeline for this request. If a final pipeline is configured, it will always run regardless of the value of this parameter., refresh: str # If `true`, Elasticsearch refreshes the affected shards to make this operation visible to search. If `wait_for`, wait for a refresh to make this operation visible to search. If `false`, do nothing with refreshes. Valid values: `true`, `false`, `wait_for`., routing: any # A custom value that is used to route operations to a specific shard., _source: any # Indicates whether to return the `_source` field (`true` or `false`) or contains a list of fields to return., _source_excludes: any # A comma-separated list of source fields to exclude from the response. You can also use this parameter to exclude fields from the subset specified in `_source_includes` query parameter. If the `_source` parameter is `false`, this parameter is ignored., _source_includes: any # A comma-separated list of source fields to include in the response. If this parameter is specified, only these source fields are returned. You can exclude fields from this subset using the `_source_excludes` query parameter. If the `_source` parameter is `false`, this parameter is ignored., timeout: any # The period each action waits for the following operations: automatic index creation, dynamic mapping updates, and waiting for active shards. The default is `1m` (one minute), which guarantees Elasticsearch waits for at least the timeout before failing. The actual wait time could be longer, particularly when multiple waits occur., wait_for_active_shards: any # The number of shard copies that must be active before proceeding with the operation. Set to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). The default is `1`, which waits for each primary shard to be active., require_alias: bool # If `true`, the request's actions must target an index alias., require_data_stream: bool # If `true`, the request's actions must target a data stream (existing or to be created).} @returns(200) {errors: bool, items: [map], took: num, ingest_took: num} @example_request "{ \"index\" : { \"_index\" : \"test\", \"_id\" : \"1\" } }\n{ \"field1\" : \"value1\" }\n{ \"delete\" : { \"_index\" : \"test\", \"_id\" : \"2\" } }\n{ \"create\" : { \"_index\" : \"test\", \"_id\" : \"3\" } }\n{ \"field1\" : \"value3\" }\n{ \"update\" : {\"_id\" : \"1\", \"_index\" : \"test\"} }\n{ \"doc\" : {\"field2\" : \"value2\"} }" @endgroup @group {index} @endpoint PUT /{index}/_bulk @desc Bulk index or delete documents @required {index: str # The name of the data stream, index, or index alias to perform bulk actions on.} @optional {include_source_on_error: bool # True or false if to include the document source in the error message in case of parsing errors., list_executed_pipelines: bool # If `true`, the response will include the ingest pipelines that were run for each index or create., pipeline: str # The pipeline identifier to use to preprocess incoming documents. If the index has a default ingest pipeline specified, setting the value to `_none` turns off the default ingest pipeline for this request. If a final pipeline is configured, it will always run regardless of the value of this parameter., refresh: str # If `true`, Elasticsearch refreshes the affected shards to make this operation visible to search. If `wait_for`, wait for a refresh to make this operation visible to search. If `false`, do nothing with refreshes. Valid values: `true`, `false`, `wait_for`., routing: any # A custom value that is used to route operations to a specific shard., _source: any # Indicates whether to return the `_source` field (`true` or `false`) or contains a list of fields to return., _source_excludes: any # A comma-separated list of source fields to exclude from the response. You can also use this parameter to exclude fields from the subset specified in `_source_includes` query parameter. If the `_source` parameter is `false`, this parameter is ignored., _source_includes: any # A comma-separated list of source fields to include in the response. If this parameter is specified, only these source fields are returned. You can exclude fields from this subset using the `_source_excludes` query parameter. If the `_source` parameter is `false`, this parameter is ignored., timeout: any # The period each action waits for the following operations: automatic index creation, dynamic mapping updates, and waiting for active shards. The default is `1m` (one minute), which guarantees Elasticsearch waits for at least the timeout before failing. The actual wait time could be longer, particularly when multiple waits occur., wait_for_active_shards: any # The number of shard copies that must be active before proceeding with the operation. Set to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). The default is `1`, which waits for each primary shard to be active., require_alias: bool # If `true`, the request's actions must target an index alias., require_data_stream: bool # If `true`, the request's actions must target a data stream (existing or to be created).} @returns(200) {errors: bool, items: [map], took: num, ingest_took: num} @example_request "{ \"index\" : { \"_index\" : \"test\", \"_id\" : \"1\" } }\n{ \"field1\" : \"value1\" }\n{ \"delete\" : { \"_index\" : \"test\", \"_id\" : \"2\" } }\n{ \"create\" : { \"_index\" : \"test\", \"_id\" : \"3\" } }\n{ \"field1\" : \"value3\" }\n{ \"update\" : {\"_id\" : \"1\", \"_index\" : \"test\"} }\n{ \"doc\" : {\"field2\" : \"value2\"} }" @endpoint POST /{index}/_bulk @desc Bulk index or delete documents @required {index: str # The name of the data stream, index, or index alias to perform bulk actions on.} @optional {include_source_on_error: bool # True or false if to include the document source in the error message in case of parsing errors., list_executed_pipelines: bool # If `true`, the response will include the ingest pipelines that were run for each index or create., pipeline: str # The pipeline identifier to use to preprocess incoming documents. If the index has a default ingest pipeline specified, setting the value to `_none` turns off the default ingest pipeline for this request. If a final pipeline is configured, it will always run regardless of the value of this parameter., refresh: str # If `true`, Elasticsearch refreshes the affected shards to make this operation visible to search. If `wait_for`, wait for a refresh to make this operation visible to search. If `false`, do nothing with refreshes. Valid values: `true`, `false`, `wait_for`., routing: any # A custom value that is used to route operations to a specific shard., _source: any # Indicates whether to return the `_source` field (`true` or `false`) or contains a list of fields to return., _source_excludes: any # A comma-separated list of source fields to exclude from the response. You can also use this parameter to exclude fields from the subset specified in `_source_includes` query parameter. If the `_source` parameter is `false`, this parameter is ignored., _source_includes: any # A comma-separated list of source fields to include in the response. If this parameter is specified, only these source fields are returned. You can exclude fields from this subset using the `_source_excludes` query parameter. If the `_source` parameter is `false`, this parameter is ignored., timeout: any # The period each action waits for the following operations: automatic index creation, dynamic mapping updates, and waiting for active shards. The default is `1m` (one minute), which guarantees Elasticsearch waits for at least the timeout before failing. The actual wait time could be longer, particularly when multiple waits occur., wait_for_active_shards: any # The number of shard copies that must be active before proceeding with the operation. Set to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). The default is `1`, which waits for each primary shard to be active., require_alias: bool # If `true`, the request's actions must target an index alias., require_data_stream: bool # If `true`, the request's actions must target a data stream (existing or to be created).} @returns(200) {errors: bool, items: [map], took: num, ingest_took: num} @example_request "{ \"index\" : { \"_index\" : \"test\", \"_id\" : \"1\" } }\n{ \"field1\" : \"value1\" }\n{ \"delete\" : { \"_index\" : \"test\", \"_id\" : \"2\" } }\n{ \"create\" : { \"_index\" : \"test\", \"_id\" : \"3\" } }\n{ \"field1\" : \"value3\" }\n{ \"update\" : {\"_id\" : \"1\", \"_index\" : \"test\"} }\n{ \"doc\" : {\"field2\" : \"value2\"} }" @endgroup @group _cat @endpoint GET /_cat/aliases @desc Get aliases @optional {h: any # A comma-separated list of columns names to display. It supports simple wildcards., s: any # List of columns that determine how the table should be sorted. Sorting defaults to ascending and can be changed by setting `:asc` or `:desc` as a suffix to the column name., expand_wildcards: any # The 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. It supports comma-separated values, such as `open,hidden`., master_timeout: any # The period to wait for a connection to the master node. If the master node is not available before the timeout expires, the request fails and returns an error. To indicated that the request should never timeout, you can set it to `-1`.} @returns(200) @endpoint GET /_cat/aliases/{name} @desc Get aliases @required {name: any # A comma-separated list of aliases to retrieve. Supports wildcards (`*`). To retrieve all aliases, omit this parameter or use `*` or `_all`.} @optional {h: any # A comma-separated list of columns names to display. It supports simple wildcards., s: any # List of columns that determine how the table should be sorted. Sorting defaults to ascending and can be changed by setting `:asc` or `:desc` as a suffix to the column name., expand_wildcards: any # The 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. It supports comma-separated values, such as `open,hidden`., master_timeout: any # The period to wait for a connection to the master node. If the master node is not available before the timeout expires, the request fails and returns an error. To indicated that the request should never timeout, you can set it to `-1`.} @returns(200) @endpoint GET /_cat/allocation @desc Get shard allocation information @optional {h: any # A comma-separated list of columns names to display. It supports simple wildcards., s: any # List of columns that determine how the table should be sorted. Sorting defaults to ascending and can be changed by setting `:asc` or `:desc` as a suffix to the column name., local: bool # If `true`, the request computes the list of selected nodes from the local cluster state. If `false` the list of selected nodes are computed from the cluster state of the master node. In both cases the coordinating node will send requests for further information to each selected node., master_timeout: any # Period to wait for a connection to the master node.} @returns(200) @endpoint GET /_cat/allocation/{node_id} @desc Get shard allocation information @required {node_id: any # A comma-separated list of node identifiers or names used to limit the returned information.} @optional {h: any # A comma-separated list of columns names to display. It supports simple wildcards., s: any # List of columns that determine how the table should be sorted. Sorting defaults to ascending and can be changed by setting `:asc` or `:desc` as a suffix to the column name., local: bool # If `true`, the request computes the list of selected nodes from the local cluster state. If `false` the list of selected nodes are computed from the cluster state of the master node. In both cases the coordinating node will send requests for further information to each selected node., master_timeout: any # Period to wait for a connection to the master node.} @returns(200) @endpoint GET /_cat/circuit_breaker @desc Get circuit breakers statistics @optional {h: any # A comma-separated list of columns names to display. It supports simple wildcards., s: any # List of columns that determine how the table should be sorted. Sorting defaults to ascending and can be changed by setting `:asc` or `:desc` as a suffix to the column name., local: bool # If `true`, the request computes the list of selected nodes from the local cluster state. If `false` the list of selected nodes are computed from the cluster state of the master node. In both cases the coordinating node will send requests for further information to each selected node., master_timeout: any # Period to wait for a connection to the master node.} @returns(200) @endpoint GET /_cat/circuit_breaker/{circuit_breaker_patterns} @desc Get circuit breakers statistics @required {circuit_breaker_patterns: any # A comma-separated list of regular-expressions to filter the circuit breakers in the output} @optional {h: any # A comma-separated list of columns names to display. It supports simple wildcards., s: any # List of columns that determine how the table should be sorted. Sorting defaults to ascending and can be changed by setting `:asc` or `:desc` as a suffix to the column name., local: bool # If `true`, the request computes the list of selected nodes from the local cluster state. If `false` the list of selected nodes are computed from the cluster state of the master node. In both cases the coordinating node will send requests for further information to each selected node., master_timeout: any # Period to wait for a connection to the master node.} @returns(200) @endpoint GET /_cat/component_templates @desc Get component templates @optional {h: any # A comma-separated list of columns names to display. It supports simple wildcards., s: any # List of columns that determine how the table should be sorted. Sorting defaults to ascending and can be changed by setting `:asc` or `:desc` as a suffix to the column name., local: bool # If `true`, the request computes the list of selected nodes from the local cluster state. If `false` the list of selected nodes are computed from the cluster state of the master node. In both cases the coordinating node will send requests for further information to each selected node., master_timeout: any # The period to wait for a connection to the master node.} @returns(200) @endpoint GET /_cat/component_templates/{name} @desc Get component templates @required {name: str # The name of the component template. It accepts wildcard expressions. If it is omitted, all component templates are returned.} @optional {h: any # A comma-separated list of columns names to display. It supports simple wildcards., s: any # List of columns that determine how the table should be sorted. Sorting defaults to ascending and can be changed by setting `:asc` or `:desc` as a suffix to the column name., local: bool # If `true`, the request computes the list of selected nodes from the local cluster state. If `false` the list of selected nodes are computed from the cluster state of the master node. In both cases the coordinating node will send requests for further information to each selected node., master_timeout: any # The period to wait for a connection to the master node.} @returns(200) @endpoint GET /_cat/count @desc Get a document count @optional {h: any # A comma-separated list of columns names to display. It supports simple wildcards., s: any # List of columns that determine how the table should be sorted. Sorting defaults to ascending and can be changed by setting `:asc` or `:desc` as a suffix to the column name.} @returns(200) @endpoint POST /_cat/count @desc Get a document count @optional {h: any # A comma-separated list of columns names to display. It supports simple wildcards., s: any # List of columns that determine how the table should be sorted. Sorting defaults to ascending and can be changed by setting `:asc` or `:desc` as a suffix to the column name.} @returns(200) @endpoint GET /_cat/count/{index} @desc Get a document count @required {index: any # A comma-separated list of data streams, indices, and aliases used to limit the request. It supports wildcards (`*`). To target all data streams and indices, omit this parameter or use `*` or `_all`.} @optional {h: any # A comma-separated list of columns names to display. It supports simple wildcards., s: any # List of columns that determine how the table should be sorted. Sorting defaults to ascending and can be changed by setting `:asc` or `:desc` as a suffix to the column name.} @returns(200) @endpoint POST /_cat/count/{index} @desc Get a document count @required {index: any # A comma-separated list of data streams, indices, and aliases used to limit the request. It supports wildcards (`*`). To target all data streams and indices, omit this parameter or use `*` or `_all`.} @optional {h: any # A comma-separated list of columns names to display. It supports simple wildcards., s: any # List of columns that determine how the table should be sorted. Sorting defaults to ascending and can be changed by setting `:asc` or `:desc` as a suffix to the column name.} @returns(200) @endpoint GET /_cat/fielddata @desc Get field data cache information @optional {fields: any # Comma-separated list of fields used to limit returned information., h: any # A comma-separated list of columns names to display. It supports simple wildcards., s: any # List of columns that determine how the table should be sorted. Sorting defaults to ascending and can be changed by setting `:asc` or `:desc` as a suffix to the column name.} @returns(200) @endpoint GET /_cat/fielddata/{fields} @desc Get field data cache information @required {fields: any # Comma-separated list of fields used to limit returned information. To retrieve all fields, omit this parameter.} @optional {fields: any # Comma-separated list of fields used to limit returned information., h: any # A comma-separated list of columns names to display. It supports simple wildcards., s: any # List of columns that determine how the table should be sorted. Sorting defaults to ascending and can be changed by setting `:asc` or `:desc` as a suffix to the column name.} @returns(200) @endpoint GET /_cat/health @desc Get the cluster health status @optional {ts: bool # If true, returns `HH:MM:SS` and Unix epoch timestamps., h: any # A comma-separated list of columns names to display. It supports simple wildcards., s: any # List of columns that determine how the table should be sorted. Sorting defaults to ascending and can be changed by setting `:asc` or `:desc` as a suffix to the column name.} @returns(200) @endpoint GET /_cat @desc Get CAT help @returns(200) @endpoint GET /_cat/indices @desc Get index information @optional {expand_wildcards: any # The type of index that wildcard patterns can match., health: str # The health status used to limit returned indices. By default, the response includes indices of any health status., include_unloaded_segments: bool # If true, the response includes information from segments that are not loaded into memory., pri: bool # If true, the response only includes information from primary shards., master_timeout: any # Period to wait for a connection to the master node., h: any # A comma-separated list of columns names to display. It supports simple wildcards., s: any # List of columns that determine how the table should be sorted. Sorting defaults to ascending and can be changed by setting `:asc` or `:desc` as a suffix to the column name.} @returns(200) @endpoint GET /_cat/indices/{index} @desc Get index information @required {index: any # Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams and indices, omit this parameter or use `*` or `_all`.} @optional {expand_wildcards: any # The type of index that wildcard patterns can match., health: str # The health status used to limit returned indices. By default, the response includes indices of any health status., include_unloaded_segments: bool # If true, the response includes information from segments that are not loaded into memory., pri: bool # If true, the response only includes information from primary shards., master_timeout: any # Period to wait for a connection to the master node., h: any # A comma-separated list of columns names to display. It supports simple wildcards., s: any # List of columns that determine how the table should be sorted. Sorting defaults to ascending and can be changed by setting `:asc` or `:desc` as a suffix to the column name.} @returns(200) @endpoint GET /_cat/master @desc Get master node information @optional {h: any # A comma-separated list of columns names to display. It supports simple wildcards., s: any # List of columns that determine how the table should be sorted. Sorting defaults to ascending and can be changed by setting `:asc` or `:desc` as a suffix to the column name., local: bool # If `true`, the request computes the list of selected nodes from the local cluster state. If `false` the list of selected nodes are computed from the cluster state of the master node. In both cases the coordinating node will send requests for further information to each selected node., master_timeout: any # Period to wait for a connection to the master node.} @returns(200) @endpoint GET /_cat/ml/data_frame/analytics @desc Get data frame analytics jobs @optional {allow_no_match: bool # Whether to ignore if a wildcard expression matches no configs. (This includes `_all` string or when no configs have been specified.), h: any # Comma-separated list of column names to display., s: any # Comma-separated list of column names or column aliases used to sort the response.} @returns(200) @endpoint GET /_cat/ml/data_frame/analytics/{id} @desc Get data frame analytics jobs @required {id: str # The ID of the data frame analytics to fetch} @optional {allow_no_match: bool # Whether to ignore if a wildcard expression matches no configs. (This includes `_all` string or when no configs have been specified.), h: any # Comma-separated list of column names to display., s: any # Comma-separated list of column names or column aliases used to sort the response.} @returns(200) @endpoint GET /_cat/ml/datafeeds @desc Get datafeeds @optional {allow_no_match: bool # Specifies what to do when the request: * Contains wildcard expressions and there are no datafeeds that match. * Contains the `_all` string or no identifiers and there are no matches. * Contains wildcard expressions and there are only partial matches. If `true`, the API returns an empty datafeeds array when there are no matches and the subset of results when there are partial matches. If `false`, the API returns a 404 status code when there are no matches or only partial matches., h: any # Comma-separated list of column names to display., s: any # Comma-separated list of column names or column aliases used to sort the response.} @returns(200) @endpoint GET /_cat/ml/datafeeds/{datafeed_id} @desc Get datafeeds @required {datafeed_id: str # A numerical character string that uniquely identifies the datafeed.} @optional {allow_no_match: bool # Specifies what to do when the request: * Contains wildcard expressions and there are no datafeeds that match. * Contains the `_all` string or no identifiers and there are no matches. * Contains wildcard expressions and there are only partial matches. If `true`, the API returns an empty datafeeds array when there are no matches and the subset of results when there are partial matches. If `false`, the API returns a 404 status code when there are no matches or only partial matches., h: any # Comma-separated list of column names to display., s: any # Comma-separated list of column names or column aliases used to sort the response.} @returns(200) @endpoint GET /_cat/ml/anomaly_detectors @desc Get anomaly detection jobs @optional {allow_no_match: bool # Specifies what to do when the request: * Contains wildcard expressions and there are no jobs that match. * Contains the `_all` string or no identifiers and there are no matches. * Contains wildcard expressions and there are only partial matches. If `true`, the API returns an empty jobs array when there are no matches and the subset of results when there are partial matches. If `false`, the API returns a 404 status code when there are no matches or only partial matches., h: any # Comma-separated list of column names to display., s: any # Comma-separated list of column names or column aliases used to sort the response.} @returns(200) @endpoint GET /_cat/ml/anomaly_detectors/{job_id} @desc Get anomaly detection jobs @required {job_id: str # Identifier for the anomaly detection job.} @optional {allow_no_match: bool # Specifies what to do when the request: * Contains wildcard expressions and there are no jobs that match. * Contains the `_all` string or no identifiers and there are no matches. * Contains wildcard expressions and there are only partial matches. If `true`, the API returns an empty jobs array when there are no matches and the subset of results when there are partial matches. If `false`, the API returns a 404 status code when there are no matches or only partial matches., h: any # Comma-separated list of column names to display., s: any # Comma-separated list of column names or column aliases used to sort the response.} @returns(200) @endpoint GET /_cat/ml/trained_models @desc Get trained models @optional {allow_no_match: bool # Specifies what to do when the request: contains wildcard expressions and there are no models that match; contains the `_all` string or no identifiers and there are no matches; contains wildcard expressions and there are only partial matches. If `true`, the API returns an empty array when there are no matches and the subset of results when there are partial matches. If `false`, the API returns a 404 status code when there are no matches or only partial matches., h: any # A comma-separated list of column names to display., s: any # A comma-separated list of column names or aliases used to sort the response., from: num # Skips the specified number of transforms., size: num # The maximum number of transforms to display.} @returns(200) @endpoint GET /_cat/ml/trained_models/{model_id} @desc Get trained models @required {model_id: str # A unique identifier for the trained model.} @optional {allow_no_match: bool # Specifies what to do when the request: contains wildcard expressions and there are no models that match; contains the `_all` string or no identifiers and there are no matches; contains wildcard expressions and there are only partial matches. If `true`, the API returns an empty array when there are no matches and the subset of results when there are partial matches. If `false`, the API returns a 404 status code when there are no matches or only partial matches., h: any # A comma-separated list of column names to display., s: any # A comma-separated list of column names or aliases used to sort the response., from: num # Skips the specified number of transforms., size: num # The maximum number of transforms to display.} @returns(200) @endpoint GET /_cat/nodeattrs @desc Get node attribute information @optional {h: any # A comma-separated list of columns names to display. It supports simple wildcards., s: any # List of columns that determine how the table should be sorted. Sorting defaults to ascending and can be changed by setting `:asc` or `:desc` as a suffix to the column name., local: bool # If `true`, the request computes the list of selected nodes from the local cluster state. If `false` the list of selected nodes are computed from the cluster state of the master node. In both cases the coordinating node will send requests for further information to each selected node., master_timeout: any # Period to wait for a connection to the master node.} @returns(200) @endpoint GET /_cat/nodes @desc Get node information @optional {full_id: bool # If `true`, return the full node ID. If `false`, return the shortened node ID., include_unloaded_segments: bool # If true, the response includes information from segments that are not loaded into memory., h: any # A comma-separated list of columns names to display. It supports simple wildcards., s: any # A comma-separated list of column names or aliases that determines the sort order. Sorting defaults to ascending and can be changed by setting `:asc` or `:desc` as a suffix to the column name., master_timeout: any # The period to wait for a connection to the master node.} @returns(200) @endpoint GET /_cat/pending_tasks @desc Get pending task information @optional {h: any # A comma-separated list of columns names to display. It supports simple wildcards., s: any # List of columns that determine how the table should be sorted. Sorting defaults to ascending and can be changed by setting `:asc` or `:desc` as a suffix to the column name., local: bool # If `true`, the request computes the list of selected nodes from the local cluster state. If `false` the list of selected nodes are computed from the cluster state of the master node. In both cases the coordinating node will send requests for further information to each selected node., master_timeout: any # Period to wait for a connection to the master node.} @returns(200) @endpoint GET /_cat/plugins @desc Get plugin information @optional {h: any # A comma-separated list of columns names to display. It supports simple wildcards., s: any # List of columns that determine how the table should be sorted. Sorting defaults to ascending and can be changed by setting `:asc` or `:desc` as a suffix to the column name., include_bootstrap: bool # Include bootstrap plugins in the response, local: bool # If `true`, the request computes the list of selected nodes from the local cluster state. If `false` the list of selected nodes are computed from the cluster state of the master node. In both cases the coordinating node will send requests for further information to each selected node., master_timeout: any # Period to wait for a connection to the master node.} @returns(200) @endpoint GET /_cat/recovery @desc Get shard recovery information @optional {active_only: bool # If `true`, the response only includes ongoing shard recoveries., detailed: bool # If `true`, the response includes detailed information about shard recoveries., index: any # Comma-separated list or wildcard expression of index names to limit the returned information, h: any # A comma-separated list of columns names to display. It supports simple wildcards., s: any # A comma-separated list of column names or aliases that determines the sort order. Sorting defaults to ascending and can be changed by setting `:asc` or `:desc` as a suffix to the column name.} @returns(200) @endpoint GET /_cat/recovery/{index} @desc Get shard recovery information @required {index: any # A comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams and indices, omit this parameter or use `*` or `_all`.} @optional {active_only: bool # If `true`, the response only includes ongoing shard recoveries., detailed: bool # If `true`, the response includes detailed information about shard recoveries., index: any # Comma-separated list or wildcard expression of index names to limit the returned information, h: any # A comma-separated list of columns names to display. It supports simple wildcards., s: any # A comma-separated list of column names or aliases that determines the sort order. Sorting defaults to ascending and can be changed by setting `:asc` or `:desc` as a suffix to the column name.} @returns(200) @endpoint GET /_cat/repositories @desc Get snapshot repository information @optional {h: any # List of columns to appear in the response. Supports simple wildcards., s: any # List of columns that determine how the table should be sorted. Sorting defaults to ascending and can be changed by setting `:asc` or `:desc` as a suffix to the column name., local: bool # If `true`, the request computes the list of selected nodes from the local cluster state. If `false` the list of selected nodes are computed from the cluster state of the master node. In both cases the coordinating node will send requests for further information to each selected node., master_timeout: any # Period to wait for a connection to the master node.} @returns(200) @endpoint GET /_cat/segments @desc Get segment information @optional {h: any # A comma-separated list of columns names to display. It supports simple wildcards., s: any # A comma-separated list of column names or aliases that determines the sort order. Sorting defaults to ascending and can be changed by setting `:asc` or `:desc` as a suffix to the column name., local: bool # If `true`, the request computes the list of selected nodes from the local cluster state. If `false` the list of selected nodes are computed from the cluster state of the master node. In both cases the coordinating node will send requests for further information to each selected node., master_timeout: any # Period to wait for a connection to the master node., expand_wildcards: any # Type of index that wildcard expressions 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., allow_no_indices: bool # A setting that does two separate checks on the index expression. If `false`, the request returns an error (1) if any wildcard expression (including `_all` and `*`) resolves to zero matching indices or (2) if the complete set of resolved indices, aliases or data streams is empty after all expressions are evaluated. If `true`, index expressions that resolve to no indices are allowed and the request returns an empty result., ignore_throttled: bool # If true, concrete, expanded or aliased indices are ignored when frozen., ignore_unavailable: bool # If `false`, the request returns an error if it targets a concrete (non-wildcarded) index, alias, or data stream that is missing, closed, or otherwise unavailable. If `true`, unavailable concrete targets are silently ignored., allow_closed: bool # If true, allow closed indices to be returned in the response otherwise if false, keep the legacy behaviour of throwing an exception if index pattern matches closed indices} @returns(200) @endpoint GET /_cat/segments/{index} @desc Get segment information @required {index: any # A comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams and indices, omit this parameter or use `*` or `_all`.} @optional {h: any # A comma-separated list of columns names to display. It supports simple wildcards., s: any # A comma-separated list of column names or aliases that determines the sort order. Sorting defaults to ascending and can be changed by setting `:asc` or `:desc` as a suffix to the column name., local: bool # If `true`, the request computes the list of selected nodes from the local cluster state. If `false` the list of selected nodes are computed from the cluster state of the master node. In both cases the coordinating node will send requests for further information to each selected node., master_timeout: any # Period to wait for a connection to the master node., expand_wildcards: any # Type of index that wildcard expressions 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., allow_no_indices: bool # A setting that does two separate checks on the index expression. If `false`, the request returns an error (1) if any wildcard expression (including `_all` and `*`) resolves to zero matching indices or (2) if the complete set of resolved indices, aliases or data streams is empty after all expressions are evaluated. If `true`, index expressions that resolve to no indices are allowed and the request returns an empty result., ignore_throttled: bool # If true, concrete, expanded or aliased indices are ignored when frozen., ignore_unavailable: bool # If `false`, the request returns an error if it targets a concrete (non-wildcarded) index, alias, or data stream that is missing, closed, or otherwise unavailable. If `true`, unavailable concrete targets are silently ignored., allow_closed: bool # If true, allow closed indices to be returned in the response otherwise if false, keep the legacy behaviour of throwing an exception if index pattern matches closed indices} @returns(200) @endpoint GET /_cat/shards @desc Get shard information @optional {h: any # List of columns to appear in the response. Supports simple wildcards., s: any # A comma-separated list of column names or aliases that determines the sort order. Sorting defaults to ascending and can be changed by setting `:asc` or `:desc` as a suffix to the column name., master_timeout: any # The period to wait for a connection to the master node.} @returns(200) @endpoint GET /_cat/shards/{index} @desc Get shard information @required {index: any # A comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams and indices, omit this parameter or use `*` or `_all`.} @optional {h: any # List of columns to appear in the response. Supports simple wildcards., s: any # A comma-separated list of column names or aliases that determines the sort order. Sorting defaults to ascending and can be changed by setting `:asc` or `:desc` as a suffix to the column name., master_timeout: any # The period to wait for a connection to the master node.} @returns(200) @endpoint GET /_cat/snapshots @desc Get snapshot information @optional {ignore_unavailable: bool # If `true`, the response does not include information from unavailable snapshots., h: any # A comma-separated list of columns names to display. It supports simple wildcards., s: any # List of columns that determine how the table should be sorted. Sorting defaults to ascending and can be changed by setting `:asc` or `:desc` as a suffix to the column name., master_timeout: any # Period to wait for a connection to the master node.} @returns(200) @endpoint GET /_cat/snapshots/{repository} @desc Get snapshot information @required {repository: any # A comma-separated list of snapshot repositories used to limit the request. Accepts wildcard expressions. `_all` returns all repositories. If any repository fails during the request, Elasticsearch returns an error.} @optional {ignore_unavailable: bool # If `true`, the response does not include information from unavailable snapshots., h: any # A comma-separated list of columns names to display. It supports simple wildcards., s: any # List of columns that determine how the table should be sorted. Sorting defaults to ascending and can be changed by setting `:asc` or `:desc` as a suffix to the column name., master_timeout: any # Period to wait for a connection to the master node.} @returns(200) @endpoint GET /_cat/tasks @desc Get task information @optional {actions: [str] # The task action names, which are used to limit the response., detailed: bool # If `true`, the response includes detailed information about shard recoveries., nodes: [str] # Unique node identifiers, which are used to limit the response., parent_task_id: str # The parent task identifier, which is used to limit the response., h: any # A comma-separated list of columns names to display. It supports simple wildcards., s: any # List of columns that determine how the table should be sorted. Sorting defaults to ascending and can be changed by setting `:asc` or `:desc` as a suffix to the column name., timeout: any # Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error., wait_for_completion: bool # If `true`, the request blocks until the task has completed.} @returns(200) @endpoint GET /_cat/templates @desc Get index template information @optional {h: any # A comma-separated list of columns names to display. It supports simple wildcards., s: any # List of columns that determine how the table should be sorted. Sorting defaults to ascending and can be changed by setting `:asc` or `:desc` as a suffix to the column name., local: bool # If `true`, the request computes the list of selected nodes from the local cluster state. If `false` the list of selected nodes are computed from the cluster state of the master node. In both cases the coordinating node will send requests for further information to each selected node., master_timeout: any # Period to wait for a connection to the master node.} @returns(200) @endpoint GET /_cat/templates/{name} @desc Get index template information @required {name: str # The name of the template to return. Accepts wildcard expressions. If omitted, all templates are returned.} @optional {h: any # A comma-separated list of columns names to display. It supports simple wildcards., s: any # List of columns that determine how the table should be sorted. Sorting defaults to ascending and can be changed by setting `:asc` or `:desc` as a suffix to the column name., local: bool # If `true`, the request computes the list of selected nodes from the local cluster state. If `false` the list of selected nodes are computed from the cluster state of the master node. In both cases the coordinating node will send requests for further information to each selected node., master_timeout: any # Period to wait for a connection to the master node.} @returns(200) @endpoint GET /_cat/thread_pool @desc Get thread pool statistics @optional {h: any # List of columns to appear in the response. Supports simple wildcards., s: any # A comma-separated list of column names or aliases that determines the sort order. Sorting defaults to ascending and can be changed by setting `:asc` or `:desc` as a suffix to the column name., local: bool # If `true`, the request computes the list of selected nodes from the local cluster state. If `false` the list of selected nodes are computed from the cluster state of the master node. In both cases the coordinating node will send requests for further information to each selected node., master_timeout: any # The period to wait for a connection to the master node.} @returns(200) @endpoint GET /_cat/thread_pool/{thread_pool_patterns} @desc Get thread pool statistics @required {thread_pool_patterns: any # A comma-separated list of thread pool names used to limit the request. Accepts wildcard expressions.} @optional {h: any # List of columns to appear in the response. Supports simple wildcards., s: any # A comma-separated list of column names or aliases that determines the sort order. Sorting defaults to ascending and can be changed by setting `:asc` or `:desc` as a suffix to the column name., local: bool # If `true`, the request computes the list of selected nodes from the local cluster state. If `false` the list of selected nodes are computed from the cluster state of the master node. In both cases the coordinating node will send requests for further information to each selected node., master_timeout: any # The period to wait for a connection to the master node.} @returns(200) @endpoint GET /_cat/transforms @desc Get transform information @optional {allow_no_match: bool # Specifies what to do when the request: contains wildcard expressions and there are no transforms that match; contains the `_all` string or no identifiers and there are no matches; contains wildcard expressions and there are only partial matches. If `true`, it returns an empty transforms array when there are no matches and the subset of results when there are partial matches. If `false`, the request returns a 404 status code when there are no matches or only partial matches., from: num # Skips the specified number of transforms., h: any # Comma-separated list of column names to display., s: any # Comma-separated list of column names or column aliases used to sort the response., size: num # The maximum number of transforms to obtain.} @returns(200) @endpoint GET /_cat/transforms/{transform_id} @desc Get transform information @required {transform_id: str # A transform identifier or a wildcard expression. If you do not specify one of these options, the API returns information for all transforms.} @optional {allow_no_match: bool # Specifies what to do when the request: contains wildcard expressions and there are no transforms that match; contains the `_all` string or no identifiers and there are no matches; contains wildcard expressions and there are only partial matches. If `true`, it returns an empty transforms array when there are no matches and the subset of results when there are partial matches. If `false`, the request returns a 404 status code when there are no matches or only partial matches., from: num # Skips the specified number of transforms., h: any # Comma-separated list of column names to display., s: any # Comma-separated list of column names or column aliases used to sort the response., size: num # The maximum number of transforms to obtain.} @returns(200) @endgroup @group _ccr @endpoint GET /_ccr/auto_follow/{name} @desc Get auto-follow patterns @required {name: str # The auto-follow pattern collection that you want to retrieve. If you do not specify a name, the API returns information for all collections.} @optional {master_timeout: any # The period to wait for a connection to the master node. If the master node is not available before the timeout expires, the request fails and returns an error. It can also be set to `-1` to indicate that the request should never timeout.} @returns(200) {patterns: [map]} @endpoint PUT /_ccr/auto_follow/{name} @desc Create or update auto-follow patterns @required {name: str # The name of the collection of auto-follow patterns., remote_cluster: str # The remote cluster containing the leader indices to match against.} @optional {master_timeout: any # Period to wait for a connection to the master node., follow_index_pattern: any # The name of follower index. The template {{leader_index}} can be used to derive the name of the follower index from the name of the leader index. When following a data stream, use {{leader_index}}; CCR does not support changes to the names of a follower data stream’s backing indices., leader_index_patterns: any # An array of simple index patterns to match against indices in the remote cluster specified by the remote_cluster field., leader_index_exclusion_patterns: any # An array of simple index patterns that can be used to exclude indices from being auto-followed. Indices in the remote cluster whose names are matching one or more leader_index_patterns and one or more leader_index_exclusion_patterns won’t be followed., max_outstanding_read_requests: num=12 # The maximum number of outstanding reads requests from the remote cluster., settings: map # Settings to override from the leader index. Note that certain settings can not be overrode (e.g., index.number_of_shards)., max_outstanding_write_requests: num=9 # The maximum number of outstanding reads requests from the remote cluster., read_poll_timeout: any=1m # The maximum time to wait for new operations on the remote cluster when the follower index is synchronized with the leader index. When the timeout has elapsed, the poll for operations will return to the follower so that it can update some statistics. Then the follower will immediately attempt to read from the leader again., max_read_request_operation_count: num=5120 # The maximum number of operations to pull per read from the remote cluster., max_read_request_size: any=32mb # The maximum size in bytes of per read of a batch of operations pulled from the remote cluster., max_retry_delay: any=500ms # The maximum time to wait before retrying an operation that failed exceptionally. An exponential backoff strategy is employed when retrying., max_write_buffer_count: num=2147483647 # The maximum number of operations that can be queued for writing. When this limit is reached, reads from the remote cluster will be deferred until the number of queued operations goes below the limit., max_write_buffer_size: any=512mb # The maximum total bytes of operations that can be queued for writing. When this limit is reached, reads from the remote cluster will be deferred until the total bytes of queued operations goes below the limit., max_write_request_operation_count: num=5120 # The maximum number of operations per bulk write request executed on the follower., max_write_request_size: any=9223372036854775807b # The maximum total bytes of operations per bulk write request executed on the follower.} @returns(200) {acknowledged: bool} @example_request "{\n \"remote_cluster\" : \"remote_cluster\",\n \"leader_index_patterns\" :\n [\n \"leader_index*\"\n ],\n \"follow_index_pattern\" : \"{{leader_index}}-follower\",\n \"settings\": {\n \"index.number_of_replicas\": 0\n },\n \"max_read_request_operation_count\" : 1024,\n \"max_outstanding_read_requests\" : 16,\n \"max_read_request_size\" : \"1024k\",\n \"max_write_request_operation_count\" : 32768,\n \"max_write_request_size\" : \"16k\",\n \"max_outstanding_write_requests\" : 8,\n \"max_write_buffer_count\" : 512,\n \"max_write_buffer_size\" : \"512k\",\n \"max_retry_delay\" : \"10s\",\n \"read_poll_timeout\" : \"30s\"\n}" @endpoint DELETE /_ccr/auto_follow/{name} @desc Delete auto-follow patterns @required {name: str # The auto-follow pattern collection to delete.} @optional {master_timeout: any # The period to wait for a connection to the master node. If the master node is not available before the timeout expires, the request fails and returns an error. It can also be set to `-1` to indicate that the request should never timeout.} @returns(200) {acknowledged: bool} @endgroup @group {index} @endpoint PUT /{index}/_ccr/follow @desc Create a follower @required {index: str # The name of the follower index., leader_index: any # The name of the index in the leader cluster to follow., remote_cluster: str # The remote cluster containing the leader index.} @optional {master_timeout: any # Period to wait for a connection to the master node., wait_for_active_shards: any # Specifies the number of shards to wait on being active before responding. This defaults to waiting on none of the shards to be active. A shard must be restored from the leader index before being active. Restoring a follower shard requires transferring all the remote Lucene segment files to the follower index., data_stream_name: str # If the leader index is part of a data stream, the name to which the local data stream for the followed index should be renamed., max_outstanding_read_requests: num # The maximum number of outstanding reads requests from the remote cluster., max_outstanding_write_requests: num # The maximum number of outstanding write requests on the follower., max_read_request_operation_count: num # The maximum number of operations to pull per read from the remote cluster., max_read_request_size: any # The maximum size in bytes of per read of a batch of operations pulled from the remote cluster., max_retry_delay: any # The maximum time to wait before retrying an operation that failed exceptionally. An exponential backoff strategy is employed when retrying., max_write_buffer_count: num # The maximum number of operations that can be queued for writing. When this limit is reached, reads from the remote cluster will be deferred until the number of queued operations goes below the limit., max_write_buffer_size: any # The maximum total bytes of operations that can be queued for writing. When this limit is reached, reads from the remote cluster will be deferred until the total bytes of queued operations goes below the limit., max_write_request_operation_count: num # The maximum number of operations per bulk write request executed on the follower., max_write_request_size: any # The maximum total bytes of operations per bulk write request executed on the follower., read_poll_timeout: any # The maximum time to wait for new operations on the remote cluster when the follower index is synchronized with the leader index. When the timeout has elapsed, the poll for operations will return to the follower so that it can update some statistics. Then the follower will immediately attempt to read from the leader again., settings: any # Settings to override from the leader index.} @returns(200) {follow_index_created: bool, follow_index_shards_acked: bool, index_following_started: bool} @example_request "{\n \"remote_cluster\" : \"remote_cluster\",\n \"leader_index\" : \"leader_index\",\n \"settings\": {\n \"index.number_of_replicas\": 0\n },\n \"max_read_request_operation_count\" : 1024,\n \"max_outstanding_read_requests\" : 16,\n \"max_read_request_size\" : \"1024k\",\n \"max_write_request_operation_count\" : 32768,\n \"max_write_request_size\" : \"16k\",\n \"max_outstanding_write_requests\" : 8,\n \"max_write_buffer_count\" : 512,\n \"max_write_buffer_size\" : \"512k\",\n \"max_retry_delay\" : \"10s\",\n \"read_poll_timeout\" : \"30s\"\n}" @endpoint GET /{index}/_ccr/info @desc Get follower information @required {index: any # A comma-delimited list of follower index patterns.} @optional {master_timeout: any # The period to wait for a connection to the master node. If the master node is not available before the timeout expires, the request fails and returns an error. It can also be set to `-1` to indicate that the request should never timeout.} @returns(200) {follower_indices: [map]} @endpoint GET /{index}/_ccr/stats @desc Get follower stats @required {index: any # A comma-delimited list of index patterns.} @optional {timeout: any # The period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.} @returns(200) {indices: [map]} @endpoint POST /{index}/_ccr/forget_follower @desc Forget a follower @required {index: str # Name of the leader index for which specified follower retention leases should be removed} @optional {timeout: any # Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error., follower_cluster: str, follower_index: any, follower_index_uuid: any, leader_remote_cluster: str} @returns(200) {_shards: any} @example_request "{\n \"follower_cluster\" : \"\",\n \"follower_index\" : \"\",\n \"follower_index_uuid\" : \"\",\n \"leader_remote_cluster\" : \"\"\n}" @endgroup @group _ccr @endpoint GET /_ccr/auto_follow @desc Get auto-follow patterns @optional {master_timeout: any # The period to wait for a connection to the master node. If the master node is not available before the timeout expires, the request fails and returns an error. It can also be set to `-1` to indicate that the request should never timeout.} @returns(200) {patterns: [map]} @endpoint POST /_ccr/auto_follow/{name}/pause @desc Pause an auto-follow pattern @required {name: str # The name of the auto-follow pattern to pause.} @optional {master_timeout: any # The period to wait for a connection to the master node. If the master node is not available before the timeout expires, the request fails and returns an error. It can also be set to `-1` to indicate that the request should never timeout.} @returns(200) {acknowledged: bool} @endgroup @group {index} @endpoint POST /{index}/_ccr/pause_follow @desc Pause a follower @required {index: str # The name of the follower index.} @optional {master_timeout: any # The period to wait for a connection to the master node. If the master node is not available before the timeout expires, the request fails and returns an error. It can also be set to `-1` to indicate that the request should never timeout.} @returns(200) {acknowledged: bool} @endgroup @group _ccr @endpoint POST /_ccr/auto_follow/{name}/resume @desc Resume an auto-follow pattern @required {name: str # The name of the auto-follow pattern to resume.} @optional {master_timeout: any # The period to wait for a connection to the master node. If the master node is not available before the timeout expires, the request fails and returns an error. It can also be set to `-1` to indicate that the request should never timeout.} @returns(200) {acknowledged: bool} @endgroup @group {index} @endpoint POST /{index}/_ccr/resume_follow @desc Resume a follower @required {index: str # Name of the follow index to resume following} @optional {master_timeout: any # Period to wait for a connection to the master node., max_outstanding_read_requests: num, max_outstanding_write_requests: num, max_read_request_operation_count: num, max_read_request_size: str, max_retry_delay: any, max_write_buffer_count: num, max_write_buffer_size: str, max_write_request_operation_count: num, max_write_request_size: str, read_poll_timeout: any} @returns(200) {acknowledged: bool} @example_request "{\n \"max_read_request_operation_count\" : 1024,\n \"max_outstanding_read_requests\" : 16,\n \"max_read_request_size\" : \"1024k\",\n \"max_write_request_operation_count\" : 32768,\n \"max_write_request_size\" : \"16k\",\n \"max_outstanding_write_requests\" : 8,\n \"max_write_buffer_count\" : 512,\n \"max_write_buffer_size\" : \"512k\",\n \"max_retry_delay\" : \"10s\",\n \"read_poll_timeout\" : \"30s\"\n}" @endgroup @group _ccr @endpoint GET /_ccr/stats @desc Get cross-cluster replication stats @optional {master_timeout: any # The period to wait for a connection to the master node. If the master node is not available before the timeout expires, the request fails and returns an error. It can also be set to `-1` to indicate that the request should never timeout., timeout: any # The period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.} @returns(200) {auto_follow_stats: any, follow_stats: any} @endgroup @group {index} @endpoint POST /{index}/_ccr/unfollow @desc Unfollow an index @required {index: str # The name of the follower index.} @optional {master_timeout: any # The period to wait for a connection to the master node. If the master node is not available before the timeout expires, the request fails and returns an error. It can also be set to `-1` to indicate that the request should never timeout.} @returns(200) {acknowledged: bool} @endgroup @group _search @endpoint GET /_search/scroll @desc Run a scrolling search @required {scroll_id: any # The scroll ID of the search.} @optional {scroll: any # The period to retain the search context for scrolling., scroll_id: str # The scroll ID, rest_total_hits_as_int: bool # If true, the API response’s hit.total property is returned as an integer. If false, the API response’s hit.total property is returned as an object., scroll: any=1d # The period to retain the search context for scrolling.} @returns(200) {took: num, timed_out: bool, _shards: any, hits: any, aggregations: map, _clusters: any, fields: map, max_score: num, num_reduce_phases: num, profile: any, pit_id: any, _scroll_id: any, suggest: map, terminated_early: bool} @example_request "{\n \"scroll_id\" : \"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAD4WYm9laVYtZndUQlNsdDcwakFMNjU1QQ==\"\n}" @endpoint POST /_search/scroll @desc Run a scrolling search @required {scroll_id: any # The scroll ID of the search.} @optional {scroll: any # The period to retain the search context for scrolling., scroll_id: str # The scroll ID, rest_total_hits_as_int: bool # If true, the API response’s hit.total property is returned as an integer. If false, the API response’s hit.total property is returned as an object., scroll: any=1d # The period to retain the search context for scrolling.} @returns(200) {took: num, timed_out: bool, _shards: any, hits: any, aggregations: map, _clusters: any, fields: map, max_score: num, num_reduce_phases: num, profile: any, pit_id: any, _scroll_id: any, suggest: map, terminated_early: bool} @example_request "{\n \"scroll_id\" : \"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAD4WYm9laVYtZndUQlNsdDcwakFMNjU1QQ==\"\n}" @endpoint DELETE /_search/scroll @desc Clear a scrolling search @optional {scroll_id: any # The scroll IDs to clear. To clear all scroll IDs, use `_all`.} @returns(200) {succeeded: bool, num_freed: num} @example_request "{\n \"scroll_id\": \"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAD4WYm9laVYtZndUQlNsdDcwakFMNjU1QQ==\"\n}" @endpoint GET /_search/scroll/{scroll_id} @desc Run a scrolling search @required {scroll_id: str # The scroll ID, scroll_id: any # The scroll ID of the search.} @optional {scroll: any # The period to retain the search context for scrolling., scroll_id: str # The scroll ID, rest_total_hits_as_int: bool # If true, the API response’s hit.total property is returned as an integer. If false, the API response’s hit.total property is returned as an object., scroll: any=1d # The period to retain the search context for scrolling.} @returns(200) {took: num, timed_out: bool, _shards: any, hits: any, aggregations: map, _clusters: any, fields: map, max_score: num, num_reduce_phases: num, profile: any, pit_id: any, _scroll_id: any, suggest: map, terminated_early: bool} @example_request "{\n \"scroll_id\" : \"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAD4WYm9laVYtZndUQlNsdDcwakFMNjU1QQ==\"\n}" @endpoint POST /_search/scroll/{scroll_id} @desc Run a scrolling search @required {scroll_id: str # The scroll ID, scroll_id: any # The scroll ID of the search.} @optional {scroll: any # The period to retain the search context for scrolling., scroll_id: str # The scroll ID, rest_total_hits_as_int: bool # If true, the API response’s hit.total property is returned as an integer. If false, the API response’s hit.total property is returned as an object., scroll: any=1d # The period to retain the search context for scrolling.} @returns(200) {took: num, timed_out: bool, _shards: any, hits: any, aggregations: map, _clusters: any, fields: map, max_score: num, num_reduce_phases: num, profile: any, pit_id: any, _scroll_id: any, suggest: map, terminated_early: bool} @example_request "{\n \"scroll_id\" : \"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAD4WYm9laVYtZndUQlNsdDcwakFMNjU1QQ==\"\n}" @endpoint DELETE /_search/scroll/{scroll_id} @desc Clear a scrolling search @required {scroll_id: any # A comma-separated list of scroll IDs to clear. To clear all scroll IDs, use `_all`. IMPORTANT: Scroll IDs can be long. It is recommended to specify scroll IDs in the request body parameter.} @optional {scroll_id: any # The scroll IDs to clear. To clear all scroll IDs, use `_all`.} @returns(200) {succeeded: bool, num_freed: num} @example_request "{\n \"scroll_id\": \"DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAD4WYm9laVYtZndUQlNsdDcwakFMNjU1QQ==\"\n}" @endgroup @group _pit @endpoint DELETE /_pit @desc Close a point in time @required {id: any # The ID of the point-in-time.} @returns(200) {succeeded: bool, num_freed: num} @example_request "{\n \"id\": \"46ToAwMDaWR5BXV1aWQyKwZub2RlXzMAAAAAAAAAACoBYwADaWR4BXV1aWQxAgZub2RlXzEAAAAAAAAAAAEBYQADaWR5BXV1aWQyKgZub2RlXzIAAAAAAAAAAAwBYgACBXV1aWQyAAAFdXVpZDEAAQltYXRjaF9hbGw_gAAAAA==\"\n}" @endgroup @group _cluster @endpoint GET /_cluster/allocation/explain @desc Explain the shard allocations @optional {index: str # The name of the index that you would like an explanation for., shard: num # An identifier for the shard that you would like an explanation for., primary: bool # If true, returns an explanation for the primary shard for the specified shard ID., current_node: str # Explain a shard only if it is currently located on the specified node name or node ID., include_disk_info: bool # If true, returns information about disk usage and shard sizes., include_yes_decisions: bool # If true, returns YES decisions in explanation., master_timeout: any # Period to wait for a connection to the master node., index: any # The name of the index that you would like an explanation for., shard: num # An identifier for the shard that you would like an explanation for., primary: bool # If true, returns an explanation for the primary shard for the specified shard ID., current_node: any # Explain a shard only if it is currently located on the specified node name or node ID.} @returns(200) {allocate_explanation: str, allocation_delay: any, allocation_delay_in_millis: any, can_allocate: any, can_move_to_other_node: any, can_rebalance_cluster: any, can_rebalance_cluster_decisions: [map], can_rebalance_to_other_node: any, can_remain_decisions: [map], can_remain_on_current_node: any, cluster_info: any, configured_delay: any, configured_delay_in_millis: any, current_node: any, current_state: str, index: any, move_explanation: str, node_allocation_decisions: [map], primary: bool, rebalance_explanation: str, remaining_delay: any, remaining_delay_in_millis: any, shard: num, unassigned_info: any, note: str} @example_request "{\n \"index\": \"my-index-000001\",\n \"shard\": 0,\n \"primary\": false,\n \"current_node\": \"my-node\"\n}" @endpoint POST /_cluster/allocation/explain @desc Explain the shard allocations @optional {index: str # The name of the index that you would like an explanation for., shard: num # An identifier for the shard that you would like an explanation for., primary: bool # If true, returns an explanation for the primary shard for the specified shard ID., current_node: str # Explain a shard only if it is currently located on the specified node name or node ID., include_disk_info: bool # If true, returns information about disk usage and shard sizes., include_yes_decisions: bool # If true, returns YES decisions in explanation., master_timeout: any # Period to wait for a connection to the master node., index: any # The name of the index that you would like an explanation for., shard: num # An identifier for the shard that you would like an explanation for., primary: bool # If true, returns an explanation for the primary shard for the specified shard ID., current_node: any # Explain a shard only if it is currently located on the specified node name or node ID.} @returns(200) {allocate_explanation: str, allocation_delay: any, allocation_delay_in_millis: any, can_allocate: any, can_move_to_other_node: any, can_rebalance_cluster: any, can_rebalance_cluster_decisions: [map], can_rebalance_to_other_node: any, can_remain_decisions: [map], can_remain_on_current_node: any, cluster_info: any, configured_delay: any, configured_delay_in_millis: any, current_node: any, current_state: str, index: any, move_explanation: str, node_allocation_decisions: [map], primary: bool, rebalance_explanation: str, remaining_delay: any, remaining_delay_in_millis: any, shard: num, unassigned_info: any, note: str} @example_request "{\n \"index\": \"my-index-000001\",\n \"shard\": 0,\n \"primary\": false,\n \"current_node\": \"my-node\"\n}" @endgroup @group _component_template @endpoint GET /_component_template/{name} @desc Get component templates @required {name: str # Name of component template to retrieve. Wildcard (`*`) expressions are supported.} @optional {flat_settings: bool # If `true`, returns settings in flat format., settings_filter: any # Filter out results, for example to filter out sensitive information. Supports wildcards or full settings keys, include_defaults: bool # Return all default configurations for the component template, local: bool # If `true`, the request retrieves information from the local node only. If `false`, information is retrieved from the master node., master_timeout: any # Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.} @returns(200) {component_templates: [map]} @endpoint PUT /_component_template/{name} @desc Create or update a component template @required {name: str # Name of the component template to create. Elasticsearch includes the following built-in component templates: `logs-mappings`; `logs-settings`; `metrics-mappings`; `metrics-settings`;`synthetics-mapping`; `synthetics-settings`. Elastic Agent uses these templates to configure backing indices for its data streams. If you use Elastic Agent and want to overwrite one of these templates, set the `version` for your replacement template higher than the current version. If you don’t use Elastic Agent and want to disable all built-in component and index templates, set `stack.templates.enabled` to `false` using the cluster update settings API., template: any # The template to be applied which includes mappings, settings, or aliases configuration.} @optional {create: bool # If `true`, this request cannot replace or update existing component templates., cause: str # User defined reason for create the component template., master_timeout: any # Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error., version: any # Version number used to manage component templates externally. This number isn't automatically generated or incremented by Elasticsearch. To unset a version, replace the template without specifying a version., _meta: any # Optional user metadata about the component template. It may have any contents. This map is not automatically generated by Elasticsearch. This information is stored in the cluster state, so keeping it short is preferable. To unset `_meta`, replace the template without specifying this information., deprecated: bool # Marks this index template as deprecated. When creating or updating a non-deprecated index template that uses deprecated components, Elasticsearch will emit a deprecation warning.} @returns(200) {acknowledged: bool} @example_request "{\n \"template\": {\n \"settings\": {\n \"number_of_shards\": 1\n },\n \"mappings\": {\n \"_source\": {\n \"enabled\": false\n },\n \"properties\": {\n \"host_name\": {\n \"type\": \"keyword\"\n },\n \"created_at\": {\n \"type\": \"date\",\n \"format\": \"EEE MMM dd HH:mm:ss Z yyyy\"\n }\n }\n }\n }\n}" @endpoint POST /_component_template/{name} @desc Create or update a component template @required {name: str # Name of the component template to create. Elasticsearch includes the following built-in component templates: `logs-mappings`; `logs-settings`; `metrics-mappings`; `metrics-settings`;`synthetics-mapping`; `synthetics-settings`. Elastic Agent uses these templates to configure backing indices for its data streams. If you use Elastic Agent and want to overwrite one of these templates, set the `version` for your replacement template higher than the current version. If you don’t use Elastic Agent and want to disable all built-in component and index templates, set `stack.templates.enabled` to `false` using the cluster update settings API., template: any # The template to be applied which includes mappings, settings, or aliases configuration.} @optional {create: bool # If `true`, this request cannot replace or update existing component templates., cause: str # User defined reason for create the component template., master_timeout: any # Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error., version: any # Version number used to manage component templates externally. This number isn't automatically generated or incremented by Elasticsearch. To unset a version, replace the template without specifying a version., _meta: any # Optional user metadata about the component template. It may have any contents. This map is not automatically generated by Elasticsearch. This information is stored in the cluster state, so keeping it short is preferable. To unset `_meta`, replace the template without specifying this information., deprecated: bool # Marks this index template as deprecated. When creating or updating a non-deprecated index template that uses deprecated components, Elasticsearch will emit a deprecation warning.} @returns(200) {acknowledged: bool} @example_request "{\n \"template\": {\n \"settings\": {\n \"number_of_shards\": 1\n },\n \"mappings\": {\n \"_source\": {\n \"enabled\": false\n },\n \"properties\": {\n \"host_name\": {\n \"type\": \"keyword\"\n },\n \"created_at\": {\n \"type\": \"date\",\n \"format\": \"EEE MMM dd HH:mm:ss Z yyyy\"\n }\n }\n }\n }\n}" @endpoint DELETE /_component_template/{name} @desc Delete component templates @required {name: any # Comma-separated list or wildcard expression of component template names used to limit the request.} @optional {master_timeout: any # Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error., timeout: any # Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.} @returns(200) {acknowledged: bool} @endpoint HEAD /_component_template/{name} @desc Check component templates @required {name: any # Comma-separated list of component template names used to limit the request. Wildcard (*) expressions are supported.} @optional {master_timeout: any # Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error., local: bool # If true, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the master node.} @returns(200) @endgroup @group _cluster @endpoint POST /_cluster/voting_config_exclusions @desc Update voting configuration exclusions @optional {node_names: any # A comma-separated list of the names of the nodes to exclude from the voting configuration. If specified, you may not also specify node_ids., node_ids: any # A comma-separated list of the persistent ids of the nodes to exclude from the voting configuration. If specified, you may not also specify node_names., master_timeout: any # Period to wait for a connection to the master node., timeout: any # When adding a voting configuration exclusion, the API waits for the specified nodes to be excluded from the voting configuration before returning. If the timeout expires before the appropriate condition is satisfied, the request fails and returns an error.} @returns(200) @endpoint DELETE /_cluster/voting_config_exclusions @desc Clear cluster voting config exclusions @optional {master_timeout: any # Period to wait for a connection to the master node., wait_for_removal: bool # Specifies whether to wait for all excluded nodes to be removed from the cluster before clearing the voting configuration exclusions list. Defaults to true, meaning that all excluded nodes must be removed from the cluster before this API takes any action. If set to false then the voting configuration exclusions list is cleared even if some excluded nodes are still in the cluster.} @returns(200) @endgroup @group _component_template @endpoint GET /_component_template @desc Get component templates @optional {flat_settings: bool # If `true`, returns settings in flat format., settings_filter: any # Filter out results, for example to filter out sensitive information. Supports wildcards or full settings keys, include_defaults: bool # Return all default configurations for the component template, local: bool # If `true`, the request retrieves information from the local node only. If `false`, information is retrieved from the master node., master_timeout: any # Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.} @returns(200) {component_templates: [map]} @endgroup @group _cluster @endpoint GET /_cluster/settings @desc Get cluster-wide settings @optional {flat_settings: bool # If `true`, returns settings in flat format., include_defaults: bool # If `true`, also returns the values of all other cluster settings set in the `elasticsearch.yml` file on one of the nodes in your cluster, together with the default values of all other cluster settings on that node. The default value of each setting may depend on the values of other settings on that node. If the nodes in your cluster do not all have the same configuration then the values returned by this API may vary from invocation to invocation and may not reflect the values that Elasticsearch uses in all situations. Use the `GET _nodes/settings` API to fetch the settings for each individual node in your cluster., master_timeout: any # Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error., timeout: any # Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.} @returns(200) {persistent: map, transient: map, defaults: map} @endpoint PUT /_cluster/settings @desc Update the cluster settings @optional {flat_settings: bool # Return settings in flat format, master_timeout: any # The period to wait for a connection to the master node., timeout: any # The period to wait for a response., persistent: map # The settings that persist after the cluster restarts., transient: map # The settings that do not persist after the cluster restarts.} @returns(200) {acknowledged: bool, persistent: map, transient: map} @example_request "{\n \"persistent\" : {\n \"indices.recovery.max_bytes_per_sec\" : \"50mb\"\n }\n}" @endpoint GET /_cluster/health @desc Get the cluster health status @optional {expand_wildcards: any # Expand wildcard expression to concrete indices that are open, closed or both., level: str # Return health information at a specific level of detail., local: bool # If true, retrieve information from the local node only. If false, retrieve information from the master node., master_timeout: any # The period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error., timeout: any # The period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error., wait_for_active_shards: any # Wait for the specified number of active shards. Use `all` to wait for all shards in the cluster to be active. Use `0` to not wait., wait_for_events: str # Wait until all currently queued events with the given priority are processed., wait_for_nodes: any # Wait until the specified number (N) of nodes is available. It also accepts `>=N`, `N` and `=N`, `N` and `