Path parameters

• name string Required

  The name of the analytics collection to be deleted

Responses

• 200 application/json
  Hide response attribute Show response attribute object

  • acknowledged boolean Required

    For a successful response, this value is always true. On failure, an exception is returned instead.

Path parameters

• index string | array[string] Required

  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.

Query parameters

• h string | array[string]

  List of columns to appear in the response. Supports simple wildcards.

• s string | array[string]

  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.

Responses

• 200 application/json
  Hide response attributes Show response attributes object

  • epoch number | string

    Some APIs will return values such as numbers also as a string (notably epoch timestamps). This behavior is used to capture this behavior while keeping the semantics of the field type.

    Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type.

    One of:

    UnitSeconds number StringifiedEpochTimeUnitSeconds string

    Time unit for seconds
  • timestamp string

    Time of day, expressed as HH:MM:SS

  • count string

    the document count

Query parameters

• bytes string

  The unit used to display byte values.

  Values are b, kb, mb, gb, tb, or pb.

• fields string | array[string]

  Comma-separated list of fields used to limit returned information.

• h string | array[string]

  List of columns to appear in the response. Supports simple wildcards.

• s string | array[string]

  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.

Responses

• 200 application/json
  Hide response attributes Show response attributes object

  • id string

    node id

  • host string

    host name

  • ip string

    ip address

  • node string

    node name

  • field string

    field name

  • size string

    field data usage

Query parameters

• allow_no_match boolean

  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 string | array[string]

  Comma-separated list of column names to display.

  Supported values include:

  • ae (or assignment_explanation): For started datafeeds only, contains messages relating to the selection of a node.
  • bc (or buckets.count, bucketsCount): The number of buckets processed.
  • id: A numerical character string that uniquely identifies the datafeed.
  • na (or node.address, nodeAddress): For started datafeeds only, the network address of the node where the datafeed is started.
  • ne (or node.ephemeral_id, nodeEphemeralId): For started datafeeds only, the ephemeral ID of the node where the datafeed is started.
  • ni (or node.id, nodeId): For started datafeeds only, the unique identifier of the node where the datafeed is started.
  • nn (or node.name, nodeName): For started datafeeds only, the name of the node where the datafeed is started.
  • sba (or search.bucket_avg, searchBucketAvg): The average search time per bucket, in milliseconds.
  • sc (or search.count, searchCount): The number of searches run by the datafeed.
  • seah (or search.exp_avg_hour, searchExpAvgHour): The exponential average search time per hour, in milliseconds.
  • st (or search.time, searchTime): The total time the datafeed spent searching, in milliseconds.
  • s (or state): The status of the datafeed: starting, started, stopping, or stopped. If starting, the datafeed has been requested to start but has not yet started. If started, the datafeed is actively receiving data. If stopping, the datafeed has been requested to stop gracefully and is completing its final action. If stopped, the datafeed is stopped and will not receive data until it is re-started.

  Values are ae, assignment_explanation, bc, buckets.count, bucketsCount, id, na, node.address, nodeAddress, ne, node.ephemeral_id, nodeEphemeralId, ni, node.id, nodeId, nn, node.name, nodeName, sba, search.bucket_avg, searchBucketAvg, sc, search.count, searchCount, seah, search.exp_avg_hour, searchExpAvgHour, st, search.time, searchTime, s, or state.

• s string | array[string]

  Comma-separated list of column names or column aliases used to sort the response.

  Supported values include:

  • ae (or assignment_explanation): For started datafeeds only, contains messages relating to the selection of a node.
  • bc (or buckets.count, bucketsCount): The number of buckets processed.
  • id: A numerical character string that uniquely identifies the datafeed.
  • na (or node.address, nodeAddress): For started datafeeds only, the network address of the node where the datafeed is started.
  • ne (or node.ephemeral_id, nodeEphemeralId): For started datafeeds only, the ephemeral ID of the node where the datafeed is started.
  • ni (or node.id, nodeId): For started datafeeds only, the unique identifier of the node where the datafeed is started.
  • nn (or node.name, nodeName): For started datafeeds only, the name of the node where the datafeed is started.
  • sba (or search.bucket_avg, searchBucketAvg): The average search time per bucket, in milliseconds.
  • sc (or search.count, searchCount): The number of searches run by the datafeed.
  • seah (or search.exp_avg_hour, searchExpAvgHour): The exponential average search time per hour, in milliseconds.
  • st (or search.time, searchTime): The total time the datafeed spent searching, in milliseconds.
  • s (or state): The status of the datafeed: starting, started, stopping, or stopped. If starting, the datafeed has been requested to start but has not yet started. If started, the datafeed is actively receiving data. If stopping, the datafeed has been requested to stop gracefully and is completing its final action. If stopped, the datafeed is stopped and will not receive data until it is re-started.

  Values are ae, assignment_explanation, bc, buckets.count, bucketsCount, id, na, node.address, nodeAddress, ne, node.ephemeral_id, nodeEphemeralId, ni, node.id, nodeId, nn, node.name, nodeName, sba, search.bucket_avg, searchBucketAvg, sc, search.count, searchCount, seah, search.exp_avg_hour, searchExpAvgHour, st, search.time, searchTime, s, or state.

• time string

  The unit used to display time values.

  Values are nanos, micros, ms, s, m, h, or d.

Responses

• 200 application/json
  Hide response attributes Show response attributes object

  • id string

    The datafeed identifier.

  • state string

    Values are started, stopped, starting, or stopping.

  • assignment_explanation string

    For started datafeeds only, contains messages relating to the selection of a node.

  • buckets.count string

    The number of buckets processed.

  • search.count string

    The number of searches run by the datafeed.

  • search.time string

    The total time the datafeed spent searching, in milliseconds.

  • search.bucket_avg string

    The average search time per bucket, in milliseconds.

  • search.exp_avg_hour string

    The exponential average search time per hour, in milliseconds.

  • node.id string

    The unique identifier of the assigned node. For started datafeeds only, this information pertains to the node upon which the datafeed is started.

  • node.name string

    The name of the assigned node. For started datafeeds only, this information pertains to the node upon which the datafeed is started.

  • node.ephemeral_id string

    The ephemeral identifier of the assigned node. For started datafeeds only, this information pertains to the node upon which the datafeed is started.

  • node.address string

    The network address of the assigned node. For started datafeeds only, this information pertains to the node upon which the datafeed is started.

Query parameters

• bytes string

  The unit used to display byte values.

  Values are b, kb, mb, gb, tb, or pb.

• full_id boolean | string

  If true, return the full node ID. If false, return the shortened node ID.

• include_unloaded_segments boolean

  If true, the response includes information from segments that are not loaded into memory.

