Fleet

class elasticsearch.client.FleetClient

To use this client, access client.fleet from an Elasticsearch client. For example:

from elasticsearch import Elasticsearch

# Create the client instance
client = Elasticsearch(...)
# Use the fleet client
client.fleet.<method>(...)
global_checkpoints(*, index, checkpoints=None, error_trace=None, filter_path=None, human=None, pretty=None, timeout=None, wait_for_advance=None, wait_for_index=None)

Get global checkpoints.

Get the current global checkpoints for an index. This API is designed for internal use by the Fleet server project.

https://www.elastic.co/docs/api/doc/elasticsearch/group/endpoint-fleet

Parameters:

  • index (str) – A single index or index alias that resolves to a single index.

  • checkpoints (Sequence[int] | None) – A comma separated list of previous global checkpoints. When used in combination with wait_for_advance, the API will only return once the global checkpoints advances past the checkpoints. Providing an empty list will cause Elasticsearch to immediately return the current global checkpoints.

  • timeout (str | Literal[-1] | ~typing.Literal[0] | None) – Period to wait for a global checkpoints to advance past checkpoints.

  • wait_for_advance (bool | None) – A boolean value which controls whether to wait (until the timeout) for the global checkpoints to advance past the provided checkpoints.

  • wait_for_index (bool | None) – A boolean value which controls whether to wait (until the timeout) for the target index to exist and all primary shards be active. Can only be true when wait_for_advance is true.

  • error_trace (bool | None)

  • filter_path (str | Sequence[str] | None)

  • human (bool | None)

  • pretty (bool | None)

Return type:

ObjectApiResponse[Any]

msearch(*, searches=None, body=None, index=None, allow_no_indices=None, allow_partial_search_results=None, ccs_minimize_roundtrips=None, error_trace=None, expand_wildcards=None, filter_path=None, human=None, ignore_throttled=None, ignore_unavailable=None, max_concurrent_searches=None, max_concurrent_shard_requests=None, pre_filter_shard_size=None, pretty=None, rest_total_hits_as_int=None, search_type=None, typed_keys=None, wait_for_checkpoints=None)

Run multiple Fleet searches. Run several Fleet searches with a single API request. The API follows the same structure as the multi search API. However, similar to the Fleet search API, it supports the wait_for_checkpoints parameter.

https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-fleet-msearch

Parameters:

  • searches (Sequence[Mapping[str, Any]] | None)

  • index (str | None) – A single target to search. If the target is an index alias, it must resolve to a single index.

  • allow_no_indices (bool | None) – If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request targeting foo*,bar* returns an error if an index starts with foo but no index starts with bar.

  • allow_partial_search_results (bool | None) – If true, returns partial results if there are shard request timeouts or shard failures. If false, returns an error with no partial results. Defaults to the configured cluster setting search.default_allow_partial_results, which is true by default.

  • ccs_minimize_roundtrips (bool | None) – If true, network roundtrips between the coordinating node and remote clusters are minimized for cross-cluster search requests.

  • expand_wildcards (Sequence[str | Literal['all', 'closed', 'hidden', 'none', 'open']] | str | ~typing.Literal['all', 'closed', 'hidden', 'none', 'open'] | None) – 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.

  • ignore_throttled (bool | None) – If true, concrete, expanded or aliased indices are ignored when frozen.

  • ignore_unavailable (bool | None) – If true, missing or closed indices are not included in the response.

  • max_concurrent_searches (int | None) – Maximum number of concurrent searches the multi search API can execute.

  • max_concurrent_shard_requests (