Path parameters

• name string Required

  The name of the analytics collection to be created or updated.

Responses

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

  • acknowledged boolean Required

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

  • name string Required

    The name of the analytics collection created or updated

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.

Query parameters

• 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

    seconds since 1970-01-01 00:00:00

    One of:

    UnitSeconds number string-2 string

    seconds since 1970-01-01 00:00:00

    seconds since 1970-01-01 00:00:00

  • timestamp string

    time in 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

Path parameters

• index string | array[string] Required

  Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (*). To target all data streams and indices, omit this parameter or use * or _all.

Query parameters

• expand_wildcards string | array[string]

  The type of index that wildcard patterns can match.

  Supported values include:

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

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

• health string

  The health status used to limit returned indices. By default, the response includes indices of any health 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.
  • unknown
  • unavailable

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

• include_unloaded_segments boolean

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

• pri boolean

  If true, the response only includes information from primary shards.

• master_timeout string

  Period to wait for a connection to the master node.

  External documentation
• 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

  • health string

    current health status

  • status string

    open/close status

  • index string

    index name

  • uuid string

    index uuid

  • pri string

    number of primary shards

  • rep string

    number of replica shards

  • docs.count string | null

    available docs

    One of:

    string-1 string string-2 string | null

  • docs.deleted string | null

    deleted docs

    One of:

    string-1 string string-2 string | null
  • creation.date string

    index creation date (millisecond value)

  • creation.date.string string

    index creation date (as string)

  • store.size string | null

    store size of primaries & replicas

    One of:

    string-1 string string-2 string | null

  • pri.store.size string | null

    store size of primaries

    One of:

    string-1 string string-2 string | null

  • dataset.size string | null

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

    One of:

    string-1 string string-2 string | null
  • completion.size string

    size of completion

  • pri.completion.size string

    size of completion

  • fielddata.memory_size string

    used fielddata cache

  • pri.fielddata.memory_size string

    used fielddata cache

  • fielddata.evictions string

    fielddata evictions

  • pri.fielddata.evictions string

    fielddata evictions

  • query_cache.memory_size string

    used query cache

  • pri.query_cache.memory_size string

    used query cache

  • query_cache.evictions string

    query cache evictions

  • pri.query_cache.evictions string

    query cache evictions

  • request_cache.memory_size string

    used request cache

  • pri.request_cache.memory_size string

    used request cache

  • request_cache.evictions string

    request cache evictions

  • pri.request_cache.evictions string

    request cache evictions

  • request_cache.hit_count string

    request cache hit count

  • pri.request_cache.hit_count string

    request cache hit count

  • request_cache.miss_count string

    request cache miss count

  • pri.request_cache.miss_count string

    request cache miss count

  • flush.total string

    number of flushes

  • pri.flush.total string

    number of flushes

  • flush.total_time string

    time spent in flush

  • pri.flush.total_time string

    time spent in flush

  • get.current string

    number of current get ops

  • pri.get.current string

    number of current get ops

  • get.time string

    time spent in get

  • pri.get.time string

    time spent in get

  • get.total string

    number of get ops

  • pri.get.total string

    number of get ops

  • get.exists_time string

    time spent in successful gets

  • pri.get.exists_time string

    time spent in successful gets

  • get.exists_total string

    number of successful gets

  • pri.get.exists_total string

    number of successful gets

  • get.missing_time string

    time spent in failed gets

  • pri.get.missing_time string

    time spent in failed gets

  • get.missing_total string

    number of failed gets

  • pri.get.missing_total string

    number of failed gets

  • indexing.delete_current string

    number of current deletions

  • pri.indexing.delete_current string

    number of current deletions

  • indexing.delete_time string

    time spent in deletions

  • pri.indexing.delete_time string

    time spent in deletions

  • indexing.delete_total string

    number of delete ops

  • pri.indexing.delete_total string

    number of delete ops

  • indexing.index_current string

    number of current indexing ops

  • pri.indexing.index_current string

    number of current indexing ops

  • indexing.index_time string

    time spent in indexing

  • pri.indexing.index_time string

    time spent in indexing

  • indexing.index_total string

    number of indexing ops

  • pri.indexing.index_total string

    number of indexing ops

  • indexing.index_failed string

    number of failed indexing ops

  • pri.indexing.index_failed string

    number of failed indexing ops

  • merges.current string

    number of current merges

  • pri.merges.current string

    number of current merges

  • merges.current_docs string

    number of current merging docs

  • pri.merges.current_docs string

    number of current merging docs

  • merges.current_size string

    size of current merges

  • pri.merges.current_size string

    size of current merges

  • merges.total string

    number of completed merge ops

  • pri.merges.total string

    number of completed merge ops

  • merges.total_docs string

    docs merged

  • pri.merges.total_docs string

    docs merged

  • merges.total_size string

    size merged

  • pri.merges.total_size string

    size merged

  • merges.total_time string

    time spent in merges

  • pri.merges.total_time string

    time spent in merges

  • refresh.total string

    total refreshes

  • pri.refresh.total string

    total refreshes

  • refresh.time string

    time spent in refreshes

  • pri.refresh.time string

    time spent in refreshes

  • refresh.external_total string

    total external refreshes

  • pri.refresh.external_total string

    total external refreshes

  • refresh.external_time string

    time spent in external refreshes

  • pri.refresh.external_time string

    time spent in external refreshes

  • refresh.listeners string

    number of pending refresh listeners

  • pri.refresh.listeners string

    number of pending refresh listeners

  • search.fetch_current string

    current fetch phase ops

  • pri.search.fetch_current string

    current fetch phase ops

  • search.fetch_time string

    time spent in fetch phase

  • pri.search.fetch_time string

    time spent in fetch phase

  • search.fetch_total string

    total fetch ops

  • pri.search.fetch_total string

    total fetch ops

  • search.open_contexts string

    open search contexts

  • pri.search.open_contexts string

    open search contexts

  • search.query_current string

    current query phase ops

  • pri.search.query_current string

    current query phase ops

  • search.query_time string

    time spent in query phase

  • pri.search.query_time string

    time spent in query phase

  • search.query_total string

    total query phase ops

  • pri.search.query_total string

    total query phase ops

  • search.scroll_current string

    open scroll contexts

  • pri.search.scroll_current string

    open scroll contexts

  • search.scroll_time string

    time scroll contexts held open

  • pri.search.scroll_time string

    time scroll contexts held open

  • search.scroll_total string

    completed scroll contexts

  • pri.search.scroll_total string

    completed scroll contexts

  • segments.count string

    number of segments

  • pri.segments.count string

    number of segments

  • segments.memory string

    memory used by segments

  • pri.segments.memory string

    memory used by segments

  • segments.index_writer_memory string

    memory used by index writer

  • pri.segments.index_writer_memory string

    memory used by index writer

  • segments.version_map_memory string

    memory used by version map

  • pri.segments.version_map_memory string

    memory used by version map

  • segments.fixed_bitset_memory string

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

  • pri.segments.fixed_bitset_memory string

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

  • warmer.current string

    current warmer ops

  • pri.warmer.current string

    current warmer ops

  • warmer.total string

    total warmer ops

  • pri.warmer.total string

    total warmer ops

  • warmer.total_time string

    time spent in warmers

  • pri.warmer.total_time string

    time spent in warmers

  • suggest.current string

    number of current suggest ops

  • pri.suggest.current string

    number of current suggest ops

  • suggest.time string

    time spend in suggest

  • pri.suggest.time string

    time spend in suggest

  • suggest.total string

    number of suggest ops

  • pri.suggest.total string

    number of suggest ops

  • memory.total string

    total used memory

  • pri.memory.total string

    total user memory

  • search.throttled string

    indicates if the index is search throttled

  • bulk.total_operations string

    number of bulk shard ops

  • pri.bulk.total_operations string

    number of bulk shard ops

  • bulk.total_time string

    time spend in shard bulk

  • pri.bulk.total_time string

    time spend in shard bulk

  • bulk.total_size_in_bytes string

    total size in bytes of shard bulk

  • pri.bulk.total_size_in_bytes string

    total size in bytes of shard bulk

  • bulk.avg_time string

    average time spend in shard bulk

  • pri.bulk.avg_time string

    average time spend in shard bulk

  • bulk.avg_size_in_bytes string

    average size in bytes of shard bulk

  • pri.bulk.avg_size_in_bytes string

    average size in bytes of shard bulk

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

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