• h string | array[string]

  A comma-separated list of columns names to display. It supports simple wildcards.

  Supported values include:

  • build (or b): The Elasticsearch build hash. For example: 5c03844.
  • completion.size (or cs, completionSize): The size of completion. For example: 0b.
  • cpu: The percentage of recent system CPU used.
  • disk.avail (or d, disk, diskAvail): The available disk space. For example: 198.4gb.
  • disk.total (or dt, diskTotal): The total disk space. For example: 458.3gb.
  • disk.used (or du, diskUsed): The used disk space. For example: 259.8gb.
  • disk.used_percent (or dup, diskUsedPercent): The percentage of disk space used.
  • fielddata.evictions (or fe, fielddataEvictions): The number of fielddata cache evictions.
  • fielddata.memory_size (or fm, fielddataMemory): The fielddata cache memory used. For example: 0b.
  • file_desc.current (or fdc, fileDescriptorCurrent): The number of file descriptors used.
  • file_desc.max (or fdm, fileDescriptorMax): The maximum number of file descriptors.
  • file_desc.percent (or fdp, fileDescriptorPercent): The percentage of file descriptors used.
  • flush.total (or ft, flushTotal): The number of flushes.
  • flush.total_time (or ftt, flushTotalTime): The amount of time spent in flush.
  • get.current (or gc, getCurrent): The number of current get operations.
  • get.exists_time (or geti, getExistsTime): The time spent in successful get operations. For example: 14ms.
  • get.exists_total (or geto, getExistsTotal): The number of successful get operations.
  • get.missing_time (or gmti, getMissingTime): The time spent in failed get operations. For example: 0s.
  • get.missing_total (or gmto, getMissingTotal): The number of failed get operations.
  • get.time (or gti, getTime): The amount of time spent in get operations. For example: 14ms.
  • get.total (or gto, getTotal): The number of get operations.
  • heap.current (or hc, heapCurrent): The used heap size. For example: 311.2mb.
  • heap.max (or hm, heapMax): The total heap size. For example: 4gb.
  • heap.percent (or hp, heapPercent): The used percentage of total allocated Elasticsearch JVM heap. This value reflects only the Elasticsearch process running within the operating system and is the most direct indicator of its JVM, heap, or memory resource performance.
  • http_address (or http): The bound HTTP address.
  • id (or nodeId): The identifier for the node.
  • indexing.delete_current (or idc, indexingDeleteCurrent): The number of current deletion operations.
  • indexing.delete_time (or idti, indexingDeleteTime): The time spent in deletion operations. For example: 2ms.
  • indexing.delete_total (or idto, indexingDeleteTotal): The number of deletion operations.
  • indexing.index_current (or iic, indexingIndexCurrent): The number of current indexing operations.
  • indexing.index_failed (or iif, indexingIndexFailed): The number of failed indexing operations.
  • indexing.index_failed_due_to_version_conflict (or iifvc, indexingIndexFailedDueToVersionConflict): The number of indexing operations that failed due to version conflict.
  • indexing.index_time (or iiti, indexingIndexTime): The time spent in indexing operations. For example: 134ms.
  • indexing.index_total (or iito, indexingIndexTotal): The number of indexing operations.
  • ip (or i): The IP address.
  • jdk (or j): The Java version. For example: 1.8.0.
  • load_1m (or l): The most recent load average. For example: 0.22.
  • load_5m (or l): The load average for the last five minutes. For example: 0.78.
  • load_15m (or l): The load average for the last fifteen minutes. For example: 1.24.
  • mappings.total_count (or mtc, mappingsTotalCount): The number of mappings, including runtime and object fields.
  • mappings.total_estimated_overhead_in_bytes (or mteo, mappingsTotalEstimatedOverheadInBytes): The estimated heap overhead, in bytes, of mappings on this node, which allows for 1KiB of heap for every mapped field.
  • master (or m): Indicates whether the node is the elected master node. Returned values include * (elected master) and - (not elected master).
  • merges.current (or mc, mergesCurrent): The number of current merge operations.
  • merges.current_docs (or mcd, mergesCurrentDocs): The number of current merging documents.
  • merges.current_size (or mcs, mergesCurrentSize): The size of current merges. For example: 0b.
  • merges.total (or mt, mergesTotal): The number of completed merge operations.
  • merges.total_docs (or mtd, mergesTotalDocs): The number of merged documents.
  • merges.total_size (or mts, mergesTotalSize): The total size of merges. For example: 0b.
  • merges.total_time (or mtt, mergesTotalTime): The time spent merging documents. For example: 0s.
  • name (or n): The node name.
  • node.role (or r, role, nodeRole): The roles of the node. Returned values include c (cold node), d (data node), f (frozen node), h (hot node), i (ingest node), l (machine learning node), m (master-eligible node), r (remote cluster client node), s (content node), t (transform node), v (voting-only node), w (warm node), and - (coordinating node only). For example, dim indicates a master-eligible data and ingest node.
  • pid (or p): The process identifier.
  • port (or po): The bound transport port number.
  • query_cache.memory_size (or qcm, queryCacheMemory): The used query cache memory. For example: 0b.
  • query_cache.evictions (or qce, queryCacheEvictions): The number of query cache evictions.
  • query_cache.hit_count (or qchc, queryCacheHitCount): The query cache hit count.
  • query_cache.miss_count (or qcmc, queryCacheMissCount): The query cache miss count.
  • ram.current (or rc, ramCurrent): The used total memory. For example: 513.4mb.
  • ram.max (or rm, ramMax): The total memory. For example: 2.9gb.
  • ram.percent (or rp, ramPercent): The used percentage of the total operating system memory. This reflects all processes running on the operating system instead of only Elasticsearch and is not guaranteed to correlate to its performance.
  • refresh.total (or rto, refreshTotal): The number of refresh operations.
  • refresh.time (or rti, refreshTime): The time spent in refresh operations. For example: 91ms.
  • request_cache.memory_size (or rcm, requestCacheMemory): The used request cache memory. For example: 0b.
  • request_cache.evictions (or rce, requestCacheEvictions): The number of request cache evictions.
  • request_cache.hit_count (or rchc, requestCacheHitCount): The request cache hit count.
  • request_cache.miss_count (or rcmc, requestCacheMissCount): The request cache miss count.
  • script.compilations (or scrcc, scriptCompilations): The number of total script compilations.
  • script.cache_evictions (or scrce, scriptCacheEvictions): The number of total compiled scripts evicted from cache.
  • search.fetch_current (or sfc, searchFetchCurrent): The number of current fetch phase operations.
  • search.fetch_time (or sfti, searchFetchTime): The time spent in fetch phase. For example: 37ms.
  • search.fetch_total (or sfto, searchFetchTotal): The number of fetch operations.
  • search.open_contexts (or so, searchOpenContexts): The number of open search contexts.
  • search.query_current (or sqc, searchQueryCurrent): The number of current query phase operations.
  • search.query_time (or sqti, searchQueryTime): The time spent in query phase. For example: 43ms.
  • search.query_total (or sqto, searchQueryTotal): The number of query operations.
  • search.scroll_current (or scc, searchScrollCurrent): The number of open scroll contexts.
  • search.scroll_time (or scti, searchScrollTime): The amount of time scroll contexts were held open. For example: 2m.
  • search.scroll_total (or scto, searchScrollTotal): The number of completed scroll contexts.
  • segments.count (or sc, segmentsCount): The number of segments.
  • segments.fixed_bitset_memory (or sfbm, fixedBitsetMemory): The memory used by fixed bit sets for nested object field types and type filters for types referred in join fields. For example: 1.0kb.
  • segments.index_writer_memory (or siwm, segmentsIndexWriterMemory): The memory used by the index writer. For example: 18mb.
  • segments.memory (or sm, segmentsMemory): The memory used by segments. For example: 1.4kb.
  • segments.version_map_memory (or svmm, segmentsVersionMapMemory): The memory used by the version map. For example: 1.0kb.
  • shard_stats.total_count (or sstc, shards, shardStatsTotalCount): The number of shards assigned.
  • suggest.current (or suc, suggestCurrent): The number of current suggest operations.
  • suggest.time (or suti, suggestTime): The time spent in suggest operations.
  • suggest.total (or suto, suggestTotal): The number of suggest operations.
  • uptime (or u): The amount of node uptime. For example: 17.3m.
  • version (or v): The Elasticsearch version. For example: 9.0.0.
