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

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

Query parameters

• include_disk_info boolean

  If true, returns information about disk usage and shard sizes.

• include_yes_decisions boolean

  If true, returns YES decisions in explanation.

• master_timeout string

  Period to wait for a connection to the master node.

Responses

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

  • allocate_explanation string
  • allocation_delay 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.

  • allocation_delay_in_millis number

    Time unit for milliseconds

  • can_allocate string

    Values are yes, no, worse_balance, throttled, awaiting_info, allocation_delayed, no_valid_shard_copy, or no_attempt.

  • can_move_to_other_node string

    Values are yes, no, worse_balance, throttled, awaiting_info, allocation_delayed, no_valid_shard_copy, or no_attempt.

  • can_rebalance_cluster string

    Values are yes, no, worse_balance, throttled, awaiting_info, allocation_delayed, no_valid_shard_copy, or no_attempt.

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

    • decider string Required
    • decision string Required

      Values are NO, YES, THROTTLE, or ALWAYS.

    • explanation string Required
  • can_rebalance_to_other_node string

    Values are yes, no, worse_balance, throttled, awaiting_info, allocation_delayed, no_valid_shard_copy, or no_attempt.

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

    • decider string Required
    • decision string Required

      Values are NO, YES, THROTTLE, or ALWAYS.

    • explanation string Required
  • can_remain_on_current_node string

    Values are yes, no, worse_balance, throttled, awaiting_info, allocation_delayed, no_valid_shard_copy, or no_attempt.

  • cluster_info object
    Hide cluster_info attributes Show cluster_info attributes object

    • nodes object Required
      Hide nodes attribute Show nodes attribute object

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

        • node_name string Required
        • least_available object Required
          Hide least_available attributes Show least_available attributes object

          • path string Required
          • total_bytes number Required
          • used_bytes number Required
          • free_bytes number Required
          • free_disk_percent number Required
          • used_disk_percent number Required
        • most_available object Required
          Hide most_available attributes Show most_available attributes object

          • path string Required
          • total_bytes number Required
          • used_bytes number Required
          • free_bytes number Required
          • free_disk_percent number Required
          • used_disk_percent number Required
    • shard_sizes object Required
      Hide shard_sizes attribute Show shard_sizes attribute object

      • * number Additional properties
    • shard_data_set_sizes object
      Hide shard_data_set_sizes attribute Show shard_data_set_sizes attribute object

      • * string Additional properties
    • shard_paths object Required
      Hide shard_paths attribute Show shard_paths attribute object

      • * string Additional properties
    • reserved_sizes array[object] Required
      Hide reserved_sizes attributes Show reserved_sizes attributes object

      • node_id string Required
      • path string Required
      • total number Required
      • shards array[string] Required
  • configured_delay 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.

  • configured_delay_in_millis number

    Time unit for milliseconds

  • current_node object
    Hide current_node attributes Show current_node attributes object

    • id string Required
    • name string Required
    • roles array[string] Required
      • @doc_id node-roles

      Values are master, data, data_cold, data_content, data_frozen, data_hot, data_warm, client, ingest, ml, voting_only, transform, remote_cluster_client, or coordinating_only.

    • attributes object Required
      Hide attributes attribute Show attributes attribute object

      • * string Additional properties
    • transport_address string Required
    • weight_ranking number Required
  • current_state string Required
  • index string Required
  • move_explanation string
  • node_allocation_decisions array[object]
    Hide node_allocation_decisions attributes Show node_allocation_decisions attributes object

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

      • decider string Required
      • decision string Required

        Values are NO, YES, THROTTLE, or ALWAYS.

      • explanation string Required
    • node_attributes object Required
      Hide node_attributes attribute Show node_attributes attribute object

      • * string Additional properties
    • node_decision string Required

      Values are yes, no, worse_balance, throttled, awaiting_info, allocation_delayed, no_valid_shard_copy, or no_attempt.

    • node_id string Required
    • node_name string Required
    • roles array[string] Required
      • @doc_id node-roles

      Values are master, data, data_cold, data_content, data_frozen, data_hot, data_warm, client, ingest, ml, voting_only, transform, remote_cluster_client, or coordinating_only.

    • store object
      Hide store attributes Show store attributes object

      • allocation_id string Required
      • found boolean Required
      • in_sync boolean Required
      • matching_size_in_bytes number Required
      • matching_sync_id boolean Required
      • store_exception string Required
    • transport_address string Required
    • weight_ranking number Required
  • primary boolean Required
  • rebalance_explanation string
  • remaining_delay 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.

  • remaining_delay_in_millis number

    Time unit for milliseconds

  • shard number Required
  • unassigned_info object
    Hide unassigned_info attributes Show unassigned_info attributes object

    • at string | number Required

      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

    • last_allocation_status string
    • reason string Required

      Values are INDEX_CREATED, CLUSTER_RECOVERED, INDEX_REOPENED, DANGLING_INDEX_IMPORTED, NEW_INDEX_RESTORED, EXISTING_INDEX_RESTORED, REPLICA_ADDED, ALLOCATION_FAILED, NODE_LEFT, REROUTE_CANCELLED, REINITIALIZED, REALLOCATED_REPLICA, PRIMARY_FAILED, FORCED_EMPTY_PRIMARY, or MANUAL_ALLOCATION.

    • details string
    • failed_allocation_attempts number
    • delayed boolean
    • allocation_status string
  • note string