Responses

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

  • id string

    The identifier for the job.

  • type string

    The type of analysis that the job performs.

  • create_time string

    The time when the job was created.

  • version string

    The version of Elasticsearch when the job was created.

  • source_index string

    The name of the source index.

  • dest_index string

    The name of the destination index.

  • 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

    The unique identifier of the assigned node.

  • node.name string

    The name of the assigned node.

  • node.ephemeral_id string

    The ephemeral identifier of the assigned node.

  • node.address string

    The network address of the assigned node.

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.

  External documentation

Responses

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

  • insertOrder string

    The task insertion order.

  • timeInQueue string

    Indicates how long the task has been in queue.

  • priority string

    The task priority.

  • source string

    The task source.

Query parameters

• h string | array[string]

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

• s string | array[string]

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

• include_bootstrap boolean

  Include bootstrap plugins in the response

• local boolean

  If true, the request computes the list of selected nodes from the local cluster state. If false the list of selected nodes are computed from the cluster state of the master node. In both cases the coordinating node will send requests for further information to each selected node.

• master_timeout string

  Period to wait for a connection to the master node.

  External documentation

Responses

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

  • id string

    The unique node identifier.

  • name string

    The node name.

  • component string

    The component name.

  • version string

    The component version.

  • description string

    The plugin details.

  • type string

    The plugin type.