• s string | array[string]

  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 string

  The period to wait for a connection to the master node.

  Values are -1 or 0.

• time string

  The unit used to display time values.

  Values are nanos, micros, ms, s, m, h, or d.

Responses

• 200 application/json
  Hide response attributes Show response attributes object

  • id string
  • pid string

    The process identifier.

  • ip string

    The IP address.

  • port string

    The bound transport port.

  • http_address string

    The bound HTTP address.

  • version string
  • flavor string

    The Elasticsearch distribution flavor.

  • type string

    The Elasticsearch distribution type.

  • build string

    The Elasticsearch build hash.

  • jdk string

    The Java version.

  • disk.total number | string

    One of:

    ByteSize number ByteSize string

  • disk.used number | string

    One of:

    ByteSize number ByteSize string

  • disk.avail number | string

    One of:

    ByteSize number ByteSize string

  • disk.used_percent string | number

    One of:

    Percentage string Percentage number
  • heap.current string

    The used heap.

  • heap.percent string | number

    One of:

    Percentage string Percentage number
  • heap.max string

    The maximum configured heap.

  • ram.current string

    The used machine memory.

  • ram.percent string | number

    One of:

    Percentage string Percentage number
  • ram.max string

    The total machine memory.

  • file_desc.current string

    The used file descriptors.

  • file_desc.percent string | number

    One of:

    Percentage string Percentage number
  • file_desc.max string

    The maximum number of file descriptors.

  • cpu string

    The recent system CPU usage as a percentage.

  • load_1m string

    The load average for the most recent minute.

  • load_5m string

    The load average for the last five minutes.

  • load_15m string

    The load average for the last fifteen minutes.

  • uptime string

    The node uptime.

  • node.role string

    The roles of the node. Returned values include c(cold node), d(data node), f(frozen node), h(hot node), i(ingest node), l(machine learning node), m (master eligible node), r(remote cluster client node), s(content node), t(transform node), v(voting-only node), w(warm node),and -(coordinating node only).

  • master string

    Indicates whether the node is the elected master node. Returned values include *(elected master) and -(not elected master).

  • name string
  • completion.size string

    The size of completion.

  • fielddata.memory_size string

    The used fielddata cache.

  • fielddata.evictions string

    The fielddata evictions.

  • query_cache.memory_size string

    The used query cache.

  • query_cache.evictions string

    The query cache evictions.

  • query_cache.hit_count string

    The query cache hit counts.

  • query_cache.miss_count string

    The query cache miss counts.

  • request_cache.memory_size string

    The used request cache.

  • request_cache.evictions string

    The request cache evictions.

  • request_cache.hit_count string

    The request cache hit counts.

  • request_cache.miss_count string

    The request cache miss counts.

  • flush.total string

    The number of flushes.

  • flush.total_time string

    The time spent in flush.

  • get.current string

    The number of current get ops.

  • get.time string

    The time spent in get.

  • get.total string

    The number of get ops.

  • get.exists_time string

    The time spent in successful gets.

  • get.exists_total string

    The number of successful get operations.

  • get.missing_time string

    The time spent in failed gets.

  • get.missing_total string

    The number of failed gets.

  • indexing.delete_current string

    The number of current deletions.

  • indexing.delete_time string

    The time spent in deletions.

  • indexing.delete_total string

    The number of delete operations.

  • indexing.index_current string

    The number of current indexing operations.

  • indexing.index_time string

    The time spent in indexing.

  • indexing.index_total string

    The number of indexing operations.

  • indexing.index_failed string

    The number of failed indexing operations.

  • merges.current string

    The number of current merges.

  • merges.current_docs string

    The number of current merging docs.

  • merges.current_size string

    The size of current merges.

  • merges.total string

    The number of completed merge operations.

  • merges.total_docs string

    The docs merged.

  • merges.total_size string

    The size merged.

  • merges.total_time string

    The time spent in merges.

  • refresh.total string

    The total refreshes.

  • refresh.time string

    The time spent in refreshes.

  • refresh.external_total string

    The total external refreshes.

  • refresh.external_time string

    The time spent in external refreshes.

  • refresh.listeners string

    The number of pending refresh listeners.

  • script.compilations string

    The total script compilations.

  • script.cache_evictions string

    The total compiled scripts evicted from the cache.

  • script.compilation_limit_triggered string

    The script cache compilation limit triggered.

  • search.fetch_current string

    The current fetch phase operations.

  • search.fetch_time string

    The time spent in fetch phase.

  • search.fetch_total string

    The total fetch operations.

  • search.open_contexts string

    The open search contexts.

  • search.query_current string

    The current query phase operations.

  • search.query_time string

    The time spent in query phase.

  • search.query_total string

    The total query phase operations.

  • search.scroll_current string

    The open scroll contexts.

  • search.scroll_time string

    The time scroll contexts held open.

  • search.scroll_total string

    The completed scroll contexts.

  • segments.count string

    The number of segments.

  • segments.memory string

    The memory used by segments.

  • segments.index_writer_memory string

    The memory used by the index writer.

  • segments.version_map_memory string

    The memory used by the version map.

  • segments.fixed_bitset_memory string

    The memory used by fixed bit sets for nested object field types and export type filters for types referred in _parent fields.

  • suggest.current string

    The number of current suggest operations.

  • suggest.time string

    The time spend in suggest.

  • suggest.total string

    The number of suggest operations.

  • bulk.total_operations string

    The number of bulk shard operations.

  • bulk.total_time string

    The time spend in shard bulk.

  • bulk.total_size_in_bytes string

    The total size in bytes of shard bulk.

  • bulk.avg_time string

    The average time spend in shard bulk.

  • bulk.avg_size_in_bytes string

    The average size in bytes of shard bulk.

Query parameters

• actions array[string]

  The task action names, which are used to limit the response.

• detailed boolean

  If true, the response includes detailed information about shard recoveries.

• nodes array[string]

  Unique node identifiers, which are used to limit the response.

• parent_task_id string

  The parent task identifier, which is used to limit the response.

• h string | array[string]

  List of columns to appear in the response. Supports simple wildcards.

• s string | array[string]

  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.

• time string

  Unit used to display time values.

  Values are nanos, micros, ms, s, m, h, or d.

• timeout string

  Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.

  Values are -1 or 0.

• wait_for_completion boolean

  If true, the request blocks until the task has completed.

Responses

• 200 application/json
  Hide response attributes Show response attributes object

  • id string
  • action string

    The task action.

  • task_id string
  • parent_task_id string

    The parent task identifier.

  • type string

    The task type.

  • start_time string

    The start time in milliseconds.

  • timestamp string

    The start time in HH:MM:SS format.

  • running_time_ns string

    The running time in nanoseconds.

  • running_time string

    The running time.

  • node_id string
  • ip string

    The IP address for the node.

  • port string

    The bound transport port for the node.

  • node string

    The node name.

  • version string
  • x_opaque_id string

    The X-Opaque-ID header.

  • description string

    The task action description.

Query parameters

• node_names string | array[string]

  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 string | array[string]

  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 string

  Period to wait for a connection to the master node.

  Values are -1 or 0.

• timeout string

  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.

  Values are -1 or 0.

Responses

• 200 application/json

Path parameters

