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 attributes Show response attributes object

  • aggregate_metric object Required

    Additional properties are allowed.

    Hide aggregate_metric attributes Show aggregate_metric attributes object

    • available boolean Required
    • enabled boolean Required
  • analytics object

    Additional properties are allowed.

    Hide analytics attributes Show analytics attributes object

    • available boolean Required
    • enabled boolean Required
    • stats object Required

      Additional properties are allowed.

      Hide stats attributes Show stats attributes object

      • boxplot_usage number Required
      • cumulative_cardinality_usage number Required
      • string_stats_usage number Required
      • top_metrics_usage number Required
      • t_test_usage number Required
      • moving_percentiles_usage number Required
      • normalize_usage number Required
      • rate_usage number Required
      • multi_terms_usage number
  • archive object

    Additional properties are allowed.

    Hide archive attributes Show archive attributes object

    • available boolean Required
    • enabled boolean Required
    • indices_count number Required
  • watcher object

    Additional properties are allowed.

    Hide watcher attributes Show watcher attributes object

    • available boolean Required
    • enabled boolean Required
    • execution object Required

      Additional properties are allowed.

      Hide execution attribute Show execution attribute object

      • actions object Required
        Hide actions attribute Show actions attribute object

        • * object Additional properties

          Additional properties are allowed.

          Hide * attributes Show * attributes object

          • total string Required

            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.

          • total_time_in_ms
    • watch object Required

      Additional properties are allowed.

      Hide watch attributes Show watch attributes object

      • input object Required
        Hide input attribute Show input attribute object

        • * object Additional properties

          Additional properties are allowed.

          Hide * attributes Show * attributes object

          • active number Required
          • total number Required
      • condition object
        Hide condition attribute Show condition attribute object

        • * object Additional properties

          Additional properties are allowed.

          Hide * attributes Show * attributes object

          • active number Required
          • total number Required
      • action object
        Hide action attribute Show action attribute object

        • * object Additional properties

          Additional properties are allowed.

          Hide * attributes Show * attributes object

          • active number Required
          • total number Required
      • trigger object Required

        Additional properties are allowed.

        Hide trigger attributes Show trigger attributes object

        • schedule object

          Additional properties are allowed.

        • _all object Required Additional properties

          Additional properties are allowed.

          Hide _all attributes Show _all attributes object

          • active number Required
          • total number Required
    • count object Required Additional properties

      Additional properties are allowed.

      Hide count attributes Show count attributes object

      • active number Required
      • total number Required
  • ccr object

    Additional properties are allowed.

    Hide ccr attributes Show ccr attributes object

    • available boolean Required
    • enabled boolean Required
    • auto_follow_patterns_count number Required
    • follower_indices_count number Required
  • data_frame object

    Additional properties are allowed.

    Hide data_frame attributes Show data_frame attributes object

    • available boolean Required
    • enabled boolean Required
  • data_science object

    Additional properties are allowed.

    Hide data_science attributes Show data_science attributes object

    • available boolean Required
    • enabled boolean Required
  • data_streams object

    Additional properties are allowed.

    Hide data_streams attributes Show data_streams attributes object

    • available boolean Required
    • enabled boolean Required
    • data_streams number Required
    • indices_count number Required
  • data_tiers object

    Additional properties are allowed.

    Hide data_tiers attributes Show data_tiers attributes object

    • available boolean Required
    • enabled boolean Required
    • data_warm object Required

      Additional properties are allowed.

      Hide data_warm attributes Show data_warm attributes object

      • node_count number Required
      • index_count number Required
      • total_shard_count number Required
      • primary_shard_count number Required
      • doc_count number Required
      • total_size_bytes number Required
      • primary_size_bytes number Required
      • primary_shard_size_avg_bytes number Required
      • primary_shard_size_median_bytes number Required
      • primary_shard_size_mad_bytes number Required
    • data_frozen object

      Additional properties are allowed.

      Hide data_frozen attributes Show data_frozen attributes object

      • node_count number Required
      • index_count number Required
      • total_shard_count number Required
      • primary_shard_count number Required
      • doc_count number Required
      • total_size_bytes number Required
      • primary_size_bytes number Required
      • primary_shard_size_avg_bytes number Required
      • primary_shard_size_median_bytes number Required
      • primary_shard_size_mad_bytes number Required
    • data_cold object Required

      Additional properties are allowed.

      Hide data_cold attributes Show data_cold attributes object

      • node_count number Required
      • index_count number Required
      • total_shard_count number Required
      • primary_shard_count number Required
      • doc_count number Required
      • total_size_bytes number Required
      • primary_size_bytes number Required
      • primary_shard_size_avg_bytes number Required
      • primary_shard_size_median_bytes number Required
      • primary_shard_size_mad_bytes number Required
    • data_content object Required

      Additional properties are allowed.

      Hide data_content attributes Show data_content attributes object

      • node_count number Required
      • index_count number Required
      • total_shard_count number Required
      • primary_shard_count number Required
      • doc_count number Required
      • total_size_bytes number Required
      • primary_size_bytes number Required
      • primary_shard_size_avg_bytes number Required
      • primary_shard_size_median_bytes number Required
      • primary_shard_size_mad_bytes number Required
    • data_hot object Required

      Additional properties are allowed.

      Hide data_hot attributes Show data_hot attributes object

      • node_count number Required
      • index_count number Required
      • total_shard_count number Required
      • primary_shard_count number Required
      • doc_count number Required
      • total_size_bytes number Required
      • primary_size_bytes number Required
      • primary_shard_size_avg_bytes number Required
      • primary_shard_size_median_bytes number Required
      • primary_shard_size_mad_bytes number Required
  • enrich object

    Additional properties are allowed.

    Hide enrich attributes Show enrich attributes object

    • available boolean Required
    • enabled boolean Required
  • eql object

    Additional properties are allowed.

    Hide eql attributes Show eql attributes object

    • available boolean Required
    • enabled boolean Required
    • features object Required

      Additional properties are allowed.

      Hide features attributes Show features attributes object

      • join number Required
      • joins object Required

        Additional properties are allowed.

        Hide joins attributes Show joins attributes object

        • join_queries_two number Required
        • join_queries_three number Required
        • join_until number Required
        • join_queries_five_or_more number Required
        • join_queries_four number Required
      • keys object Required

        Additional properties are allowed.

        Hide keys attributes Show keys attributes object

        • join_keys_two number Required
        • join_keys_one number Required
        • join_keys_three number Required
        • join_keys_five_or_more number Required
        • join_keys_four number Required
      • event number Required
      • pipes object Required

        Additional properties are allowed.

        Hide pipes attributes Show pipes attributes object

        • pipe_tail number Required
        • pipe_head number Required
      • sequence number Required
      • sequences object Required

        Additional properties are allowed.

        Hide sequences attributes Show sequences attributes object

        • sequence_queries_three number Required
        • sequence_queries_four number Required
        • sequence_queries_two number Required
        • sequence_until number Required
        • sequence_queries_five_or_more number Required
        • sequence_maxspan number Required
    • queries object Required
      Hide queries attribute Show queries attribute object

      • * object Additional properties

        Additional properties are allowed.

        Hide * attributes Show * attributes object

        • count number
        • failed number
        • paging number
        • total number
  • flattened object

    Additional properties are allowed.

    Hide flattened attributes Show flattened attributes object

    • available boolean Required
    • enabled boolean Required
    • field_count number Required
  • frozen_indices object

    Additional properties are allowed.

    Hide frozen_indices attributes Show frozen_indices attributes object

    • available boolean Required
    • enabled boolean Required
    • indices_count number Required
  • graph object Required

    Additional properties are allowed.

    Hide graph attributes Show graph attributes object

    • available boolean Required
    • enabled boolean Required
  • health_api object

    Additional properties are allowed.

    Hide health_api attributes Show health_api attributes object

    • available boolean Required
    • enabled boolean Required
    • invocations object Required

      Additional properties are allowed.

      Hide invocations attribute Show invocations attribute object

      • total number Required
  • ilm object Required

    Additional properties are allowed.

    Hide ilm attributes Show ilm attributes object

    • policy_count number Required
    • policy_stats array[object] Required
      Hide policy_stats attributes Show policy_stats attributes object

      • indices_managed number Required
      • phases object Required

        Additional properties are allowed.

        Hide phases attributes Show phases attributes object

        • cold object

          Additional properties are allowed.

          Hide cold attributes Show cold attributes object

          • actions object

            Additional properties are allowed.

          • min_age
        • delete object

          Additional properties are allowed.

          Hide delete attributes Show delete attributes object

          • actions object

            Additional properties are allowed.

          • min_age
        • frozen object

          Additional properties are allowed.

          Hide frozen attributes Show frozen attributes object

          • actions object

            Additional properties are allowed.

          • min_age
        • hot object

          Additional properties are allowed.

          Hide hot attributes Show hot attributes object

          • actions object

            Additional properties are allowed.

          • min_age
        • warm object

          Additional properties are allowed.

          Hide warm attributes Show warm attributes object

          • actions object

            Additional properties are allowed.

          • min_age
  • logstash object Required

    Additional properties are allowed.

    Hide logstash attributes Show logstash attributes object

    • available boolean Required
    • enabled boolean Required
  • ml object

    Additional properties are allowed.

    Hide ml attributes Show ml attributes object

    • available boolean Required
    • enabled boolean Required
    • datafeeds object Required
      Hide datafeeds attribute Show datafeeds attribute object

      • * object Additional properties

        Additional properties are allowed.

        Hide * attribute Show * attribute object

        • count number Required
    • jobs object Required

      Job usage statistics. The _all entry is always present and gathers statistics for all jobs.

      Hide jobs attribute Show jobs attribute object

      • * object Additional properties

        Additional properties are allowed.

        Hide * attributes Show * attributes object

        • count number Required
        • created_by object Required
          Hide created_by attribute Show created_by attribute object

          • * number Additional properties
        • detectors object Required

          Additional properties are allowed.

          Hide detectors attributes Show detectors attributes object

          • avg number Required
          • max number Required
          • min number Required
          • total number Required
        • forecasts object Required

          Additional properties are allowed.

          Hide forecasts attributes Show forecasts attributes object

          • total number Required
          • forecasted_jobs number Required
        • model_size object Required

          Additional properties are allowed.

          Hide model_size attributes Show model_size attributes object

          • avg number Required
          • max number Required
          • min number Required
          • total number Required
    • node_count number Required
    • data_frame_analytics_jobs object Required

      Additional properties are allowed.

      Hide data_frame_analytics_jobs attributes Show data_frame_analytics_jobs attributes object

      • memory_usage object

        Additional properties are allowed.

        Hide memory_usage attribute Show memory_usage attribute object

        • peak_usage_bytes object Required

          Additional properties are allowed.

          Hide peak_usage_bytes attributes Show peak_usage_bytes attributes object

          • avg number Required
          • max number Required
          • min number Required
          • total number Required
      • _all object Required

        Additional properties are allowed.

        Hide _all attribute Show _all attribute object

        • count number Required
      • analysis_counts object

        Additional properties are allowed.

        Hide analysis_counts attributes Show analysis_counts attributes object

        • classification number
        • outlier_detection number
        • regression number
      • stopped object

        Additional properties are allowed.

        Hide stopped attribute Show stopped attribute object

        • count number Required
    • inference object Required

      Additional properties are allowed.

      Hide inference attributes Show inference attributes object

      • ingest_processors object Required
        Hide ingest_processors attribute Show ingest_processors attribute object

        • * object Additional properties

          Additional properties are allowed.

          Hide * attributes Show * attributes object

          • num_docs_processed object Required

            Additional properties are allowed.

          • pipelines object Required

            Additional properties are allowed.

          • num_failures object Required

            Additional properties are allowed.

          • time_ms object Required

            Additional properties are allowed.

      • trained_models object Required

        Additional properties are allowed.

        Hide trained_models attributes Show trained_models attributes object

        • estimated_operations object

          Additional properties are allowed.

          Hide estimated_operations attributes Show estimated_operations attributes object

          • avg number Required
          • max number Required
          • min number Required
          • total number Required
        • estimated_heap_memory_usage_bytes object

          Additional properties are allowed.

          Hide estimated_heap_memory_usage_bytes attributes Show estimated_heap_memory_usage_bytes attributes object

          • avg number Required
          • max number Required
          • min number Required
          • total number Required
        • count object

          Additional properties are allowed.

          Hide count attributes Show count attributes object

          • total number Required
          • prepackaged number Required
          • other number Required
          • pass_through number
          • regression number
          • classification number
          • ner number
          • text_embedding number
        • _all object Required

          Additional properties are allowed.

          Hide _all attribute Show _all attribute object

          • count number Required
        • model_size_bytes object

          Additional properties are allowed.

          Hide model_size_bytes attributes Show model_size_bytes attributes object

          • avg number Required
          • max number Required
          • min number Required
          • total number Required
      • deployments object

        Additional properties are allowed.

        Hide deployments attributes Show deployments attributes object

        • count number Required
        • inference_counts object Required

          Additional properties are allowed.

          Hide inference_counts attributes Show inference_counts attributes object

          • avg number Required
          • max number Required
          • min number Required
          • total number Required
        • model_sizes_bytes object Required

          Additional properties are allowed.

          Hide model_sizes_bytes attributes Show model_sizes_bytes attributes object

          • avg number Required
          • max number Required
          • min number Required
          • total number Required
        • time_ms object Required

          Additional properties are allowed.

          Hide time_ms attribute Show time_ms attribute object

          • avg number Required
  • monitoring object

    Additional properties are allowed.

    Hide monitoring attributes Show monitoring attributes object

    • available boolean Required
    • enabled boolean Required
    • collection_enabled boolean Required
    • enabled_exporters object Required
      Hide enabled_exporters attribute Show enabled_exporters attribute object

      • * number Additional properties
  • rollup object Required

    Additional properties are allowed.

    Hide rollup attributes Show rollup attributes object

    • available boolean Required
    • enabled boolean Required
  • runtime_fields object

    Additional properties are allowed.

    Hide runtime_fields attributes Show runtime_fields attributes object

    • available boolean Required
    • enabled boolean Required
    • field_types array[object] Required
      Hide field_types attributes Show field_types attributes object

      • chars_max number Required
      • chars_total number Required
      • count number Required
      • doc_max number Required
      • doc_total number Required
      • index_count number Required
      • lang array[string] Required
      • lines_max number Required
      • lines_total number Required
      • name string Required

        Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.

      • scriptless_count number Required
      • shadowed_count number Required
      • source_max number Required
      • source_total number Required
  • spatial object Required

    Additional properties are allowed.

    Hide spatial attributes Show spatial attributes object

    • available boolean Required
    • enabled boolean Required
  • searchable_snapshots object

    Additional properties are allowed.

    Hide searchable_snapshots attributes Show searchable_snapshots attributes object

    • available boolean Required
    • enabled boolean Required
    • indices_count number Required
    • full_copy_indices_count number
    • shared_cache_indices_count number
  • security object

    Additional properties are allowed.

    Hide security attributes Show security attributes object

    • available boolean Required
    • enabled boolean Required
    • api_key_service object Required

      Additional properties are allowed.

      Hide api_key_service attribute Show api_key_service attribute object

      • enabled boolean Required
    • anonymous object Required

      Additional properties are allowed.

      Hide anonymous attribute Show anonymous attribute object

      • enabled boolean Required
    • audit object

      Additional properties are allowed.

      Hide audit attributes Show audit attributes object

      • enabled boolean Required
      • outputs array[string]
    • fips_140 object Required

      Additional properties are allowed.

      Hide fips_140 attribute Show fips_140 attribute object

      • enabled boolean Required
    • ipfilter object Required

      Additional properties are allowed.

      Hide ipfilter attributes Show ipfilter attributes object

      • http boolean Required
      • transport boolean Required
    • realms object Required
    • role_mapping object Required
      Hide role_mapping attribute Show role_mapping attribute object

      • * object Additional properties

        Additional properties are allowed.

        Hide * attributes Show * attributes object

        • enabled number Required
        • size number Required
    • roles object Required

      Additional properties are allowed.

      Hide roles attributes Show roles attributes object

      • native object Required

        Additional properties are allowed.

        Hide native attributes Show native attributes object

        • dls boolean Required
        • fls boolean Required
        • size number Required
      • dls object Required

        Additional properties are allowed.

        Hide dls attribute Show dls attribute object

        • bit_set_cache object Required

          Additional properties are allowed.

          Hide bit_set_cache attributes Show bit_set_cache attributes object

          • count number Required
          • memory
          • memory_in_bytes number Required
      • file object Required

        Additional properties are allowed.

        Hide file attributes Show file attributes object

        • dls boolean Required
        • fls boolean Required
        • size number Required
    • ssl object Required

      Additional properties are allowed.

      Hide ssl attributes Show ssl attributes object

      • http object Required

        Additional properties are allowed.

        Hide http attribute Show http attribute object

        • enabled boolean Required
      • transport object Required

        Additional properties are allowed.

        Hide transport attribute Show transport attribute object

        • enabled boolean Required
    • system_key object

      Additional properties are allowed.

      Hide system_key attribute Show system_key attribute object

      • enabled boolean Required
    • token_service object Required

      Additional properties are allowed.

      Hide token_service attribute Show token_service attribute object

      • enabled boolean Required
    • operator_privileges object Required

      Additional properties are allowed.

      Hide operator_privileges attributes Show operator_privileges attributes object

      • available boolean Required
      • enabled boolean Required
  • slm object

    Additional properties are allowed.

    Hide slm attributes Show slm attributes object

    • available boolean Required
    • enabled boolean Required
    • policy_count number
    • policy_stats object

      Additional properties are allowed.

      Hide policy_stats attributes Show policy_stats attributes object

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

      • retention_deletion_time_millis number

        Time unit for milliseconds

      • retention_failed number
      • retention_runs number
      • retention_timed_out number
      • policy string
      • total_snapshots_deleted number
      • total_snapshot_deletion_failures number
      • total_snapshots_failed number
      • total_snapshots_taken number
  • sql object

    Additional properties are allowed.

    Hide sql attributes Show sql attributes object

    • available boolean Required
    • enabled boolean Required
    • features object Required
      Hide features attribute Show features attribute object

      • * number Additional properties
    • queries object Required
      Hide queries attribute Show queries attribute object

      • * object Additional properties

        Additional properties are allowed.

        Hide * attributes Show * attributes object

        • count number
        • failed number
        • paging number
        • total number
  • transform object Required

    Additional properties are allowed.

    Hide transform attributes Show transform attributes object

    • available boolean Required
    • enabled boolean Required
  • vectors object

    Additional properties are allowed.

    Hide vectors attributes Show vectors attributes object

    • available boolean Required
    • enabled boolean Required
    • dense_vector_dims_avg_count number Required
    • dense_vector_fields_count number Required
    • sparse_vector_fields_count number
  • voting_only object Required

    Additional properties are allowed.

    Hide voting_only attributes Show voting_only attributes object

    • available boolean Required
    • enabled boolean Required