Path parameters

• index string | array[string] Required

  A comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (*). To target all data streams and indices, omit this parameter or use * or _all.

Query parameters

• h string | array[string]

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

  Supported values include:

  • index (or i, idx): The name of the index.
  • shard (or s, sh): The name of the shard.
  • prirep (or p, pr, primaryOrReplica): The shard type. Returned values are 'primary' or 'replica'.
  • ip: IP address of the segment’s shard, such as '127.0.1.1'.
  • segment: The name of the segment, such as '_0'. The segment name is derived from the segment generation and used internally to create file names in the directory of the shard.
  • generation: Generation number, such as '0'. Elasticsearch increments this generation number for each segment written. Elasticsearch then uses this number to derive the segment name.
  • docs.count: The number of documents as reported by Lucene. This excludes deleted documents and counts any nested documents separately from their parents. It also excludes documents which were indexed recently and do not yet belong to a segment.
  • docs.deleted: The number of deleted documents as reported by Lucene, which may be higher or lower than the number of delete operations you have performed. This number excludes deletes that were performed recently and do not yet belong to a segment. Deleted documents are cleaned up by the automatic merge process if it makes sense to do so. Also, Elasticsearch creates extra deleted documents to internally track the recent history of operations on a shard.
  • size: The disk space used by the segment, such as '50kb'.
  • size.memory: The bytes of segment data stored in memory for efficient search, such as '1264'. A value of '-1' indicates Elasticsearch was unable to compute this number.
  • committed: If 'true', the segments is synced to disk. Segments that are synced can survive a hard reboot. If 'false', the data from uncommitted segments is also stored in the transaction log so that Elasticsearch is able to replay changes on the next start.
  • searchable: If 'true', the segment is searchable. If 'false', the segment has most likely been written to disk but needs a refresh to be searchable.
  • version: The version of Lucene used to write the segment.
  • compound: If 'true', the segment is stored in a compound file. This means Lucene merged all files from the segment in a single file to save file descriptors.
  • id: The ID of the node, such as 'k0zy'.

  Values are index, i, idx, shard, s, sh, prirep, p, pr, primaryOrReplica, ip, segment, generation, docs.count, docs.deleted, size, size.memory, committed, searchable, version, compound, or id.

• s string | array[string]

  A comma-separated list of column names or aliases that determines the sort order. Sorting defaults to ascending and can be changed by setting :asc or :desc as a suffix to the column name.

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

  External documentation