• index string | array[string] Required

  Comma-separated list of data streams, indices, and index aliases used to limit the request. Wildcard expressions (*) are supported. To target all data streams and indices in a cluster, omit this parameter or use _all or *.

Query parameters

• expand_wildcards string | array[string]

  Whether to expand wildcard expression to concrete indices that are open, closed or both.

  Supported values include:

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

  Values are all, open, closed, hidden, or none.

• level string

  Can be one of cluster, indices or shards. Controls the details level of the health information returned.

  Values are cluster, indices, or shards.

• local boolean

  If true, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the master node.

• master_timeout string

  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.

  Values are -1 or 0.

• timeout string

  Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.

  Values are -1 or 0.

• wait_for_active_shards number | string

  A number controlling to how many active shards to wait for, all to wait for all shards in the cluster to be active, or 0 to not wait.

  Values are all or index-setting.

• wait_for_events string

  Can be one of immediate, urgent, high, normal, low, languid. Wait until all currently queued events with the given priority are processed.

  Values are immediate, urgent, high, normal, low, or languid.

• wait_for_nodes string | number

  The request waits until the specified number N of nodes is available. It also accepts >=N, <=N, >N and <N. Alternatively, it is possible to use ge(N), le(N), gt(N) and lt(N) notation.

• wait_for_no_initializing_shards boolean

  A boolean value which controls whether to wait (until the timeout provided) for the cluster to have no shard initializations. Defaults to false, which means it will not wait for initializing shards.

• wait_for_no_relocating_shards boolean

  A boolean value which controls whether to wait (until the timeout provided) for the cluster to have no shard relocations. Defaults to false, which means it will not wait for relocating shards.

• wait_for_status string

  One of green, yellow or red. Will wait (until the timeout provided) until the status of the cluster changes to the one provided or better, i.e. green > yellow > red. By default, will not wait for any status.

  Supported values include:

  • green (or GREEN): All shards are assigned.
  • yellow (or YELLOW): All primary shards are assigned, but one or more replica shards are unassigned. If a node in the cluster fails, some data could be unavailable until that node is repaired.
  • red (or RED): One or more primary shards are unassigned, so some data is unavailable. This can occur briefly during cluster startup as primary shards are assigned.

  Values are green, GREEN, yellow, YELLOW, red, or RED.

Responses

• 200 application/json
  Hide response attributes Show response attributes object

  • active_primary_shards number Required

    The number of active primary shards.

  • active_shards number Required

    The total number of active primary and replica shards.

  • active_shards_percent string

    The ratio of active shards in the cluster expressed as a string formatted percentage.

  • active_shards_percent_as_number number Required

    The ratio of active shards in the cluster expressed as a percentage.

  • cluster_name string Required
  • delayed_unassigned_shards number Required

    The number of shards whose allocation has been delayed by the timeout settings.

  • indices object
    Hide indices attribute Show indices attribute object

    • * object Additional properties
      Hide * attributes Show * attributes object

      • active_primary_shards number Required
      • active_shards number Required
      • initializing_shards number Required
      • number_of_replicas number Required
      • number_of_shards number Required
      • relocating_shards number Required
      • shards object
        Hide shards attribute Show shards attribute object

        • * object Additional properties
          Hide * attributes Show * attributes object

          • active_shards number Required
          • initializing_shards number Required
          • primary_active boolean Required
          • relocating_shards number Required
          • status string Required

            Values are green, GREEN, yellow, YELLOW, red, or RED.

          • unassigned_shards number Required
          • unassigned_primary_shards number Required
      • status string Required

        Values are green, GREEN, yellow, YELLOW, red, or RED.

      • unassigned_shards number Required
      • unassigned_primary_shards number Required
  • initializing_shards number Required

    The number of shards that are under initialization.

  • number_of_data_nodes number Required

    The number of nodes that are dedicated data nodes.

  • number_of_in_flight_fetch number Required

    The number of unfinished fetches.

  • number_of_nodes number Required

    The number of nodes within the cluster.

  • number_of_pending_tasks number Required

    The number of cluster-level changes that have not yet been executed.

  • relocating_shards number Required

    The number of shards that are under relocation.

  • status string Required

    Values are green, GREEN, yellow, YELLOW, red, or RED.

  • task_max_waiting_in_queue string

    A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.

  • task_max_waiting_in_queue_millis number

    Time unit for milliseconds

  • timed_out boolean Required

    If false the response returned within the period of time that is specified by the timeout parameter (30s by default)

  • unassigned_primary_shards number Required

    The number of primary shards that are not allocated.

  • unassigned_shards number Required

    The number of shards that are not allocated.

Query parameters

• dry_run boolean

  If true, then the request simulates the operation. It will calculate the result of applying the commands to the current cluster state and return the resulting cluster state after the commands (and rebalancing) have been applied; it will not actually perform the requested changes.

• explain boolean

  If true, then the response contains an explanation of why the commands can or cannot run.

• metric string | array[string]

  Limits the information returned to the specified metrics.

• retry_failed boolean

  If true, then retries allocation of shards that are blocked due to too many subsequent allocation failures.

• master_timeout string

  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.

  Values are -1 or 0.

• timeout string

  Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.

  Values are -1 or 0.

Responses

• 200 application/json
  Hide response attributes Show response attributes object

  • acknowledged boolean Required
  • explanations array[object]
    Hide explanations attributes Show explanations attributes object

    • command string Required
    • decisions array[object] Required
      Hide decisions attributes Show decisions attributes object

      • decider string Required
      • decision string Required
      • explanation string Required
    • parameters object Required
      Hide parameters attributes Show parameters attributes object

      • allow_primary boolean Required
      • index string Required
      • node string Required
      • shard number Required
      • from_node string
      • to_node string
  • state object

    There aren't any guarantees on the output/structure of the raw cluster state. Here you will find the internal representation of the cluster, which can differ from the external representation.

Path parameters

• metric string | array[string] Required

  Limit the information returned to the specified metrics

• index string | array[string] Required

  A comma-separated list of index names; use _all or empty string to perform the operation on all indices

Query parameters

• allow_no_indices boolean

  Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes _all string or when no indices have been specified)

• expand_wildcards string | array[string]

  Whether to expand wildcard expression to concrete indices that are open, closed or both.

  Supported values include:

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

  Values are all, open, closed, hidden, or none.

• flat_settings boolean

  Return settings in flat format (default: false)

• ignore_unavailable boolean

  Whether specified concrete indices should be ignored when unavailable (missing or closed)

• local boolean

  Return local information, do not retrieve the state from master node (default: false)

• master_timeout string

  Specify timeout for connection to master

  Values are -1 or 0.

• wait_for_metadata_version number

  Wait for the metadata version to be equal or greater than the specified metadata version

• wait_for_timeout string

  The maximum time to wait for wait_for_metadata_version before timing out

  Values are -1 or 0.

Responses

• 200 application/json

Query parameters

• include_remotes boolean

  Include remote cluster data into the response

• timeout string

  Period to wait for each node to respond. If a node does not respond before its timeout expires, the response does not include its stats. However, timed out nodes are included in the response’s _nodes.failed property. Defaults to no timeout.

  Values are -1 or 0.

Responses

