Query parameters

• 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.

Responses

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

  • policies object Required
    Hide policies attribute Show policies attribute object

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

      • required_capacity object Required
        Hide required_capacity attributes Show required_capacity attributes object

        • node object Required
          Hide node attributes Show node attributes object

          • storage number Required
          • memory number Required
        • total object Required
          Hide total attributes Show total attributes object

          • storage number Required
          • memory number Required
      • current_capacity object Required
        Hide current_capacity attributes Show current_capacity attributes object

        • node object Required
          Hide node attributes Show node attributes object

          • storage number Required
          • memory number Required
        • total object Required
          Hide total attributes Show total attributes object

          • storage number Required
          • memory number Required
      • current_nodes array[object] Required
        Hide current_nodes attribute Show current_nodes attribute object

        • name string Required
      • deciders object Required
        Hide deciders attribute Show deciders attribute object

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

          • required_capacity object Required
            Hide required_capacity attributes Show required_capacity attributes object

            • node object Required
            • total object Required
          • reason_summary string
          • reason_details object

Path parameters

• collection_name string Required

  The name of the behavioral analytics collection.

• event_type string Required

  The analytics event type.

  Values are page_view, search, or search_click.

Query parameters

• debug boolean

  Whether the response type has to include more details

Responses

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

  • accepted boolean Required
  • event object

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.

• expand_wildcards string | array[string]

  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.

• local boolean

  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 string

  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.

Responses

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

  • alias string

    alias name

  • index string
  • filter string

    filter

  • routing.index string

    index routing

  • routing.search string

    search routing

  • is_write_index string

    write index

Path parameters

• name string | array[string] Required

  A comma-separated list of aliases to retrieve. Supports wildcards (*). To retrieve all aliases, 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.

• expand_wildcards string | array[string]

  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.

• local boolean

  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 string

  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.

Responses

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

  • alias string

    alias name

  • index string
  • filter string

    filter

  • routing.index string

    index routing

  • routing.search string

    search routing

  • is_write_index string

    write index

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

Path parameters

• datafeed_id string Required

  A numerical character string that uniquely identifies the datafeed.

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.

• s string | array[string]

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

• 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.

Path parameters

• job_id string Required

  Identifier for the anomaly detection job.

Query parameters

• allow_no_match boolean

  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.

• bytes string

  The unit used to display byte values.

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

• h string | array[string]

  Comma-separated list of column names to display.

• s string | array[string]

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

