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

• name array[string] Required

  A list of analytics collections to limit the returned information

Responses

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

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

    • event_data_stream object Required
      Hide event_data_stream attribute Show event_data_stream attribute object

      • name string Required

Path parameters

• name string Required

  The name of the analytics collection to be deleted

Responses

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

  • acknowledged boolean Required

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

Path parameters

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

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

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

Responses

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

  • name string Required

  • version string | null Required

    One of:

    string-1 string string-2 string | null
  • alias_count string Required
  • mapping_count string Required
  • settings_count string Required
  • metadata_count string Required
  • included_in string Required

Query parameters

• time string

  The unit used to display time values.

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

• ts boolean

  If true, returns HH:MM:SS and Unix epoch timestamps.

• 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

  • cluster string

    cluster name

  • status string

    health status

  • node.total string

    total number of nodes

  • node.data string

    number of nodes that can store data

  • shards string

    total number of shards

  • pri string

    number of primary shards

  • relo string

    number of relocating nodes

  • init string

    number of initializing nodes

  • unassign.pri string

    number of unassigned primary shards

  • unassign string

    number of unassigned shards

  • pending_tasks string

    number of pending tasks

  • max_task_wait_time string

    wait time of longest task pending

  • active_shards_percent string

    active number of shards in percent

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

  • id string

    node id

  • host string

    host name

  • ip string

    ip address

  • node string

    node name

Query parameters

• allow_no_match boolean

  Whether to ignore if a wildcard expression matches no configs. (This includes _all string or when no configs have been specified)

• bytes string

  The unit in which 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.

  Supported values include:

  • assignment_explanation (or ae): Contains messages relating to the selection of a node.
  • create_time (or ct, createTime): The time when the data frame analytics job was created.
  • description (or d): A description of a job.
  • dest_index (or di, destIndex): Name of the destination index.
  • failure_reason (or fr, failureReason): Contains messages about the reason why a data frame analytics job failed.
  • id: Identifier for the data frame analytics job.
  • model_memory_limit (or mml, modelMemoryLimit): The approximate maximum amount of memory resources that are permitted for the data frame analytics job.
  • node.address (or na, nodeAddress): The network address of the node that the data frame analytics job is assigned to.
  • node.ephemeral_id (or ne, nodeEphemeralId): The ephemeral ID of the node that the data frame analytics job is assigned to.
  • node.id (or ni, nodeId): The unique identifier of the node that the data frame analytics job is assigned to.
  • node.name (or nn, nodeName): The name of the node that the data frame analytics job is assigned to.
  • progress (or p): The progress report of the data frame analytics job by phase.
  • source_index (or si, sourceIndex): Name of the source index.
  • state (or s): Current state of the data frame analytics job.
  • type (or t): The type of analysis that the data frame analytics job performs.
  • version (or v): The Elasticsearch version number in which the data frame analytics job was created.
• s string | array[string]

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

  Supported values include:

  • assignment_explanation (or ae): Contains messages relating to the selection of a node.
  • create_time (or ct, createTime): The time when the data frame analytics job was created.
  • description (or d): A description of a job.
  • dest_index (or di, destIndex): Name of the destination index.
  • failure_reason (or fr, failureReason): Contains messages about the reason why a data frame analytics job failed.
  • id: Identifier for the data frame analytics job.
  • model_memory_limit (or mml, modelMemoryLimit): The approximate maximum amount of memory resources that are permitted for the data frame analytics job.
  • node.address (or na, nodeAddress): The network address of the node that the data frame analytics job is assigned to.
  • node.ephemeral_id (or ne, nodeEphemeralId): The ephemeral ID of the node that the data frame analytics job is assigned to.
  • node.id (or ni, nodeId): The unique identifier of the node that the data frame analytics job is assigned to.
  • node.name (or nn, nodeName): The name of the node that the data frame analytics job is assigned to.
  • progress (or p): The progress report of the data frame analytics job by phase.
  • source_index (or si, sourceIndex): Name of the source index.
  • state (or s): Current state of the data frame analytics job.
  • type (or t): The type of analysis that the data frame analytics job performs.
  • version (or v): The Elasticsearch version number in which the data frame analytics job was created.
• 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
  • type string

    The type of analysis that the job performs.

  • create_time string

    The time when the job was created.

  • version string
  • source_index string
  • dest_index string
  • description string

    A description of the job.

  • model_memory_limit string

    The approximate maximum amount of memory resources that are permitted for the job.

  • state string

    The current status of the job.

  • failure_reason string

    Messages about the reason why the job failed.

  • progress string

    The progress report for the job by phase.

  • assignment_explanation string

    Messages related to the selection of a node.

  • node.id string
  • node.name string
  • node.ephemeral_id string
  • node.address string

    The network address of the assigned node.