• 200 application/json
  Hide response attributes Show response attributes object

  • _nodes object
    Hide _nodes attributes Show _nodes attributes object

    • failures array[object]
      Hide failures attributes Show failures attributes object

      • type string Required

        The type of error

      • reason string | null

        A human-readable explanation of the error, in English.

        One of:

        string-1 string string-2 string | null
      • stack_trace string

        The server stack trace. Present only if the error_trace=true parameter was sent with the request.

      • caused_by object
      • root_cause array[object]
      • suppressed array[object]
    • total number Required

      Total number of nodes selected by the request.

    • successful number Required

      Number of nodes that responded successfully to the request.

    • failed number Required

      Number of nodes that rejected the request or failed to respond. If this value is not 0, a reason for the rejection or failure is included in the response.

  • cluster_name string Required
  • cluster_uuid string Required
  • indices object Required
    Hide indices attributes Show indices attributes object

    • analysis object Required
      Hide analysis attributes Show analysis attributes object

      • analyzer_types array[object] Required

        Contains statistics about analyzer types used in selected nodes.

        Hide analyzer_types attributes Show analyzer_types attributes object

        • name string Required
        • count number Required

          The number of occurrences of the field type in selected nodes.

        • index_count number Required

          The number of indices containing the field type in selected nodes.

        • indexed_vector_count number

          For dense_vector field types, number of indexed vector types in selected nodes.

        • indexed_vector_dim_max number

          For dense_vector field types, the maximum dimension of all indexed vector types in selected nodes.

        • indexed_vector_dim_min number

          For dense_vector field types, the minimum dimension of all indexed vector types in selected nodes.

        • script_count number

          The number of fields that declare a script.

      • built_in_analyzers array[object] Required

        Contains statistics about built-in analyzers used in selected nodes.

        Hide built_in_analyzers attributes Show built_in_analyzers attributes object

        • name string Required
        • count number Required

          The number of occurrences of the field type in selected nodes.

        • index_count number Required

          The number of indices containing the field type in selected nodes.

        • indexed_vector_count number

          For dense_vector field types, number of indexed vector types in selected nodes.

        • indexed_vector_dim_max number

          For dense_vector field types, the maximum dimension of all indexed vector types in selected nodes.

        • indexed_vector_dim_min number

          For dense_vector field types, the minimum dimension of all indexed vector types in selected nodes.

        • script_count number

          The number of fields that declare a script.

      • built_in_char_filters array[object] Required

        Contains statistics about built-in character filters used in selected nodes.

        Hide built_in_char_filters attributes Show built_in_char_filters attributes object

        • name string Required
        • count number Required

          The number of occurrences of the field type in selected nodes.

        • index_count number Required

          The number of indices containing the field type in selected nodes.

        • indexed_vector_count number

          For dense_vector field types, number of indexed vector types in selected nodes.

        • indexed_vector_dim_max number

          For dense_vector field types, the maximum dimension of all indexed vector types in selected nodes.

        • indexed_vector_dim_min number

          For dense_vector field types, the minimum dimension of all indexed vector types in selected nodes.

        • script_count number

          The number of fields that declare a script.

      • built_in_filters array[object] Required

        Contains statistics about built-in token filters used in selected nodes.

        Hide built_in_filters attributes Show built_in_filters attributes object

        • name string Required
        • count number Required

          The number of occurrences of the field type in selected nodes.

        • index_count number Required

          The number of indices containing the field type in selected nodes.

        • indexed_vector_count number

          For dense_vector field types, number of indexed vector types in selected nodes.

        • indexed_vector_dim_max number

          For dense_vector field types, the maximum dimension of all indexed vector types in selected nodes.

        • indexed_vector_dim_min number

          For dense_vector field types, the minimum dimension of all indexed vector types in selected nodes.

        • script_count number

          The number of fields that declare a script.

      • built_in_tokenizers array[object] Required

        Contains statistics about built-in tokenizers used in selected nodes.

        Hide built_in_tokenizers attributes Show built_in_tokenizers attributes object

        • name string Required
        • count number Required

          The number of occurrences of the field type in selected nodes.

        • index_count number Required

          The number of indices containing the field type in selected nodes.

        • indexed_vector_count number

          For dense_vector field types, number of indexed vector types in selected nodes.

        • indexed_vector_dim_max number

          For dense_vector field types, the maximum dimension of all indexed vector types in selected nodes.

        • indexed_vector_dim_min number

          For dense_vector field types, the minimum dimension of all indexed vector types in selected nodes.

        • script_count number

          The number of fields that declare a script.

      • char_filter_types array[object] Required

        Contains statistics about character filter types used in selected nodes.

        Hide char_filter_types attributes Show char_filter_types attributes object

        • name string Required
        • count number Required

          The number of occurrences of the field type in selected nodes.

        • index_count number Required

          The number of indices containing the field type in selected nodes.

        • indexed_vector_count number

          For dense_vector field types, number of indexed vector types in selected nodes.

        • indexed_vector_dim_max number

          For dense_vector field types, the maximum dimension of all indexed vector types in selected nodes.

        • indexed_vector_dim_min number

          For dense_vector field types, the minimum dimension of all indexed vector types in selected nodes.

        • script_count number

          The number of fields that declare a script.

      • filter_types array[object] Required

        Contains statistics about token filter types used in selected nodes.

        Hide filter_types attributes Show filter_types attributes object

        • name string Required
        • count number Required

          The number of occurrences of the field type in selected nodes.

        • index_count number Required

          The number of indices containing the field type in selected nodes.

        • indexed_vector_count number

          For dense_vector field types, number of indexed vector types in selected nodes.

        • indexed_vector_dim_max number

          For dense_vector field types, the maximum dimension of all indexed vector types in selected nodes.

        • indexed_vector_dim_min number

          For dense_vector field types, the minimum dimension of all indexed vector types in selected nodes.

        • script_count number

          The number of fields that declare a script.

      • tokenizer_types array[object] Required

        Contains statistics about tokenizer types used in selected nodes.

        Hide tokenizer_types attributes Show tokenizer_types attributes object

        • name string Required
        • count number Required

          The number of occurrences of the field type in selected nodes.

        • index_count number Required

          The number of indices containing the field type in selected nodes.

        • indexed_vector_count number

          For dense_vector field types, number of indexed vector types in selected nodes.

        • indexed_vector_dim_max number

          For dense_vector field types, the maximum dimension of all indexed vector types in selected nodes.

        • indexed_vector_dim_min number

          For dense_vector field types, the minimum dimension of all indexed vector types in selected nodes.

        • script_count number

          The number of fields that declare a script.

    • completion object Required
      Hide completion attributes Show completion attributes object

      • size_in_bytes number Required

        Total amount, in bytes, of memory used for completion across all shards assigned to selected nodes.

      • size number | string

        One of:

        ByteSize number ByteSize string
      • fields object
        Hide fields attribute Show fields attribute object

        • * object Additional properties
          Hide * attributes Show * attributes object

          • size
          • size_in_bytes number Required
    • count number Required

      Total number of indices with shards assigned to selected nodes.

    • docs object Required
      Hide docs attributes Show docs attributes object

      • count number Required

        Total number of non-deleted documents across all primary shards assigned to selected nodes. This number is based on documents in Lucene segments and may include documents from nested fields.

      • deleted number

        Total number of deleted documents across all primary shards assigned to selected nodes. This number is based on documents in Lucene segments. Elasticsearch reclaims the disk space of deleted Lucene documents when a segment is merged.

    • fielddata object Required
      Hide fielddata attributes Show fielddata attributes object

      • evictions number

      • memory_size number | string

        One of:

        ByteSize number ByteSize string
      • memory_size_in_bytes number Required
      • fields object
        Hide fields attribute Show fields attribute object

        • * object Additional properties
          Hide * attributes Show * attributes object

          • memory_size
          • memory_size_in_bytes number Required
    • query_cache object Required
      Hide query_cache attributes Show query_cache attributes object

      • cache_count number Required

        Total number of entries added to the query cache across all shards assigned to selected nodes. This number includes current and evicted entries.

      • cache_size number Required

        Total number of entries currently in the query cache across all shards assigned to selected nodes.

      • evictions number Required

        Total number of query cache evictions across all shards assigned to selected nodes.

      • hit_count number Required

        Total count of query cache hits across all shards assigned to selected nodes.

      • memory_size number | string

        One of:

        ByteSize number ByteSize string
      • memory_size_in_bytes number Required

        Total amount, in bytes, of memory used for the query cache across all shards assigned to selected nodes.

      • miss_count number Required

        Total count of query cache misses across all shards assigned to selected nodes.

      • total_count number Required

        Total count of hits and misses in the query cache across all shards assigned to selected nodes.

    • segments object Required
      Hide segments attributes Show segments attributes object

      • count number Required

        Total number of segments across all shards assigned to selected nodes.

      • doc_values_memory number | string

        One of:

        ByteSize number ByteSize string
      • doc_values_memory_in_bytes number Required

        Total amount, in bytes, of memory used for doc values across all shards assigned to selected nodes.

      • file_sizes object Required

        This object is not populated by the cluster stats API. To get information on segment files, use the node stats API.

        Hide file_sizes attribute Show file_sizes attribute object

        • * object Additional properties
          Hide * attributes Show * attributes object

          • description string Required
          • size_in_bytes number Required
          • min_size_in_bytes number
          • max_size_in_bytes number
          • average_size_in_bytes number
          • count number

      • fixed_bit_set number | string

        One of:

        ByteSize number ByteSize string
      • fixed_bit_set_memory_in_bytes number Required

        Total amount of memory, in bytes, used by fixed bit sets across all shards assigned to selected nodes.

      • index_writer_memory number | string

        One of:

        ByteSize number ByteSize string
      • index_writer_max_memory_in_bytes number
      • index_writer_memory_in_bytes number Required

        Total amount, in bytes, of memory used by all index writers across all shards assigned to selected nodes.

      • max_unsafe_auto_id_timestamp number Required

        Unix timestamp, in milliseconds, of the most recently retried indexing request.

      • memory number | string

        One of:

        ByteSize number ByteSize string
      • memory_in_bytes number Required

        Total amount, in bytes, of memory used for segments across all shards assigned to selected nodes.

      • norms_memory number | string

        One of:

        ByteSize number ByteSize string
      • norms_memory_in_bytes number Required

        Total amount, in bytes, of memory used for normalization factors across all shards assigned to selected nodes.

      • points_memory number | string

        One of:

        ByteSize number ByteSize string
      • points_memory_in_bytes number Required

        Total amount, in bytes, of memory used for points across all shards assigned to selected nodes.

      • stored_memory number | string

        One of:

        ByteSize number ByteSize string
      • stored_fields_memory_in_bytes number Required

        Total amount, in bytes, of memory used for stored fields across all shards assigned to selected nodes.

      • terms_memory_in_bytes number Required

        Total amount, in bytes, of memory used for terms across all shards assigned to selected nodes.

      • terms_memory number | string

        One of:

        ByteSize number ByteSize string

      • term_vectory_memory number | string

        One of:

        ByteSize number ByteSize string
      • term_vectors_memory_in_bytes number Required

        Total amount, in bytes, of memory used for term vectors across all shards assigned to selected nodes.

      • version_map_memory number | string

        One of:

        ByteSize number ByteSize string
      • version_map_memory_in_bytes number Required

        Total amount, in bytes, of memory used by all version maps across all shards assigned to selected nodes.

    • shards object Required
      Hide shards attributes Show shards attributes object

      • index object
        Hide index attributes Show index attributes object

        • primaries object Required
          Hide primaries attributes Show primaries attributes object

          • avg number Required

            Mean number of shards in an index, counting only shards assigned to selected nodes.

          • max number Required

            Maximum number of shards in an index, counting only shards assigned to selected nodes.

          • min number Required

            Minimum number of shards in an index, counting only shards assigned to selected nodes.

        • replication object Required
          Hide replication attributes Show replication attributes object

          • avg number Required

            Mean number of shards in an index, counting only shards assigned to selected nodes.

          • max number Required

            Maximum number of shards in an index, counting only shards assigned to selected nodes.

          • min number Required

            Minimum number of shards in an index, counting only shards assigned to selected nodes.

        • shards object Required
          Hide shards attributes Show shards attributes object

          • avg number Required

            Mean number of shards in an index, counting only shards assigned to selected nodes.

          • max number Required

            Maximum number of shards in an index, counting only shards assigned to selected nodes.

          • min number Required

            Minimum number of shards in an index, counting only shards assigned to selected nodes.

      • primaries number

        Number of primary shards assigned to selected nodes.

      • replication number

        Ratio of replica shards to primary shards across all selected nodes.

      • total number

        Total number of shards assigned to selected nodes.

    • store object Required
      Hide store attributes Show store attributes object

      • size number | string

        One of:

        ByteSize number ByteSize string
      • size_in_bytes number Required

        Total size, in bytes, of all shards assigned to selected nodes.

      • reserved number | string

        One of:

        ByteSize number ByteSize string
      • reserved_in_bytes number Required

        A prediction, in bytes, of how much larger the shard stores will eventually grow due to ongoing peer recoveries, restoring snapshots, and similar activities.

      • total_data_set_size number | string

        One of:

        ByteSize number ByteSize string
      • total_data_set_size_in_bytes number

        Total data set size, in bytes, of all shards assigned to selected nodes. This includes the size of shards not stored fully on the nodes, such as the cache for partially mounted indices.

    • mappings object Required
      Hide mappings attributes Show mappings attributes object

      • field_types array[object] Required

        Contains statistics about field data types used in selected nodes.

        Hide field_types attributes Show field_types attributes object

        • name string Required
        • count number Required

          The number of occurrences of the field type in selected nodes.

        • index_count number Required

          The number of indices containing the field type in selected nodes.

        • indexed_vector_count number

          For dense_vector field types, number of indexed vector types in selected nodes.

        • indexed_vector_dim_max number

          For dense_vector field types, the maximum dimension of all indexed vector types in selected nodes.

        • indexed_vector_dim_min number

          For dense_vector field types, the minimum dimension of all indexed vector types in selected nodes.

        • script_count number

          The number of fields that declare a script.

      • runtime_field_types array[object]

        Contains statistics about runtime field data types used in selected nodes.

        Hide runtime_field_types attributes Show runtime_field_types attributes object

        • chars_max number Required

          Maximum number of characters for a single runtime field script.

        • chars_total number Required

          Total number of characters for the scripts that define the current runtime field data type.

        • count number Required

          Number of runtime fields mapped to the field data type in selected nodes.

        • doc_max number Required

          Maximum number of accesses to doc_values for a single runtime field script

        • doc_total number Required

          Total number of accesses to doc_values for the scripts that define the current runtime field data type.

        • index_count number Required

          Number of indices containing a mapping of the runtime field data type in selected nodes.

        • lang array[string] Required

          Script languages used for the runtime fields scripts.

        • lines_max number Required

          Maximum number of lines for a single runtime field script.

        • lines_total number Required

          Total number of lines for the scripts that define the current runtime field data type.

        • name string Required
        • scriptless_count number Required

          Number of runtime fields that don’t declare a script.

        • shadowed_count number Required

          Number of runtime fields that shadow an indexed field.

        • source_max number Required

          Maximum number of accesses to _source for a single runtime field script.

        • source_total number Required

          Total number of accesses to _source for the scripts that define the current runtime field data type.

      • total_field_count number

        Total number of fields in all non-system indices.

      • total_deduplicated_field_count number

        Total number of fields in all non-system indices, accounting for mapping deduplication.

      • total_deduplicated_mapping_size number | string

        One of:

        ByteSize number ByteSize string
      • total_deduplicated_mapping_size_in_bytes number

        Total size of all mappings, in bytes, after deduplication and compression.

    • versions array[object]

      Contains statistics about analyzers and analyzer components used in selected nodes.

      Hide versions attributes Show versions attributes object

      • index_count number Required
      • primary_shard_count number Required
      • total_primary_bytes number Required
      • version string Required
  • nodes object Required
    Hide nodes attributes Show nodes attributes object

    • count object Required
      Hide count attributes Show count attributes object

      • coordinating_only number Required
      • data number Required
      • data_cold number Required
      • data_content number Required
      • data_frozen number
      • data_hot number Required
      • data_warm number Required
      • ingest number Required
      • master number Required
      • ml number Required
      • remote_cluster_client number Required
      • total number Required
      • transform number Required
      • voting_only number Required
    • discovery_types object Required

      Contains statistics about the discovery types used by selected nodes.

      Hide discovery_types attribute Show discovery_types attribute object

      • * number Additional properties
    • fs object Required
      Hide fs attributes Show fs attributes object

      • available_in_bytes number Required

        Total number of bytes available to JVM in file stores across all selected nodes. Depending on operating system or process-level restrictions, this number may be less than nodes.fs.free_in_byes. This is the actual amount of free disk space the selected Elasticsearch nodes can use.

      • free_in_bytes number Required

        Total number of unallocated bytes in file stores across all selected nodes.

      • total_in_bytes number Required

        Total size, in bytes, of all file stores across all selected nodes.

    • indexing_pressure object Required
      Hide indexing_pressure attribute Show indexing_pressure attribute object

      • memory object Required
        Hide memory attributes Show memory attributes object

        • current object Required
          Hide current attributes Show current attributes object

          • all_in_bytes number Required
          • combined_coordinating_and_primary_in_bytes number Required
          • coordinating_in_bytes number Required
          • coordinating_rejections number
          • primary_in_bytes number Required
          • primary_rejections number
          • replica_in_bytes number Required
          • replica_rejections number
        • limit_in_bytes number Required
        • total object Required
          Hide total attributes Show total attributes object

          • all_in_bytes number Required
          • combined_coordinating_and_primary_in_bytes number Required
          • coordinating_in_bytes number Required
          • coordinating_rejections number
          • primary_in_bytes number Required
          • primary_rejections number
          • replica_in_bytes number Required
          • replica_rejections number
    • ingest object Required
      Hide ingest attributes Show ingest attributes object

      • number_of_pipelines number Required
      • processor_stats object Required
        Hide processor_stats attribute Show processor_stats attribute object

        • * object Additional properties
          Hide * attributes Show * attributes object

          • count number Required
          • current number Required
          • failed number Required
          • time string

            A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.

    • jvm object Required
      Hide jvm attributes Show jvm attributes object

      • Time unit for milliseconds

      • mem object Required
        Hide mem attributes Show mem attributes object

        • heap_max_in_bytes number Required

          Maximum amount of memory, in bytes, available for use by the heap across all selected nodes.

        • heap_used_in_bytes number Required

          Memory, in bytes, currently in use by the heap across all selected nodes.

      • threads number Required

        Number of active threads in use by JVM across all selected nodes.

      • versions array[object] Required

        Contains statistics about the JVM versions used by selected nodes.

        Hide versions attributes Show versions attributes object

        • bundled_jdk boolean Required

          Always true. All distributions come with a bundled Java Development Kit (JDK).

        • count number Required

          Total number of selected nodes using JVM.

        • using_bundled_jdk boolean Required

          If true, a bundled JDK is in use by JVM.

        • version string Required
        • vm_name string Required

          Name of the JVM.

        • vm_vendor string Required

          Vendor of the JVM.

        • vm_version string Required
    • network_types object Required
      Hide network_types attributes Show network_types attributes object

      • http_types object Required

        Contains statistics about the HTTP network types used by selected nodes.

        Hide http_types attribute Show http_types attribute object

        • * number Additional properties
      • transport_types object Required

        Contains statistics about the transport network types used by selected nodes.

        Hide transport_types attribute Show transport_types attribute object

        • * number Additional properties
    • os object Required
      Hide os attributes Show os attributes object

      • allocated_processors number Required

        Number of processors used to calculate thread pool size across all selected nodes. This number can be set with the processors setting of a node and defaults to the number of processors reported by the operating system. In both cases, this number will never be larger than 32.

      • architectures array[object]

        Contains statistics about processor architectures (for example, x86_64 or aarch64) used by selected nodes.

        Hide architectures attributes Show architectures attributes object

        • arch string Required

          Name of an architecture used by one or more selected nodes.

        • count number Required

          Number of selected nodes using the architecture.

      • available_processors number Required

        Number of processors available to JVM across all selected nodes.

      • mem object Required
        Hide mem attributes Show mem attributes object

        • adjusted_total_in_bytes number

          Total amount, in bytes, of memory across all selected nodes, but using the value specified using the es.total_memory_bytes system property instead of measured total memory for those nodes where that system property was set.

        • free_in_bytes number Required

          Amount, in bytes, of free physical memory across all selected nodes.

        • free_percent number Required

          Percentage of free physical memory across all selected nodes.

        • total_in_bytes number Required

          Total amount, in bytes, of physical memory across all selected nodes.

        • used_in_bytes number Required

          Amount, in bytes, of physical memory in use across all selected nodes.

        • used_percent number Required

          Percentage of physical memory in use across all selected nodes.

      • names array[object] Required

        Contains statistics about operating systems used by selected nodes.

        Hide names attributes Show names attributes object

        • count number Required

          Number of selected nodes using the operating system.

        • name string Required
      • pretty_names array[object] Required

        Contains statistics about operating systems used by selected nodes.

        Hide pretty_names attributes Show pretty_names attributes object

        • count number Required

          Number of selected nodes using the operating system.

        • pretty_name string Required
    • packaging_types array[object] Required

      Contains statistics about Elasticsearch distributions installed on selected nodes.

      Hide packaging_types attributes Show packaging_types attributes object

      • count number Required

        Number of selected nodes using the distribution flavor and file type.

      • flavor string Required

        Type of Elasticsearch distribution. This is always default.

      • type string Required

        File type (such as tar or zip) used for the distribution package.

    • plugins array[object] Required

      Contains statistics about installed plugins and modules by selected nodes. If no plugins or modules are installed, this array is empty.

      Hide plugins attributes Show plugins attributes object

      • classname string Required
      • description string Required
      • elasticsearch_version string Required
      • extended_plugins array[string] Required
      • has_native_controller boolean Required
      • java_version string Required
      • name string Required
      • version string Required
      • licensed boolean Required
    • process object Required
      Hide process attributes Show process attributes object

      • cpu object Required
        Hide cpu attribute Show cpu attribute object

        • percent number Required

          Percentage of CPU used across all selected nodes. Returns -1 if not supported.

      • open_file_descriptors object Required
        Hide open_file_descriptors attributes Show open_file_descriptors attributes object

        • avg number Required

          Average number of concurrently open file descriptors. Returns -1 if not supported.

        • max number Required

          Maximum number of concurrently open file descriptors allowed across all selected nodes. Returns -1 if not supported.

        • min number Required

          Minimum number of concurrently open file descriptors across all selected nodes. Returns -1 if not supported.

    • versions array[string] Required

      Array of Elasticsearch versions used on selected nodes.

  • status string Required

    Values are green, GREEN, yellow, YELLOW, red, or RED.

  • timestamp number Required

    Unix timestamp, in milliseconds, for the last time the cluster statistics were refreshed.

  • ccs object Required
    Hide ccs attributes Show ccs attributes object

    • clusters object

      Contains remote cluster settings and metrics collected from them. The keys are cluster names, and the values are per-cluster data. Only present if include_remotes option is set to true.

      Hide clusters attribute Show clusters attribute object

      • * object Additional properties
        Hide * attributes Show * attributes object

        • cluster_uuid string Required

          The UUID of the remote cluster.

        • mode string Required

          The connection mode used to communicate with the remote cluster.

        • skip_unavailable boolean Required

          The skip_unavailable setting used for this remote cluster.

        • transport_compress string Required

          Transport compression setting used for this remote cluster.

        • status string Required

          Values are green, GREEN, yellow, YELLOW, red, or RED.

        • version array[string] Required

          The list of Elasticsearch versions used by the nodes on the remote cluster.

        • nodes_count number Required

          The total count of nodes in the remote cluster.

        • shards_count number Required

          The total number of shards in the remote cluster.

        • indices_count number Required

          The total number of indices in the remote cluster.

        • indices_total_size_in_bytes number Required

          Total data set size, in bytes, of all shards assigned to selected nodes.

        • indices_total_size string

          Total data set size of all shards assigned to selected nodes, as a human-readable string.

        • max_heap_in_bytes number Required

          Maximum amount of memory, in bytes, available for use by the heap across the nodes of the remote cluster.

        • max_heap string

          Maximum amount of memory available for use by the heap across the nodes of the remote cluster, as a human-readable string.

        • mem_total_in_bytes number Required

          Total amount, in bytes, of physical memory across the nodes of the remote cluster.

        • mem_total string

          Total amount of physical memory across the nodes of the remote cluster, as a human-readable string.

    • _search object Required
      Hide _search attributes Show _search attributes object

      • total number Required

        The total number of cross-cluster search requests that have been executed by the cluster.

      • success number Required

        The total number of cross-cluster search requests that have been successfully executed by the cluster.

      • skipped number Required

        The total number of cross-cluster search requests (successful or failed) that had at least one remote cluster skipped.

      • took object Required
        Hide took attributes Show took attributes object

        • Time unit for milliseconds

        • Time unit for milliseconds

        • Time unit for milliseconds

      • took_mrt_true object
        Hide took_mrt_true attributes Show took_mrt_true attributes object

        • Time unit for milliseconds

        • Time unit for milliseconds

        • Time unit for milliseconds

      • took_mrt_false object
        Hide took_mrt_false attributes Show took_mrt_false attributes object

        • Time unit for milliseconds

        • Time unit for milliseconds

        • Time unit for milliseconds

      • remotes_per_search_max number Required

        The maximum number of remote clusters that were queried in a single cross-cluster search request.

      • remotes_per_search_avg number Required

        The average number of remote clusters that were queried in a single cross-cluster search request.

      • failure_reasons object Required

        Statistics about the reasons for cross-cluster search request failures. The keys are the failure reason names and the values are the number of requests that failed for that reason.

        Hide failure_reasons attribute Show failure_reasons attribute object

        • * number Additional properties
      • features object Required

        The keys are the names of the search feature, and the values are the number of requests that used that feature. Single request can use more than one feature (e.g. both async and wildcard).

        Hide features attribute Show features attribute object

        • * number Additional properties
      • clients object Required

        Statistics about the clients that executed cross-cluster search requests. The keys are the names of the clients, and the values are the number of requests that were executed by that client. Only known clients (such as kibana or elasticsearch) are counted.

        Hide clients attribute Show clients attribute object

        • * number Additional properties
      • clusters object Required

        Statistics about the clusters that were queried in cross-cluster search requests. The keys are cluster names, and the values are per-cluster telemetry data. This also includes the local cluster itself, which uses the name (local).

        Hide clusters attribute Show clusters attribute object

        • * object Additional properties
          Hide * attributes Show * attributes object

          • total number Required

            The total number of successful (not skipped) cross-cluster search requests that were executed against this cluster. This may include requests where partial results were returned, but not requests in which the cluster has been skipped entirely.

          • skipped number Required

            The total number of cross-cluster search requests for which this cluster was skipped.

          • took object Required
    • _esql object
      Hide _esql attributes Show _esql attributes object

      • total number Required

        The total number of cross-cluster search requests that have been executed by the cluster.

      • success number Required

        The total number of cross-cluster search requests that have been successfully executed by the cluster.

      • skipped number Required

        The total number of cross-cluster search requests (successful or failed) that had at least one remote cluster skipped.

      • took object Required
        Hide took attributes Show took attributes object

        • Time unit for milliseconds

        • Time unit for milliseconds

        • Time unit for milliseconds

      • took_mrt_true object
        Hide took_mrt_true attributes Show took_mrt_true attributes object

        • Time unit for milliseconds

        • Time unit for milliseconds

        • Time unit for milliseconds

      • took_mrt_false object
        Hide took_mrt_false attributes Show took_mrt_false attributes object

        • Time unit for milliseconds

        • Time unit for milliseconds

        • Time unit for milliseconds

      • remotes_per_search_max number Required

        The maximum number of remote clusters that were queried in a single cross-cluster search request.

      • remotes_per_search_avg number Required

        The average number of remote clusters that were queried in a single cross-cluster search request.

      • failure_reasons object Required

        Statistics about the reasons for cross-cluster search request failures. The keys are the failure reason names and the values are the number of requests that failed for that reason.

        Hide failure_reasons attribute Show failure_reasons attribute object

        • * number Additional properties
      • features object Required

        The keys are the names of the search feature, and the values are the number of requests that used that feature. Single request can use more than one feature (e.g. both async and wildcard).

        Hide features attribute Show features attribute object

        • * number Additional properties
      • clients object Required

        Statistics about the clients that executed cross-cluster search requests. The keys are the names of the clients, and the values are the number of requests that were executed by that client. Only known clients (such as kibana or elasticsearch) are counted.

        Hide clients attribute Show clients attribute object

        • * number Additional properties
      • clusters object Required

        Statistics about the clusters that were queried in cross-cluster search requests. The keys are cluster names, and the values are per-cluster telemetry data. This also includes the local cluster itself, which uses the name (local).

        Hide clusters attribute Show clusters attribute object

        • * object Additional properties
          Hide * attributes Show * attributes object

          • total number Required

            The total number of successful (not skipped) cross-cluster search requests that were executed against this cluster. This may include requests where partial results were returned, but not requests in which the cluster has been skipped entirely.

          • skipped number Required

            The total number of cross-cluster search requests for which this cluster was skipped.

          • took object Required