• 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
  • state string

    Values are closing, closed, opened, failed, or opening.

  • opened_time string

    For open jobs only, the amount of time the job has been opened.

  • assignment_explanation string

    For open anomaly detection jobs only, contains messages relating to the selection of a node to run the job.

  • data.processed_records string

    The number of input documents that have been processed by the anomaly detection job. This value includes documents with missing fields, since they are nonetheless analyzed. If you use datafeeds and have aggregations in your search query, the processed_record_count is the number of aggregation results processed, not the number of Elasticsearch documents.

  • data.processed_fields string

    The total number of fields in all the documents that have been processed by the anomaly detection job. Only fields that are specified in the detector configuration object contribute to this count. The timestamp is not included in this count.

  • data.input_bytes number | string

    One of:

    ByteSize number ByteSize string
  • data.input_records string

    The number of input documents posted to the anomaly detection job.

  • data.input_fields string

    The total number of fields in input documents posted to the anomaly detection job. This count includes fields that are not used in the analysis. However, be aware that if you are using a datafeed, it extracts only the required fields from the documents it retrieves before posting them to the job.

  • data.invalid_dates string

    The number of input documents with either a missing date field or a date that could not be parsed.

  • data.missing_fields string

    The number of input documents that are missing a field that the anomaly detection job is configured to analyze. Input documents with missing fields are still processed because it is possible that not all fields are missing. If you are using datafeeds or posting data to the job in JSON format, a high missing_field_count is often not an indication of data issues. It is not necessarily a cause for concern.

  • data.out_of_order_timestamps string

    The number of input documents that have a timestamp chronologically preceding the start of the current anomaly detection bucket offset by the latency window. This information is applicable only when you provide data to the anomaly detection job by using the post data API. These out of order documents are discarded, since jobs require time series data to be in ascending chronological order.

  • data.empty_buckets string

    The number of buckets which did not contain any data. If your data contains many empty buckets, consider increasing your bucket_span or using functions that are tolerant to gaps in data such as mean, non_null_sum or non_zero_count.

  • data.sparse_buckets string

    The number of buckets that contained few data points compared to the expected number of data points. If your data contains many sparse buckets, consider using a longer bucket_span.

  • data.buckets string

    The total number of buckets processed.

  • data.earliest_record string

    The timestamp of the earliest chronologically input document.

  • data.latest_record string

    The timestamp of the latest chronologically input document.

  • data.last string

    The timestamp at which data was last analyzed, according to server time.

  • data.last_empty_bucket string

    The timestamp of the last bucket that did not contain any data.

  • data.last_sparse_bucket string

    The timestamp of the last bucket that was considered sparse.

  • model.bytes number | string

    One of:

    ByteSize number ByteSize string
  • model.memory_status string

    Values are ok, soft_limit, or hard_limit.

  • model.bytes_exceeded number | string

    One of:

    ByteSize number ByteSize string
  • model.memory_limit string

    The upper limit for model memory usage, checked on increasing values.

  • model.by_fields string

    The number of by field values that were analyzed by the models. This value is cumulative for all detectors in the job.

  • model.over_fields string

    The number of over field values that were analyzed by the models. This value is cumulative for all detectors in the job.

  • model.partition_fields string

    The number of partition field values that were analyzed by the models. This value is cumulative for all detectors in the job.

  • model.bucket_allocation_failures string

    The number of buckets for which new entities in incoming data were not processed due to insufficient model memory. This situation is also signified by a hard_limit: memory_status property value.

  • model.categorization_status string

    Values are ok or warn.

  • model.categorized_doc_count string

    The number of documents that have had a field categorized.

  • model.total_category_count string

    The number of categories created by categorization.

  • model.frequent_category_count string

    The number of categories that match more than 1% of categorized documents.

  • model.rare_category_count string

    The number of categories that match just one categorized document.

  • model.dead_category_count string

    The number of categories created by categorization that will never be assigned again because another category’s definition makes it a superset of the dead category. Dead categories are a side effect of the way categorization has no prior training.

  • model.failed_category_count string

    The number of times that categorization wanted to create a new category but couldn’t because the job had hit its model_memory_limit. This count does not track which specific categories failed to be created. Therefore you cannot use this value to determine the number of unique categories that were missed.

  • model.log_time string

    The timestamp when the model stats were gathered, according to server time.

  • model.timestamp string

    The timestamp of the last record when the model stats were gathered.

  • forecasts.total string

    The number of individual forecasts currently available for the job. A value of one or more indicates that forecasts exist.

  • forecasts.memory.min string

    The minimum memory usage in bytes for forecasts related to the anomaly detection job.

  • forecasts.memory.max string

    The maximum memory usage in bytes for forecasts related to the anomaly detection job.

  • forecasts.memory.avg string

    The average memory usage in bytes for forecasts related to the anomaly detection job.

  • forecasts.memory.total string

    The total memory usage in bytes for forecasts related to the anomaly detection job.

  • forecasts.records.min string

    The minimum number of model_forecast documents written for forecasts related to the anomaly detection job.

  • forecasts.records.max string

    The maximum number of model_forecast documents written for forecasts related to the anomaly detection job.

  • forecasts.records.avg string

    The average number of model_forecast documents written for forecasts related to the anomaly detection job.

  • forecasts.records.total string

    The total number of model_forecast documents written for forecasts related to the anomaly detection job.

  • forecasts.time.min string

    The minimum runtime in milliseconds for forecasts related to the anomaly detection job.

  • forecasts.time.max string

    The maximum runtime in milliseconds for forecasts related to the anomaly detection job.

  • forecasts.time.avg string

    The average runtime in milliseconds for forecasts related to the anomaly detection job.

  • forecasts.time.total string

    The total runtime in milliseconds for forecasts related to the anomaly detection job.

  • node.id string
  • node.name string

    The name of the assigned node.

  • node.ephemeral_id string
  • node.address string

    The network address of the assigned node.

  • buckets.count string

    The number of bucket results produced by the job.

  • buckets.time.total string

    The sum of all bucket processing times, in milliseconds.

  • buckets.time.min string

    The minimum of all bucket processing times, in milliseconds.

  • buckets.time.max string

    The maximum of all bucket processing times, in milliseconds.

  • buckets.time.exp_avg string

    The exponential moving average of all bucket processing times, in milliseconds.

  • buckets.time.exp_avg_hour string

    The exponential moving average of bucket processing times calculated in a one hour time window, in milliseconds.

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.