Responses

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

  • index string

    The index name.

  • shard string

    The shard name.

  • prirep string

    The shard type: primary or replica.

  • ip string

    The IP address of the node where it lives.

  • id string

    The unique identifier of the node where it lives.

  • segment string

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

  • generation string

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

  • docs.count string

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

  • docs.deleted string

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

  • size number | string

    The segment size in bytes.

    One of:

    number-1 number string-2 string

    The segment size in bytes.

    The segment size in bytes.

  • size.memory number | string

    The segment memory in bytes. A value of -1 indicates Elasticsearch was unable to compute this number.

    One of:

    number-1 number string-2 string

    The segment memory in bytes. A value of -1 indicates Elasticsearch was unable to compute this number.

    The segment memory in bytes. A value of -1 indicates Elasticsearch was unable to compute this number.

  • committed string

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

  • searchable string

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

  • version string

    The version of Lucene used to write the segment.

  • compound string

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

Path parameters

• repository string | array[string] Required

  A comma-separated list of snapshot repositories used to limit the request. Accepts wildcard expressions. _all returns all repositories. If any repository fails during the request, Elasticsearch returns an error.

Query parameters

• ignore_unavailable boolean

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

• h string | array[string]

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

  Supported values include:

  • id (or snapshot): The ID of the snapshot, such as 'snap1'.
  • repository (or re, repo): The name of the repository, such as 'repo1'.
  • status (or s): State of the snapshot process. Returned values are: '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 (or ste, startEpoch): The unix epoch time at which the snapshot process started.
  • start_time (or sti, startTime): 'HH:MM:SS' time at which the snapshot process started.
  • end_epoch (or ete, endEpoch): The unix epoch time at which the snapshot process ended.
  • end_time (or eti, endTime): 'HH:MM:SS' time at which the snapshot process ended.
  • duration (or dur): The time it took the snapshot process to complete in time units.
  • indices (or i): The number of indices in the snapshot.
  • successful_shards (or ss): The number of successful shards in the snapshot.
  • failed_shards (or fs): The number of failed shards in the snapshot.
  • total_shards (or ts): The total number of shards in the snapshot.
  • reason (or r): The reason for any snapshot failures.

  Values are id, snapshot, repository, re, repo, status, s, start_epoch, ste, startEpoch, start_time, sti, startTime, end_epoch, ete, endEpoch, end_time, eti, endTime, duration, dur, indices, i, successful_shards, ss, failed_shards, fs, total_shards, ts, reason, or r.

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

  External documentation

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

    The Unix epoch time (seconds since 1970-01-01 00:00:00) at which the snapshot process started.

    One of:

    UnitSeconds number string-2 string

    The Unix epoch time (seconds since 1970-01-01 00:00:00) at which the snapshot process started.

    The Unix epoch time (seconds since 1970-01-01 00:00:00) at which the snapshot process started.

  • start_time string | object

    The time (HH:MM:SS) at which the snapshot process started.

    One of:

    string-1 string HourAndMinute object

    The time (HH:MM:SS) at which the snapshot process started.

    The time (HH:MM:SS) at which the snapshot process started.

    Hide attributes Show attributes

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

  • end_epoch number | string

    The Unix epoch time (seconds since 1970-01-01 00:00:00) at which the snapshot process ended.

    One of:

    UnitSeconds number string-2 string

    The Unix epoch time (seconds since 1970-01-01 00:00:00) at which the snapshot process ended.

    The Unix epoch time (seconds since 1970-01-01 00:00:00) at which the snapshot process ended.

  • end_time string

    The time (HH:MM:SS) at which the snapshot process ended.

  • duration string

    The time it took the snapshot process to complete, in time units.

    External documentation
  • indices string

    The number of indices in the snapshot.

  • successful_shards string

    The number of successful shards in the snapshot.

  • failed_shards string

    The number of failed shards in the snapshot.

  • total_shards string

    The total number of shards in the snapshot.

  • reason string

    The reason for any snapshot failures.

Path parameters

• thread_pool_patterns string | array[string] Required

  A comma-separated list of thread pool names used to limit the request. Accepts wildcard expressions.

Query parameters