Path parameters

• target string | array[string] Required

  Limits the information returned to the specific target. Supports a comma-separated list, such as http,ingest.

  Supported values include: _all, http, ingest, thread_pool, script

Responses

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

  • cluster_name string Required
  • http object
    Hide http attributes Show http attributes object

    • current_open number

      Current number of open HTTP connections for the node.

    • total_opened number

      Total number of HTTP connections opened for the node.

    • clients array[object]

      Information on current and recently-closed HTTP client connections. Clients that have been closed longer than the http.client_stats.closed_channels.max_age setting will not be represented here.

      Hide clients attributes Show clients attributes object

      • id number

        Unique ID for the HTTP client.

      • agent string

        Reported agent for the HTTP client. If unavailable, this property is not included in the response.

      • local_address string

        Local address for the HTTP connection.

      • remote_address string

        Remote address for the HTTP connection.

      • last_uri string

        The URI of the client’s most recent request.

      • opened_time_millis number

        Time at which the client opened the connection.

      • closed_time_millis number

        Time at which the client closed the connection if the connection is closed.

      • last_request_time_millis number

        Time of the most recent request from this client.

      • request_count number

        Number of requests from this client.

      • request_size_bytes number

        Cumulative size in bytes of all requests from this client.

      • x_opaque_id string

        Value from the client’s x-opaque-id HTTP header. If unavailable, this property is not included in the response.

    • routes object Required Added in 8.12.0

      Detailed HTTP stats broken down by route

      Hide routes attribute Show routes attribute object

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

        • requests object Required
          Hide requests attributes Show requests attributes object

          • count number Required
          • total_size_in_bytes number Required
          • size_histogram array[object] Required
        • responses object Required
          Hide responses attributes Show responses attributes object

          • count number Required
          • total_size_in_bytes number Required
          • handling_time_histogram array[object] Required
          • size_histogram array[object] Required
  • ingest object
    Hide ingest attributes Show ingest attributes object

    • pipelines object

      Contains statistics about ingest pipelines for the node.

      Hide pipelines attribute Show pipelines attribute object

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

        • count number Required

          Total number of documents ingested during the lifetime of this node.

        • current number Required

          Total number of documents currently being ingested.

        • failed number Required

          Total number of failed ingest operations during the lifetime of this node.

        • processors array[object] Required

          Total number of ingest processors.

          Hide processors attribute Show processors attribute object

          • * object Additional properties
        • time_in_millis number

          Time unit for milliseconds

        • ingested_as_first_pipeline_in_bytes number Required Added in 8.15.0

          Total number of bytes of all documents ingested by the pipeline. This field is only present on pipelines which are the first to process a document. Thus, it is not present on pipelines which only serve as a final pipeline after a default pipeline, a pipeline run after a reroute processor, or pipelines in pipeline processors.

        • produced_as_first_pipeline_in_bytes number Required Added in 8.15.0

          Total number of bytes of all documents produced by the pipeline. This field is only present on pipelines which are the first to process a document. Thus, it is not present on pipelines which only serve as a final pipeline after a default pipeline, a pipeline run after a reroute processor, or pipelines in pipeline processors. In situations where there are subsequent pipelines, the value represents the size of the document after all pipelines have run.

    • total object
      Hide total attributes Show total attributes object

      • count number Required

        Total number of documents ingested during the lifetime of this node.

      • current number Required

        Total number of documents currently being ingested.

      • failed number Required

        Total number of failed ingest operations during the lifetime of this node.

      • time_in_millis number

        Time unit for milliseconds

  • thread_pool object
    Hide thread_pool attribute Show thread_pool attribute object

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

      • active number

        Number of active threads in the thread pool.

      • completed number

        Number of tasks completed by the thread pool executor.

      • largest number

        Highest number of active threads in the thread pool.

      • queue number

        Number of tasks in queue for the thread pool.

      • rejected number

        Number of tasks rejected by the thread pool executor.

      • threads number

        Number of threads in the thread pool.

  • script object
    Hide script attributes Show script attributes object

    • cache_evictions number

      Total number of times the script cache has evicted old data.

    • compilations number

      Total number of inline script compilations performed by the node.

    • compilations_history object

      Contains this recent history of script compilations.

      Hide compilations_history attribute Show compilations_history attribute object

      • * number Additional properties
    • compilation_limit_triggered number

      Total number of times the script compilation circuit breaker has limited inline script compilations.

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

      • context string
      • compilations number
      • cache_evictions number
      • compilation_limit_triggered number

Path parameters

• metric string | array[string] Required

  Limit the information returned to the specified metrics

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

• 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

Responses

• 200 application/json