• local boolean

  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 string

  Period to wait for a connection to the master node.

Responses

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

  • node string

    The node name.

  • id string

    The unique node identifier.

  • pid string

    The process identifier.

  • host string

    The host name.

  • ip string

    The IP address.

  • port string

    The bound transport port.

  • attr string

    The attribute name.

  • value string

    The attribute value.

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]

  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.

• master_timeout string

  Period to wait for a connection to the master node.

• time string

  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

• 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.

• include_bootstrap boolean

  Include bootstrap plugins in the response

• local boolean

  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 string

  Period to wait for a connection to the master node.

Responses

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

  • id string
  • name string
  • component string

    The component name.

  • version string
  • description string

    The plugin details.

  • type string

    The plugin type.

Query parameters

• active_only boolean

  If true, the response only includes ongoing shard recoveries.

• bytes string

  The unit used to display byte values.

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

• detailed boolean

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

• index string | array[string]

  Comma-separated list or wildcard expression of index names to limit the 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.

• time string

  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

  • index string
  • shard string

    The shard name.

  • start_time string | number

    A date and time, either as a string whose format can depend on the context (defaulting to ISO 8601), or a number of milliseconds since the Epoch. Elasticsearch accepts both as input, but will generally output a string representation.

    One of:

    DateTime string UnitMillis number

    Time unit for milliseconds

  • start_time_millis number

    Time unit for milliseconds

  • stop_time string | number

    A date and time, either as a string whose format can depend on the context (defaulting to ISO 8601), or a number of milliseconds since the Epoch. Elasticsearch accepts both as input, but will generally output a string representation.

    One of:

    DateTime string UnitMillis number

    Time unit for milliseconds

  • stop_time_millis number

    Time unit for milliseconds

  • 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.

  • type string

    The recovery type.

  • stage string

    The recovery stage.

  • source_host string

    The source host.

  • source_node string

    The source node name.

  • target_host string

    The target host.

  • target_node string

    The target node name.

  • repository string

    The repository name.

  • snapshot string

    The snapshot name.

  • files string

    The number of files to recover.

  • files_recovered string

    The files recovered.

  • files_percent string | number

    One of:

    Percentage string Percentage number
  • files_total string

    The total number of files.

  • bytes string

    The number of bytes to recover.

  • bytes_recovered string

    The bytes recovered.

  • bytes_percent string | number

    One of:

    Percentage string Percentage number
  • bytes_total string

    The total number of bytes.

  • translog_ops string

    The number of translog operations to recover.

  • translog_ops_recovered string

    The translog operations recovered.

  • translog_ops_percent string | number

    One of:

    Percentage string Percentage number

Query parameters

• bytes string

  The unit used to display byte values.

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

• 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.

• local boolean

  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 string

  Period to wait for a connection to the master node.

Responses

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

  • index string
  • shard string

    The shard name.

  • prirep string

    The shard type: primary or replica.

  • ip string

    The IP address of the node where it lives.

  • id string
  • segment string

    The segment name, which is derived from the segment generation and used internally to create file names in the directory of the shard.

  • generation string

    The segment generation number. Elasticsearch increments this generation number for each segment written then uses this number to derive the segment name.

  • docs.count string

    The number of documents in the segment. This excludes deleted documents and counts any nested documents separately from their parents. It also excludes documents which were indexed recently and do not yet belong to a segment.

  • docs.deleted string

    The number of deleted documents in the segment, which might be higher or lower than the number of delete operations you have performed. This number excludes deletes that were performed recently and do not yet belong to a segment. Deleted documents are cleaned up by the automatic merge process if it makes sense to do so. Also, Elasticsearch creates extra deleted documents to internally track the recent history of operations on a shard.

  • size number | string

    One of:

    ByteSize number ByteSize string

  • size.memory number | string

    One of:

    ByteSize number ByteSize string
  • committed string

    If true, the segment is synced to disk. Segments that are synced can survive a hard reboot. If false, the data from uncommitted segments is also stored in the transaction log so that Elasticsearch is able to replay changes on the next start.

  • searchable string

    If true, the segment is searchable. If false, the segment has most likely been written to disk but needs a refresh to be searchable.

  • version string
  • compound string

    If true, the segment is stored in a compound file. This means Lucene merged all files from the segment in a single file to save file descriptors.