Path parameters

• id string Required

  The ID of the data frame analytics to fetch

Query parameters

• allow_no_match boolean

  Whether to ignore if a wildcard expression matches no configs. (This includes _all string or when no configs have been specified)

• bytes string

  The unit in which 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.

  Supported values include:

  • assignment_explanation (or ae): Contains messages relating to the selection of a node.
  • create_time (or ct, createTime): The time when the data frame analytics job was created.
  • description (or d): A description of a job.
  • dest_index (or di, destIndex): Name of the destination index.
  • failure_reason (or fr, failureReason): Contains messages about the reason why a data frame analytics job failed.
  • id: Identifier for the data frame analytics job.
  • model_memory_limit (or mml, modelMemoryLimit): The approximate maximum amount of memory resources that are permitted for the data frame analytics job.
  • node.address (or na, nodeAddress): The network address of the node that the data frame analytics job is assigned to.
  • node.ephemeral_id (or ne, nodeEphemeralId): The ephemeral ID of the node that the data frame analytics job is assigned to.
  • node.id (or ni, nodeId): The unique identifier of the node that the data frame analytics job is assigned to.
  • node.name (or nn, nodeName): The name of the node that the data frame analytics job is assigned to.
  • progress (or p): The progress report of the data frame analytics job by phase.
  • source_index (or si, sourceIndex): Name of the source index.
  • state (or s): Current state of the data frame analytics job.
  • type (or t): The type of analysis that the data frame analytics job performs.
  • version (or v): The Elasticsearch version number in which the data frame analytics job was created.
• s string | array[string]

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

  Supported values include:

  • assignment_explanation (or ae): Contains messages relating to the selection of a node.
  • create_time (or ct, createTime): The time when the data frame analytics job was created.
  • description (or d): A description of a job.
  • dest_index (or di, destIndex): Name of the destination index.
  • failure_reason (or fr, failureReason): Contains messages about the reason why a data frame analytics job failed.
  • id: Identifier for the data frame analytics job.
  • model_memory_limit (or mml, modelMemoryLimit): The approximate maximum amount of memory resources that are permitted for the data frame analytics job.
  • node.address (or na, nodeAddress): The network address of the node that the data frame analytics job is assigned to.
  • node.ephemeral_id (or ne, nodeEphemeralId): The ephemeral ID of the node that the data frame analytics job is assigned to.
  • node.id (or ni, nodeId): The unique identifier of the node that the data frame analytics job is assigned to.
  • node.name (or nn, nodeName): The name of the node that the data frame analytics job is assigned to.
  • progress (or p): The progress report of the data frame analytics job by phase.
  • source_index (or si, sourceIndex): Name of the source index.
  • state (or s): Current state of the data frame analytics job.
  • type (or t): The type of analysis that the data frame analytics job performs.
  • version (or v): The Elasticsearch version number in which the data frame analytics job was created.
• 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
  • type string

    The type of analysis that the job performs.

  • create_time string

    The time when the job was created.

  • version string
  • source_index string
  • dest_index string
  • description string

    A description of the job.

  • model_memory_limit string

    The approximate maximum amount of memory resources that are permitted for the job.

  • state string

    The current status of the job.

  • failure_reason string

    Messages about the reason why the job failed.

  • progress string

    The progress report for the job by phase.

  • assignment_explanation string

    Messages related to the selection of a node.

  • node.id string
  • node.name string
  • node.ephemeral_id string
  • node.address string

    The network address of the assigned node.

Query parameters

• allow_no_match boolean

  Specifies what to do when the request:

  • Contains wildcard expressions and there are no datafeeds that match.
  • Contains the _all string or no identifiers and there are no matches.
  • Contains wildcard expressions and there are only partial matches.

  If true, the API returns an empty datafeeds array when there are no matches and the subset of results when there are partial matches. If false, the API returns a 404 status code when there are no matches or only partial matches.

• h string | array[string]

  Comma-separated list of column names to display.

  Supported values include:

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

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

  Supported values include:

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

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

  Supported values include:

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

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

  Supported values include:

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

  The unit used to display time values.

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

Responses

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

  • id string

    The datafeed identifier.

  • state string

    Values are started, stopped, starting, or stopping.

  • assignment_explanation string

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

  • buckets.count string

    The number of buckets processed.

  • search.count string

    The number of searches run by the datafeed.

  • search.time string

    The total time the datafeed spent searching, in milliseconds.

  • search.bucket_avg string

    The average search time per bucket, in milliseconds.

  • search.exp_avg_hour string

    The exponential average search time per hour, in milliseconds.

  • node.id string

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

  • node.name string

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

  • node.ephemeral_id string

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

  • node.address string

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