• h string | array[string]

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

  Supported values include:

  • active (or a): Number of active threads in the current thread pool.
  • completed (or c): Number of tasks completed by the thread pool executor.
  • core (or cr): Configured core number of active threads allowed in the current thread pool.
  • ephemeral_id (or eid): Ephemeral node ID.
  • host (or h): Hostname for the current node.
  • ip (or i): IP address for the current node.
  • keep_alive (or k): Configured keep alive time for threads.
  • largest (or l): Highest number of active threads in the current thread pool.
  • max (or mx): Configured maximum number of active threads allowed in the current thread pool.
  • name: Name of the thread pool, such as analyze or generic.
  • node_id (or id): ID of the node, such as k0zy.
  • node_name: Node name, such as I8hydUG.
  • pid (or p): Process ID of the running node.
  • pool_size (or psz): Number of threads in the current thread pool.
  • port (or po): Bound transport port for the current node.
  • queue (or q): Number of tasks in the queue for the current thread pool.
  • queue_size (or qs): Maximum number of tasks permitted in the queue for the current thread pool.
  • rejected (or r): Number of tasks rejected by the thread pool executor.
  • size (or sz): Configured fixed number of active threads allowed in the current thread pool.
  • type (or t): Type of thread pool. Returned values are fixed, fixed_auto_queue_size, direct, or scaling.

  Values are active, a, completed, c, core, cr, ephemeral_id, eid, host, h, ip, i, keep_alive, k, largest, l, max, mx, name, node_id, id, node_name, pid, p, pool_size, psz, port, po, queue, q, queue_size, qs, rejected, r, size, sz, type, or t.

• s string | array[string]

  A comma-separated list of column names or aliases that determines the sort order. Sorting defaults to ascending and can be changed by setting :asc or :desc as a suffix to the column name.

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

  External documentation

Responses

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

  • node_name string

    The node name.

  • node_id string

    The persistent node identifier.

  • ephemeral_node_id string

    The ephemeral node identifier.

  • pid string

    The process identifier.

  • host string

    The host name for the current node.

  • ip string

    The IP address for the current node.

  • port string

    The bound transport port for the current node.

  • name string

    The thread pool name.

  • type string

    The thread pool type. Returned values include fixed, fixed_auto_queue_size, direct, and scaling.

  • active string

    The number of active threads in the current thread pool.

  • pool_size string

    The number of threads in the current thread pool.

  • queue string

    The number of tasks currently in queue.

  • queue_size string

    The maximum number of tasks permitted in the queue.

  • rejected string

    The number of rejected tasks.

  • largest string

    The highest number of active threads in the current thread pool.

  • completed string

    The number of completed tasks.

  • core string | null

    The core number of active threads allowed in a scaling thread pool.

    One of:

    string-1 string string-2 string | null

  • max string | null

    The maximum number of active threads allowed in a scaling thread pool.

    One of:

    string-1 string string-2 string | null

  • size string | null

    The number of active threads allowed in a fixed thread pool.

    One of:

    string-1 string string-2 string | null

  • keep_alive string | null

    The thread keep alive time.

    One of:

    string-1 string string-2 string | null

Path parameters

• transform_id string Required

  A transform identifier or a wildcard expression. If you do not specify one of these options, the API returns information for all transforms.

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.

• size number

  The maximum number of transforms to obtain.

Responses

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

  • id string

    The transform identifier.

  • 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

    The version of Elasticsearch that existed on the node when the transform was created.

  • 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

  Return settings in flat format (default: false)

• master_timeout string

  Explicit operation timeout for connection to master node

  External documentation
• timeout string

  Explicit operation timeout

  External documentation

Responses

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

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

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

    • * object Additional properties

Path parameters

• index string | array[string] Required

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

Query parameters

• expand_wildcards string | array[string]

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

  Supported values include:

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

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

• level string

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

  Values are cluster, indices, or shards.

• local boolean

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

• master_timeout string

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

  External documentation
• timeout string

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

  External documentation
• wait_for_active_shards number | string

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

  Values are all or index-setting.

• wait_for_events string

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

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

• wait_for_nodes string | number

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

• wait_for_no_initializing_shards boolean

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

• wait_for_no_relocating_shards boolean

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

• wait_for_status string

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

  Supported values include:

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

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

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

    The name of the cluster.

  • 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

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

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

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

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

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

      • 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

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

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

  • task_max_waiting_in_queue string

    The time since the earliest initiated task is waiting for being performed.

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