Query parameters

• bytes string

  The unit used to display byte values.

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

• 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.

• master_timeout string

  Period to wait for a connection to the master node.

• time string

  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

  • index string

    The index name.

  • shard string

    The shard name.

  • prirep string

    The shard type: primary or replica.

  • state string

    The shard state. Returned values include: INITIALIZING: The shard is recovering from a peer shard or gateway. RELOCATING: The shard is relocating. STARTED: The shard has started. UNASSIGNED: The shard is not assigned to any node.

  • docs string | null

    The number of documents in the shard.

    One of:

    string-1 string string-2 string | null

  • store string | null

    The disk space used by the shard.

    One of:

    string-1 string string-2 string | null

  • dataset string | null

    total size of dataset (including the cache for partially mounted indices)

    One of:

    string-1 string string-2 string | null

  • ip string | null

    The IP address of the node.

    One of:

    string-1 string string-2 string | null
  • id string

    The unique identifier for the node.

  • node string | null

    The name of node.

    One of:

    string-1 string string-2 string | null
  • sync_id string

    The sync identifier.

  • unassigned.reason string

    The reason for the last change to the state of an unassigned shard. It does not explain why the shard is currently unassigned; use the cluster allocation explain API for that information. Returned values include: ALLOCATION_FAILED: Unassigned as a result of a failed allocation of the shard. CLUSTER_RECOVERED: Unassigned as a result of a full cluster recovery. DANGLING_INDEX_IMPORTED: Unassigned as a result of importing a dangling index. EXISTING_INDEX_RESTORED: Unassigned as a result of restoring into a closed index. FORCED_EMPTY_PRIMARY: The shard’s allocation was last modified by forcing an empty primary using the cluster reroute API. INDEX_CLOSED: Unassigned because the index was closed. INDEX_CREATED: Unassigned as a result of an API creation of an index. INDEX_REOPENED: Unassigned as a result of opening a closed index. MANUAL_ALLOCATION: The shard’s allocation was last modified by the cluster reroute API. NEW_INDEX_RESTORED: Unassigned as a result of restoring into a new index. NODE_LEFT: Unassigned as a result of the node hosting it leaving the cluster. NODE_RESTARTING: Similar to NODE_LEFT, except that the node was registered as restarting using the node shutdown API. PRIMARY_FAILED: The shard was initializing as a replica, but the primary shard failed before the initialization completed. REALLOCATED_REPLICA: A better replica location is identified and causes the existing replica allocation to be cancelled. REINITIALIZED: When a shard moves from started back to initializing. REPLICA_ADDED: Unassigned as a result of explicit addition of a replica. REROUTE_CANCELLED: Unassigned as a result of explicit cancel reroute command.

  • unassigned.at string

    The time at which the shard became unassigned in Coordinated Universal Time (UTC).

  • unassigned.for string

    The time at which the shard was requested to be unassigned in Coordinated Universal Time (UTC).

  • unassigned.details string

    Additional details as to why the shard became unassigned. It does not explain why the shard is not assigned; use the cluster allocation explain API for that information.

  • recoverysource.type string

    The type of recovery source.

  • completion.size string

    The size of completion.

  • fielddata.memory_size string

    The used fielddata cache memory.

  • fielddata.evictions string

    The fielddata cache evictions.

  • query_cache.memory_size string

    The used query cache memory.

  • query_cache.evictions string

    The query cache evictions.

  • flush.total string

    The number of flushes.

  • flush.total_time string

    The time spent in flush.

  • get.current string

    The number of current get operations.

  • get.time string

    The time spent in get operations.

  • get.total string

    The number of get operations.

  • get.exists_time string

    The time spent in successful get operations.

  • get.exists_total string

    The number of successful get operations.

  • get.missing_time string

    The time spent in failed get operations.

  • get.missing_total string

    The number of failed get operations.

  • indexing.delete_current string

    The number of current deletion operations.

  • indexing.delete_time string

    The time spent in deletion operations.

  • 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 operations.

  • 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 merge operations.

  • merges.current_docs string

    The number of current merging documents.

  • merges.current_size string

    The size of current merge operations.

  • merges.total string

    The number of completed merge operations.

  • merges.total_docs string

    The nuber of merged documents.

  • merges.total_size string

    The size of current merges.

  • merges.total_time string

    The time spent merging documents.

  • refresh.total string

    The total number of refreshes.

  • refresh.time string

    The time spent in refreshes.

  • refresh.external_total string

    The total nunber of external refreshes.

  • refresh.external_time string

    The time spent in external refreshes.

  • refresh.listeners string

    The number of pending refresh listeners.

  • 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 number of fetch operations.

  • search.open_contexts string

    The number of 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 number of query phase operations.

  • search.scroll_current string

    The open scroll contexts.

  • search.scroll_time string

    The time scroll contexts were held open.

  • search.scroll_total string

    The number of 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.

  • seq_no.max string

    The maximum sequence number.

  • seq_no.local_checkpoint string

    The local checkpoint.

  • seq_no.global_checkpoint string

    The global checkpoint.

  • warmer.current string

    The number of current warmer operations.

  • warmer.total string

    The total number of warmer operations.

  • warmer.total_time string

    The time spent in warmer operations.

  • path.data string

    The shard data path.

  • path.state string

    The shard state path.

  • bulk.total_operations string

    The number of bulk shard operations.

  • bulk.total_time string

    The time spent in shard bulk operations.

  • bulk.total_size_in_bytes string

    The total size in bytes of shard bulk operations.

  • bulk.avg_time string

    The average time spent in shard bulk operations.

  • bulk.avg_size_in_bytes string

    The average size in bytes of shard bulk operations.