Query parameters

• 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

  • id string

    The unique repository identifier.

  • type string

    The repository 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

• actions array[string]

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

• detailed boolean

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

• nodes array[string]

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

• parent_task_id string

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

• h string | array[string]

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

• s string | array[string]

  List of columns that determine how the table should be sorted. Sorting defaults to ascending and can be changed by setting :asc or :desc as a suffix to the column name.

• time string

  Unit used to display time values.

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

• timeout string

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

• wait_for_completion boolean

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

Responses

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

  • id string
  • action string

    The task action.

  • task_id string
  • parent_task_id string

    The parent task identifier.

  • type string

    The task type.

  • start_time string

    The start time in milliseconds.

  • timestamp string

    The start time in HH:MM:SS format.

  • running_time_ns string

    The running time in nanoseconds.

  • running_time string

    The running time.

  • node_id string
  • ip string

    The IP address for the node.

  • port string

    The bound transport port for the node.

  • node string

    The node name.

  • version string
  • x_opaque_id string

    The X-Opaque-ID header.

  • description string

    The task action description.

Query parameters

• allow_no_match boolean

  Specifies what to do when the request: contains wildcard expressions and there are no transforms 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, it returns an empty transforms array when there are no matches and the subset of results when there are partial matches. If false, the request returns a 404 status code when there are no matches or only partial matches.

• from number

  Skips the specified number of transforms.