Path parameters

• repository string | array[string] Required

  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.

Query parameters

• ignore_unavailable boolean

  If true, the response does not include information from unavailable snapshots.

• 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.

• master_timeout string

  Period to wait for a connection to the master node.

• time string

  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 unique identifier for the snapshot.

  • repository string

    The repository name.

  • status string

    The state of the snapshot process. Returned values include: FAILED: The snapshot process failed. INCOMPATIBLE: The snapshot process is incompatible with the current cluster version. IN_PROGRESS: The snapshot process started but has not completed. PARTIAL: The snapshot process completed with a partial success. SUCCESS: The snapshot process completed with a full success.

  • start_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

  • start_time string | object

    A time of day, expressed either as hh:mm, noon, midnight, or an hour/minutes structure.

    One of:

    ScheduleTimeOfDay string HourAndMinute object

    Hide attributes Show attributes

    • hour array[number] Required
    • minute array[number] Required

  • end_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
  • end_time string

    Time of day, expressed as HH:MM:SS

  • duration 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.

  • indices string

    The number of indices in the snapshot.

  • successful_shards string

    The number of successful shards in the snapshot.

  • failed_shards string

    The number of failed shards in the snapshot.

  • total_shards string

    The total number of shards in the snapshot.

  • reason string

    The reason for any snapshot failures.

Path parameters

• name string Required

  The name of the template to return. Accepts wildcard expressions. If omitted, all templates are returned.

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.

• local boolean

  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 string

  Period to wait for a connection to the master node.

Responses

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

  • name string
  • index_patterns string

    The template index patterns.

  • order string

    The template application order or priority number.

  • version string | null

    The template version.

    One of:

    VersionString string string-2 string | null
  • composed_of string

    The component templates that comprise the index template.

Query parameters

• flat_settings boolean

  Return settings in flat format (default: false)

• master_timeout string

  Explicit operation timeout for connection to master node

• timeout string

  Explicit operation timeout

Responses

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

  • acknowledged boolean Required
  • persistent object Required
    Hide persistent attribute Show persistent attribute object

    • * object Additional properties
  • transient object Required
    Hide transient attribute Show transient attribute object

    • * object Additional properties

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.

• 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.

• timeout string

  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 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.

• 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.

  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

• local boolean

  If true, the request retrieves information from the local node only. If false, 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.

Responses

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

  • tasks array[object] Required
    Hide tasks attributes Show tasks attributes object

    • executing boolean Required

      Indicates whether the pending tasks are currently executing or not.

    • insert_order number Required

      The number that represents when the task has been inserted into the task queue.

    • priority string Required

      The priority of the pending task. The valid priorities in descending priority order are: IMMEDIATE > URGENT > HIGH > NORMAL > LOW > LANGUID.

    • source string Required

      A general description of the cluster task that may include a reason and origin.

    • time_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.

    • time_in_queue_millis number

      Time unit for milliseconds

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.

• timeout string

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