• h string | array[string]

  Comma-separated list of column names to display.

  Supported values include:

  • changes_last_detection_time (or cldt): The timestamp when changes were last detected in the source indices.
  • checkpoint (or cp): The sequence number for the checkpoint.
  • checkpoint_duration_time_exp_avg (or cdtea, checkpointTimeExpAvg): Exponential moving average of the duration of the checkpoint, in milliseconds.
  • checkpoint_progress (or c, checkpointProgress): The progress of the next checkpoint that is currently in progress.
  • create_time (or ct, createTime): The time the transform was created.
  • delete_time (or dtime): The amount of time spent deleting, in milliseconds.
  • description (or d): The description of the transform.
  • dest_index (or di, destIndex): The destination index for the transform. The mappings of the destination index are deduced based on the source fields when possible. If alternate mappings are required, use the Create index API prior to starting the transform.
  • documents_deleted (or docd): The number of documents that have been deleted from the destination index due to the retention policy for this transform.
  • documents_indexed (or doci): The number of documents that have been indexed into the destination index for the transform.
  • docs_per_second (or dps): Specifies a limit on the number of input documents per second. This setting throttles the transform by adding a wait time between search requests. The default value is null, which disables throttling.
  • documents_processed (or docp): The number of documents that have been processed from the source index of the transform.
  • frequency (or f): The interval between checks for changes in the source indices when the transform is running continuously. Also determines the retry interval in the event of transient failures while the transform is searching or indexing. The minimum value is 1s and the maximum is 1h. The default value is 1m.
  • id: Identifier for the transform.
  • index_failure (or if): The number of indexing failures.
  • index_time (or itime): The amount of time spent indexing, in milliseconds.
  • index_total (or it): The number of index operations.
  • indexed_documents_exp_avg (or idea): Exponential moving average of the number of new documents that have been indexed.
  • last_search_time (or lst, lastSearchTime): The timestamp of the last search in the source indices. This field is only shown if the transform is running.
  • max_page_search_size (or mpsz): Defines the initial page size to use for the composite aggregation for each checkpoint. If circuit breaker exceptions occur, the page size is dynamically adjusted to a lower value. The minimum value is 10 and the maximum is 65,536. The default value is 500.
  • pages_processed (or pp): The number of search or bulk index operations processed. Documents are processed in batches instead of individually.
  • pipeline (or p): The unique identifier for an ingest pipeline.
  • processed_documents_exp_avg (or pdea): Exponential moving average of the number of documents that have been processed.
  • processing_time (or pt): The amount of time spent processing results, in milliseconds.
  • reason (or r): If a transform has a failed state, this property provides details about the reason for the failure.
  • search_failure (or sf): The number of search failures.
  • search_time (or stime): The amount of time spent searching, in milliseconds.
  • search_total (or st): The number of search operations on the source index for the transform.
  • source_index (or si, sourceIndex): The source indices for the transform. It can be a single index, an index pattern (for example, "my-index-*"), an array of indices (for example, ["my-index-000001", "my-index-000002"]), or an array of index patterns (for example, ["my-index-*", "my-other-index-*"]. For remote indices use the syntax "remote_name:index_name". If any indices are in remote clusters then the master node and at least one transform node must have the remote_cluster_client node role.

  • state (or s): The status of the transform, which can be one of the following values:

    • aborting: The transform is aborting.
    • failed: The transform failed. For more information about the failure, check the reason field.
    • indexing: The transform is actively processing data and creating new documents.
    • started: The transform is running but not actively indexing data.
    • stopped: The transform is stopped.
    • stopping: The transform is stopping.

  • transform_type (or tt): Indicates the type of transform: batch or continuous.

  • trigger_count (or tc): The number of times the transform has been triggered by the scheduler. For example, the scheduler triggers the transform indexer to check for updates or ingest new data at an interval specified in the frequency property.

  • version (or v): The version of Elasticsearch that existed on the node when the transform was created.

• s string | array[string]

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

  Supported values include:

  • changes_last_detection_time (or cldt): The timestamp when changes were last detected in the source indices.
  • checkpoint (or cp): The sequence number for the checkpoint.
  • checkpoint_duration_time_exp_avg (or cdtea, checkpointTimeExpAvg): Exponential moving average of the duration of the checkpoint, in milliseconds.
  • checkpoint_progress (or c, checkpointProgress): The progress of the next checkpoint that is currently in progress.
  • create_time (or ct, createTime): The time the transform was created.
  • delete_time (or dtime): The amount of time spent deleting, in milliseconds.
  • description (or d): The description of the transform.
  • dest_index (or di, destIndex): The destination index for the transform. The mappings of the destination index are deduced based on the source fields when possible. If alternate mappings are required, use the Create index API prior to starting the transform.
  • documents_deleted (or docd): The number of documents that have been deleted from the destination index due to the retention policy for this transform.
  • documents_indexed (or doci): The number of documents that have been indexed into the destination index for the transform.
  • docs_per_second (or dps): Specifies a limit on the number of input documents per second. This setting throttles the transform by adding a wait time between search requests. The default value is null, which disables throttling.
  • documents_processed (or docp): The number of documents that have been processed from the source index of the transform.
  • frequency (or f): The interval between checks for changes in the source indices when the transform is running continuously. Also determines the retry interval in the event of transient failures while the transform is searching or indexing. The minimum value is 1s and the maximum is 1h. The default value is 1m.
  • id: Identifier for the transform.
  • index_failure (or if): The number of indexing failures.
  • index_time (or itime): The amount of time spent indexing, in milliseconds.
  • index_total (or it): The number of index operations.
  • indexed_documents_exp_avg (or idea): Exponential moving average of the number of new documents that have been indexed.
  • last_search_time (or lst, lastSearchTime): The timestamp of the last search in the source indices. This field is only shown if the transform is running.
  • max_page_search_size (or mpsz): Defines the initial page size to use for the composite aggregation for each checkpoint. If circuit breaker exceptions occur, the page size is dynamically adjusted to a lower value. The minimum value is 10 and the maximum is 65,536. The default value is 500.
  • pages_processed (or pp): The number of search or bulk index operations processed. Documents are processed in batches instead of individually.
  • pipeline (or p): The unique identifier for an ingest pipeline.
  • processed_documents_exp_avg (or pdea): Exponential moving average of the number of documents that have been processed.
  • processing_time (or pt): The amount of time spent processing results, in milliseconds.
  • reason (or r): If a transform has a failed state, this property provides details about the reason for the failure.
  • search_failure (or sf): The number of search failures.
  • search_time (or stime): The amount of time spent searching, in milliseconds.
  • search_total (or st): The number of search operations on the source index for the transform.
  • source_index (or si, sourceIndex): The source indices for the transform. It can be a single index, an index pattern (for example, "my-index-*"), an array of indices (for example, ["my-index-000001", "my-index-000002"]), or an array of index patterns (for example, ["my-index-*", "my-other-index-*"]. For remote indices use the syntax "remote_name:index_name". If any indices are in remote clusters then the master node and at least one transform node must have the remote_cluster_client node role.

  • state (or s): The status of the transform, which can be one of the following values:

    • aborting: The transform is aborting.
    • failed: The transform failed. For more information about the failure, check the reason field.
    • indexing: The transform is actively processing data and creating new documents.
    • started: The transform is running but not actively indexing data.
    • stopped: The transform is stopped.
    • stopping: The transform is stopping.

  • transform_type (or tt): Indicates the type of transform: batch or continuous.

  • trigger_count (or tc): The number of times the transform has been triggered by the scheduler. For example, the scheduler triggers the transform indexer to check for updates or ingest new data at an interval specified in the frequency property.

  • version (or v): The version of Elasticsearch that existed on the node when the transform was created.

• time string

  The unit used to display time values.

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

• size number

  The maximum number of transforms to obtain.

Responses

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

  • id string
  • state string

    The status of the transform. Returned values include: aborting: The transform is aborting. failed: The transform failed. For more information about the failure, check thereasonfield. indexing: The transform is actively processing data and creating new documents. started: The transform is running but not actively indexing data. stopped: The transform is stopped. stopping`: The transform is stopping.

  • checkpoint string

    The sequence number for the checkpoint.

  • documents_processed string

    The number of documents that have been processed from the source index of the transform.

  • checkpoint_progress string | null

    The progress of the next checkpoint that is currently in progress.

    One of:

    string-1 string string-2 string | null

  • last_search_time string | null

    The timestamp of the last search in the source indices. This field is shown only if the transform is running.

    One of:

    string-1 string string-2 string | null

  • changes_last_detection_time string | null

    The timestamp when changes were last detected in the source indices.

    One of:

    string-1 string string-2 string | null
  • create_time string

    The time the transform was created.

  • version string
  • source_index string

    The source indices for the transform.

  • dest_index string

    The destination index for the transform.

  • pipeline string

    The unique identifier for the ingest pipeline.

  • description string

    The description of the transform.

  • transform_type string

    The type of transform: batch or continuous.

  • frequency string

    The interval between checks for changes in the source indices when the transform is running continuously.

  • max_page_search_size string

    The initial page size that is used for the composite aggregation for each checkpoint.

  • docs_per_second string

    The number of input documents per second.

  • reason string

    If a transform has a failed state, these details describe the reason for failure.

  • search_total string

    The total number of search operations on the source index for the transform.

  • search_failure string

    The total number of search failures.

  • search_time string

    The total amount of search time, in milliseconds.

  • index_total string

    The total number of index operations done by the transform.

  • index_failure string

    The total number of indexing failures.

  • index_time string

    The total time spent indexing documents, in milliseconds.

  • documents_indexed string

    The number of documents that have been indexed into the destination index for the transform.

  • delete_time string

    The total time spent deleting documents, in milliseconds.

  • documents_deleted string

    The number of documents deleted from the destination index due to the retention policy for the transform.

  • trigger_count string

    The number of times the transform has been triggered by the scheduler. For example, the scheduler triggers the transform indexer to check for updates or ingest new data at an interval specified in the frequency property.

  • pages_processed string

    The number of search or bulk index operations processed. Documents are processed in batches instead of individually.

  • processing_time string

    The total time spent processing results, in milliseconds.

  • checkpoint_duration_time_exp_avg string

    The exponential moving average of the duration of the checkpoint, in milliseconds.

  • indexed_documents_exp_avg string

    The exponential moving average of the number of new documents that have been indexed.

  • processed_documents_exp_avg string

    The exponential moving average of the number of documents that have been processed.

Query parameters

• flat_settings boolean

  If true, returns settings in flat format.

• include_defaults boolean

  If true, returns default cluster settings from the local 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.

Responses

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

  • 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
  • defaults object
    Hide defaults attribute Show defaults 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.

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

  Supported values include:

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

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

Responses

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

  • active_primary_shards number Required

    The number of active primary shards.

  • active_shards number Required

    The total number of active primary and replica shards.

  • active_shards_percent string

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

  • active_shards_percent_as_number number Required

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

  • cluster_name string Required
  • delayed_unassigned_shards number Required

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

  • indices object
    Hide indices attribute Show indices attribute object

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

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

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

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

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

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

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

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

    The number of shards that are under initialization.

  • number_of_data_nodes number Required

    The number of nodes that are dedicated data nodes.

  • number_of_in_flight_fetch number Required

    The number of unfinished fetches.

  • number_of_nodes number Required

    The number of nodes within the cluster.

  • number_of_pending_tasks number Required

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

  • relocating_shards number Required

    The number of shards that are under relocation.

  • status string Required

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

  • task_max_waiting_in_queue string

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

  • task_max_waiting_in_queue_millis number

    Time unit for milliseconds

  • timed_out boolean Required

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

  • unassigned_primary_shards number Required

    The number of primary shards that are not allocated.

  • unassigned_shards number Required

    The number of shards that are not allocated.

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

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.

Responses

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

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

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

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

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

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

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

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

Path parameters

• metric string | array[string] Required

  Limit the information returned to the specified metrics

• index string | array[string] Required

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

Query parameters

• allow_no_indices boolean

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

• expand_wildcards string | array[string]

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

  Supported values include:

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